@wix/auto_sdk_ecom_orders 1.0.244 → 1.0.245

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (41) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-DCa6i0d-.d.ts → ecom-v1-order-orders.universal-KcLEcCNU.d.ts} +1590 -1590
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +75 -75
  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 +75 -75
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1590 -1590
  9. package/build/cjs/meta.js +75 -75
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-DCa6i0d-.d.mts → ecom-v1-order-orders.universal-KcLEcCNU.d.mts} +1590 -1590
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +75 -75
  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 +75 -75
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1590 -1590
  19. package/build/es/meta.mjs +75 -75
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-m8UbhxW9.d.ts → ecom-v1-order-orders.universal-HbPNk6ZU.d.ts} +1631 -1631
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.js +75 -75
  24. package/build/internal/cjs/index.js.map +1 -1
  25. package/build/internal/cjs/index.typings.d.ts +2 -2
  26. package/build/internal/cjs/index.typings.js +75 -75
  27. package/build/internal/cjs/index.typings.js.map +1 -1
  28. package/build/internal/cjs/meta.d.ts +1590 -1590
  29. package/build/internal/cjs/meta.js +75 -75
  30. package/build/internal/cjs/meta.js.map +1 -1
  31. package/build/internal/es/{ecom-v1-order-orders.universal-m8UbhxW9.d.mts → ecom-v1-order-orders.universal-HbPNk6ZU.d.mts} +1631 -1631
  32. package/build/internal/es/index.d.mts +2 -2
  33. package/build/internal/es/index.mjs +75 -75
  34. package/build/internal/es/index.mjs.map +1 -1
  35. package/build/internal/es/index.typings.d.mts +2 -2
  36. package/build/internal/es/index.typings.mjs +75 -75
  37. package/build/internal/es/index.typings.mjs.map +1 -1
  38. package/build/internal/es/meta.d.mts +1590 -1590
  39. package/build/internal/es/meta.mjs +75 -75
  40. package/build/internal/es/meta.mjs.map +1 -1
  41. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { df as ImportOrderRequest$1, dg as ImportOrderResponse$1, dh as SetOrderNumberCounterRequest$1, di as SetOrderNumberCounterResponse$1, dj as BulkDeleteImportedOrdersRequest$1, dk as BulkDeleteImportedOrdersResponse$1, f4 as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, f8 as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, f9 as RecordManuallyCollectedPaymentRequest$1, fc as RecordManuallyCollectedPaymentResponse$1, fd as MarkOrderAsPaidRequest$1, fe as MarkOrderAsPaidResponse$1, ff as BulkMarkOrdersAsPaidRequest$1, fg as BulkMarkOrdersAsPaidResponse$1, fl as GetRefundabilityStatusRequest$1, fm as GetRefundabilityStatusResponse$1, fp as CreatePaymentGatewayOrderRequest$1, fr as CreatePaymentGatewayOrderResponse$1, fs as ChargeMembershipsRequest$1, fw as ChargeMembershipsResponse$1, fx as TriggerRefundRequest$1, fC as TriggerRefundResponse$1, g4 as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, g5 as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, ga as GetOrderRequest$1, gb as GetOrderResponse$1, gn as SearchOrdersRequest$1, S as SearchOrdersResponse$1, gr as CreateOrderRequest$1, gv as CreateOrderResponse$1, gw as UpdateOrderRequest$1, gx as UpdateOrderResponse$1, gy as BulkUpdateOrdersRequest$1, l as BulkUpdateOrdersResponse$1, h1 as UpdateOrderLineItemRequest$1, h2 as UpdateOrderLineItemResponse$1, ht as AddActivityRequest$1, hw as AddActivityResponse$1, hx as AddActivitiesRequest$1, m as AddActivitiesResponse$1, hy as UpdateActivityRequest$1, hz as UpdateActivityResponse$1, hA as DeleteActivityRequest$1, hB as DeleteActivityResponse$1, hH as CancelOrderRequest$1, o as CancelOrderResponse$1, hI as UpdateOrderStatusRequest$1, hJ as UpdateOrderStatusResponse$1, i5 as AggregateOrdersRequest$1, i6 as AggregateOrdersResponse$1, ia as BulkUpdateOrderTagsRequest$1, r as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DCa6i0d-.js';
1
+ import { df as ImportOrderRequest$1, dg as ImportOrderResponse$1, dh as SetOrderNumberCounterRequest$1, di as SetOrderNumberCounterResponse$1, dj as BulkDeleteImportedOrdersRequest$1, dk as BulkDeleteImportedOrdersResponse$1, dM as PreparePaymentCollectionRequest$1, b as PreparePaymentCollectionResponse$1, dQ as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, dR as RecordManuallyCollectedPaymentRequest$1, dU as RecordManuallyCollectedPaymentResponse$1, dV as MarkOrderAsPaidRequest$1, dW as MarkOrderAsPaidResponse$1, dX as BulkMarkOrdersAsPaidRequest$1, dY as BulkMarkOrdersAsPaidResponse$1, e1 as GetRefundabilityStatusRequest$1, e2 as GetRefundabilityStatusResponse$1, e5 as CreatePaymentGatewayOrderRequest$1, e7 as CreatePaymentGatewayOrderResponse$1, e8 as ChargeMembershipsRequest$1, ec as ChargeMembershipsResponse$1, ed as TriggerRefundRequest$1, en as TriggerRefundResponse$1, eR as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, eS as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, ga as GetOrderRequest$1, gb as GetOrderResponse$1, gn as SearchOrdersRequest$1, S as SearchOrdersResponse$1, gr as CreateOrderRequest$1, gv as CreateOrderResponse$1, gw as UpdateOrderRequest$1, gx as UpdateOrderResponse$1, gy as BulkUpdateOrdersRequest$1, l as BulkUpdateOrdersResponse$1, h1 as UpdateOrderLineItemRequest$1, h2 as UpdateOrderLineItemResponse$1, ht as AddActivityRequest$1, hw as AddActivityResponse$1, hx as AddActivitiesRequest$1, m as AddActivitiesResponse$1, hy as UpdateActivityRequest$1, hz as UpdateActivityResponse$1, hA as DeleteActivityRequest$1, hB as DeleteActivityResponse$1, hH as CancelOrderRequest$1, o as CancelOrderResponse$1, hI as UpdateOrderStatusRequest$1, hJ as UpdateOrderStatusResponse$1, i5 as AggregateOrdersRequest$1, i6 as AggregateOrdersResponse$1, ia as BulkUpdateOrderTagsRequest$1, r as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-KcLEcCNU.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -3762,2010 +3762,2010 @@ interface TriggerReindexOrderRequest {
3762
3762
  */
3763
3763
  orderId?: string;
3764
3764
  }
3765
- interface SendBuyerConfirmationEmailRequest {
3766
- /** @format GUID */
3767
- orderId?: string;
3768
- }
3769
- interface SendBuyerConfirmationEmailResponse {
3770
- }
3771
- interface SendBuyerPaymentsReceivedEmailRequest {
3765
+ interface PreparePaymentCollectionRequest {
3772
3766
  /**
3767
+ * Ecom order ID.
3773
3768
  * @minLength 1
3774
3769
  * @maxLength 100
3775
3770
  */
3776
- orderId?: string;
3777
- }
3778
- interface SendBuyerPaymentsReceivedEmailResponse {
3779
- }
3780
- interface SendBuyerPickupConfirmationEmailRequest {
3771
+ ecomOrderId: string;
3772
+ /** Amount to collect */
3773
+ amount: Price;
3781
3774
  /**
3782
- * @minLength 1
3783
- * @maxLength 100
3775
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
3776
+ * Existing payment gateway order will be updated with a new amount.
3777
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
3784
3778
  */
3785
- orderId?: string;
3786
- }
3787
- interface SendBuyerPickupConfirmationEmailResponse {
3788
- }
3789
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
3779
+ paymentGatewayOrderId?: string | null;
3790
3780
  /**
3791
- * IDs of orders to send pickup emails for.
3792
- * @minSize 1
3793
- * @maxSize 300
3781
+ * Whether to delay capture of the payment.
3782
+ * Default: false
3783
+ * @deprecated Whether to delay capture of the payment.
3784
+ * Default: false
3785
+ * @replacedBy delayed_capture_settings.scheduled_action
3786
+ * @targetRemovalDate 2024-09-30
3794
3787
  */
3795
- orderIds?: string[];
3796
- }
3797
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
3788
+ delayedCapture?: boolean;
3789
+ /** Delayed capture payment settings */
3790
+ delayedCaptureSettings?: DelayedCaptureSettings;
3798
3791
  }
3799
- interface SendBuyerShippingConfirmationEmailRequest {
3792
+ interface RedirectUrls {
3800
3793
  /**
3801
- * @minLength 1
3802
- * @maxLength 100
3794
+ * URL to redirect buyer in case of approved (successful) transaction
3795
+ * @format WEB_URL
3803
3796
  */
3804
- orderId?: string;
3797
+ successUrl?: string | null;
3798
+ /**
3799
+ * URL to redirect buyer in case of buyer canceled the transaction
3800
+ * @format WEB_URL
3801
+ */
3802
+ cancelUrl?: string | null;
3803
+ /**
3804
+ * URL to redirect buyer in case of failed/rejected transaction
3805
+ * @format WEB_URL
3806
+ */
3807
+ errorUrl?: string | null;
3808
+ /**
3809
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
3810
+ * @format WEB_URL
3811
+ */
3812
+ pendingUrl?: string | null;
3805
3813
  }
3806
- interface SendBuyerShippingConfirmationEmailResponse {
3814
+ interface DelayedCaptureSettings {
3815
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
3816
+ scheduledAction?: ScheduledActionWithLiterals;
3817
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
3818
+ delayDuration?: Duration;
3807
3819
  }
3808
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
3820
+ declare enum ScheduledAction {
3821
+ /** Whether payment will be auto-voided when duration passes */
3822
+ VOID = "VOID",
3823
+ /** Whether payment will be auto-captured when duration passes */
3824
+ CAPTURE = "CAPTURE"
3825
+ }
3826
+ /** @enumType */
3827
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
3828
+ interface Duration {
3809
3829
  /**
3810
- * IDs of orders to send pickup emails for.
3811
- * @minSize 1
3812
- * @maxSize 300
3830
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
3831
+ * @min 1
3813
3832
  */
3814
- orderIds?: string[];
3833
+ count?: number;
3834
+ /** Duration unit: MINUTES, HOURS and DAYS */
3835
+ unit?: DurationUnitWithLiterals;
3815
3836
  }
3816
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
3837
+ declare enum DurationUnit {
3838
+ MINUTES = "MINUTES",
3839
+ HOURS = "HOURS",
3840
+ DAYS = "DAYS"
3817
3841
  }
3818
- interface SendMerchantOrderReceivedNotificationRequest {
3842
+ /** @enumType */
3843
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
3844
+ interface PreparePaymentCollectionResponse {
3845
+ /** Payment gateway order id which is associated with given payment */
3846
+ paymentGatewayOrderId?: string;
3847
+ }
3848
+ interface GetPaymentCollectabilityStatusRequest {
3819
3849
  /**
3850
+ * Ecom order ID.
3820
3851
  * @minLength 1
3821
3852
  * @maxLength 100
3822
3853
  */
3823
- orderId?: string;
3854
+ ecomOrderId: string;
3824
3855
  }
3825
- interface SendMerchantOrderReceivedNotificationResponse {
3856
+ interface GetPaymentCollectabilityStatusResponse {
3857
+ /** Payment collectability status */
3858
+ status?: PaymentCollectabilityStatusWithLiterals;
3859
+ /** Collectable order amount */
3860
+ amount?: Price;
3826
3861
  }
3827
- interface SendCancelRefundEmailRequest {
3862
+ declare enum PaymentCollectabilityStatus {
3863
+ UNKNOWN = "UNKNOWN",
3864
+ COLLECTABLE = "COLLECTABLE",
3865
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
3866
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
3867
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
3868
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
3869
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
3870
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
3871
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
3872
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
3873
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
3874
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
3875
+ }
3876
+ /** @enumType */
3877
+ 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';
3878
+ interface RecordManuallyCollectedPaymentRequest {
3828
3879
  /**
3829
- * The ID of order that is canceled/refunded
3880
+ * Order ID.
3830
3881
  * @minLength 1
3831
3882
  * @maxLength 100
3832
3883
  */
3833
- orderId?: string;
3834
- /**
3835
- * Personal note added to the email (optional)
3836
- * @minLength 1
3837
- * @maxLength 1000
3838
- */
3839
- customMessage?: string | null;
3840
- /** Refund amount */
3841
- refundAmount?: Price;
3842
- /**
3843
- * Refund ID. (Optional)
3844
- * @format GUID
3845
- */
3846
- refundId?: string | null;
3847
- }
3848
- interface SendCancelRefundEmailResponse {
3884
+ orderId: string;
3885
+ /** Amount to be recorded as approved manual payment for given order */
3886
+ amount: Price;
3849
3887
  }
3850
- interface SendRefundEmailRequest {
3851
- /**
3852
- * The ID of order that is refunded
3853
- * @format GUID
3854
- */
3855
- orderId?: string;
3856
- /**
3857
- * Refund ID
3858
- * @format GUID
3859
- */
3860
- refundId?: string;
3888
+ /**
3889
+ * User-defined payment method name.
3890
+ * Allows specifying either a predefined type or a custom name.
3891
+ */
3892
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
3893
+ /** Predefined payment method. */
3894
+ predefined?: PredefinedPaymentMethodWithLiterals;
3861
3895
  /**
3862
- * Personal note added to the email (optional)
3896
+ * Custom payment method name provided by user.
3897
+ *
3898
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
3863
3899
  * @minLength 1
3864
- * @maxLength 1000
3900
+ * @maxLength 100
3865
3901
  */
3866
- customMessage?: string | null;
3867
- }
3868
- interface SendRefundEmailResponse {
3869
- }
3870
- interface SendFulfillmentEmailRequest {
3871
- /** @format GUID */
3872
- orderId?: string;
3873
- /** @format GUID */
3874
- fulfillerId?: string;
3875
- }
3876
- interface SendFulfillmentEmailResponse {
3902
+ custom?: string | null;
3877
3903
  }
3878
- interface SendMerchantOrderReceivedPushRequest {
3904
+ /** @oneof */
3905
+ interface UserDefinedPaymentMethodNameKindOneOf {
3906
+ /** Predefined payment method. */
3907
+ predefined?: PredefinedPaymentMethodWithLiterals;
3879
3908
  /**
3909
+ * Custom payment method name provided by user.
3910
+ *
3911
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
3880
3912
  * @minLength 1
3881
3913
  * @maxLength 100
3882
3914
  */
3883
- orderId?: string;
3884
- }
3885
- interface SendMerchantOrderReceivedPushResponse {
3886
- }
3887
- interface PreviewEmailByTypeRequest {
3888
- emailType?: PreviewEmailTypeWithLiterals;
3915
+ custom?: string | null;
3889
3916
  }
3890
- declare enum PreviewEmailType {
3891
- ORDER_PLACED = "ORDER_PLACED",
3892
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
3893
- ORDER_SHIPPED = "ORDER_SHIPPED",
3894
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
3917
+ /** Predefined payment method types for offline/manual payments. */
3918
+ declare enum PredefinedPaymentMethod {
3919
+ /** Cash payment. */
3920
+ CASH = "CASH",
3921
+ /** Bank transfer. */
3922
+ BANK_TRANSFER = "BANK_TRANSFER",
3923
+ /** Payment by check. */
3924
+ CHECK = "CHECK"
3895
3925
  }
3896
3926
  /** @enumType */
3897
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
3898
- interface PreviewEmailByTypeResponse {
3899
- emailPreview?: string;
3927
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
3928
+ interface RecordManuallyCollectedPaymentResponse {
3900
3929
  }
3901
- interface PreviewRefundEmailRequest {
3930
+ interface MarkOrderAsPaidRequest {
3902
3931
  /**
3932
+ * Ecom order ID.
3903
3933
  * @minLength 1
3904
3934
  * @maxLength 100
3905
3935
  */
3906
- orderId?: string;
3907
- /** Refund amount */
3908
- refundAmount?: Price;
3909
- /** Refund business details */
3910
- details?: RefundDetails;
3936
+ ecomOrderId: string;
3937
+ }
3938
+ interface MarkOrderAsPaidResponse {
3939
+ /** Updated order. */
3940
+ order?: Order;
3941
+ }
3942
+ interface BulkMarkOrdersAsPaidRequest {
3911
3943
  /**
3912
- * Personal note added to the email (optional)
3944
+ * IDs of orders to mark as paid.
3945
+ * @minSize 1
3946
+ * @maxSize 100
3913
3947
  * @minLength 1
3914
- * @maxLength 1000
3915
- */
3916
- customMessage?: string | null;
3917
- /**
3918
- * Refund ID. (Optional)
3919
- * @format GUID
3948
+ * @maxLength 100
3920
3949
  */
3921
- refundId?: string | null;
3950
+ ecomOrderIds: string[];
3922
3951
  }
3923
- /** Business model of a refund request */
3924
- interface RefundDetails {
3952
+ interface BulkMarkOrdersAsPaidResponse {
3925
3953
  /**
3926
- * Order line item IDs and quantities that were refunded.
3927
- * @maxSize 300
3954
+ * Items updated by the bulk action.
3955
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
3928
3956
  */
3929
- items?: RefundItem[];
3930
- /** Whether the shipping fee was also refunded. */
3931
- shippingIncluded?: boolean;
3957
+ results?: BulkOrderResult[];
3958
+ /** Bulk action metadata. */
3959
+ bulkActionMetadata?: BulkActionMetadata;
3960
+ }
3961
+ interface BulkOrderResult {
3962
+ /** Item metadata. */
3963
+ itemMetadata?: ItemMetadata;
3932
3964
  /**
3933
- * Reason for the refund, provided by customer (optional).
3934
- * @maxLength 200
3965
+ * Updated order.
3966
+ *
3967
+ * Returned when `returnFullEntity = true`.
3935
3968
  */
3936
- reason?: string | null;
3969
+ item?: Order;
3970
+ }
3971
+ interface ItemMetadata {
3972
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
3973
+ id?: string | null;
3974
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
3975
+ originalIndex?: number;
3976
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
3977
+ success?: boolean;
3978
+ /** Details about the error in case of failure. */
3979
+ error?: ApplicationError;
3980
+ }
3981
+ interface ApplicationError {
3982
+ /** Error code. */
3983
+ code?: string;
3984
+ /** Description of the error. */
3985
+ description?: string;
3986
+ /** Data related to the error. */
3987
+ data?: Record<string, any> | null;
3988
+ }
3989
+ interface BulkActionMetadata {
3990
+ /** Number of items that were successfully processed. */
3991
+ totalSuccesses?: number;
3992
+ /** Number of items that couldn't be processed. */
3993
+ totalFailures?: number;
3994
+ /** Number of failures without details because detailed failure threshold was exceeded. */
3995
+ undetailedFailures?: number;
3996
+ }
3997
+ interface GetRefundabilityStatusRequest {
3937
3998
  /**
3938
- * Line items that were refunded.
3939
- * @maxSize 300
3999
+ * Order ID.
4000
+ * @minLength 1
4001
+ * @maxLength 100
3940
4002
  */
3941
- lineItems?: LineItemRefund[];
4003
+ ecomOrderId: string;
4004
+ }
4005
+ interface GetRefundabilityStatusResponse {
3942
4006
  /**
3943
- * Additional fees that were refunded.
3944
- * @maxSize 100
4007
+ * Refundability details.
4008
+ * @maxSize 300
3945
4009
  */
3946
- additionalFees?: AdditionalFeeRefund[];
3947
- /** Shipping amount that was refunded. */
3948
- shipping?: ShippingRefund;
3949
- }
3950
- interface RefundItem {
4010
+ refundabilities?: Refundability[];
3951
4011
  /**
3952
- * Line item ID the refunded line item.
3953
- * @format GUID
4012
+ * Whether the order supports refunding per item.
4013
+ * @deprecated
3954
4014
  */
3955
- lineItemId?: string;
4015
+ refundablePerItem?: boolean;
4016
+ }
4017
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4018
+ /** Reason why payment is not refundable. */
4019
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4020
+ /** Reason why payment is only refundable manually. */
4021
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4022
+ /** Payment ID. */
4023
+ paymentId?: string;
4024
+ /** Payment refundability status. */
4025
+ refundabilityStatus?: RefundableStatusWithLiterals;
4026
+ /** Link to payment provider dashboard. */
4027
+ providerLink?: string | null;
4028
+ }
4029
+ /** @oneof */
4030
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4031
+ /** Reason why payment is not refundable. */
4032
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4033
+ /** Reason why payment is only refundable manually. */
4034
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4035
+ }
4036
+ declare enum RefundableStatus {
4037
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4038
+ MANUAL = "MANUAL",
4039
+ REFUNDABLE = "REFUNDABLE"
4040
+ }
4041
+ /** @enumType */
4042
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4043
+ declare enum NonRefundableReason {
4044
+ NONE = "NONE",
4045
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4046
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4047
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4048
+ NOT_PAID = "NOT_PAID",
4049
+ ACCESS_DENIED = "ACCESS_DENIED",
4050
+ ZERO_PRICE = "ZERO_PRICE",
4051
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4052
+ PENDING_REFUND = "PENDING_REFUND",
4053
+ FORBIDDEN = "FORBIDDEN",
4054
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4055
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4056
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4057
+ }
4058
+ /** @enumType */
4059
+ 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';
4060
+ declare enum ManuallyRefundableReason {
4061
+ EXPIRED = "EXPIRED",
4062
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4063
+ OFFLINE = "OFFLINE",
4064
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4065
+ }
4066
+ /** @enumType */
4067
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4068
+ interface CreatePaymentGatewayOrderRequest {
3956
4069
  /**
3957
- * Line item quantity refunded.
3958
- * @min 1
3959
- * @max 100000
4070
+ * Ecom order ID.
4071
+ * @minLength 1
4072
+ * @maxLength 100
3960
4073
  */
3961
- quantity?: number;
4074
+ ecomOrderId: string;
4075
+ /** Information about the user who initiated the payment. */
4076
+ chargedBy?: ChargedBy;
3962
4077
  }
3963
- interface LineItemRefund {
4078
+ interface ChargedBy {
3964
4079
  /**
3965
- * Line item ID.
4080
+ * ID - id of the user who initiated the payment
3966
4081
  * @format GUID
3967
- * @immutable
3968
4082
  */
3969
- lineItemId?: string;
4083
+ id?: string;
3970
4084
  /**
3971
- * Refund quantity.
3972
- * @min 1
3973
- * @max 100000
3974
- * @immutable
4085
+ * Full name - name of the user who initiated the payment
4086
+ * @minLength 1
4087
+ * @maxLength 200
3975
4088
  */
3976
- quantity?: number;
4089
+ fullName?: string | null;
3977
4090
  }
3978
- interface AdditionalFeeRefund {
4091
+ interface CreatePaymentGatewayOrderResponse {
4092
+ /** ID of the order created in the payment gateway */
4093
+ paymentGatewayOrderId?: string;
4094
+ }
4095
+ interface ChargeMembershipsRequest {
3979
4096
  /**
3980
- * Additional fee ID.
3981
- * @format GUID
3982
- * @immutable
4097
+ * Order ID.
4098
+ * @minLength 1
4099
+ * @maxLength 100
3983
4100
  */
3984
- additionalFeeId?: string;
4101
+ ecomOrderId: string;
3985
4102
  /**
3986
- * Refund amount.
3987
- * @immutable
4103
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4104
+ * but a user which is using the membership on behalf of the a member
4105
+ * @format GUID
3988
4106
  */
3989
- amount?: Price;
3990
- }
3991
- interface ShippingRefund {
4107
+ memberId: string;
3992
4108
  /**
3993
- * Refund amount.
3994
- * @immutable
4109
+ * List of items to be paid by memberships
4110
+ * @minSize 1
4111
+ * @maxSize 300
3995
4112
  */
3996
- amount?: Price;
3997
- }
3998
- interface PreviewRefundEmailResponse {
3999
- emailPreview?: string;
4113
+ membershipCharges?: MembershipChargeItem[];
4000
4114
  }
4001
- interface PreviewCancelEmailRequest {
4115
+ interface MembershipChargeItem {
4002
4116
  /**
4117
+ * The id of used membership
4003
4118
  * @minLength 1
4004
4119
  * @maxLength 100
4005
4120
  */
4006
- orderId?: string;
4121
+ membershipId?: string;
4007
4122
  /**
4008
- * Personal note added to the email (optional)
4123
+ * ID of the application providing this payment option
4124
+ * @format GUID
4125
+ */
4126
+ appId?: string;
4127
+ /** The name of used membership */
4128
+ membershipName?: MembershipName;
4129
+ /** Additional data about this membership */
4130
+ membershipAdditionalData?: Record<string, any> | null;
4131
+ /** Catalog and item reference info. */
4132
+ catalogReference?: CatalogReference;
4133
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
4134
+ serviceProperties?: ServiceProperties;
4135
+ /**
4136
+ * Usually would be the same as catalogReference.catalogItemId
4137
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
4138
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4009
4139
  * @minLength 1
4010
- * @maxLength 1000
4140
+ * @maxLength 36
4011
4141
  */
4012
- customMessage?: string | null;
4013
- }
4014
- interface PreviewCancelEmailResponse {
4015
- emailPreview?: string;
4016
- }
4017
- interface PreviewCancelRefundEmailRequest {
4142
+ rootCatalogItemId?: string | null;
4018
4143
  /**
4144
+ * line item id of Checkout/Order line item
4019
4145
  * @minLength 1
4020
4146
  * @maxLength 100
4021
4147
  */
4022
- orderId?: string;
4148
+ lineItemId?: string;
4149
+ }
4150
+ interface MembershipName {
4023
4151
  /**
4024
- * Personal note added to the email (optional)
4025
- * @minLength 1
4026
- * @maxLength 1000
4152
+ * Membership name.
4153
+ * @maxLength 100
4027
4154
  */
4028
- customMessage?: string | null;
4029
- /** Refund amount */
4030
- refundAmount?: Price;
4155
+ original?: string;
4031
4156
  /**
4032
- * Refund ID. (Optional)
4033
- * @format GUID
4157
+ * Translated membership name. Defaults to `original` when not provided.
4158
+ * @maxLength 100
4034
4159
  */
4035
- refundId?: string | null;
4036
- }
4037
- interface PreviewCancelRefundEmailResponse {
4038
- emailPreview?: string;
4039
- }
4040
- interface PreviewBuyerPaymentsReceivedEmailRequest {
4160
+ translated?: string | null;
4041
4161
  }
4042
- interface PreviewBuyerPaymentsReceivedEmailResponse {
4043
- emailPreview?: string;
4162
+ interface ServiceProperties {
4163
+ /**
4164
+ * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4165
+ * For example, the start time of a class.
4166
+ */
4167
+ scheduledDate?: Date | null;
4168
+ /**
4169
+ * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
4170
+ * @min 1
4171
+ * @max 10000
4172
+ */
4173
+ numberOfParticipants?: number | null;
4044
4174
  }
4045
- interface PreviewBuyerConfirmationEmailRequest {
4175
+ interface ChargeMembershipsResponse {
4046
4176
  }
4047
- interface PreviewBuyerConfirmationEmailResponse {
4048
- emailPreview?: string;
4049
- }
4050
- interface PreviewBuyerPickupConfirmationEmailRequest {
4051
- }
4052
- interface PreviewBuyerPickupConfirmationEmailResponse {
4053
- emailPreview?: string;
4054
- }
4055
- interface PreviewShippingConfirmationEmailRequest {
4056
- }
4057
- interface PreviewShippingConfirmationEmailResponse {
4058
- emailPreview?: string;
4059
- }
4060
- interface PreviewResendDownloadLinksEmailRequest {
4061
- }
4062
- interface PreviewResendDownloadLinksEmailResponse {
4063
- emailPreview?: string;
4064
- }
4065
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4066
- /** Emitted on a meta site creation. */
4067
- siteCreated?: SiteCreated;
4068
- /** Emitted on a meta site transfer completion. */
4069
- siteTransferred?: SiteTransferred;
4070
- /** Emitted on a meta site deletion. */
4071
- siteDeleted?: SiteDeleted;
4072
- /** Emitted on a meta site restoration. */
4073
- siteUndeleted?: SiteUndeleted;
4074
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4075
- sitePublished?: SitePublished;
4076
- /** Emitted on a meta site unpublish. */
4077
- siteUnpublished?: SiteUnpublished;
4078
- /** Emitted when meta site is marked as template. */
4079
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4080
- /** Emitted when meta site is marked as a WixSite. */
4081
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4082
- /** Emitted when an application is provisioned (installed). */
4083
- serviceProvisioned?: ServiceProvisioned;
4084
- /** Emitted when an application is removed (uninstalled). */
4085
- serviceRemoved?: ServiceRemoved;
4086
- /** Emitted when meta site name (URL slug) is changed. */
4087
- siteRenamedPayload?: SiteRenamed;
4088
- /** Emitted when meta site was permanently deleted. */
4089
- hardDeleted?: SiteHardDeleted;
4090
- /** Emitted on a namespace change. */
4091
- namespaceChanged?: NamespaceChanged;
4092
- /** Emitted when Studio is attached. */
4093
- studioAssigned?: StudioAssigned;
4094
- /** Emitted when Studio is detached. */
4095
- studioUnassigned?: StudioUnassigned;
4096
- /**
4097
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4098
- * the actual URL.
4099
- *
4100
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4101
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4102
- */
4103
- urlChanged?: SiteUrlChanged;
4104
- /** Site is marked as PurgedExternally */
4105
- sitePurgedExternally?: SitePurgedExternally;
4106
- /** Emitted when Odeditor is attached. */
4107
- odeditorAssigned?: OdeditorAssigned;
4108
- /** Emitted when Odeditor is detached. */
4109
- odeditorUnassigned?: OdeditorUnassigned;
4110
- /** Emitted when Picasso is attached. */
4111
- picassoAssigned?: PicassoAssigned;
4112
- /** Emitted when Picasso is detached. */
4113
- picassoUnassigned?: PicassoUnassigned;
4114
- /** Emitted when Wixel is attached. */
4115
- wixelAssigned?: WixelAssigned;
4116
- /** Emitted when Wixel is detached. */
4117
- wixelUnassigned?: WixelUnassigned;
4118
- /** Emitted when StudioTwo is attached. */
4119
- studioTwoAssigned?: StudioTwoAssigned;
4120
- /** Emitted when StudioTwo is detached. */
4121
- studioTwoUnassigned?: StudioTwoUnassigned;
4122
- /** Emitted when media from user domain is enabled. */
4123
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4124
- /** Emitted when media from user domain is disabled. */
4125
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4126
- /** Emitted when Editorless is attached. */
4127
- editorlessAssigned?: EditorlessAssigned;
4128
- /** Emitted when Editorless is detached. */
4129
- editorlessUnassigned?: EditorlessUnassigned;
4130
- /**
4131
- * A meta site id.
4132
- * @format GUID
4133
- */
4134
- metaSiteId?: string;
4135
- /** A meta site version. Monotonically increasing. */
4136
- version?: string;
4137
- /** A timestamp of the event. */
4138
- timestamp?: string;
4139
- /**
4140
- * TODO(meta-site): Change validation once validations are disabled for consumers
4141
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4142
- * @maxSize 4000
4143
- */
4144
- assets?: Asset[];
4145
- }
4146
- /** @oneof */
4147
- interface MetaSiteSpecialEventPayloadOneOf {
4148
- /** Emitted on a meta site creation. */
4149
- siteCreated?: SiteCreated;
4150
- /** Emitted on a meta site transfer completion. */
4151
- siteTransferred?: SiteTransferred;
4152
- /** Emitted on a meta site deletion. */
4153
- siteDeleted?: SiteDeleted;
4154
- /** Emitted on a meta site restoration. */
4155
- siteUndeleted?: SiteUndeleted;
4156
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4157
- sitePublished?: SitePublished;
4158
- /** Emitted on a meta site unpublish. */
4159
- siteUnpublished?: SiteUnpublished;
4160
- /** Emitted when meta site is marked as template. */
4161
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4162
- /** Emitted when meta site is marked as a WixSite. */
4163
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4164
- /** Emitted when an application is provisioned (installed). */
4165
- serviceProvisioned?: ServiceProvisioned;
4166
- /** Emitted when an application is removed (uninstalled). */
4167
- serviceRemoved?: ServiceRemoved;
4168
- /** Emitted when meta site name (URL slug) is changed. */
4169
- siteRenamedPayload?: SiteRenamed;
4170
- /** Emitted when meta site was permanently deleted. */
4171
- hardDeleted?: SiteHardDeleted;
4172
- /** Emitted on a namespace change. */
4173
- namespaceChanged?: NamespaceChanged;
4174
- /** Emitted when Studio is attached. */
4175
- studioAssigned?: StudioAssigned;
4176
- /** Emitted when Studio is detached. */
4177
- studioUnassigned?: StudioUnassigned;
4178
- /**
4179
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4180
- * the actual URL.
4181
- *
4182
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4183
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4184
- */
4185
- urlChanged?: SiteUrlChanged;
4186
- /** Site is marked as PurgedExternally */
4187
- sitePurgedExternally?: SitePurgedExternally;
4188
- /** Emitted when Odeditor is attached. */
4189
- odeditorAssigned?: OdeditorAssigned;
4190
- /** Emitted when Odeditor is detached. */
4191
- odeditorUnassigned?: OdeditorUnassigned;
4192
- /** Emitted when Picasso is attached. */
4193
- picassoAssigned?: PicassoAssigned;
4194
- /** Emitted when Picasso is detached. */
4195
- picassoUnassigned?: PicassoUnassigned;
4196
- /** Emitted when Wixel is attached. */
4197
- wixelAssigned?: WixelAssigned;
4198
- /** Emitted when Wixel is detached. */
4199
- wixelUnassigned?: WixelUnassigned;
4200
- /** Emitted when StudioTwo is attached. */
4201
- studioTwoAssigned?: StudioTwoAssigned;
4202
- /** Emitted when StudioTwo is detached. */
4203
- studioTwoUnassigned?: StudioTwoUnassigned;
4204
- /** Emitted when media from user domain is enabled. */
4205
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4206
- /** Emitted when media from user domain is disabled. */
4207
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4208
- /** Emitted when Editorless is attached. */
4209
- editorlessAssigned?: EditorlessAssigned;
4210
- /** Emitted when Editorless is detached. */
4211
- editorlessUnassigned?: EditorlessUnassigned;
4212
- }
4213
- interface Asset {
4214
- /**
4215
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4216
- * @maxLength 36
4217
- */
4218
- appDefId?: string;
4219
- /**
4220
- * An instance id. For legacy reasons may be UUID or a string.
4221
- * @maxLength 200
4222
- */
4223
- instanceId?: string;
4224
- /** An application state. */
4225
- state?: StateWithLiterals;
4226
- }
4227
- declare enum State {
4228
- UNKNOWN = "UNKNOWN",
4229
- ENABLED = "ENABLED",
4230
- DISABLED = "DISABLED",
4231
- PENDING = "PENDING",
4232
- DEMO = "DEMO"
4233
- }
4234
- /** @enumType */
4235
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4236
- interface SiteCreated {
4237
- /**
4238
- * A template identifier (empty if not created from a template).
4239
- * @maxLength 36
4240
- */
4241
- originTemplateId?: string;
4242
- /**
4243
- * An account id of the owner.
4244
- * @format GUID
4245
- */
4246
- ownerId?: string;
4247
- /** A context in which meta site was created. */
4248
- context?: SiteCreatedContextWithLiterals;
4249
- /**
4250
- * A meta site id from which this site was created.
4251
- *
4252
- * In case of a creation from a template it's a template id.
4253
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4254
- * @format GUID
4255
- */
4256
- originMetaSiteId?: string | null;
4257
- /**
4258
- * A meta site name (URL slug).
4259
- * @maxLength 20
4260
- */
4261
- siteName?: string;
4262
- /** A namespace. */
4263
- namespace?: NamespaceWithLiterals;
4264
- }
4265
- declare enum SiteCreatedContext {
4266
- /** A valid option, we don't expose all reasons why site might be created. */
4267
- OTHER = "OTHER",
4268
- /** A meta site was created from template. */
4269
- FROM_TEMPLATE = "FROM_TEMPLATE",
4270
- /** A meta site was created by copying of the transfferred meta site. */
4271
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4272
- /** A copy of existing meta site. */
4273
- DUPLICATE = "DUPLICATE",
4274
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4275
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4276
- /** deprecated A meta site was created for Flash editor. */
4277
- FLASH = "FLASH"
4278
- }
4279
- /** @enumType */
4280
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4281
- declare enum Namespace {
4282
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4283
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4284
- WIX = "WIX",
4285
- /** 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. */
4286
- SHOUT_OUT = "SHOUT_OUT",
4287
- /** 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. */
4288
- ALBUMS = "ALBUMS",
4289
- /** 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. */
4290
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4291
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4292
- HOTELS = "HOTELS",
4293
- /** 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. */
4294
- CLUBS = "CLUBS",
4295
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4296
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4297
- /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4298
- DEV_SITE = "DEV_SITE",
4299
- /** 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. */
4300
- LOGOS = "LOGOS",
4301
- /** 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. */
4302
- VIDEO_MAKER = "VIDEO_MAKER",
4303
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4304
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4305
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4306
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4307
- /**
4308
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4309
- *
4310
- * Meta site with this namespace will *not* be shown in a user's site list by default.
4311
- */
4312
- HTML_DRAFT = "HTML_DRAFT",
4313
- /**
4314
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4315
- * Will be accessible from Site List and will not have a website app.
4316
- * Once the user attaches a site, the site will become a regular wixsite.
4317
- */
4318
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
4319
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4320
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
4321
- /** It is to be used in the Business First efforts. */
4322
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
4323
- /** Bookings business flow with no site. */
4324
- ANYWHERE = "ANYWHERE",
4325
- /** Namespace for Headless Backoffice with no editor */
4326
- HEADLESS = "HEADLESS",
4327
- /**
4328
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4329
- * The site will be used for account level CSM feature for enterprise
4330
- */
4331
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4332
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4333
- RISE = "RISE",
4334
- /**
4335
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4336
- * There's a blank site behind the scene but it's blank).
4337
- * The Mobile company will be the owner of this namespace.
4338
- */
4339
- BRANDED_FIRST = "BRANDED_FIRST",
4340
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4341
- NOWNIA = "NOWNIA",
4342
- /**
4343
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
4344
- * The Partners company owns this namespace.
4345
- */
4346
- UGC_TEMPLATE = "UGC_TEMPLATE",
4347
- /** Codux Headless Sites */
4348
- CODUX = "CODUX",
4349
- /** Bobb - AI Design Creator. */
4350
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4351
- /**
4352
- * Shared Blog Site is a unique single site across Enterprise account,
4353
- * This site will hold all Blog posts related to the Marketing product.
4354
- */
4355
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4356
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4357
- STANDALONE_FORMS = "STANDALONE_FORMS",
4358
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4359
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
4360
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4361
- MIMIR = "MIMIR",
4362
- /** Wix Twins platform. */
4363
- TWINS = "TWINS",
4364
- /** Wix Nano. */
4365
- NANO = "NANO",
4366
- /** Base44 headless sites. */
4367
- BASE44 = "BASE44",
4368
- /** Wix Channels Sites */
4369
- CHANNELS = "CHANNELS",
4370
- /** Nautilus platform. */
4371
- NAUTILUS = "NAUTILUS"
4372
- }
4373
- /** @enumType */
4374
- 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';
4375
- /** Site transferred to another user. */
4376
- interface SiteTransferred {
4377
- /**
4378
- * A previous owner id (user that transfers meta site).
4379
- * @format GUID
4380
- */
4381
- oldOwnerId?: string;
4382
- /**
4383
- * A new owner id (user that accepts meta site).
4384
- * @format GUID
4385
- */
4386
- newOwnerId?: string;
4387
- }
4388
- /** Soft deletion of the meta site. Could be restored. */
4389
- interface SiteDeleted {
4390
- /** A deletion context. */
4391
- deleteContext?: DeleteContext;
4392
- }
4393
- interface DeleteContext {
4394
- /** When the meta site was deleted. */
4395
- dateDeleted?: Date | null;
4396
- /** A status. */
4397
- deleteStatus?: DeleteStatusWithLiterals;
4398
- /**
4399
- * A reason (flow).
4400
- * @maxLength 255
4401
- */
4402
- deleteOrigin?: string;
4403
- /**
4404
- * A service that deleted it.
4405
- * @maxLength 255
4406
- */
4407
- initiatorId?: string | null;
4408
- }
4409
- declare enum DeleteStatus {
4410
- UNKNOWN = "UNKNOWN",
4411
- TRASH = "TRASH",
4412
- DELETED = "DELETED",
4413
- PENDING_PURGE = "PENDING_PURGE",
4414
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4415
- }
4416
- /** @enumType */
4417
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4418
- /** Restoration of the meta site. */
4419
- interface SiteUndeleted {
4420
- }
4421
- /** First publish of a meta site. Or subsequent publish after unpublish. */
4422
- interface SitePublished {
4423
- }
4424
- interface SiteUnpublished {
4425
- /**
4426
- * A list of URLs previously associated with the meta site.
4427
- * @maxLength 4000
4428
- * @maxSize 10000
4429
- */
4430
- urls?: string[];
4431
- }
4432
- interface SiteMarkedAsTemplate {
4433
- }
4434
- interface SiteMarkedAsWixSite {
4435
- }
4436
- /**
4437
- * Represents a service provisioned a site.
4438
- *
4439
- * Note on `origin_instance_id`:
4440
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4441
- * This is because of the following scenario:
4442
- *
4443
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
4444
- * such as a product catalog. When you create a site from this template, you inherit this
4445
- * default product catalog. However, if the template's product catalog is modified,
4446
- * your site will retain the catalog as it was at the time of site creation. This ensures that
4447
- * your site remains consistent with what you initially received and does not include any
4448
- * changes made to the original template afterward.
4449
- * To ensure this, the TPA on the template gets a new instance_id.
4450
- */
4451
- interface ServiceProvisioned {
4452
- /**
4453
- * Either UUID or EmbeddedServiceType.
4454
- * @maxLength 36
4455
- */
4456
- appDefId?: string;
4457
- /**
4458
- * Not only UUID. Something here could be something weird.
4459
- * @maxLength 36
4460
- */
4461
- instanceId?: string;
4177
+ interface TriggerRefundRequest {
4462
4178
  /**
4463
- * An instance id from which this instance is originated.
4464
- * @maxLength 36
4179
+ * The order this refund related to
4180
+ * @minLength 1
4181
+ * @maxLength 100
4465
4182
  */
4466
- originInstanceId?: string;
4183
+ ecomOrderId: string;
4467
4184
  /**
4468
- * A version.
4469
- * @maxLength 500
4185
+ * Refund operations information
4186
+ * @minSize 1
4187
+ * @maxSize 1
4470
4188
  */
4471
- version?: string | null;
4189
+ payments: PaymentRefund[];
4190
+ /** Business model of a refund */
4191
+ details?: RefundDetails;
4192
+ /** Side effect details related to refund */
4193
+ sideEffects?: RefundSideEffects;
4194
+ }
4195
+ interface PaymentRefund {
4472
4196
  /**
4473
- * The origin meta site id
4197
+ * Specific payment within the order to refund
4474
4198
  * @format GUID
4475
4199
  */
4476
- originMetaSiteId?: string | null;
4477
- }
4478
- interface ServiceRemoved {
4200
+ paymentId?: string;
4201
+ /** Refund amount. Not relevant for membership and gift card refunds. */
4202
+ amount?: Price;
4479
4203
  /**
4480
- * Either UUID or EmbeddedServiceType.
4481
- * @maxLength 36
4204
+ * Whether refund is made externally and manually (on the payment provider's side)
4205
+ * 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.
4206
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4482
4207
  */
4483
- appDefId?: string;
4208
+ externalRefund?: boolean;
4209
+ }
4210
+ /** Business model of a refund request */
4211
+ interface RefundDetails {
4484
4212
  /**
4485
- * Not only UUID. Something here could be something weird.
4486
- * @maxLength 36
4213
+ * Order line item IDs and quantities that were refunded.
4214
+ * @maxSize 300
4487
4215
  */
4488
- instanceId?: string;
4216
+ items?: RefundItem[];
4217
+ /** Whether the shipping fee was also refunded. */
4218
+ shippingIncluded?: boolean;
4489
4219
  /**
4490
- * A version.
4491
- * @maxLength 500
4220
+ * Reason for the refund, provided by customer (optional).
4221
+ * @maxLength 200
4492
4222
  */
4493
- version?: string | null;
4494
- }
4495
- /** Rename of the site. Meaning, free public url has been changed as well. */
4496
- interface SiteRenamed {
4223
+ reason?: string | null;
4497
4224
  /**
4498
- * A new meta site name (URL slug).
4499
- * @maxLength 20
4225
+ * Line items that were refunded.
4226
+ * @maxSize 300
4500
4227
  */
4501
- newSiteName?: string;
4228
+ lineItems?: LineItemRefund[];
4502
4229
  /**
4503
- * A previous meta site name (URL slug).
4504
- * @maxLength 255
4230
+ * Additional fees that were refunded.
4231
+ * @maxSize 100
4505
4232
  */
4506
- oldSiteName?: string;
4507
- }
4508
- /**
4509
- * Hard deletion of the meta site.
4510
- *
4511
- * Could not be restored. Therefore it's desirable to cleanup data.
4512
- */
4513
- interface SiteHardDeleted {
4514
- /** A deletion context. */
4515
- deleteContext?: DeleteContext;
4516
- }
4517
- interface NamespaceChanged {
4518
- /** A previous namespace. */
4519
- oldNamespace?: NamespaceWithLiterals;
4520
- /** A new namespace. */
4521
- newNamespace?: NamespaceWithLiterals;
4522
- }
4523
- /** Assigned Studio editor */
4524
- interface StudioAssigned {
4525
- }
4526
- /** Unassigned Studio editor */
4527
- interface StudioUnassigned {
4528
- }
4529
- /**
4530
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4531
- *
4532
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4533
- * with sites and its urls, you need to listen to another topic/event. Read about it:
4534
- *
4535
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4536
- */
4537
- interface SiteUrlChanged {
4233
+ additionalFees?: AdditionalFeeRefund[];
4234
+ /** Shipping amount that was refunded. */
4235
+ shipping?: ShippingRefund;
4538
4236
  }
4539
- /**
4540
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4541
- * Consumed by other teams to remove relevant data.
4542
- */
4543
- interface SitePurgedExternally {
4237
+ interface RefundItem {
4544
4238
  /**
4545
- * @maxLength 2048
4546
- * @maxSize 100
4547
- * @deprecated
4548
- * @targetRemovalDate 2025-04-15
4239
+ * Line item ID the refunded line item.
4240
+ * @format GUID
4549
4241
  */
4550
- appDefId?: string[];
4551
- }
4552
- /** Assigned Odeditor */
4553
- interface OdeditorAssigned {
4554
- }
4555
- /** Unassigned Odeditor */
4556
- interface OdeditorUnassigned {
4557
- }
4558
- /** Assigned Picasso editor */
4559
- interface PicassoAssigned {
4560
- }
4561
- /** Unassigned Picasso */
4562
- interface PicassoUnassigned {
4563
- }
4564
- /** Assigned Wixel */
4565
- interface WixelAssigned {
4566
- }
4567
- /** Unassigned Wixel */
4568
- interface WixelUnassigned {
4569
- }
4570
- /** Assigned StudioTwo */
4571
- interface StudioTwoAssigned {
4572
- }
4573
- /** Unassigned StudioTwo */
4574
- interface StudioTwoUnassigned {
4575
- }
4576
- /** Media from user domain is enabled. */
4577
- interface UserDomainMediaEnabled {
4578
- }
4579
- /** Media from user domain is disabled. */
4580
- interface UserDomainMediaDisabled {
4581
- }
4582
- /** Assigned Editorless */
4583
- interface EditorlessAssigned {
4584
- }
4585
- /** Unassigned Editorless */
4586
- interface EditorlessUnassigned {
4587
- }
4588
- interface HasCustomEmailConfigurationsRequest {
4589
- }
4590
- interface HasCustomEmailConfigurationsResponse {
4591
- hasCustomConfigurations?: boolean;
4592
- }
4593
- interface AddToAutomationMigrationPopulationRequest {
4594
- /** When true, sends custom email configurations to automation system via email */
4595
- sendCustomEmailConfigs?: boolean;
4596
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4597
- origin?: OriginWithLiterals;
4598
- }
4599
- declare enum Origin {
4600
- OPT_IN = "OPT_IN",
4601
- MIGRATION = "MIGRATION"
4602
- }
4603
- /** @enumType */
4604
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4605
- interface AddToAutomationMigrationPopulationResponse {
4606
- success?: boolean;
4607
- }
4608
- interface IsInAutomationMigrationPopulationRequest {
4609
- }
4610
- interface IsInAutomationMigrationPopulationResponse {
4611
- inPopulation?: boolean;
4612
- }
4613
- interface PreparePaymentCollectionRequest {
4242
+ lineItemId?: string;
4614
4243
  /**
4615
- * Ecom order ID.
4616
- * @minLength 1
4617
- * @maxLength 100
4244
+ * Line item quantity refunded.
4245
+ * @min 1
4246
+ * @max 100000
4618
4247
  */
4619
- ecomOrderId: string;
4620
- /** Amount to collect */
4621
- amount: Price;
4248
+ quantity?: number;
4249
+ }
4250
+ interface LineItemRefund {
4622
4251
  /**
4623
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4624
- * Existing payment gateway order will be updated with a new amount.
4625
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4252
+ * Line item ID.
4253
+ * @format GUID
4254
+ * @immutable
4626
4255
  */
4627
- paymentGatewayOrderId?: string | null;
4256
+ lineItemId?: string;
4628
4257
  /**
4629
- * Whether to delay capture of the payment.
4630
- * Default: false
4631
- * @deprecated Whether to delay capture of the payment.
4632
- * Default: false
4633
- * @replacedBy delayed_capture_settings.scheduled_action
4634
- * @targetRemovalDate 2024-09-30
4258
+ * Refund quantity.
4259
+ * @min 1
4260
+ * @max 100000
4261
+ * @immutable
4635
4262
  */
4636
- delayedCapture?: boolean;
4637
- /** Delayed capture payment settings */
4638
- delayedCaptureSettings?: DelayedCaptureSettings;
4263
+ quantity?: number;
4639
4264
  }
4640
- interface RedirectUrls {
4265
+ interface AdditionalFeeRefund {
4641
4266
  /**
4642
- * URL to redirect buyer in case of approved (successful) transaction
4643
- * @format WEB_URL
4267
+ * Additional fee ID.
4268
+ * @format GUID
4269
+ * @immutable
4644
4270
  */
4645
- successUrl?: string | null;
4271
+ additionalFeeId?: string;
4646
4272
  /**
4647
- * URL to redirect buyer in case of buyer canceled the transaction
4648
- * @format WEB_URL
4273
+ * Refund amount.
4274
+ * @immutable
4649
4275
  */
4650
- cancelUrl?: string | null;
4276
+ amount?: Price;
4277
+ }
4278
+ interface ShippingRefund {
4651
4279
  /**
4652
- * URL to redirect buyer in case of failed/rejected transaction
4653
- * @format WEB_URL
4280
+ * Refund amount.
4281
+ * @immutable
4654
4282
  */
4655
- errorUrl?: string | null;
4283
+ amount?: Price;
4284
+ }
4285
+ interface RefundSideEffects {
4286
+ /** Inventory restock details as part of this refund. */
4287
+ restockInfo?: RestockInfo;
4288
+ /** Whether to send a refund confirmation email to the customer. */
4289
+ sendOrderRefundedEmail?: boolean;
4656
4290
  /**
4657
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4658
- * @format WEB_URL
4291
+ * Custom message added to the refund confirmation email.
4292
+ * @minLength 1
4293
+ * @maxLength 1000
4659
4294
  */
4660
- pendingUrl?: string | null;
4295
+ customMessage?: string | null;
4661
4296
  }
4662
- interface DelayedCaptureSettings {
4663
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4664
- scheduledAction?: ScheduledActionWithLiterals;
4665
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4666
- delayDuration?: Duration;
4297
+ interface RestockInfo {
4298
+ /** Restock type. */
4299
+ type?: RestockTypeWithLiterals;
4300
+ /**
4301
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4302
+ * @maxSize 300
4303
+ */
4304
+ items?: RestockItem[];
4667
4305
  }
4668
- declare enum ScheduledAction {
4669
- /** Whether payment will be auto-voided when duration passes */
4670
- VOID = "VOID",
4671
- /** Whether payment will be auto-captured when duration passes */
4672
- CAPTURE = "CAPTURE"
4306
+ declare enum RestockType {
4307
+ NO_ITEMS = "NO_ITEMS",
4308
+ ALL_ITEMS = "ALL_ITEMS",
4309
+ SOME_ITEMS = "SOME_ITEMS"
4673
4310
  }
4674
4311
  /** @enumType */
4675
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4676
- interface Duration {
4312
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4313
+ interface RestockItem {
4677
4314
  /**
4678
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4315
+ * ID of the line item being restocked.
4316
+ * @format GUID
4317
+ */
4318
+ lineItemId?: string;
4319
+ /**
4320
+ * Line item quantity being restocked.
4679
4321
  * @min 1
4322
+ * @max 100000
4680
4323
  */
4681
- count?: number;
4682
- /** Duration unit: MINUTES, HOURS and DAYS */
4683
- unit?: DurationUnitWithLiterals;
4684
- }
4685
- declare enum DurationUnit {
4686
- MINUTES = "MINUTES",
4687
- HOURS = "HOURS",
4688
- DAYS = "DAYS"
4324
+ quantity?: number;
4689
4325
  }
4690
- /** @enumType */
4691
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4692
- interface PreparePaymentCollectionResponse {
4693
- /** Payment gateway order id which is associated with given payment */
4694
- paymentGatewayOrderId?: string;
4326
+ interface TriggerRefundResponse {
4327
+ /** All order's transactions after the refunds were added */
4328
+ orderTransactions?: OrderTransactions;
4329
+ /** Created refund ID */
4330
+ refundId?: string | null;
4331
+ /** Payment ID's that the refund execution had failed for */
4332
+ failedPaymentIds?: ItemMetadata[];
4695
4333
  }
4696
- interface GetPaymentCollectabilityStatusRequest {
4334
+ /**
4335
+ * A record of all payments and refunds associated with an order.
4336
+ *
4337
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4338
+ */
4339
+ interface OrderTransactions {
4697
4340
  /**
4698
- * Ecom order ID.
4699
- * @minLength 1
4700
- * @maxLength 100
4341
+ * Order ID.
4342
+ * @format GUID
4701
4343
  */
4702
- ecomOrderId: string;
4344
+ orderId?: string;
4345
+ /**
4346
+ * Record of payments made to the merchant.
4347
+ * @maxSize 100
4348
+ */
4349
+ payments?: Payment[];
4350
+ /**
4351
+ * Record of refunds made to the buyer.
4352
+ * @maxSize 300
4353
+ */
4354
+ refunds?: Refund[];
4703
4355
  }
4704
- interface GetPaymentCollectabilityStatusResponse {
4705
- /** Payment collectability status */
4706
- status?: PaymentCollectabilityStatusWithLiterals;
4707
- /** Collectable order amount */
4356
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
4357
+ /** Regular payment details. */
4358
+ regularPaymentDetails?: RegularPaymentDetails;
4359
+ /** Gift card payment details. */
4360
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4361
+ /**
4362
+ * Payment ID.
4363
+ * @format GUID
4364
+ * @readonly
4365
+ */
4366
+ id?: string | null;
4367
+ /** 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. */
4368
+ createdDate?: Date | null;
4369
+ /**
4370
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4371
+ * @readonly
4372
+ */
4373
+ updatedDate?: Date | null;
4374
+ /** Payment amount. */
4708
4375
  amount?: Price;
4376
+ /**
4377
+ * Whether refunds for this payment are disabled.
4378
+ * + `true`: This payment is not refundable.
4379
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4380
+ */
4381
+ refundDisabled?: boolean;
4709
4382
  }
4710
- declare enum PaymentCollectabilityStatus {
4711
- UNKNOWN = "UNKNOWN",
4712
- COLLECTABLE = "COLLECTABLE",
4713
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4714
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4715
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4716
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4717
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4718
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4719
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4720
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4721
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4722
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED"
4383
+ /** @oneof */
4384
+ interface PaymentPaymentDetailsOneOf {
4385
+ /** Regular payment details. */
4386
+ regularPaymentDetails?: RegularPaymentDetails;
4387
+ /** Gift card payment details. */
4388
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4723
4389
  }
4724
- /** @enumType */
4725
- 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';
4726
- interface RecordManuallyCollectedPaymentRequest {
4390
+ /** @oneof */
4391
+ interface PaymentReceiptInfoOneOf {
4392
+ }
4393
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4394
+ /** Credit card details. */
4395
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4727
4396
  /**
4728
- * Order ID.
4729
- * @minLength 1
4397
+ * Wix Payments order ID.
4730
4398
  * @maxLength 100
4731
4399
  */
4732
- orderId: string;
4733
- /** Amount to be recorded as approved manual payment for given order */
4734
- amount: Price;
4735
- }
4736
- /**
4737
- * User-defined payment method name.
4738
- * Allows specifying either a predefined type or a custom name.
4739
- */
4740
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4741
- /** Predefined payment method. */
4742
- predefined?: PredefinedPaymentMethodWithLiterals;
4400
+ paymentOrderId?: string | null;
4743
4401
  /**
4744
- * Custom payment method name provided by user.
4745
- *
4746
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4747
- * @minLength 1
4402
+ * Payment gateway's transaction ID.
4403
+ * This field is only returned when the value of `offline_payment` is `false`.
4748
4404
  * @maxLength 100
4749
4405
  */
4750
- custom?: string | null;
4751
- }
4752
- /** @oneof */
4753
- interface UserDefinedPaymentMethodNameKindOneOf {
4754
- /** Predefined payment method. */
4755
- predefined?: PredefinedPaymentMethodWithLiterals;
4406
+ gatewayTransactionId?: string | null;
4756
4407
  /**
4757
- * Custom payment method name provided by user.
4758
- *
4759
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4760
- * @minLength 1
4408
+ * Payment method.
4409
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4410
+ * Non-exhaustive list of supported values:
4411
+ * + `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`
4761
4412
  * @maxLength 100
4413
+ * @deprecated Payment method.
4414
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4415
+ * Non-exhaustive list of supported values:
4416
+ * + `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`
4417
+ * @replacedBy payment_method_name
4418
+ * @targetRemovalDate 2026-07-01
4762
4419
  */
4763
- custom?: string | null;
4764
- }
4765
- /** Predefined payment method types for offline/manual payments. */
4766
- declare enum PredefinedPaymentMethod {
4767
- /** Cash payment. */
4768
- CASH = "CASH",
4769
- /** Bank transfer. */
4770
- BANK_TRANSFER = "BANK_TRANSFER",
4771
- /** Payment by check. */
4772
- CHECK = "CHECK"
4773
- }
4774
- /** @enumType */
4775
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4776
- interface RecordManuallyCollectedPaymentResponse {
4777
- }
4778
- interface MarkOrderAsPaidRequest {
4420
+ paymentMethod?: string | null;
4421
+ /**
4422
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4423
+ * @maxLength 100
4424
+ */
4425
+ providerTransactionId?: string | null;
4426
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4427
+ offlinePayment?: boolean;
4428
+ /** Payment status. */
4429
+ status?: TransactionStatusWithLiterals;
4430
+ /**
4431
+ * Whether there is a payment agreement that allows for future charges.
4432
+ * @immutable
4433
+ */
4434
+ savedPaymentMethod?: boolean;
4435
+ /** Authorization details. */
4436
+ authorizationDetails?: AuthorizationDetails;
4437
+ /**
4438
+ * Record of chargebacks made by the buyer.
4439
+ * @maxSize 6
4440
+ */
4441
+ chargebacks?: Chargeback[];
4442
+ /** Platform fee amount associated with this payment. */
4443
+ platformFee?: Price;
4779
4444
  /**
4780
- * Ecom order ID.
4781
- * @minLength 1
4782
- * @maxLength 100
4445
+ * Payment method with buyer and optional owner translations.
4446
+ * Non-exhaustive list of supported values:
4447
+ * + `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`
4783
4448
  */
4784
- ecomOrderId: string;
4449
+ paymentMethodName?: PaymentMethodName;
4785
4450
  }
4786
- interface MarkOrderAsPaidResponse {
4787
- /** Updated order. */
4788
- order?: Order;
4451
+ /** @oneof */
4452
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4453
+ /** Credit card details. */
4454
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4789
4455
  }
4790
- interface BulkMarkOrdersAsPaidRequest {
4456
+ declare enum TransactionStatus {
4457
+ UNDEFINED = "UNDEFINED",
4458
+ APPROVED = "APPROVED",
4459
+ PENDING = "PENDING",
4460
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4461
+ CANCELED = "CANCELED",
4462
+ DECLINED = "DECLINED",
4463
+ REFUNDED = "REFUNDED",
4464
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4465
+ AUTHORIZED = "AUTHORIZED",
4466
+ VOIDED = "VOIDED"
4467
+ }
4468
+ /** @enumType */
4469
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4470
+ interface CreditCardPaymentMethodDetails {
4791
4471
  /**
4792
- * IDs of orders to mark as paid.
4793
- * @minSize 1
4794
- * @maxSize 100
4795
- * @minLength 1
4796
- * @maxLength 100
4472
+ * The last 4 digits of the card number.
4473
+ * @maxLength 4
4797
4474
  */
4798
- ecomOrderIds: string[];
4799
- }
4800
- interface BulkMarkOrdersAsPaidResponse {
4475
+ lastFourDigits?: string | null;
4801
4476
  /**
4802
- * Items updated by the bulk action.
4803
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4477
+ * Card issuer's brand.
4478
+ * @maxLength 100
4804
4479
  */
4805
- results?: BulkOrderResult[];
4806
- /** Bulk action metadata. */
4807
- bulkActionMetadata?: BulkActionMetadata;
4480
+ brand?: string | null;
4808
4481
  }
4809
- interface BulkOrderResult {
4810
- /** Item metadata. */
4811
- itemMetadata?: ItemMetadata;
4482
+ interface AuthorizationDetails {
4812
4483
  /**
4813
- * Updated order.
4814
- *
4815
- * Returned when `returnFullEntity = true`.
4484
+ * Whether the authorized payment is of a delayed capture.
4485
+ * @readonly
4816
4486
  */
4817
- item?: Order;
4818
- }
4819
- interface ItemMetadata {
4820
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4821
- id?: string | null;
4822
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4823
- originalIndex?: number;
4824
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4825
- success?: boolean;
4826
- /** Details about the error in case of failure. */
4827
- error?: ApplicationError;
4828
- }
4829
- interface ApplicationError {
4830
- /** Error code. */
4831
- code?: string;
4832
- /** Description of the error. */
4833
- description?: string;
4834
- /** Data related to the error. */
4835
- data?: Record<string, any> | null;
4836
- }
4837
- interface BulkActionMetadata {
4838
- /** Number of items that were successfully processed. */
4839
- totalSuccesses?: number;
4840
- /** Number of items that couldn't be processed. */
4841
- totalFailures?: number;
4842
- /** Number of failures without details because detailed failure threshold was exceeded. */
4843
- undetailedFailures?: number;
4844
- }
4845
- interface GetRefundabilityStatusRequest {
4487
+ delayedCapture?: boolean;
4488
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4489
+ authorizedDate?: Date | null;
4846
4490
  /**
4847
- * Order ID.
4848
- * @minLength 1
4849
- * @maxLength 100
4491
+ * List of captures associated with payment
4492
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4493
+ * @maxSize 1
4850
4494
  */
4851
- ecomOrderId: string;
4495
+ captures?: AuthorizationCapture[];
4496
+ /** Void associated with payment */
4497
+ void?: AuthorizationVoid;
4498
+ /** Scheduled action for this transaction */
4499
+ scheduledAction?: V1ScheduledAction;
4852
4500
  }
4853
- interface GetRefundabilityStatusResponse {
4501
+ interface AuthorizationCapture {
4854
4502
  /**
4855
- * Refundability details.
4856
- * @maxSize 300
4503
+ * Capture ID.
4504
+ * @format GUID
4505
+ * @readonly
4857
4506
  */
4858
- refundabilities?: Refundability[];
4507
+ id?: string | null;
4508
+ /** Status of this capture action */
4509
+ status?: AuthorizationCaptureStatusWithLiterals;
4859
4510
  /**
4860
- * Whether the order supports refunding per item.
4861
- * @deprecated
4511
+ * Amount of this capture
4512
+ * @immutable
4862
4513
  */
4863
- refundablePerItem?: boolean;
4514
+ amount?: Price;
4515
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4516
+ createdDate?: Date | null;
4517
+ /** In case of status is FAILED may contain failure details */
4518
+ failureDetails?: AuthorizationActionFailureDetails;
4864
4519
  }
4865
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4866
- /** Reason why payment is not refundable. */
4867
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4868
- /** Reason why payment is only refundable manually. */
4869
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4870
- /** Payment ID. */
4871
- paymentId?: string;
4872
- /** Payment refundability status. */
4873
- refundabilityStatus?: RefundableStatusWithLiterals;
4874
- /** Link to payment provider dashboard. */
4875
- providerLink?: string | null;
4520
+ declare enum AuthorizationCaptureStatus {
4521
+ /** Capture operation still in progress. */
4522
+ PENDING = "PENDING",
4523
+ /** Capture operation succeeded. */
4524
+ SUCCEEDED = "SUCCEEDED",
4525
+ /** Capture operation failed. */
4526
+ FAILED = "FAILED"
4876
4527
  }
4877
- /** @oneof */
4878
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4879
- /** Reason why payment is not refundable. */
4880
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4881
- /** Reason why payment is only refundable manually. */
4882
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4528
+ /** @enumType */
4529
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4530
+ interface AuthorizationActionFailureDetails {
4531
+ /** @maxLength 100 */
4532
+ failureCode?: string;
4883
4533
  }
4884
- declare enum RefundableStatus {
4885
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4534
+ interface AuthorizationVoid {
4535
+ /** Status of this void action */
4536
+ status?: AuthorizationVoidStatusWithLiterals;
4537
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4538
+ voidedDate?: Date | null;
4539
+ /** In case of status is FAILED may contain failure details */
4540
+ failureDetails?: AuthorizationActionFailureDetails;
4541
+ /** Reason of void action */
4542
+ reason?: ReasonWithLiterals;
4543
+ }
4544
+ declare enum AuthorizationVoidStatus {
4545
+ /** Void operation still in progress. */
4546
+ PENDING = "PENDING",
4547
+ /** Void operation succeeded. */
4548
+ SUCCEEDED = "SUCCEEDED",
4549
+ /** Void operation failed. */
4550
+ FAILED = "FAILED"
4551
+ }
4552
+ /** @enumType */
4553
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4554
+ /** Reason the authorization was voided. */
4555
+ declare enum Reason {
4556
+ /** Authorization was voided by user. */
4886
4557
  MANUAL = "MANUAL",
4887
- REFUNDABLE = "REFUNDABLE"
4558
+ /** Authorization passed execution date. */
4559
+ SCHEDULED = "SCHEDULED"
4888
4560
  }
4889
4561
  /** @enumType */
4890
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4891
- declare enum NonRefundableReason {
4892
- NONE = "NONE",
4893
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4894
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4895
- INTERNAL_ERROR = "INTERNAL_ERROR",
4896
- NOT_PAID = "NOT_PAID",
4897
- ACCESS_DENIED = "ACCESS_DENIED",
4898
- ZERO_PRICE = "ZERO_PRICE",
4899
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4900
- PENDING_REFUND = "PENDING_REFUND",
4901
- FORBIDDEN = "FORBIDDEN",
4902
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4903
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4904
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4562
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4563
+ interface V1ScheduledAction {
4564
+ /** Type of the action. */
4565
+ actionType?: ActionTypeWithLiterals;
4566
+ /** The date and time of the action. */
4567
+ executionDate?: Date | null;
4568
+ }
4569
+ declare enum ActionType {
4570
+ VOID = "VOID",
4571
+ CAPTURE = "CAPTURE"
4905
4572
  }
4906
4573
  /** @enumType */
4907
- 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';
4908
- declare enum ManuallyRefundableReason {
4909
- EXPIRED = "EXPIRED",
4910
- NOT_SUPPORTED = "NOT_SUPPORTED",
4911
- OFFLINE = "OFFLINE",
4912
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4574
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4575
+ interface Chargeback {
4576
+ /**
4577
+ * Chargeback ID.
4578
+ * @format GUID
4579
+ * @readonly
4580
+ * @immutable
4581
+ */
4582
+ id?: string;
4583
+ /**
4584
+ * 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.
4585
+ * @readonly
4586
+ * @immutable
4587
+ */
4588
+ createdDate?: Date | null;
4589
+ /**
4590
+ * 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.
4591
+ * @readonly
4592
+ */
4593
+ updatedDate?: Date | null;
4594
+ /**
4595
+ * Amount.
4596
+ * @readonly
4597
+ * @immutable
4598
+ */
4599
+ amount?: Price;
4600
+ /**
4601
+ * Reversal amount. Present only when status is REVERSED.
4602
+ * @readonly
4603
+ */
4604
+ reversalAmount?: Price;
4605
+ /**
4606
+ * Status.
4607
+ *
4608
+ * Default: `"APPROVED"`.
4609
+ */
4610
+ status?: ChargebackStatusWithLiterals;
4611
+ /**
4612
+ * External chargeback ID.
4613
+ * @format GUID
4614
+ * @readonly
4615
+ * @immutable
4616
+ */
4617
+ externalId?: string | null;
4618
+ }
4619
+ declare enum ChargebackStatus {
4620
+ /** Chargeback was approved. */
4621
+ APPROVED = "APPROVED",
4622
+ /** Chargeback was reversed. */
4623
+ REVERSED = "REVERSED"
4913
4624
  }
4914
4625
  /** @enumType */
4915
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4916
- interface CreatePaymentGatewayOrderRequest {
4626
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4627
+ interface PaymentMethodName {
4917
4628
  /**
4918
- * Ecom order ID.
4919
- * @minLength 1
4629
+ * Translated payment method name in buyer language.
4920
4630
  * @maxLength 100
4921
4631
  */
4922
- ecomOrderId: string;
4923
- /** Information about the user who initiated the payment. */
4924
- chargedBy?: ChargedBy;
4925
- }
4926
- interface ChargedBy {
4632
+ buyerLanguageName?: string | null;
4927
4633
  /**
4928
- * ID - id of the user who initiated the payment
4929
- * @format GUID
4634
+ * Translated payment method name in site owner language.
4635
+ * @maxLength 100
4930
4636
  */
4931
- id?: string;
4637
+ siteLanguageName?: string | null;
4932
4638
  /**
4933
- * Full name - name of the user who initiated the payment
4934
- * @minLength 1
4935
- * @maxLength 200
4639
+ * User-provided payment method name.
4640
+ *
4641
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
4936
4642
  */
4937
- fullName?: string | null;
4938
- }
4939
- interface CreatePaymentGatewayOrderResponse {
4940
- /** ID of the order created in the payment gateway */
4941
- paymentGatewayOrderId?: string;
4643
+ userDefinedName?: UserDefinedPaymentMethodName;
4942
4644
  }
4943
- interface ChargeMembershipsRequest {
4645
+ interface GiftCardPaymentDetails {
4944
4646
  /**
4945
- * Order ID.
4946
- * @minLength 1
4647
+ * Gift card payment ID.
4947
4648
  * @maxLength 100
4948
4649
  */
4949
- ecomOrderId: string;
4650
+ giftCardPaymentId?: string;
4950
4651
  /**
4951
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4952
- * but a user which is using the membership on behalf of the a member
4652
+ * ID of the app that created the gift card.
4953
4653
  * @format GUID
4954
4654
  */
4955
- memberId: string;
4655
+ appId?: string;
4956
4656
  /**
4957
- * List of items to be paid by memberships
4958
- * @minSize 1
4959
- * @maxSize 300
4657
+ * Whether the gift card is voided.
4658
+ * @readonly
4960
4659
  */
4961
- membershipCharges?: MembershipChargeItem[];
4660
+ voided?: boolean;
4962
4661
  }
4963
- interface MembershipChargeItem {
4662
+ interface MembershipPaymentDetails {
4964
4663
  /**
4965
- * The id of used membership
4664
+ * Membership ID.
4966
4665
  * @minLength 1
4967
4666
  * @maxLength 100
4968
4667
  */
4969
4668
  membershipId?: string;
4970
4669
  /**
4971
- * ID of the application providing this payment option
4972
- * @format GUID
4973
- */
4974
- appId?: string;
4975
- /** The name of used membership */
4976
- membershipName?: MembershipName;
4977
- /** Additional data about this membership */
4978
- membershipAdditionalData?: Record<string, any> | null;
4979
- /** Catalog and item reference info. */
4980
- catalogReference?: CatalogReference;
4981
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4982
- serviceProperties?: ServiceProperties;
4983
- /**
4984
- * Usually would be the same as catalogReference.catalogItemId
4985
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4986
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4670
+ * ID of the line item this membership applies to.
4987
4671
  * @minLength 1
4988
- * @maxLength 36
4672
+ * @maxLength 100
4989
4673
  */
4990
- rootCatalogItemId?: string | null;
4674
+ lineItemId?: string;
4675
+ /** Payment status. */
4676
+ status?: MembershipPaymentStatusWithLiterals;
4677
+ /** Membership name. */
4678
+ name?: MembershipName;
4991
4679
  /**
4992
- * line item id of Checkout/Order line item
4680
+ * The transaction ID in the membership system. Can be used to void the transaction.
4993
4681
  * @minLength 1
4994
4682
  * @maxLength 100
4995
4683
  */
4996
- lineItemId?: string;
4684
+ externalTransactionId?: string | null;
4685
+ /**
4686
+ * Whether the membership is voided.
4687
+ * @readonly
4688
+ */
4689
+ voided?: boolean;
4690
+ /**
4691
+ * ID of the application providing this payment option.
4692
+ * @format GUID
4693
+ */
4694
+ providerAppId?: string;
4997
4695
  }
4998
- interface MembershipName {
4696
+ declare enum MembershipPaymentStatus {
4697
+ /** Payment was charged. */
4698
+ CHARGED = "CHARGED",
4699
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
4700
+ CHARGE_FAILED = "CHARGE_FAILED",
4701
+ /** Payment is pending. */
4702
+ CHARGE_PENDING = "CHARGE_PENDING",
4703
+ /** Payment was voided. */
4704
+ VOIDED = "VOIDED"
4705
+ }
4706
+ /** @enumType */
4707
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
4708
+ interface WixReceiptInfo {
4999
4709
  /**
5000
- * Membership name.
5001
- * @maxLength 100
4710
+ * Receipt ID
4711
+ * @format GUID
5002
4712
  */
5003
- original?: string;
4713
+ receiptId?: string;
5004
4714
  /**
5005
- * Translated membership name. Defaults to `original` when not provided.
5006
- * @maxLength 100
4715
+ * Display number of receipt
4716
+ * @minLength 1
4717
+ * @maxLength 40
5007
4718
  */
5008
- translated?: string | null;
4719
+ displayNumber?: string | null;
5009
4720
  }
5010
- interface ServiceProperties {
4721
+ interface ExternalReceiptInfo {
5011
4722
  /**
5012
- * Date and time the service is to be provided, in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5013
- * For example, the start time of a class.
4723
+ * External receipt ID
4724
+ * @maxLength 100
5014
4725
  */
5015
- scheduledDate?: Date | null;
4726
+ receiptId?: string | null;
5016
4727
  /**
5017
- * The number of people participating in the service. For example, the number of people attending a class or the number of people per hotel room.
5018
- * @min 1
5019
- * @max 10000
4728
+ * ID of the app providing the receipt
4729
+ * @format GUID
5020
4730
  */
5021
- numberOfParticipants?: number | null;
4731
+ appId?: string | null;
4732
+ /**
4733
+ * Display number of receipt
4734
+ * @minLength 1
4735
+ * @maxLength 40
4736
+ */
4737
+ displayNumber?: string | null;
5022
4738
  }
5023
- interface ChargeMembershipsResponse {
4739
+ interface CashRoundingDetails {
5024
4740
  }
5025
- interface TriggerRefundRequest {
4741
+ declare enum PaymentStatus {
4742
+ APPROVED = "APPROVED",
4743
+ PENDING = "PENDING",
4744
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4745
+ CANCELED = "CANCELED",
4746
+ DECLINED = "DECLINED",
4747
+ REFUNDED = "REFUNDED",
4748
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4749
+ AUTHORIZED = "AUTHORIZED",
4750
+ VOIDED = "VOIDED"
4751
+ }
4752
+ /** @enumType */
4753
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4754
+ interface Refund {
5026
4755
  /**
5027
- * The order this refund related to
5028
- * @minLength 1
5029
- * @maxLength 100
4756
+ * Refund ID.
4757
+ * @format GUID
4758
+ * @readonly
5030
4759
  */
5031
- ecomOrderId: string;
4760
+ id?: string;
5032
4761
  /**
5033
- * Refund operations information
5034
- * @minSize 1
5035
- * @maxSize 1
4762
+ * List of transactions.
4763
+ * @maxSize 50
5036
4764
  */
5037
- payments: PaymentRefund[];
5038
- /** Business model of a refund */
4765
+ transactions?: RefundTransaction[];
4766
+ /** Refund business details. */
5039
4767
  details?: RefundDetails;
5040
- /** Side effect details related to refund */
5041
- sideEffects?: RefundSideEffects;
4768
+ /**
4769
+ * 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.
4770
+ * @readonly
4771
+ * @immutable
4772
+ */
4773
+ createdDate?: Date | null;
4774
+ /**
4775
+ * Aggregated refund summary.
4776
+ * @readonly
4777
+ */
4778
+ summary?: AggregatedRefundSummary;
4779
+ /**
4780
+ * ID of the app that initiated this refund.
4781
+ * @format GUID
4782
+ * @readonly
4783
+ * @immutable
4784
+ */
4785
+ requestingServiceAppId?: string | null;
5042
4786
  }
5043
- interface PaymentRefund {
4787
+ interface RefundTransaction {
5044
4788
  /**
5045
- * Specific payment within the order to refund
4789
+ * ID of the payment associated with this refund.
5046
4790
  * @format GUID
4791
+ * @immutable
5047
4792
  */
5048
4793
  paymentId?: string;
5049
- /** Refund amount. Not relevant for membership and gift card refunds. */
4794
+ /**
4795
+ * Refund amount.
4796
+ * @immutable
4797
+ */
5050
4798
  amount?: Price;
4799
+ /** Refund status. */
4800
+ refundStatus?: RefundStatusWithLiterals;
4801
+ /** Optional details of current refund status. */
4802
+ refundStatusInfo?: RefundStatusInfo;
5051
4803
  /**
5052
- * Whether refund is made externally and manually (on the payment provider's side)
5053
- * 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.
5054
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4804
+ * Payment gateway's refund ID.
4805
+ * This field is only returned when the value of `external_refund` is `false`.
4806
+ * @format GUID
4807
+ */
4808
+ gatewayRefundId?: string | null;
4809
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
4810
+ providerRefundId?: string | null;
4811
+ /**
4812
+ * Whether refund was made externally and manually on the payment provider's side.
4813
+ * @immutable
5055
4814
  */
5056
4815
  externalRefund?: boolean;
5057
4816
  }
5058
- interface RefundSideEffects {
5059
- /** Inventory restock details as part of this refund. */
5060
- restockInfo?: RestockInfo;
5061
- /** Whether to send a refund confirmation email to the customer. */
5062
- sendOrderRefundedEmail?: boolean;
4817
+ /** Refund transaction status. */
4818
+ declare enum RefundStatus {
4819
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
4820
+ PENDING = "PENDING",
4821
+ /** Refund transaction succeeded. */
4822
+ SUCCEEDED = "SUCCEEDED",
4823
+ /** Refund transaction failed. */
4824
+ FAILED = "FAILED",
4825
+ /** Refund request acknowledged, and will be executed soon. */
4826
+ SCHEDULED = "SCHEDULED",
4827
+ /** Refund was initiated on payment provider side. */
4828
+ STARTED = "STARTED"
4829
+ }
4830
+ /** @enumType */
4831
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
4832
+ interface RefundStatusInfo {
4833
+ /**
4834
+ * Reason code for the refund's current status.
4835
+ *
4836
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
4837
+ * @minLength 1
4838
+ * @maxLength 10
4839
+ */
4840
+ paymentGatewayReasonCode?: string | null;
5063
4841
  /**
5064
- * Custom message added to the refund confirmation email.
4842
+ * Free text explanation of current refund status.
5065
4843
  * @minLength 1
5066
4844
  * @maxLength 1000
5067
4845
  */
5068
- customMessage?: string | null;
4846
+ description?: string | null;
5069
4847
  }
5070
- interface RestockInfo {
5071
- /** Restock type. */
5072
- type?: RestockTypeWithLiterals;
4848
+ interface AggregatedRefundSummary {
4849
+ /** Total amount requested for refund. */
4850
+ requestedRefund?: Price;
4851
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
4852
+ pendingRefund?: Price;
4853
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
4854
+ refunded?: Price;
4855
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
4856
+ failedRefundAmount?: Price;
4857
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
4858
+ pending?: boolean;
4859
+ /** Breakdown of refunded items. Available only after refund is complete. */
4860
+ breakdown?: RefundItemsBreakdown;
4861
+ }
4862
+ interface RefundItemsBreakdown {
5073
4863
  /**
5074
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4864
+ * Refunded line items and the amount refunded for each.
5075
4865
  * @maxSize 300
5076
4866
  */
5077
- items?: RestockItem[];
5078
- }
5079
- declare enum RestockType {
5080
- NO_ITEMS = "NO_ITEMS",
5081
- ALL_ITEMS = "ALL_ITEMS",
5082
- SOME_ITEMS = "SOME_ITEMS"
4867
+ lineItems?: LineItemRefundSummary[];
5083
4868
  }
5084
- /** @enumType */
5085
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5086
- interface RestockItem {
4869
+ interface LineItemRefundSummary {
5087
4870
  /**
5088
- * ID of the line item being restocked.
4871
+ * ID of the refunded line item.
5089
4872
  * @format GUID
5090
4873
  */
5091
4874
  lineItemId?: string;
5092
- /**
5093
- * Line item quantity being restocked.
5094
- * @min 1
5095
- * @max 100000
5096
- */
5097
- quantity?: number;
5098
- }
5099
- interface TriggerRefundResponse {
5100
- /** All order's transactions after the refunds were added */
5101
- orderTransactions?: OrderTransactions;
5102
- /** Created refund ID */
5103
- refundId?: string | null;
5104
- /** Payment ID's that the refund execution had failed for */
5105
- failedPaymentIds?: ItemMetadata[];
4875
+ /** Total refunded amount for the line item. */
4876
+ totalRefundedAmount?: Price;
5106
4877
  }
5107
- /**
5108
- * A record of all payments and refunds associated with an order.
5109
- *
5110
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5111
- */
5112
- interface OrderTransactions {
5113
- /**
5114
- * Order ID.
5115
- * @format GUID
5116
- */
5117
- orderId?: string;
4878
+ interface CalculateRefundRequest {
5118
4879
  /**
5119
- * Record of payments made to the merchant.
5120
- * @maxSize 100
4880
+ * Order ID
4881
+ * @minLength 1
4882
+ * @maxLength 100
5121
4883
  */
5122
- payments?: Payment[];
4884
+ ecomOrderId?: string;
5123
4885
  /**
5124
- * Record of refunds made to the buyer.
4886
+ * Refunded line items and quantity
5125
4887
  * @maxSize 300
5126
4888
  */
5127
- refunds?: Refund[];
4889
+ refundItems?: CalculateRefundItemRequest[];
4890
+ /** Should include shipping in refund calculation */
4891
+ refundShipping?: boolean;
5128
4892
  }
5129
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
5130
- /** Regular payment details. */
5131
- regularPaymentDetails?: RegularPaymentDetails;
5132
- /** Gift card payment details. */
5133
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4893
+ interface CalculateRefundItemRequest {
5134
4894
  /**
5135
- * Payment ID.
4895
+ * ID of the line item being refunded
5136
4896
  * @format GUID
5137
- * @readonly
5138
- */
5139
- id?: string | null;
5140
- /** 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. */
5141
- createdDate?: Date | null;
5142
- /**
5143
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5144
- * @readonly
5145
4897
  */
5146
- updatedDate?: Date | null;
5147
- /** Payment amount. */
5148
- amount?: Price;
4898
+ id?: string;
5149
4899
  /**
5150
- * Whether refunds for this payment are disabled.
5151
- * + `true`: This payment is not refundable.
5152
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4900
+ * How much of that line item is being refunded
4901
+ * @min 1
4902
+ * @max 100000
5153
4903
  */
5154
- refundDisabled?: boolean;
5155
- }
5156
- /** @oneof */
5157
- interface PaymentPaymentDetailsOneOf {
5158
- /** Regular payment details. */
5159
- regularPaymentDetails?: RegularPaymentDetails;
5160
- /** Gift card payment details. */
5161
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5162
- }
5163
- /** @oneof */
5164
- interface PaymentReceiptInfoOneOf {
4904
+ quantity?: number;
5165
4905
  }
5166
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5167
- /** Credit card details. */
5168
- creditCardDetails?: CreditCardPaymentMethodDetails;
5169
- /**
5170
- * Wix Payments order ID.
5171
- * @maxLength 100
5172
- */
5173
- paymentOrderId?: string | null;
4906
+ interface CalculateRefundResponse {
4907
+ /** Total refundable amount */
4908
+ total?: Price;
4909
+ /** Tax cost of the order */
4910
+ tax?: Price;
4911
+ /** Discount given for this order */
4912
+ discount?: Price;
4913
+ /** Total cost of the order (without tax) */
4914
+ subtotal?: Price;
4915
+ /** Total shipping cost for order */
4916
+ shipping?: Price;
4917
+ /** Previous refund given on that order */
4918
+ previouslyRefundedAmount?: Price;
5174
4919
  /**
5175
- * Payment gateway's transaction ID.
5176
- * This field is only returned when the value of `offline_payment` is `false`.
5177
- * @maxLength 100
4920
+ * The refundable items of that order
4921
+ * @maxSize 300
5178
4922
  */
5179
- gatewayTransactionId?: string | null;
4923
+ items?: CalculateRefundItemResponse[];
4924
+ }
4925
+ interface CalculateRefundItemResponse {
5180
4926
  /**
5181
- * Payment method.
5182
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5183
- * Non-exhaustive list of supported values:
5184
- * + `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`
5185
- * @maxLength 100
5186
- * @deprecated Payment method.
5187
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5188
- * Non-exhaustive list of supported values:
5189
- * + `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`
5190
- * @replacedBy payment_method_name
5191
- * @targetRemovalDate 2026-07-01
4927
+ * Line item ID
4928
+ * @format GUID
5192
4929
  */
5193
- paymentMethod?: string | null;
4930
+ id?: string;
4931
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
4932
+ price?: Price;
4933
+ }
4934
+ interface VoidAuthorizedPaymentsRequest {
5194
4935
  /**
5195
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4936
+ * Wix eCommerce order ID
4937
+ * @minLength 1
5196
4938
  * @maxLength 100
5197
4939
  */
5198
- providerTransactionId?: string | null;
5199
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5200
- offlinePayment?: boolean;
5201
- /** Payment status. */
5202
- status?: TransactionStatusWithLiterals;
5203
- /**
5204
- * Whether there is a payment agreement that allows for future charges.
5205
- * @immutable
5206
- */
5207
- savedPaymentMethod?: boolean;
5208
- /** Authorization details. */
5209
- authorizationDetails?: AuthorizationDetails;
5210
- /**
5211
- * Record of chargebacks made by the buyer.
5212
- * @maxSize 6
5213
- */
5214
- chargebacks?: Chargeback[];
5215
- /** Platform fee amount associated with this payment. */
5216
- platformFee?: Price;
4940
+ ecomOrderId: string;
5217
4941
  /**
5218
- * Payment method with buyer and optional owner translations.
5219
- * Non-exhaustive list of supported values:
5220
- * + `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`
4942
+ * Payment IDs
4943
+ * @minSize 1
4944
+ * @maxSize 100
4945
+ * @format GUID
5221
4946
  */
5222
- paymentMethodName?: PaymentMethodName;
5223
- }
5224
- /** @oneof */
5225
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5226
- /** Credit card details. */
5227
- creditCardDetails?: CreditCardPaymentMethodDetails;
4947
+ paymentIds: string[];
5228
4948
  }
5229
- declare enum TransactionStatus {
5230
- UNDEFINED = "UNDEFINED",
5231
- APPROVED = "APPROVED",
5232
- PENDING = "PENDING",
5233
- PENDING_MERCHANT = "PENDING_MERCHANT",
5234
- CANCELED = "CANCELED",
5235
- DECLINED = "DECLINED",
5236
- REFUNDED = "REFUNDED",
5237
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5238
- AUTHORIZED = "AUTHORIZED",
5239
- VOIDED = "VOIDED"
4949
+ interface VoidAuthorizedPaymentsResponse {
4950
+ /** All order's transactions after the void was triggered */
4951
+ orderTransactions?: OrderTransactions;
5240
4952
  }
5241
- /** @enumType */
5242
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5243
- interface CreditCardPaymentMethodDetails {
5244
- /**
5245
- * The last 4 digits of the card number.
5246
- * @maxLength 4
5247
- */
5248
- lastFourDigits?: string | null;
4953
+ interface CaptureAuthorizedPaymentsRequest {
5249
4954
  /**
5250
- * Card issuer's brand.
4955
+ * Wix eCommerce order ID
4956
+ * @minLength 1
5251
4957
  * @maxLength 100
5252
4958
  */
5253
- brand?: string | null;
5254
- }
5255
- interface AuthorizationDetails {
5256
- /**
5257
- * Whether the authorized payment is of a delayed capture.
5258
- * @readonly
5259
- */
5260
- delayedCapture?: boolean;
5261
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5262
- authorizedDate?: Date | null;
4959
+ ecomOrderId: string;
5263
4960
  /**
5264
- * List of captures associated with payment
5265
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5266
- * @maxSize 1
4961
+ * Capture payments information
4962
+ * @minSize 1
4963
+ * @maxSize 100
5267
4964
  */
5268
- captures?: AuthorizationCapture[];
5269
- /** Void associated with payment */
5270
- void?: AuthorizationVoid;
5271
- /** Scheduled action for this transaction */
5272
- scheduledAction?: V1ScheduledAction;
4965
+ payments: PaymentCapture[];
5273
4966
  }
5274
- interface AuthorizationCapture {
4967
+ interface PaymentCapture {
5275
4968
  /**
5276
- * Capture ID.
4969
+ * Payment ID
5277
4970
  * @format GUID
5278
- * @readonly
5279
4971
  */
5280
- id?: string | null;
5281
- /** Status of this capture action */
5282
- status?: AuthorizationCaptureStatusWithLiterals;
4972
+ paymentId?: string | null;
5283
4973
  /**
5284
- * Amount of this capture
5285
- * @immutable
4974
+ * Capture amount.
4975
+ * If not provided - full authorized amount will be captured.
5286
4976
  */
5287
4977
  amount?: Price;
5288
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5289
- createdDate?: Date | null;
5290
- /** In case of status is FAILED may contain failure details */
5291
- failureDetails?: AuthorizationActionFailureDetails;
5292
4978
  }
5293
- declare enum AuthorizationCaptureStatus {
5294
- /** Capture operation still in progress. */
5295
- PENDING = "PENDING",
5296
- /** Capture operation succeeded. */
5297
- SUCCEEDED = "SUCCEEDED",
5298
- /** Capture operation failed. */
5299
- FAILED = "FAILED"
4979
+ interface CaptureAuthorizedPaymentsResponse {
4980
+ /** All order's transactions after the capture was triggered */
4981
+ orderTransactions?: OrderTransactions;
5300
4982
  }
5301
- /** @enumType */
5302
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5303
- interface AuthorizationActionFailureDetails {
5304
- /** @maxLength 100 */
5305
- failureCode?: string;
4983
+ interface ChargeSavedPaymentMethodRequest {
4984
+ /**
4985
+ * Ecom Order ID.
4986
+ * @minLength 1
4987
+ * @maxLength 100
4988
+ */
4989
+ ecomOrderId?: string;
4990
+ /** Amount to be charged */
4991
+ amount?: Price;
5306
4992
  }
5307
- interface AuthorizationVoid {
5308
- /** Status of this void action */
5309
- status?: AuthorizationVoidStatusWithLiterals;
5310
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5311
- voidedDate?: Date | null;
5312
- /** In case of status is FAILED may contain failure details */
5313
- failureDetails?: AuthorizationActionFailureDetails;
5314
- /** Reason of void action */
5315
- reason?: ReasonWithLiterals;
4993
+ interface ChargeSavedPaymentMethodResponse {
4994
+ /** Payment gateway's order ID (e.g Wix Payments) */
4995
+ paymentGatewayOrderId?: string;
5316
4996
  }
5317
- declare enum AuthorizationVoidStatus {
5318
- /** Void operation still in progress. */
5319
- PENDING = "PENDING",
5320
- /** Void operation succeeded. */
5321
- SUCCEEDED = "SUCCEEDED",
5322
- /** Void operation failed. */
5323
- FAILED = "FAILED"
4997
+ interface SendBuyerConfirmationEmailRequest {
4998
+ /** @format GUID */
4999
+ orderId?: string;
5324
5000
  }
5325
- /** @enumType */
5326
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5327
- /** Reason the authorization was voided. */
5328
- declare enum Reason {
5329
- /** Authorization was voided by user. */
5330
- MANUAL = "MANUAL",
5331
- /** Authorization passed execution date. */
5332
- SCHEDULED = "SCHEDULED"
5001
+ interface SendBuyerConfirmationEmailResponse {
5333
5002
  }
5334
- /** @enumType */
5335
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5336
- interface V1ScheduledAction {
5337
- /** Type of the action. */
5338
- actionType?: ActionTypeWithLiterals;
5339
- /** The date and time of the action. */
5340
- executionDate?: Date | null;
5003
+ interface SendBuyerPaymentsReceivedEmailRequest {
5004
+ /**
5005
+ * @minLength 1
5006
+ * @maxLength 100
5007
+ */
5008
+ orderId?: string;
5341
5009
  }
5342
- declare enum ActionType {
5343
- VOID = "VOID",
5344
- CAPTURE = "CAPTURE"
5010
+ interface SendBuyerPaymentsReceivedEmailResponse {
5345
5011
  }
5346
- /** @enumType */
5347
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5348
- interface Chargeback {
5012
+ interface SendBuyerPickupConfirmationEmailRequest {
5349
5013
  /**
5350
- * Chargeback ID.
5351
- * @format GUID
5352
- * @readonly
5353
- * @immutable
5014
+ * @minLength 1
5015
+ * @maxLength 100
5354
5016
  */
5355
- id?: string;
5017
+ orderId?: string;
5018
+ }
5019
+ interface SendBuyerPickupConfirmationEmailResponse {
5020
+ }
5021
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
5356
5022
  /**
5357
- * 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.
5358
- * @readonly
5359
- * @immutable
5023
+ * IDs of orders to send pickup emails for.
5024
+ * @minSize 1
5025
+ * @maxSize 300
5360
5026
  */
5361
- createdDate?: Date | null;
5027
+ orderIds?: string[];
5028
+ }
5029
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
5030
+ }
5031
+ interface SendBuyerShippingConfirmationEmailRequest {
5362
5032
  /**
5363
- * 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.
5364
- * @readonly
5033
+ * @minLength 1
5034
+ * @maxLength 100
5365
5035
  */
5366
- updatedDate?: Date | null;
5036
+ orderId?: string;
5037
+ }
5038
+ interface SendBuyerShippingConfirmationEmailResponse {
5039
+ }
5040
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
5367
5041
  /**
5368
- * Amount.
5369
- * @readonly
5370
- * @immutable
5042
+ * IDs of orders to send pickup emails for.
5043
+ * @minSize 1
5044
+ * @maxSize 300
5371
5045
  */
5372
- amount?: Price;
5046
+ orderIds?: string[];
5047
+ }
5048
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
5049
+ }
5050
+ interface SendMerchantOrderReceivedNotificationRequest {
5373
5051
  /**
5374
- * Reversal amount. Present only when status is REVERSED.
5375
- * @readonly
5052
+ * @minLength 1
5053
+ * @maxLength 100
5376
5054
  */
5377
- reversalAmount?: Price;
5055
+ orderId?: string;
5056
+ }
5057
+ interface SendMerchantOrderReceivedNotificationResponse {
5058
+ }
5059
+ interface SendCancelRefundEmailRequest {
5378
5060
  /**
5379
- * Status.
5380
- *
5381
- * Default: `"APPROVED"`.
5061
+ * The ID of order that is canceled/refunded
5062
+ * @minLength 1
5063
+ * @maxLength 100
5382
5064
  */
5383
- status?: ChargebackStatusWithLiterals;
5065
+ orderId?: string;
5384
5066
  /**
5385
- * External chargeback ID.
5067
+ * Personal note added to the email (optional)
5068
+ * @minLength 1
5069
+ * @maxLength 1000
5070
+ */
5071
+ customMessage?: string | null;
5072
+ /** Refund amount */
5073
+ refundAmount?: Price;
5074
+ /**
5075
+ * Refund ID. (Optional)
5386
5076
  * @format GUID
5387
- * @readonly
5388
- * @immutable
5389
5077
  */
5390
- externalId?: string | null;
5078
+ refundId?: string | null;
5391
5079
  }
5392
- declare enum ChargebackStatus {
5393
- /** Chargeback was approved. */
5394
- APPROVED = "APPROVED",
5395
- /** Chargeback was reversed. */
5396
- REVERSED = "REVERSED"
5080
+ interface SendCancelRefundEmailResponse {
5397
5081
  }
5398
- /** @enumType */
5399
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5400
- interface PaymentMethodName {
5082
+ interface SendRefundEmailRequest {
5401
5083
  /**
5402
- * Translated payment method name in buyer language.
5403
- * @maxLength 100
5084
+ * The ID of order that is refunded
5085
+ * @format GUID
5404
5086
  */
5405
- buyerLanguageName?: string | null;
5087
+ orderId?: string;
5406
5088
  /**
5407
- * Translated payment method name in site owner language.
5408
- * @maxLength 100
5089
+ * Refund ID
5090
+ * @format GUID
5409
5091
  */
5410
- siteLanguageName?: string | null;
5092
+ refundId?: string;
5411
5093
  /**
5412
- * User-provided payment method name.
5413
- *
5414
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5094
+ * Personal note added to the email (optional)
5095
+ * @minLength 1
5096
+ * @maxLength 1000
5415
5097
  */
5416
- userDefinedName?: UserDefinedPaymentMethodName;
5098
+ customMessage?: string | null;
5417
5099
  }
5418
- interface GiftCardPaymentDetails {
5100
+ interface SendRefundEmailResponse {
5101
+ }
5102
+ interface SendFulfillmentEmailRequest {
5103
+ /** @format GUID */
5104
+ orderId?: string;
5105
+ /** @format GUID */
5106
+ fulfillerId?: string;
5107
+ }
5108
+ interface SendFulfillmentEmailResponse {
5109
+ }
5110
+ interface SendMerchantOrderReceivedPushRequest {
5419
5111
  /**
5420
- * Gift card payment ID.
5112
+ * @minLength 1
5421
5113
  * @maxLength 100
5422
5114
  */
5423
- giftCardPaymentId?: string;
5115
+ orderId?: string;
5116
+ }
5117
+ interface SendMerchantOrderReceivedPushResponse {
5118
+ }
5119
+ interface PreviewEmailByTypeRequest {
5120
+ emailType?: PreviewEmailTypeWithLiterals;
5121
+ }
5122
+ declare enum PreviewEmailType {
5123
+ ORDER_PLACED = "ORDER_PLACED",
5124
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5125
+ ORDER_SHIPPED = "ORDER_SHIPPED",
5126
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5127
+ }
5128
+ /** @enumType */
5129
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5130
+ interface PreviewEmailByTypeResponse {
5131
+ emailPreview?: string;
5132
+ }
5133
+ interface PreviewRefundEmailRequest {
5424
5134
  /**
5425
- * ID of the app that created the gift card.
5426
- * @format GUID
5135
+ * @minLength 1
5136
+ * @maxLength 100
5427
5137
  */
5428
- appId?: string;
5138
+ orderId?: string;
5139
+ /** Refund amount */
5140
+ refundAmount?: Price;
5141
+ /** Refund business details */
5142
+ details?: RefundDetails;
5429
5143
  /**
5430
- * Whether the gift card is voided.
5431
- * @readonly
5144
+ * Personal note added to the email (optional)
5145
+ * @minLength 1
5146
+ * @maxLength 1000
5147
+ */
5148
+ customMessage?: string | null;
5149
+ /**
5150
+ * Refund ID. (Optional)
5151
+ * @format GUID
5432
5152
  */
5433
- voided?: boolean;
5153
+ refundId?: string | null;
5434
5154
  }
5435
- interface MembershipPaymentDetails {
5155
+ interface PreviewRefundEmailResponse {
5156
+ emailPreview?: string;
5157
+ }
5158
+ interface PreviewCancelEmailRequest {
5436
5159
  /**
5437
- * Membership ID.
5438
5160
  * @minLength 1
5439
5161
  * @maxLength 100
5440
5162
  */
5441
- membershipId?: string;
5163
+ orderId?: string;
5442
5164
  /**
5443
- * ID of the line item this membership applies to.
5165
+ * Personal note added to the email (optional)
5444
5166
  * @minLength 1
5445
- * @maxLength 100
5167
+ * @maxLength 1000
5446
5168
  */
5447
- lineItemId?: string;
5448
- /** Payment status. */
5449
- status?: MembershipPaymentStatusWithLiterals;
5450
- /** Membership name. */
5451
- name?: MembershipName;
5169
+ customMessage?: string | null;
5170
+ }
5171
+ interface PreviewCancelEmailResponse {
5172
+ emailPreview?: string;
5173
+ }
5174
+ interface PreviewCancelRefundEmailRequest {
5452
5175
  /**
5453
- * The transaction ID in the membership system. Can be used to void the transaction.
5454
5176
  * @minLength 1
5455
5177
  * @maxLength 100
5456
5178
  */
5457
- externalTransactionId?: string | null;
5179
+ orderId?: string;
5458
5180
  /**
5459
- * Whether the membership is voided.
5460
- * @readonly
5181
+ * Personal note added to the email (optional)
5182
+ * @minLength 1
5183
+ * @maxLength 1000
5461
5184
  */
5462
- voided?: boolean;
5185
+ customMessage?: string | null;
5186
+ /** Refund amount */
5187
+ refundAmount?: Price;
5463
5188
  /**
5464
- * ID of the application providing this payment option.
5189
+ * Refund ID. (Optional)
5465
5190
  * @format GUID
5466
5191
  */
5467
- providerAppId?: string;
5192
+ refundId?: string | null;
5468
5193
  }
5469
- declare enum MembershipPaymentStatus {
5470
- /** Payment was charged. */
5471
- CHARGED = "CHARGED",
5472
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5473
- CHARGE_FAILED = "CHARGE_FAILED",
5474
- /** Payment is pending. */
5475
- CHARGE_PENDING = "CHARGE_PENDING",
5476
- /** Payment was voided. */
5477
- VOIDED = "VOIDED"
5194
+ interface PreviewCancelRefundEmailResponse {
5195
+ emailPreview?: string;
5478
5196
  }
5479
- /** @enumType */
5480
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5481
- interface WixReceiptInfo {
5197
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5198
+ }
5199
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5200
+ emailPreview?: string;
5201
+ }
5202
+ interface PreviewBuyerConfirmationEmailRequest {
5203
+ }
5204
+ interface PreviewBuyerConfirmationEmailResponse {
5205
+ emailPreview?: string;
5206
+ }
5207
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5208
+ }
5209
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5210
+ emailPreview?: string;
5211
+ }
5212
+ interface PreviewShippingConfirmationEmailRequest {
5213
+ }
5214
+ interface PreviewShippingConfirmationEmailResponse {
5215
+ emailPreview?: string;
5216
+ }
5217
+ interface PreviewResendDownloadLinksEmailRequest {
5218
+ }
5219
+ interface PreviewResendDownloadLinksEmailResponse {
5220
+ emailPreview?: string;
5221
+ }
5222
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5223
+ /** Emitted on a meta site creation. */
5224
+ siteCreated?: SiteCreated;
5225
+ /** Emitted on a meta site transfer completion. */
5226
+ siteTransferred?: SiteTransferred;
5227
+ /** Emitted on a meta site deletion. */
5228
+ siteDeleted?: SiteDeleted;
5229
+ /** Emitted on a meta site restoration. */
5230
+ siteUndeleted?: SiteUndeleted;
5231
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5232
+ sitePublished?: SitePublished;
5233
+ /** Emitted on a meta site unpublish. */
5234
+ siteUnpublished?: SiteUnpublished;
5235
+ /** Emitted when meta site is marked as template. */
5236
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5237
+ /** Emitted when meta site is marked as a WixSite. */
5238
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5239
+ /** Emitted when an application is provisioned (installed). */
5240
+ serviceProvisioned?: ServiceProvisioned;
5241
+ /** Emitted when an application is removed (uninstalled). */
5242
+ serviceRemoved?: ServiceRemoved;
5243
+ /** Emitted when meta site name (URL slug) is changed. */
5244
+ siteRenamedPayload?: SiteRenamed;
5245
+ /** Emitted when meta site was permanently deleted. */
5246
+ hardDeleted?: SiteHardDeleted;
5247
+ /** Emitted on a namespace change. */
5248
+ namespaceChanged?: NamespaceChanged;
5249
+ /** Emitted when Studio is attached. */
5250
+ studioAssigned?: StudioAssigned;
5251
+ /** Emitted when Studio is detached. */
5252
+ studioUnassigned?: StudioUnassigned;
5482
5253
  /**
5483
- * Receipt ID
5254
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5255
+ * the actual URL.
5256
+ *
5257
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5258
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5259
+ */
5260
+ urlChanged?: SiteUrlChanged;
5261
+ /** Site is marked as PurgedExternally */
5262
+ sitePurgedExternally?: SitePurgedExternally;
5263
+ /** Emitted when Odeditor is attached. */
5264
+ odeditorAssigned?: OdeditorAssigned;
5265
+ /** Emitted when Odeditor is detached. */
5266
+ odeditorUnassigned?: OdeditorUnassigned;
5267
+ /** Emitted when Picasso is attached. */
5268
+ picassoAssigned?: PicassoAssigned;
5269
+ /** Emitted when Picasso is detached. */
5270
+ picassoUnassigned?: PicassoUnassigned;
5271
+ /** Emitted when Wixel is attached. */
5272
+ wixelAssigned?: WixelAssigned;
5273
+ /** Emitted when Wixel is detached. */
5274
+ wixelUnassigned?: WixelUnassigned;
5275
+ /** Emitted when StudioTwo is attached. */
5276
+ studioTwoAssigned?: StudioTwoAssigned;
5277
+ /** Emitted when StudioTwo is detached. */
5278
+ studioTwoUnassigned?: StudioTwoUnassigned;
5279
+ /** Emitted when media from user domain is enabled. */
5280
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5281
+ /** Emitted when media from user domain is disabled. */
5282
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5283
+ /** Emitted when Editorless is attached. */
5284
+ editorlessAssigned?: EditorlessAssigned;
5285
+ /** Emitted when Editorless is detached. */
5286
+ editorlessUnassigned?: EditorlessUnassigned;
5287
+ /**
5288
+ * A meta site id.
5484
5289
  * @format GUID
5485
5290
  */
5486
- receiptId?: string;
5291
+ metaSiteId?: string;
5292
+ /** A meta site version. Monotonically increasing. */
5293
+ version?: string;
5294
+ /** A timestamp of the event. */
5295
+ timestamp?: string;
5487
5296
  /**
5488
- * Display number of receipt
5489
- * @minLength 1
5490
- * @maxLength 40
5297
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5298
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5299
+ * @maxSize 4000
5491
5300
  */
5492
- displayNumber?: string | null;
5301
+ assets?: Asset[];
5493
5302
  }
5494
- interface ExternalReceiptInfo {
5303
+ /** @oneof */
5304
+ interface MetaSiteSpecialEventPayloadOneOf {
5305
+ /** Emitted on a meta site creation. */
5306
+ siteCreated?: SiteCreated;
5307
+ /** Emitted on a meta site transfer completion. */
5308
+ siteTransferred?: SiteTransferred;
5309
+ /** Emitted on a meta site deletion. */
5310
+ siteDeleted?: SiteDeleted;
5311
+ /** Emitted on a meta site restoration. */
5312
+ siteUndeleted?: SiteUndeleted;
5313
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5314
+ sitePublished?: SitePublished;
5315
+ /** Emitted on a meta site unpublish. */
5316
+ siteUnpublished?: SiteUnpublished;
5317
+ /** Emitted when meta site is marked as template. */
5318
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5319
+ /** Emitted when meta site is marked as a WixSite. */
5320
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5321
+ /** Emitted when an application is provisioned (installed). */
5322
+ serviceProvisioned?: ServiceProvisioned;
5323
+ /** Emitted when an application is removed (uninstalled). */
5324
+ serviceRemoved?: ServiceRemoved;
5325
+ /** Emitted when meta site name (URL slug) is changed. */
5326
+ siteRenamedPayload?: SiteRenamed;
5327
+ /** Emitted when meta site was permanently deleted. */
5328
+ hardDeleted?: SiteHardDeleted;
5329
+ /** Emitted on a namespace change. */
5330
+ namespaceChanged?: NamespaceChanged;
5331
+ /** Emitted when Studio is attached. */
5332
+ studioAssigned?: StudioAssigned;
5333
+ /** Emitted when Studio is detached. */
5334
+ studioUnassigned?: StudioUnassigned;
5335
+ /**
5336
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5337
+ * the actual URL.
5338
+ *
5339
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5340
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5341
+ */
5342
+ urlChanged?: SiteUrlChanged;
5343
+ /** Site is marked as PurgedExternally */
5344
+ sitePurgedExternally?: SitePurgedExternally;
5345
+ /** Emitted when Odeditor is attached. */
5346
+ odeditorAssigned?: OdeditorAssigned;
5347
+ /** Emitted when Odeditor is detached. */
5348
+ odeditorUnassigned?: OdeditorUnassigned;
5349
+ /** Emitted when Picasso is attached. */
5350
+ picassoAssigned?: PicassoAssigned;
5351
+ /** Emitted when Picasso is detached. */
5352
+ picassoUnassigned?: PicassoUnassigned;
5353
+ /** Emitted when Wixel is attached. */
5354
+ wixelAssigned?: WixelAssigned;
5355
+ /** Emitted when Wixel is detached. */
5356
+ wixelUnassigned?: WixelUnassigned;
5357
+ /** Emitted when StudioTwo is attached. */
5358
+ studioTwoAssigned?: StudioTwoAssigned;
5359
+ /** Emitted when StudioTwo is detached. */
5360
+ studioTwoUnassigned?: StudioTwoUnassigned;
5361
+ /** Emitted when media from user domain is enabled. */
5362
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5363
+ /** Emitted when media from user domain is disabled. */
5364
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5365
+ /** Emitted when Editorless is attached. */
5366
+ editorlessAssigned?: EditorlessAssigned;
5367
+ /** Emitted when Editorless is detached. */
5368
+ editorlessUnassigned?: EditorlessUnassigned;
5369
+ }
5370
+ interface Asset {
5371
+ /**
5372
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5373
+ * @maxLength 36
5374
+ */
5375
+ appDefId?: string;
5376
+ /**
5377
+ * An instance id. For legacy reasons may be UUID or a string.
5378
+ * @maxLength 200
5379
+ */
5380
+ instanceId?: string;
5381
+ /** An application state. */
5382
+ state?: StateWithLiterals;
5383
+ }
5384
+ declare enum State {
5385
+ UNKNOWN = "UNKNOWN",
5386
+ ENABLED = "ENABLED",
5387
+ DISABLED = "DISABLED",
5388
+ PENDING = "PENDING",
5389
+ DEMO = "DEMO"
5390
+ }
5391
+ /** @enumType */
5392
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5393
+ interface SiteCreated {
5394
+ /**
5395
+ * A template identifier (empty if not created from a template).
5396
+ * @maxLength 36
5397
+ */
5398
+ originTemplateId?: string;
5495
5399
  /**
5496
- * External receipt ID
5497
- * @maxLength 100
5400
+ * An account id of the owner.
5401
+ * @format GUID
5498
5402
  */
5499
- receiptId?: string | null;
5403
+ ownerId?: string;
5404
+ /** A context in which meta site was created. */
5405
+ context?: SiteCreatedContextWithLiterals;
5500
5406
  /**
5501
- * ID of the app providing the receipt
5407
+ * A meta site id from which this site was created.
5408
+ *
5409
+ * In case of a creation from a template it's a template id.
5410
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5502
5411
  * @format GUID
5503
5412
  */
5504
- appId?: string | null;
5413
+ originMetaSiteId?: string | null;
5505
5414
  /**
5506
- * Display number of receipt
5507
- * @minLength 1
5508
- * @maxLength 40
5415
+ * A meta site name (URL slug).
5416
+ * @maxLength 20
5509
5417
  */
5510
- displayNumber?: string | null;
5511
- }
5512
- interface CashRoundingDetails {
5418
+ siteName?: string;
5419
+ /** A namespace. */
5420
+ namespace?: NamespaceWithLiterals;
5513
5421
  }
5514
- declare enum PaymentStatus {
5515
- APPROVED = "APPROVED",
5516
- PENDING = "PENDING",
5517
- PENDING_MERCHANT = "PENDING_MERCHANT",
5518
- CANCELED = "CANCELED",
5519
- DECLINED = "DECLINED",
5520
- REFUNDED = "REFUNDED",
5521
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5522
- AUTHORIZED = "AUTHORIZED",
5523
- VOIDED = "VOIDED"
5422
+ declare enum SiteCreatedContext {
5423
+ /** A valid option, we don't expose all reasons why site might be created. */
5424
+ OTHER = "OTHER",
5425
+ /** A meta site was created from template. */
5426
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5427
+ /** A meta site was created by copying of the transfferred meta site. */
5428
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5429
+ /** A copy of existing meta site. */
5430
+ DUPLICATE = "DUPLICATE",
5431
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5432
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5433
+ /** deprecated A meta site was created for Flash editor. */
5434
+ FLASH = "FLASH"
5524
5435
  }
5525
5436
  /** @enumType */
5526
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5527
- interface Refund {
5528
- /**
5529
- * Refund ID.
5530
- * @format GUID
5531
- * @readonly
5532
- */
5533
- id?: string;
5437
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5438
+ declare enum Namespace {
5439
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5440
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5441
+ WIX = "WIX",
5442
+ /** 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. */
5443
+ SHOUT_OUT = "SHOUT_OUT",
5444
+ /** 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. */
5445
+ ALBUMS = "ALBUMS",
5446
+ /** 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. */
5447
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5448
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5449
+ HOTELS = "HOTELS",
5450
+ /** 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. */
5451
+ CLUBS = "CLUBS",
5452
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5453
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5454
+ /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5455
+ DEV_SITE = "DEV_SITE",
5456
+ /** 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. */
5457
+ LOGOS = "LOGOS",
5458
+ /** 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. */
5459
+ VIDEO_MAKER = "VIDEO_MAKER",
5460
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5461
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5462
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5463
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5534
5464
  /**
5535
- * List of transactions.
5536
- * @maxSize 50
5465
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5466
+ *
5467
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5537
5468
  */
5538
- transactions?: RefundTransaction[];
5539
- /** Refund business details. */
5540
- details?: RefundDetails;
5469
+ HTML_DRAFT = "HTML_DRAFT",
5541
5470
  /**
5542
- * 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.
5543
- * @readonly
5544
- * @immutable
5471
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5472
+ * Will be accessible from Site List and will not have a website app.
5473
+ * Once the user attaches a site, the site will become a regular wixsite.
5545
5474
  */
5546
- createdDate?: Date | null;
5475
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5476
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5477
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5478
+ /** It is to be used in the Business First efforts. */
5479
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5480
+ /** Bookings business flow with no site. */
5481
+ ANYWHERE = "ANYWHERE",
5482
+ /** Namespace for Headless Backoffice with no editor */
5483
+ HEADLESS = "HEADLESS",
5547
5484
  /**
5548
- * Aggregated refund summary.
5549
- * @readonly
5485
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5486
+ * The site will be used for account level CSM feature for enterprise
5550
5487
  */
5551
- summary?: AggregatedRefundSummary;
5488
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5489
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5490
+ RISE = "RISE",
5552
5491
  /**
5553
- * ID of the app that initiated this refund.
5554
- * @format GUID
5555
- * @readonly
5556
- * @immutable
5492
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5493
+ * There's a blank site behind the scene but it's blank).
5494
+ * The Mobile company will be the owner of this namespace.
5557
5495
  */
5558
- requestingServiceAppId?: string | null;
5559
- }
5560
- interface RefundTransaction {
5496
+ BRANDED_FIRST = "BRANDED_FIRST",
5497
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5498
+ NOWNIA = "NOWNIA",
5561
5499
  /**
5562
- * ID of the payment associated with this refund.
5563
- * @format GUID
5564
- * @immutable
5500
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5501
+ * The Partners company owns this namespace.
5565
5502
  */
5566
- paymentId?: string;
5503
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5504
+ /** Codux Headless Sites */
5505
+ CODUX = "CODUX",
5506
+ /** Bobb - AI Design Creator. */
5507
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5567
5508
  /**
5568
- * Refund amount.
5569
- * @immutable
5509
+ * Shared Blog Site is a unique single site across Enterprise account,
5510
+ * This site will hold all Blog posts related to the Marketing product.
5570
5511
  */
5571
- amount?: Price;
5572
- /** Refund status. */
5573
- refundStatus?: RefundStatusWithLiterals;
5574
- /** Optional details of current refund status. */
5575
- refundStatusInfo?: RefundStatusInfo;
5512
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5513
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5514
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5515
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5516
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5517
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5518
+ MIMIR = "MIMIR",
5519
+ /** Wix Twins platform. */
5520
+ TWINS = "TWINS",
5521
+ /** Wix Nano. */
5522
+ NANO = "NANO",
5523
+ /** Base44 headless sites. */
5524
+ BASE44 = "BASE44",
5525
+ /** Wix Channels Sites */
5526
+ CHANNELS = "CHANNELS",
5527
+ /** Nautilus platform. */
5528
+ NAUTILUS = "NAUTILUS"
5529
+ }
5530
+ /** @enumType */
5531
+ 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';
5532
+ /** Site transferred to another user. */
5533
+ interface SiteTransferred {
5576
5534
  /**
5577
- * Payment gateway's refund ID.
5578
- * This field is only returned when the value of `external_refund` is `false`.
5535
+ * A previous owner id (user that transfers meta site).
5579
5536
  * @format GUID
5580
5537
  */
5581
- gatewayRefundId?: string | null;
5582
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5583
- providerRefundId?: string | null;
5538
+ oldOwnerId?: string;
5584
5539
  /**
5585
- * Whether refund was made externally and manually on the payment provider's side.
5586
- * @immutable
5540
+ * A new owner id (user that accepts meta site).
5541
+ * @format GUID
5587
5542
  */
5588
- externalRefund?: boolean;
5543
+ newOwnerId?: string;
5589
5544
  }
5590
- /** Refund transaction status. */
5591
- declare enum RefundStatus {
5592
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5593
- PENDING = "PENDING",
5594
- /** Refund transaction succeeded. */
5595
- SUCCEEDED = "SUCCEEDED",
5596
- /** Refund transaction failed. */
5597
- FAILED = "FAILED",
5598
- /** Refund request acknowledged, and will be executed soon. */
5599
- SCHEDULED = "SCHEDULED",
5600
- /** Refund was initiated on payment provider side. */
5601
- STARTED = "STARTED"
5545
+ /** Soft deletion of the meta site. Could be restored. */
5546
+ interface SiteDeleted {
5547
+ /** A deletion context. */
5548
+ deleteContext?: DeleteContext;
5602
5549
  }
5603
- /** @enumType */
5604
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5605
- interface RefundStatusInfo {
5550
+ interface DeleteContext {
5551
+ /** When the meta site was deleted. */
5552
+ dateDeleted?: Date | null;
5553
+ /** A status. */
5554
+ deleteStatus?: DeleteStatusWithLiterals;
5606
5555
  /**
5607
- * Reason code for the refund's current status.
5608
- *
5609
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5610
- * @minLength 1
5611
- * @maxLength 10
5556
+ * A reason (flow).
5557
+ * @maxLength 255
5612
5558
  */
5613
- paymentGatewayReasonCode?: string | null;
5559
+ deleteOrigin?: string;
5614
5560
  /**
5615
- * Free text explanation of current refund status.
5616
- * @minLength 1
5617
- * @maxLength 1000
5561
+ * A service that deleted it.
5562
+ * @maxLength 255
5618
5563
  */
5619
- description?: string | null;
5564
+ initiatorId?: string | null;
5620
5565
  }
5621
- interface AggregatedRefundSummary {
5622
- /** Total amount requested for refund. */
5623
- requestedRefund?: Price;
5624
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5625
- pendingRefund?: Price;
5626
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5627
- refunded?: Price;
5628
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5629
- failedRefundAmount?: Price;
5630
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5631
- pending?: boolean;
5632
- /** Breakdown of refunded items. Available only after refund is complete. */
5633
- breakdown?: RefundItemsBreakdown;
5566
+ declare enum DeleteStatus {
5567
+ UNKNOWN = "UNKNOWN",
5568
+ TRASH = "TRASH",
5569
+ DELETED = "DELETED",
5570
+ PENDING_PURGE = "PENDING_PURGE",
5571
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5634
5572
  }
5635
- interface RefundItemsBreakdown {
5636
- /**
5637
- * Refunded line items and the amount refunded for each.
5638
- * @maxSize 300
5639
- */
5640
- lineItems?: LineItemRefundSummary[];
5573
+ /** @enumType */
5574
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5575
+ /** Restoration of the meta site. */
5576
+ interface SiteUndeleted {
5641
5577
  }
5642
- interface LineItemRefundSummary {
5643
- /**
5644
- * ID of the refunded line item.
5645
- * @format GUID
5646
- */
5647
- lineItemId?: string;
5648
- /** Total refunded amount for the line item. */
5649
- totalRefundedAmount?: Price;
5578
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5579
+ interface SitePublished {
5650
5580
  }
5651
- interface CalculateRefundRequest {
5581
+ interface SiteUnpublished {
5652
5582
  /**
5653
- * Order ID
5654
- * @minLength 1
5655
- * @maxLength 100
5583
+ * A list of URLs previously associated with the meta site.
5584
+ * @maxLength 4000
5585
+ * @maxSize 10000
5656
5586
  */
5657
- ecomOrderId?: string;
5587
+ urls?: string[];
5588
+ }
5589
+ interface SiteMarkedAsTemplate {
5590
+ }
5591
+ interface SiteMarkedAsWixSite {
5592
+ }
5593
+ /**
5594
+ * Represents a service provisioned a site.
5595
+ *
5596
+ * Note on `origin_instance_id`:
5597
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5598
+ * This is because of the following scenario:
5599
+ *
5600
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5601
+ * such as a product catalog. When you create a site from this template, you inherit this
5602
+ * default product catalog. However, if the template's product catalog is modified,
5603
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5604
+ * your site remains consistent with what you initially received and does not include any
5605
+ * changes made to the original template afterward.
5606
+ * To ensure this, the TPA on the template gets a new instance_id.
5607
+ */
5608
+ interface ServiceProvisioned {
5658
5609
  /**
5659
- * Refunded line items and quantity
5660
- * @maxSize 300
5610
+ * Either UUID or EmbeddedServiceType.
5611
+ * @maxLength 36
5661
5612
  */
5662
- refundItems?: CalculateRefundItemRequest[];
5663
- /** Should include shipping in refund calculation */
5664
- refundShipping?: boolean;
5665
- }
5666
- interface CalculateRefundItemRequest {
5613
+ appDefId?: string;
5667
5614
  /**
5668
- * ID of the line item being refunded
5669
- * @format GUID
5615
+ * Not only UUID. Something here could be something weird.
5616
+ * @maxLength 36
5670
5617
  */
5671
- id?: string;
5618
+ instanceId?: string;
5672
5619
  /**
5673
- * How much of that line item is being refunded
5674
- * @min 1
5675
- * @max 100000
5620
+ * An instance id from which this instance is originated.
5621
+ * @maxLength 36
5676
5622
  */
5677
- quantity?: number;
5678
- }
5679
- interface CalculateRefundResponse {
5680
- /** Total refundable amount */
5681
- total?: Price;
5682
- /** Tax cost of the order */
5683
- tax?: Price;
5684
- /** Discount given for this order */
5685
- discount?: Price;
5686
- /** Total cost of the order (without tax) */
5687
- subtotal?: Price;
5688
- /** Total shipping cost for order */
5689
- shipping?: Price;
5690
- /** Previous refund given on that order */
5691
- previouslyRefundedAmount?: Price;
5623
+ originInstanceId?: string;
5692
5624
  /**
5693
- * The refundable items of that order
5694
- * @maxSize 300
5625
+ * A version.
5626
+ * @maxLength 500
5695
5627
  */
5696
- items?: CalculateRefundItemResponse[];
5697
- }
5698
- interface CalculateRefundItemResponse {
5628
+ version?: string | null;
5699
5629
  /**
5700
- * Line item ID
5630
+ * The origin meta site id
5701
5631
  * @format GUID
5702
5632
  */
5703
- id?: string;
5704
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5705
- price?: Price;
5633
+ originMetaSiteId?: string | null;
5706
5634
  }
5707
- interface VoidAuthorizedPaymentsRequest {
5708
- /**
5709
- * Wix eCommerce order ID
5710
- * @minLength 1
5711
- * @maxLength 100
5712
- */
5713
- ecomOrderId: string;
5635
+ interface ServiceRemoved {
5714
5636
  /**
5715
- * Payment IDs
5716
- * @minSize 1
5717
- * @maxSize 100
5718
- * @format GUID
5637
+ * Either UUID or EmbeddedServiceType.
5638
+ * @maxLength 36
5719
5639
  */
5720
- paymentIds: string[];
5721
- }
5722
- interface VoidAuthorizedPaymentsResponse {
5723
- /** All order's transactions after the void was triggered */
5724
- orderTransactions?: OrderTransactions;
5725
- }
5726
- interface CaptureAuthorizedPaymentsRequest {
5640
+ appDefId?: string;
5727
5641
  /**
5728
- * Wix eCommerce order ID
5729
- * @minLength 1
5730
- * @maxLength 100
5642
+ * Not only UUID. Something here could be something weird.
5643
+ * @maxLength 36
5731
5644
  */
5732
- ecomOrderId: string;
5645
+ instanceId?: string;
5733
5646
  /**
5734
- * Capture payments information
5735
- * @minSize 1
5736
- * @maxSize 100
5647
+ * A version.
5648
+ * @maxLength 500
5737
5649
  */
5738
- payments: PaymentCapture[];
5650
+ version?: string | null;
5739
5651
  }
5740
- interface PaymentCapture {
5652
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5653
+ interface SiteRenamed {
5741
5654
  /**
5742
- * Payment ID
5743
- * @format GUID
5655
+ * A new meta site name (URL slug).
5656
+ * @maxLength 20
5744
5657
  */
5745
- paymentId?: string | null;
5658
+ newSiteName?: string;
5746
5659
  /**
5747
- * Capture amount.
5748
- * If not provided - full authorized amount will be captured.
5660
+ * A previous meta site name (URL slug).
5661
+ * @maxLength 255
5749
5662
  */
5750
- amount?: Price;
5663
+ oldSiteName?: string;
5751
5664
  }
5752
- interface CaptureAuthorizedPaymentsResponse {
5753
- /** All order's transactions after the capture was triggered */
5754
- orderTransactions?: OrderTransactions;
5665
+ /**
5666
+ * Hard deletion of the meta site.
5667
+ *
5668
+ * Could not be restored. Therefore it's desirable to cleanup data.
5669
+ */
5670
+ interface SiteHardDeleted {
5671
+ /** A deletion context. */
5672
+ deleteContext?: DeleteContext;
5755
5673
  }
5756
- interface ChargeSavedPaymentMethodRequest {
5674
+ interface NamespaceChanged {
5675
+ /** A previous namespace. */
5676
+ oldNamespace?: NamespaceWithLiterals;
5677
+ /** A new namespace. */
5678
+ newNamespace?: NamespaceWithLiterals;
5679
+ }
5680
+ /** Assigned Studio editor */
5681
+ interface StudioAssigned {
5682
+ }
5683
+ /** Unassigned Studio editor */
5684
+ interface StudioUnassigned {
5685
+ }
5686
+ /**
5687
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5688
+ *
5689
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5690
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5691
+ *
5692
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5693
+ */
5694
+ interface SiteUrlChanged {
5695
+ }
5696
+ /**
5697
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5698
+ * Consumed by other teams to remove relevant data.
5699
+ */
5700
+ interface SitePurgedExternally {
5757
5701
  /**
5758
- * Ecom Order ID.
5759
- * @minLength 1
5760
- * @maxLength 100
5702
+ * @maxLength 2048
5703
+ * @maxSize 100
5704
+ * @deprecated
5705
+ * @targetRemovalDate 2025-04-15
5761
5706
  */
5762
- ecomOrderId?: string;
5763
- /** Amount to be charged */
5764
- amount?: Price;
5707
+ appDefId?: string[];
5765
5708
  }
5766
- interface ChargeSavedPaymentMethodResponse {
5767
- /** Payment gateway's order ID (e.g Wix Payments) */
5768
- paymentGatewayOrderId?: string;
5709
+ /** Assigned Odeditor */
5710
+ interface OdeditorAssigned {
5711
+ }
5712
+ /** Unassigned Odeditor */
5713
+ interface OdeditorUnassigned {
5714
+ }
5715
+ /** Assigned Picasso editor */
5716
+ interface PicassoAssigned {
5717
+ }
5718
+ /** Unassigned Picasso */
5719
+ interface PicassoUnassigned {
5720
+ }
5721
+ /** Assigned Wixel */
5722
+ interface WixelAssigned {
5723
+ }
5724
+ /** Unassigned Wixel */
5725
+ interface WixelUnassigned {
5726
+ }
5727
+ /** Assigned StudioTwo */
5728
+ interface StudioTwoAssigned {
5729
+ }
5730
+ /** Unassigned StudioTwo */
5731
+ interface StudioTwoUnassigned {
5732
+ }
5733
+ /** Media from user domain is enabled. */
5734
+ interface UserDomainMediaEnabled {
5735
+ }
5736
+ /** Media from user domain is disabled. */
5737
+ interface UserDomainMediaDisabled {
5738
+ }
5739
+ /** Assigned Editorless */
5740
+ interface EditorlessAssigned {
5741
+ }
5742
+ /** Unassigned Editorless */
5743
+ interface EditorlessUnassigned {
5744
+ }
5745
+ interface HasCustomEmailConfigurationsRequest {
5746
+ }
5747
+ interface HasCustomEmailConfigurationsResponse {
5748
+ hasCustomConfigurations?: boolean;
5749
+ }
5750
+ interface AddToAutomationMigrationPopulationRequest {
5751
+ /** When true, sends custom email configurations to automation system via email */
5752
+ sendCustomEmailConfigs?: boolean;
5753
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5754
+ origin?: OriginWithLiterals;
5755
+ }
5756
+ declare enum Origin {
5757
+ OPT_IN = "OPT_IN",
5758
+ MIGRATION = "MIGRATION"
5759
+ }
5760
+ /** @enumType */
5761
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5762
+ interface AddToAutomationMigrationPopulationResponse {
5763
+ success?: boolean;
5764
+ }
5765
+ interface IsInAutomationMigrationPopulationRequest {
5766
+ }
5767
+ interface IsInAutomationMigrationPopulationResponse {
5768
+ inPopulation?: boolean;
5769
5769
  }
5770
5770
  interface DiffmatokyPayload {
5771
5771
  left?: string;