@wix/auto_sdk_ecom_orders 1.0.240 → 1.0.241

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