@wix/auto_sdk_ecom_orders 1.0.238 → 1.0.239

package/build/internal/cjs/meta.d.ts

@@ -1,4 +1,4 @@
-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-C8_CZEHt.js';
+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-CVrXK60v.js';
 import '@wix/sdk-types';
 
 /**
@@ -3762,2008 +3762,2008 @@ interface TriggerReindexOrderRequest {
      */
     orderId?: string;
 }
-interface SendBuyerConfirmationEmailRequest {
-    /** @format GUID */
-    orderId?: string;
-}
-interface SendBuyerConfirmationEmailResponse {
-}
-interface SendBuyerPaymentsReceivedEmailRequest {
+interface PreparePaymentCollectionRequest {
     /**
+     * Ecom order ID.
      * @minLength 1
      * @maxLength 100
      */
-    orderId?: string;
-}
-interface SendBuyerPaymentsReceivedEmailResponse {
-}
-interface SendBuyerPickupConfirmationEmailRequest {
+    ecomOrderId: string;
+    /** Amount to collect */
+    amount: Price;
     /**
-     * @minLength 1
-     * @maxLength 100
+     * Optional parameter. When present, payment collection will be performed using given payment gateway order.
+     * Existing payment gateway order will be updated with a new amount.
+     * When parameter is absent, new payment gateway order will be created and used for payment collection.
      */
-    orderId?: string;
-}
-interface SendBuyerPickupConfirmationEmailResponse {
-}
-interface BulkSendBuyerPickupConfirmationEmailsRequest {
+    paymentGatewayOrderId?: string | null;
     /**
-     * IDs of orders to send pickup emails for.
-     * @minSize 1
-     * @maxSize 300
+     * Whether to delay capture of the payment.
+     * Default: false
+     * @deprecated Whether to delay capture of the payment.
+     * Default: false
+     * @replacedBy delayed_capture_settings.scheduled_action
+     * @targetRemovalDate 2024-09-30
      */
-    orderIds?: string[];
-}
-interface BulkSendBuyerPickupConfirmationEmailsResponse {
+    delayedCapture?: boolean;
+    /** Delayed capture payment settings */
+    delayedCaptureSettings?: DelayedCaptureSettings;
 }
-interface SendBuyerShippingConfirmationEmailRequest {
+interface RedirectUrls {
     /**
-     * @minLength 1
-     * @maxLength 100
+     * URL to redirect buyer in case of approved (successful) transaction
+     * @format WEB_URL
      */
-    orderId?: string;
+    successUrl?: string | null;
+    /**
+     * URL to redirect buyer in case of buyer canceled the transaction
+     * @format WEB_URL
+     */
+    cancelUrl?: string | null;
+    /**
+     * URL to redirect buyer in case of failed/rejected transaction
+     * @format WEB_URL
+     */
+    errorUrl?: string | null;
+    /**
+     * URL to redirect buyer in case of pending transaction (that might take some time to process)
+     * @format WEB_URL
+     */
+    pendingUrl?: string | null;
 }
-interface SendBuyerShippingConfirmationEmailResponse {
+interface DelayedCaptureSettings {
+    /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
+    scheduledAction?: ScheduledActionWithLiterals;
+    /** Delay duration before execution. Optional - if not set, providers default period will be used */
+    delayDuration?: Duration;
 }
-interface BulkSendBuyerShippingConfirmationEmailsRequest {
+declare enum ScheduledAction {
+    /** Whether payment will be auto-voided when duration passes */
+    VOID = "VOID",
+    /** Whether payment will be auto-captured when duration passes */
+    CAPTURE = "CAPTURE"
+}
+/** @enumType */
+type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
+interface Duration {
     /**
-     * IDs of orders to send pickup emails for.
-     * @minSize 1
-     * @maxSize 300
+     * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
+     * @min 1
      */
-    orderIds?: string[];
+    count?: number;
+    /** Duration unit: MINUTES, HOURS and DAYS */
+    unit?: DurationUnitWithLiterals;
 }
-interface BulkSendBuyerShippingConfirmationEmailsResponse {
+declare enum DurationUnit {
+    MINUTES = "MINUTES",
+    HOURS = "HOURS",
+    DAYS = "DAYS"
 }
-interface SendMerchantOrderReceivedNotificationRequest {
+/** @enumType */
+type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
+interface PreparePaymentCollectionResponse {
+    /** Payment gateway order id which is associated with given payment */
+    paymentGatewayOrderId?: string;
+}
+interface GetPaymentCollectabilityStatusRequest {
     /**
+     * Ecom order ID.
      * @minLength 1
      * @maxLength 100
      */
-    orderId?: string;
+    ecomOrderId: string;
 }
-interface SendMerchantOrderReceivedNotificationResponse {
+interface GetPaymentCollectabilityStatusResponse {
+    /** Payment collectability status */
+    status?: PaymentCollectabilityStatusWithLiterals;
+    /** Collectable order amount */
+    amount?: Price;
 }
-interface SendCancelRefundEmailRequest {
+declare enum PaymentCollectabilityStatus {
+    UNKNOWN = "UNKNOWN",
+    COLLECTABLE = "COLLECTABLE",
+    NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
+    NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
+    NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
+    NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
+    NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
+    NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
+    NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
+    NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
+    NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION"
+}
+/** @enumType */
+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';
+interface RecordManuallyCollectedPaymentRequest {
     /**
-     * The ID of order that is canceled/refunded
+     * Order ID.
      * @minLength 1
      * @maxLength 100
      */
-    orderId?: string;
-    /**
-     * Personal note added to the email (optional)
-     * @minLength 1
-     * @maxLength 1000
-     */
-    customMessage?: string | null;
-    /** Refund amount */
-    refundAmount?: Price;
-    /**
-     * Refund ID. (Optional)
-     * @format GUID
-     */
-    refundId?: string | null;
-}
-interface SendCancelRefundEmailResponse {
+    orderId: string;
+    /** Amount to be recorded as approved manual payment for given order */
+    amount: Price;
 }
-interface SendRefundEmailRequest {
-    /**
-     * The ID of order that is refunded
-     * @format GUID
-     */
-    orderId?: string;
-    /**
-     * Refund ID
-     * @format GUID
-     */
-    refundId?: string;
+/**
+ * User-defined payment method name.
+ * Allows specifying either a predefined type or a custom name.
+ */
+interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
+    /** Predefined payment method. */
+    predefined?: PredefinedPaymentMethodWithLiterals;
     /**
-     * Personal note added to the email (optional)
+     * Custom payment method name provided by user.
+     *
+     * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
      * @minLength 1
-     * @maxLength 1000
+     * @maxLength 100
      */
-    customMessage?: string | null;
-}
-interface SendRefundEmailResponse {
-}
-interface SendFulfillmentEmailRequest {
-    /** @format GUID */
-    orderId?: string;
-    /** @format GUID */
-    fulfillerId?: string;
-}
-interface SendFulfillmentEmailResponse {
+    custom?: string | null;
 }
-interface SendMerchantOrderReceivedPushRequest {
+/** @oneof */
+interface UserDefinedPaymentMethodNameKindOneOf {
+    /** Predefined payment method. */
+    predefined?: PredefinedPaymentMethodWithLiterals;
     /**
+     * Custom payment method name provided by user.
+     *
+     * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
      * @minLength 1
      * @maxLength 100
      */
-    orderId?: string;
-}
-interface SendMerchantOrderReceivedPushResponse {
-}
-interface PreviewEmailByTypeRequest {
-    emailType?: PreviewEmailTypeWithLiterals;
+    custom?: string | null;
 }
-declare enum PreviewEmailType {
-    ORDER_PLACED = "ORDER_PLACED",
-    DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
-    ORDER_SHIPPED = "ORDER_SHIPPED",
-    ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
+/** Predefined payment method types for offline/manual payments. */
+declare enum PredefinedPaymentMethod {
+    /** Cash payment. */
+    CASH = "CASH",
+    /** Bank transfer. */
+    BANK_TRANSFER = "BANK_TRANSFER",
+    /** Payment by check. */
+    CHECK = "CHECK"
 }
 /** @enumType */
-type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
-interface PreviewEmailByTypeResponse {
-    emailPreview?: string;
+type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
+interface RecordManuallyCollectedPaymentResponse {
 }
-interface PreviewRefundEmailRequest {
+interface MarkOrderAsPaidRequest {
     /**
+     * Ecom order ID.
      * @minLength 1
      * @maxLength 100
      */
-    orderId?: string;
-    /** Refund amount */
-    refundAmount?: Price;
-    /** Refund business details */
-    details?: RefundDetails;
+    ecomOrderId: string;
+}
+interface MarkOrderAsPaidResponse {
+    /** Updated order. */
+    order?: Order;
+}
+interface BulkMarkOrdersAsPaidRequest {
     /**
-     * Personal note added to the email (optional)
+     * IDs of orders to mark as paid.
+     * @minSize 1
+     * @maxSize 100
      * @minLength 1
-     * @maxLength 1000
-     */
-    customMessage?: string | null;
-    /**
-     * Refund ID. (Optional)
-     * @format GUID
+     * @maxLength 100
      */
-    refundId?: string | null;
+    ecomOrderIds: string[];
 }
-/** Business model of a refund request */
-interface RefundDetails {
+interface BulkMarkOrdersAsPaidResponse {
     /**
-     * Order line item IDs and quantities that were refunded.
-     * @maxSize 300
+     * Items updated by the bulk action.
+     * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
      */
-    items?: RefundItem[];
-    /** Whether the shipping fee was also refunded. */
-    shippingIncluded?: boolean;
+    results?: BulkOrderResult[];
+    /** Bulk action metadata. */
+    bulkActionMetadata?: BulkActionMetadata;
+}
+interface BulkOrderResult {
+    /** Item metadata. */
+    itemMetadata?: ItemMetadata;
     /**
-     * Reason for the refund, provided by customer (optional).
-     * @maxLength 200
+     * Updated order.
+     *
+     * Returned when `returnFullEntity = true`.
      */
-    reason?: string | null;
+    item?: Order;
+}
+interface ItemMetadata {
+    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
+    id?: string | null;
+    /** Index of the item within the request array. Allows for correlation between request and response items. */
+    originalIndex?: number;
+    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
+    success?: boolean;
+    /** Details about the error in case of failure. */
+    error?: ApplicationError;
+}
+interface ApplicationError {
+    /** Error code. */
+    code?: string;
+    /** Description of the error. */
+    description?: string;
+    /** Data related to the error. */
+    data?: Record<string, any> | null;
+}
+interface BulkActionMetadata {
+    /** Number of items that were successfully processed. */
+    totalSuccesses?: number;
+    /** Number of items that couldn't be processed. */
+    totalFailures?: number;
+    /** Number of failures without details because detailed failure threshold was exceeded. */
+    undetailedFailures?: number;
+}
+interface GetRefundabilityStatusRequest {
     /**
-     * Line items that were refunded.
-     * @maxSize 300
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
      */
-    lineItems?: LineItemRefund[];
+    ecomOrderId: string;
+}
+interface GetRefundabilityStatusResponse {
     /**
-     * Additional fees that were refunded.
-     * @maxSize 100
+     * Refundability details.
+     * @maxSize 300
      */
-    additionalFees?: AdditionalFeeRefund[];
-    /** Shipping amount that was refunded. */
-    shipping?: ShippingRefund;
-}
-interface RefundItem {
+    refundabilities?: Refundability[];
     /**
-     * Line item ID the refunded line item.
-     * @format GUID
+     * Whether the order supports refunding per item.
+     * @deprecated
      */
-    lineItemId?: string;
+    refundablePerItem?: boolean;
+}
+interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
+    /** Reason why payment is not refundable. */
+    nonRefundableReason?: NonRefundableReasonWithLiterals;
+    /** Reason why payment is only refundable manually. */
+    manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
+    /** Payment ID. */
+    paymentId?: string;
+    /** Payment refundability status. */
+    refundabilityStatus?: RefundableStatusWithLiterals;
+    /** Link to payment provider dashboard. */
+    providerLink?: string | null;
+}
+/** @oneof */
+interface RefundabilityAdditionalRefundabilityInfoOneOf {
+    /** Reason why payment is not refundable. */
+    nonRefundableReason?: NonRefundableReasonWithLiterals;
+    /** Reason why payment is only refundable manually. */
+    manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
+}
+declare enum RefundableStatus {
+    NOT_REFUNDABLE = "NOT_REFUNDABLE",
+    MANUAL = "MANUAL",
+    REFUNDABLE = "REFUNDABLE"
+}
+/** @enumType */
+type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
+declare enum NonRefundableReason {
+    NONE = "NONE",
+    ALREADY_REFUNDED = "ALREADY_REFUNDED",
+    PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
+    INTERNAL_ERROR = "INTERNAL_ERROR",
+    NOT_PAID = "NOT_PAID",
+    ACCESS_DENIED = "ACCESS_DENIED",
+    ZERO_PRICE = "ZERO_PRICE",
+    DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
+    PENDING_REFUND = "PENDING_REFUND",
+    FORBIDDEN = "FORBIDDEN",
+    TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
+    ORDER_IS_PENDING = "ORDER_IS_PENDING",
+    ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
+}
+/** @enumType */
+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';
+declare enum ManuallyRefundableReason {
+    EXPIRED = "EXPIRED",
+    NOT_SUPPORTED = "NOT_SUPPORTED",
+    OFFLINE = "OFFLINE",
+    REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
+}
+/** @enumType */
+type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
+interface CreatePaymentGatewayOrderRequest {
     /**
-     * Line item quantity refunded.
-     * @min 1
-     * @max 100000
+     * Ecom order ID.
+     * @minLength 1
+     * @maxLength 100
      */
-    quantity?: number;
+    ecomOrderId: string;
+    /** Information about the user who initiated the payment. */
+    chargedBy?: ChargedBy;
 }
-interface LineItemRefund {
+interface ChargedBy {
     /**
-     * Line item ID.
+     * ID - id of the user who initiated the payment
      * @format GUID
-     * @immutable
      */
-    lineItemId?: string;
+    id?: string;
     /**
-     * Refund quantity.
-     * @min 1
-     * @max 100000
-     * @immutable
+     * Full name - name of the user who initiated the payment
+     * @minLength 1
+     * @maxLength 200
      */
-    quantity?: number;
+    fullName?: string | null;
 }
-interface AdditionalFeeRefund {
+interface CreatePaymentGatewayOrderResponse {
+    /** ID of the order created in the payment gateway */
+    paymentGatewayOrderId?: string;
+}
+interface ChargeMembershipsRequest {
     /**
-     * Additional fee ID.
-     * @format GUID
-     * @immutable
+     * Order ID.
+     * @minLength 1
+     * @maxLength 100
      */
-    additionalFeeId?: string;
+    ecomOrderId: string;
     /**
-     * Refund amount.
-     * @immutable
+     * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
+     * but a user which is using the membership on behalf of the a member
+     * @format GUID
      */
-    amount?: Price;
-}
-interface ShippingRefund {
+    memberId: string;
     /**
-     * Refund amount.
-     * @immutable
+     * List of items to be paid by memberships
+     * @minSize 1
+     * @maxSize 300
      */
-    amount?: Price;
-}
-interface PreviewRefundEmailResponse {
-    emailPreview?: string;
+    membershipCharges?: MembershipChargeItem[];
 }
-interface PreviewCancelEmailRequest {
+interface MembershipChargeItem {
     /**
+     * The id of used membership
      * @minLength 1
      * @maxLength 100
      */
-    orderId?: string;
+    membershipId?: string;
     /**
-     * Personal note added to the email (optional)
+     * ID of the application providing this payment option
+     * @format GUID
+     */
+    appId?: string;
+    /** The name of used membership */
+    membershipName?: MembershipName;
+    /** Additional data about this membership */
+    membershipAdditionalData?: Record<string, any> | null;
+    /** Catalog and item reference info. */
+    catalogReference?: CatalogReference;
+    /** Properties of the service. When relevant, contains information such as date and number of participants. */
+    serviceProperties?: ServiceProperties;
+    /**
+     * Usually would be the same as catalogReference.catalogItemId
+     * For cases when these are not the same, this field would return the actual id of the item in the catalog
+     * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
      * @minLength 1
-     * @maxLength 1000
+     * @maxLength 36
      */
-    customMessage?: string | null;
-}
-interface PreviewCancelEmailResponse {
-    emailPreview?: string;
-}
-interface PreviewCancelRefundEmailRequest {
+    rootCatalogItemId?: string | null;
     /**
+     * line item id of Checkout/Order line item
      * @minLength 1
      * @maxLength 100
      */
-    orderId?: string;
+    lineItemId?: string;
+}
+interface MembershipName {
     /**
-     * Personal note added to the email (optional)
-     * @minLength 1
-     * @maxLength 1000
+     * Membership name.
+     * @maxLength 100
      */
-    customMessage?: string | null;
-    /** Refund amount */
-    refundAmount?: Price;
+    original?: string;
     /**
-     * Refund ID. (Optional)
-     * @format GUID
+     * Translated membership name. Defaults to `original` when not provided.
+     * @maxLength 100
      */
-    refundId?: string | null;
-}
-interface PreviewCancelRefundEmailResponse {
-    emailPreview?: string;
-}
-interface PreviewBuyerPaymentsReceivedEmailRequest {
-}
-interface PreviewBuyerPaymentsReceivedEmailResponse {
-    emailPreview?: string;
+    translated?: string | null;
 }
-interface PreviewBuyerConfirmationEmailRequest {
+interface ServiceProperties {
+    /**
+     * 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.
+     * For example, the start time of a class.
+     */
+    scheduledDate?: Date | null;
+    /**
+     * 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.
+     * @min 1
+     * @max 10000
+     */
+    numberOfParticipants?: number | null;
 }
-interface PreviewBuyerConfirmationEmailResponse {
-    emailPreview?: string;
+interface ChargeMembershipsResponse {
 }
-interface PreviewBuyerPickupConfirmationEmailRequest {
-}
-interface PreviewBuyerPickupConfirmationEmailResponse {
-    emailPreview?: string;
-}
-interface PreviewShippingConfirmationEmailRequest {
-}
-interface PreviewShippingConfirmationEmailResponse {
-    emailPreview?: string;
-}
-interface PreviewResendDownloadLinksEmailRequest {
-}
-interface PreviewResendDownloadLinksEmailResponse {
-    emailPreview?: string;
-}
-interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
-    /** Emitted on a meta site creation. */
-    siteCreated?: SiteCreated;
-    /** Emitted on a meta site transfer completion. */
-    siteTransferred?: SiteTransferred;
-    /** Emitted on a meta site deletion. */
-    siteDeleted?: SiteDeleted;
-    /** Emitted on a meta site restoration. */
-    siteUndeleted?: SiteUndeleted;
-    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
-    sitePublished?: SitePublished;
-    /** Emitted on a meta site unpublish. */
-    siteUnpublished?: SiteUnpublished;
-    /** Emitted when meta site is marked as template. */
-    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
-    /** Emitted when meta site is marked as a WixSite. */
-    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
-    /** Emitted when an application is provisioned (installed). */
-    serviceProvisioned?: ServiceProvisioned;
-    /** Emitted when an application is removed (uninstalled). */
-    serviceRemoved?: ServiceRemoved;
-    /** Emitted when meta site name (URL slug) is changed. */
-    siteRenamedPayload?: SiteRenamed;
-    /** Emitted when meta site was permanently deleted. */
-    hardDeleted?: SiteHardDeleted;
-    /** Emitted on a namespace change. */
-    namespaceChanged?: NamespaceChanged;
-    /** Emitted when Studio is attached. */
-    studioAssigned?: StudioAssigned;
-    /** Emitted when Studio is detached. */
-    studioUnassigned?: StudioUnassigned;
+interface TriggerRefundRequest {
     /**
-     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
-     * the actual URL.
-     *
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     * The order this refund related to
+     * @minLength 1
+     * @maxLength 100
      */
-    urlChanged?: SiteUrlChanged;
-    /** Site is marked as PurgedExternally */
-    sitePurgedExternally?: SitePurgedExternally;
-    /** Emitted when Odeditor is attached. */
-    odeditorAssigned?: OdeditorAssigned;
-    /** Emitted when Odeditor is detached. */
-    odeditorUnassigned?: OdeditorUnassigned;
-    /** Emitted when Picasso is attached. */
-    picassoAssigned?: PicassoAssigned;
-    /** Emitted when Picasso is detached. */
-    picassoUnassigned?: PicassoUnassigned;
-    /** Emitted when Wixel is attached. */
-    wixelAssigned?: WixelAssigned;
-    /** Emitted when Wixel is detached. */
-    wixelUnassigned?: WixelUnassigned;
-    /** Emitted when StudioTwo is attached. */
-    studioTwoAssigned?: StudioTwoAssigned;
-    /** Emitted when StudioTwo is detached. */
-    studioTwoUnassigned?: StudioTwoUnassigned;
-    /** Emitted when media from user domain is enabled. */
-    userDomainMediaEnabled?: UserDomainMediaEnabled;
-    /** Emitted when media from user domain is disabled. */
-    userDomainMediaDisabled?: UserDomainMediaDisabled;
-    /** Emitted when Editorless is attached. */
-    editorlessAssigned?: EditorlessAssigned;
-    /** Emitted when Editorless is detached. */
-    editorlessUnassigned?: EditorlessUnassigned;
+    ecomOrderId: string;
     /**
-     * A meta site id.
-     * @format GUID
+     * Refund operations information
+     * @minSize 1
+     * @maxSize 1
      */
-    metaSiteId?: string;
-    /** A meta site version. Monotonically increasing. */
-    version?: string;
-    /** A timestamp of the event. */
-    timestamp?: string;
+    payments: PaymentRefund[];
+    /** Business model of a refund */
+    details?: RefundDetails;
+    /** Side effect details related to refund */
+    sideEffects?: RefundSideEffects;
+}
+interface PaymentRefund {
     /**
-     * TODO(meta-site): Change validation once validations are disabled for consumers
-     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
-     * @maxSize 4000
+     * Specific payment within the order to refund
+     * @format GUID
      */
-    assets?: Asset[];
-}
-/** @oneof */
-interface MetaSiteSpecialEventPayloadOneOf {
-    /** Emitted on a meta site creation. */
-    siteCreated?: SiteCreated;
-    /** Emitted on a meta site transfer completion. */
-    siteTransferred?: SiteTransferred;
-    /** Emitted on a meta site deletion. */
-    siteDeleted?: SiteDeleted;
-    /** Emitted on a meta site restoration. */
-    siteUndeleted?: SiteUndeleted;
-    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
-    sitePublished?: SitePublished;
-    /** Emitted on a meta site unpublish. */
-    siteUnpublished?: SiteUnpublished;
-    /** Emitted when meta site is marked as template. */
-    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
-    /** Emitted when meta site is marked as a WixSite. */
-    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
-    /** Emitted when an application is provisioned (installed). */
-    serviceProvisioned?: ServiceProvisioned;
-    /** Emitted when an application is removed (uninstalled). */
-    serviceRemoved?: ServiceRemoved;
-    /** Emitted when meta site name (URL slug) is changed. */
-    siteRenamedPayload?: SiteRenamed;
-    /** Emitted when meta site was permanently deleted. */
-    hardDeleted?: SiteHardDeleted;
-    /** Emitted on a namespace change. */
-    namespaceChanged?: NamespaceChanged;
-    /** Emitted when Studio is attached. */
-    studioAssigned?: StudioAssigned;
-    /** Emitted when Studio is detached. */
-    studioUnassigned?: StudioUnassigned;
+    paymentId?: string;
+    /** Refund amount. Not relevant for membership and gift card refunds. */
+    amount?: Price;
     /**
-     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
-     * the actual URL.
-     *
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
-     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
+     * Whether refund is made externally and manually (on the payment provider's side)
+     * 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.
+     * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
      */
-    urlChanged?: SiteUrlChanged;
-    /** Site is marked as PurgedExternally */
-    sitePurgedExternally?: SitePurgedExternally;
-    /** Emitted when Odeditor is attached. */
-    odeditorAssigned?: OdeditorAssigned;
-    /** Emitted when Odeditor is detached. */
-    odeditorUnassigned?: OdeditorUnassigned;
-    /** Emitted when Picasso is attached. */
-    picassoAssigned?: PicassoAssigned;
-    /** Emitted when Picasso is detached. */
-    picassoUnassigned?: PicassoUnassigned;
-    /** Emitted when Wixel is attached. */
-    wixelAssigned?: WixelAssigned;
-    /** Emitted when Wixel is detached. */
-    wixelUnassigned?: WixelUnassigned;
-    /** Emitted when StudioTwo is attached. */
-    studioTwoAssigned?: StudioTwoAssigned;
-    /** Emitted when StudioTwo is detached. */
-    studioTwoUnassigned?: StudioTwoUnassigned;
-    /** Emitted when media from user domain is enabled. */
-    userDomainMediaEnabled?: UserDomainMediaEnabled;
-    /** Emitted when media from user domain is disabled. */
-    userDomainMediaDisabled?: UserDomainMediaDisabled;
-    /** Emitted when Editorless is attached. */
-    editorlessAssigned?: EditorlessAssigned;
-    /** Emitted when Editorless is detached. */
-    editorlessUnassigned?: EditorlessUnassigned;
+    externalRefund?: boolean;
 }
-interface Asset {
+/** Business model of a refund request */
+interface RefundDetails {
     /**
-     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
-     * @maxLength 36
+     * Order line item IDs and quantities that were refunded.
+     * @maxSize 300
      */
-    appDefId?: string;
+    items?: RefundItem[];
+    /** Whether the shipping fee was also refunded. */
+    shippingIncluded?: boolean;
     /**
-     * An instance id. For legacy reasons may be UUID or a string.
+     * Reason for the refund, provided by customer (optional).
      * @maxLength 200
      */
-    instanceId?: string;
-    /** An application state. */
-    state?: StateWithLiterals;
-}
-declare enum State {
-    UNKNOWN = "UNKNOWN",
-    ENABLED = "ENABLED",
-    DISABLED = "DISABLED",
-    PENDING = "PENDING",
-    DEMO = "DEMO"
-}
-/** @enumType */
-type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
-interface SiteCreated {
+    reason?: string | null;
     /**
-     * A template identifier (empty if not created from a template).
-     * @maxLength 36
+     * Line items that were refunded.
+     * @maxSize 300
      */
-    originTemplateId?: string;
+    lineItems?: LineItemRefund[];
     /**
-     * An account id of the owner.
-     * @format GUID
+     * Additional fees that were refunded.
+     * @maxSize 100
      */
-    ownerId?: string;
-    /** A context in which meta site was created. */
-    context?: SiteCreatedContextWithLiterals;
+    additionalFees?: AdditionalFeeRefund[];
+    /** Shipping amount that was refunded. */
+    shipping?: ShippingRefund;
+}
+interface RefundItem {
     /**
-     * A meta site id from which this site was created.
-     *
-     * In case of a creation from a template it's a template id.
-     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
+     * Line item ID the refunded line item.
      * @format GUID
      */
-    originMetaSiteId?: string | null;
+    lineItemId?: string;
     /**
-     * A meta site name (URL slug).
-     * @maxLength 20
-     */
-    siteName?: string;
-    /** A namespace. */
-    namespace?: NamespaceWithLiterals;
-}
-declare enum SiteCreatedContext {
-    /** A valid option, we don't expose all reasons why site might be created. */
-    OTHER = "OTHER",
-    /** A meta site was created from template. */
-    FROM_TEMPLATE = "FROM_TEMPLATE",
-    /** A meta site was created by copying of the transfferred meta site. */
-    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
-    /** A copy of existing meta site. */
-    DUPLICATE = "DUPLICATE",
-    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
-    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
-    /** deprecated A meta site was created for Flash editor. */
-    FLASH = "FLASH"
-}
-/** @enumType */
-type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
-declare enum Namespace {
-    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
-    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
-    WIX = "WIX",
-    /** 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. */
-    SHOUT_OUT = "SHOUT_OUT",
-    /** 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. */
-    ALBUMS = "ALBUMS",
-    /** 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. */
-    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
-    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    HOTELS = "HOTELS",
-    /** 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. */
-    CLUBS = "CLUBS",
-    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
-    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    DEV_SITE = "DEV_SITE",
-    /** 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. */
-    LOGOS = "LOGOS",
-    /** 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. */
-    VIDEO_MAKER = "VIDEO_MAKER",
-    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
-    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
+     * Line item quantity refunded.
+     * @min 1
+     * @max 100000
+     */
+    quantity?: number;
+}
+interface LineItemRefund {
     /**
-     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
-     *
-     * Meta site with this namespace will *not* be shown in a user's site list by default.
+     * Line item ID.
+     * @format GUID
+     * @immutable
      */
-    HTML_DRAFT = "HTML_DRAFT",
+    lineItemId?: string;
     /**
-     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
-     * Will be accessible from Site List and will not have a website app.
-     * Once the user attaches a site, the site will become a regular wixsite.
+     * Refund quantity.
+     * @min 1
+     * @max 100000
+     * @immutable
      */
-    SITELESS_BUSINESS = "SITELESS_BUSINESS",
-    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
-    CREATOR_ECONOMY = "CREATOR_ECONOMY",
-    /** It is to be used in the Business First efforts. */
-    DASHBOARD_FIRST = "DASHBOARD_FIRST",
-    /** Bookings business flow with no site. */
-    ANYWHERE = "ANYWHERE",
-    /** Namespace for Headless Backoffice with no editor */
-    HEADLESS = "HEADLESS",
+    quantity?: number;
+}
+interface AdditionalFeeRefund {
     /**
-     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
-     * The site will be used for account level CSM feature for enterprise
+     * Additional fee ID.
+     * @format GUID
+     * @immutable
      */
-    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
-    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
-    RISE = "RISE",
+    additionalFeeId?: string;
     /**
-     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
-     * There's a blank site behind the scene but it's blank).
-     * The Mobile company will be the owner of this namespace.
+     * Refund amount.
+     * @immutable
      */
-    BRANDED_FIRST = "BRANDED_FIRST",
-    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
-    NOWNIA = "NOWNIA",
+    amount?: Price;
+}
+interface ShippingRefund {
     /**
-     * UGC Templates are templates that are created by users for personal use and to sale to other users.
-     * The Partners company owns this namespace.
+     * Refund amount.
+     * @immutable
      */
-    UGC_TEMPLATE = "UGC_TEMPLATE",
-    /** Codux Headless Sites */
-    CODUX = "CODUX",
-    /** Bobb - AI Design Creator. */
-    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
+    amount?: Price;
+}
+interface RefundSideEffects {
+    /** Inventory restock details as part of this refund. */
+    restockInfo?: RestockInfo;
+    /** Whether to send a refund confirmation email to the customer. */
+    sendOrderRefundedEmail?: boolean;
     /**
-     * Shared Blog Site is a unique single site across Enterprise account,
-     * This site will hold all Blog posts related to the Marketing product.
+     * Custom message added to the refund confirmation email.
+     * @minLength 1
+     * @maxLength 1000
      */
-    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
-    /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    STANDALONE_FORMS = "STANDALONE_FORMS",
-    /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
-    STANDALONE_EVENTS = "STANDALONE_EVENTS",
-    /** MIMIR - Siteless account for MIMIR Ai Job runner. */
-    MIMIR = "MIMIR",
-    /** Wix Twins platform. */
-    TWINS = "TWINS",
-    /** Wix Nano. */
-    NANO = "NANO",
-    /** Base44 headless sites. */
-    BASE44 = "BASE44",
-    /** Wix Channels Sites */
-    CHANNELS = "CHANNELS"
+    customMessage?: string | null;
+}
+interface RestockInfo {
+    /** Restock type. */
+    type?: RestockTypeWithLiterals;
+    /**
+     * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
+     * @maxSize 300
+     */
+    items?: RestockItem[];
+}
+declare enum RestockType {
+    NO_ITEMS = "NO_ITEMS",
+    ALL_ITEMS = "ALL_ITEMS",
+    SOME_ITEMS = "SOME_ITEMS"
 }
 /** @enumType */
-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';
-/** Site transferred to another user. */
-interface SiteTransferred {
+type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
+interface RestockItem {
     /**
-     * A previous owner id (user that transfers meta site).
+     * ID of the line item being restocked.
      * @format GUID
      */
-    oldOwnerId?: string;
+    lineItemId?: string;
     /**
-     * A new owner id (user that accepts meta site).
-     * @format GUID
+     * Line item quantity being restocked.
+     * @min 1
+     * @max 100000
      */
-    newOwnerId?: string;
+    quantity?: number;
 }
-/** Soft deletion of the meta site. Could be restored. */
-interface SiteDeleted {
-    /** A deletion context. */
-    deleteContext?: DeleteContext;
+interface TriggerRefundResponse {
+    /** All order's transactions after the refunds were added */
+    orderTransactions?: OrderTransactions;
+    /** Created refund ID */
+    refundId?: string | null;
+    /** Payment ID's that the refund execution had failed for */
+    failedPaymentIds?: ItemMetadata[];
 }
-interface DeleteContext {
-    /** When the meta site was deleted. */
-    dateDeleted?: Date | null;
-    /** A status. */
-    deleteStatus?: DeleteStatusWithLiterals;
+/**
+ * A record of all payments and refunds associated with an order.
+ *
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
+ */
+interface OrderTransactions {
     /**
-     * A reason (flow).
-     * @maxLength 255
+     * Order ID.
+     * @format GUID
      */
-    deleteOrigin?: string;
+    orderId?: string;
     /**
-     * A service that deleted it.
-     * @maxLength 255
+     * Record of payments made to the merchant.
+     * @maxSize 100
      */
-    initiatorId?: string | null;
-}
-declare enum DeleteStatus {
-    UNKNOWN = "UNKNOWN",
-    TRASH = "TRASH",
-    DELETED = "DELETED",
-    PENDING_PURGE = "PENDING_PURGE",
-    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
-}
-/** @enumType */
-type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
-/** Restoration of the meta site. */
-interface SiteUndeleted {
-}
-/** First publish of a meta site. Or subsequent publish after unpublish. */
-interface SitePublished {
+    payments?: Payment[];
+    /**
+     * Record of refunds made to the buyer.
+     * @maxSize 300
+     */
+    refunds?: Refund[];
 }
-interface SiteUnpublished {
+interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
+    /** Regular payment details. */
+    regularPaymentDetails?: RegularPaymentDetails;
+    /** Gift card payment details. */
+    giftcardPaymentDetails?: GiftCardPaymentDetails;
     /**
-     * A list of URLs previously associated with the meta site.
-     * @maxLength 4000
-     * @maxSize 10000
+     * Payment ID.
+     * @format GUID
+     * @readonly
      */
-    urls?: string[];
+    id?: string | null;
+    /** 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. */
+    createdDate?: Date | null;
+    /**
+     * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
+     * @readonly
+     */
+    updatedDate?: Date | null;
+    /** Payment amount. */
+    amount?: Price;
+    /**
+     * Whether refunds for this payment are disabled.
+     * + `true`: This payment is not refundable.
+     * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
+     */
+    refundDisabled?: boolean;
 }
-interface SiteMarkedAsTemplate {
+/** @oneof */
+interface PaymentPaymentDetailsOneOf {
+    /** Regular payment details. */
+    regularPaymentDetails?: RegularPaymentDetails;
+    /** Gift card payment details. */
+    giftcardPaymentDetails?: GiftCardPaymentDetails;
 }
-interface SiteMarkedAsWixSite {
+/** @oneof */
+interface PaymentReceiptInfoOneOf {
 }
-/**
- * Represents a service provisioned a site.
- *
- * Note on `origin_instance_id`:
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
- * This is because of the following scenario:
- *
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
- * such as a product catalog. When you create a site from this template, you inherit this
- * default product catalog. However, if the template's product catalog is modified,
- * your site will retain the catalog as it was at the time of site creation. This ensures that
- * your site remains consistent with what you initially received and does not include any
- * changes made to the original template afterward.
- * To ensure this, the TPA on the template gets a new instance_id.
- */
-interface ServiceProvisioned {
+interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
+    /** Credit card details. */
+    creditCardDetails?: CreditCardPaymentMethodDetails;
     /**
-     * Either UUID or EmbeddedServiceType.
-     * @maxLength 36
+     * Wix Payments order ID.
+     * @maxLength 100
      */
-    appDefId?: string;
+    paymentOrderId?: string | null;
     /**
-     * Not only UUID. Something here could be something weird.
-     * @maxLength 36
+     * Payment gateway's transaction ID.
+     * This field is only returned when the value of `offline_payment` is `false`.
+     * @maxLength 100
+     */
+    gatewayTransactionId?: string | null;
+    /**
+     * Payment method.
+     * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
+     * Non-exhaustive list of supported values:
+     * + `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`
+     * @maxLength 100
+     * @deprecated Payment method.
+     * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
+     * Non-exhaustive list of supported values:
+     * + `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`
+     * @replacedBy payment_method_name
+     * @targetRemovalDate 2026-07-01
      */
-    instanceId?: string;
+    paymentMethod?: string | null;
     /**
-     * An instance id from which this instance is originated.
-     * @maxLength 36
+     * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
+     * @maxLength 100
      */
-    originInstanceId?: string;
+    providerTransactionId?: string | null;
+    /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
+    offlinePayment?: boolean;
+    /** Payment status. */
+    status?: TransactionStatusWithLiterals;
     /**
-     * A version.
-     * @maxLength 500
+     * Whether there is a payment agreement that allows for future charges.
+     * @immutable
      */
-    version?: string | null;
+    savedPaymentMethod?: boolean;
+    /** Authorization details. */
+    authorizationDetails?: AuthorizationDetails;
     /**
-     * The origin meta site id
-     * @format GUID
+     * Record of chargebacks made by the buyer.
+     * @maxSize 6
      */
-    originMetaSiteId?: string | null;
-}
-interface ServiceRemoved {
+    chargebacks?: Chargeback[];
+    /** Platform fee amount associated with this payment. */
+    platformFee?: Price;
     /**
-     * Either UUID or EmbeddedServiceType.
-     * @maxLength 36
+     * Payment method with buyer and optional owner translations.
+     * Non-exhaustive list of supported values:
+     * + `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`
      */
-    appDefId?: string;
+    paymentMethodName?: PaymentMethodName;
+}
+/** @oneof */
+interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
+    /** Credit card details. */
+    creditCardDetails?: CreditCardPaymentMethodDetails;
+}
+declare enum TransactionStatus {
+    UNDEFINED = "UNDEFINED",
+    APPROVED = "APPROVED",
+    PENDING = "PENDING",
+    PENDING_MERCHANT = "PENDING_MERCHANT",
+    CANCELED = "CANCELED",
+    DECLINED = "DECLINED",
+    REFUNDED = "REFUNDED",
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+    AUTHORIZED = "AUTHORIZED",
+    VOIDED = "VOIDED"
+}
+/** @enumType */
+type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
+interface CreditCardPaymentMethodDetails {
     /**
-     * Not only UUID. Something here could be something weird.
-     * @maxLength 36
+     * The last 4 digits of the card number.
+     * @maxLength 4
      */
-    instanceId?: string;
+    lastFourDigits?: string | null;
     /**
-     * A version.
-     * @maxLength 500
+     * Card issuer's brand.
+     * @maxLength 100
      */
-    version?: string | null;
+    brand?: string | null;
 }
-/** Rename of the site. Meaning, free public url has been changed as well. */
-interface SiteRenamed {
+interface AuthorizationDetails {
     /**
-     * A new meta site name (URL slug).
-     * @maxLength 20
+     * Whether the authorized payment is of a delayed capture.
+     * @readonly
      */
-    newSiteName?: string;
+    delayedCapture?: boolean;
+    /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
+    authorizedDate?: Date | null;
     /**
-     * A previous meta site name (URL slug).
-     * @maxLength 255
+     * List of captures associated with payment
+     * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
+     * @maxSize 1
      */
-    oldSiteName?: string;
-}
-/**
- * Hard deletion of the meta site.
- *
- * Could not be restored. Therefore it's desirable to cleanup data.
- */
-interface SiteHardDeleted {
-    /** A deletion context. */
-    deleteContext?: DeleteContext;
-}
-interface NamespaceChanged {
-    /** A previous namespace. */
-    oldNamespace?: NamespaceWithLiterals;
-    /** A new namespace. */
-    newNamespace?: NamespaceWithLiterals;
-}
-/** Assigned Studio editor */
-interface StudioAssigned {
-}
-/** Unassigned Studio editor */
-interface StudioUnassigned {
-}
-/**
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
- *
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
- * with sites and its urls, you need to listen to another topic/event. Read about it:
- *
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
- */
-interface SiteUrlChanged {
+    captures?: AuthorizationCapture[];
+    /** Void associated with payment */
+    void?: AuthorizationVoid;
+    /** Scheduled action for this transaction */
+    scheduledAction?: V1ScheduledAction;
 }
-/**
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
- * Consumed by other teams to remove relevant data.
- */
-interface SitePurgedExternally {
+interface AuthorizationCapture {
     /**
-     * @maxLength 2048
-     * @maxSize 100
-     * @deprecated
-     * @targetRemovalDate 2025-04-15
+     * Capture ID.
+     * @format GUID
+     * @readonly
      */
-    appDefId?: string[];
-}
-/** Assigned Odeditor */
-interface OdeditorAssigned {
-}
-/** Unassigned Odeditor */
-interface OdeditorUnassigned {
-}
-/** Assigned Picasso editor */
-interface PicassoAssigned {
-}
-/** Unassigned Picasso */
-interface PicassoUnassigned {
-}
-/** Assigned Wixel */
-interface WixelAssigned {
-}
-/** Unassigned Wixel */
-interface WixelUnassigned {
-}
-/** Assigned StudioTwo */
-interface StudioTwoAssigned {
-}
-/** Unassigned StudioTwo */
-interface StudioTwoUnassigned {
-}
-/** Media from user domain is enabled. */
-interface UserDomainMediaEnabled {
-}
-/** Media from user domain is disabled. */
-interface UserDomainMediaDisabled {
-}
-/** Assigned Editorless */
-interface EditorlessAssigned {
-}
-/** Unassigned Editorless */
-interface EditorlessUnassigned {
+    id?: string | null;
+    /** Status of this capture action */
+    status?: AuthorizationCaptureStatusWithLiterals;
+    /**
+     * Amount of this capture
+     * @immutable
+     */
+    amount?: Price;
+    /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
+    createdDate?: Date | null;
+    /** In case of status is FAILED may contain failure details */
+    failureDetails?: AuthorizationActionFailureDetails;
 }
-interface HasCustomEmailConfigurationsRequest {
+declare enum AuthorizationCaptureStatus {
+    /** Capture operation still in progress. */
+    PENDING = "PENDING",
+    /** Capture operation succeeded. */
+    SUCCEEDED = "SUCCEEDED",
+    /** Capture operation failed. */
+    FAILED = "FAILED"
 }
-interface HasCustomEmailConfigurationsResponse {
-    hasCustomConfigurations?: boolean;
+/** @enumType */
+type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
+interface AuthorizationActionFailureDetails {
+    /** @maxLength 100 */
+    failureCode?: string;
 }
-interface AddToAutomationMigrationPopulationRequest {
-    /** When true, sends custom email configurations to automation system via email */
-    sendCustomEmailConfigs?: boolean;
-    /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
-    origin?: OriginWithLiterals;
+interface AuthorizationVoid {
+    /** Status of this void action */
+    status?: AuthorizationVoidStatusWithLiterals;
+    /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
+    voidedDate?: Date | null;
+    /** In case of status is FAILED may contain failure details */
+    failureDetails?: AuthorizationActionFailureDetails;
+    /** Reason of void action */
+    reason?: ReasonWithLiterals;
 }
-declare enum Origin {
-    OPT_IN = "OPT_IN",
-    MIGRATION = "MIGRATION"
+declare enum AuthorizationVoidStatus {
+    /** Void operation still in progress. */
+    PENDING = "PENDING",
+    /** Void operation succeeded. */
+    SUCCEEDED = "SUCCEEDED",
+    /** Void operation failed. */
+    FAILED = "FAILED"
 }
 /** @enumType */
-type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
-interface AddToAutomationMigrationPopulationResponse {
-    success?: boolean;
+type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
+/** Reason the authorization was voided. */
+declare enum Reason {
+    /** Authorization was voided by user. */
+    MANUAL = "MANUAL",
+    /** Authorization passed execution date. */
+    SCHEDULED = "SCHEDULED"
 }
-interface IsInAutomationMigrationPopulationRequest {
+/** @enumType */
+type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
+interface V1ScheduledAction {
+    /** Type of the action. */
+    actionType?: ActionTypeWithLiterals;
+    /** The date and time of the action. */
+    executionDate?: Date | null;
 }
-interface IsInAutomationMigrationPopulationResponse {
-    inPopulation?: boolean;
+declare enum ActionType {
+    VOID = "VOID",
+    CAPTURE = "CAPTURE"
 }
-interface PreparePaymentCollectionRequest {
-    /**
-     * Ecom order ID.
-     * @minLength 1
-     * @maxLength 100
-     */
-    ecomOrderId: string;
-    /** Amount to collect */
-    amount: Price;
+/** @enumType */
+type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
+interface Chargeback {
     /**
-     * Optional parameter. When present, payment collection will be performed using given payment gateway order.
-     * Existing payment gateway order will be updated with a new amount.
-     * When parameter is absent, new payment gateway order will be created and used for payment collection.
+     * Chargeback ID.
+     * @format GUID
+     * @readonly
+     * @immutable
      */
-    paymentGatewayOrderId?: string | null;
+    id?: string;
     /**
-     * Whether to delay capture of the payment.
-     * Default: false
-     * @deprecated Whether to delay capture of the payment.
-     * Default: false
-     * @replacedBy delayed_capture_settings.scheduled_action
-     * @targetRemovalDate 2024-09-30
+     * 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.
+     * @readonly
+     * @immutable
      */
-    delayedCapture?: boolean;
-    /** Delayed capture payment settings */
-    delayedCaptureSettings?: DelayedCaptureSettings;
-}
-interface RedirectUrls {
+    createdDate?: Date | null;
     /**
-     * URL to redirect buyer in case of approved (successful) transaction
-     * @format WEB_URL
+     * 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.
+     * @readonly
      */
-    successUrl?: string | null;
+    updatedDate?: Date | null;
     /**
-     * URL to redirect buyer in case of buyer canceled the transaction
-     * @format WEB_URL
+     * Amount.
+     * @readonly
+     * @immutable
      */
-    cancelUrl?: string | null;
+    amount?: Price;
     /**
-     * URL to redirect buyer in case of failed/rejected transaction
-     * @format WEB_URL
+     * Reversal amount. Present only when status is REVERSED.
+     * @readonly
      */
-    errorUrl?: string | null;
+    reversalAmount?: Price;
     /**
-     * URL to redirect buyer in case of pending transaction (that might take some time to process)
-     * @format WEB_URL
+     * Status.
+     *
+     * Default: `"APPROVED"`.
      */
-    pendingUrl?: string | null;
-}
-interface DelayedCaptureSettings {
-    /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
-    scheduledAction?: ScheduledActionWithLiterals;
-    /** Delay duration before execution. Optional - if not set, providers default period will be used */
-    delayDuration?: Duration;
-}
-declare enum ScheduledAction {
-    /** Whether payment will be auto-voided when duration passes */
-    VOID = "VOID",
-    /** Whether payment will be auto-captured when duration passes */
-    CAPTURE = "CAPTURE"
-}
-/** @enumType */
-type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
-interface Duration {
+    status?: ChargebackStatusWithLiterals;
     /**
-     * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
-     * @min 1
+     * External chargeback ID.
+     * @format GUID
+     * @readonly
+     * @immutable
      */
-    count?: number;
-    /** Duration unit: MINUTES, HOURS and DAYS */
-    unit?: DurationUnitWithLiterals;
+    externalId?: string | null;
 }
-declare enum DurationUnit {
-    MINUTES = "MINUTES",
-    HOURS = "HOURS",
-    DAYS = "DAYS"
+declare enum ChargebackStatus {
+    /** Chargeback was approved. */
+    APPROVED = "APPROVED",
+    /** Chargeback was reversed. */
+    REVERSED = "REVERSED"
 }
 /** @enumType */
-type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
-interface PreparePaymentCollectionResponse {
-    /** Payment gateway order id which is associated with given payment */
-    paymentGatewayOrderId?: string;
-}
-interface GetPaymentCollectabilityStatusRequest {
+type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
+interface PaymentMethodName {
     /**
-     * Ecom order ID.
-     * @minLength 1
+     * Translated payment method name in buyer language.
      * @maxLength 100
      */
-    ecomOrderId: string;
-}
-interface GetPaymentCollectabilityStatusResponse {
-    /** Payment collectability status */
-    status?: PaymentCollectabilityStatusWithLiterals;
-    /** Collectable order amount */
-    amount?: Price;
-}
-declare enum PaymentCollectabilityStatus {
-    UNKNOWN = "UNKNOWN",
-    COLLECTABLE = "COLLECTABLE",
-    NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
-    NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
-    NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
-    NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
-    NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
-    NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
-    NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
-    NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
-    NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION"
-}
-/** @enumType */
-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';
-interface RecordManuallyCollectedPaymentRequest {
+    buyerLanguageName?: string | null;
     /**
-     * Order ID.
-     * @minLength 1
+     * Translated payment method name in site owner language.
      * @maxLength 100
      */
-    orderId: string;
-    /** Amount to be recorded as approved manual payment for given order */
-    amount: Price;
-}
-/**
- * User-defined payment method name.
- * Allows specifying either a predefined type or a custom name.
- */
-interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
-    /** Predefined payment method. */
-    predefined?: PredefinedPaymentMethodWithLiterals;
+    siteLanguageName?: string | null;
     /**
-     * Custom payment method name provided by user.
+     * User-provided payment method name.
      *
-     * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
-     * @minLength 1
-     * @maxLength 100
+     * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
      */
-    custom?: string | null;
+    userDefinedName?: UserDefinedPaymentMethodName;
 }
-/** @oneof */
-interface UserDefinedPaymentMethodNameKindOneOf {
-    /** Predefined payment method. */
-    predefined?: PredefinedPaymentMethodWithLiterals;
+interface GiftCardPaymentDetails {
     /**
-     * Custom payment method name provided by user.
-     *
-     * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
+     * Gift card payment ID.
      * @minLength 1
      * @maxLength 100
      */
-    custom?: string | null;
-}
-/** Predefined payment method types for offline/manual payments. */
-declare enum PredefinedPaymentMethod {
-    /** Cash payment. */
-    CASH = "CASH",
-    /** Bank transfer. */
-    BANK_TRANSFER = "BANK_TRANSFER",
-    /** Payment by check. */
-    CHECK = "CHECK"
-}
-/** @enumType */
-type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
-interface RecordManuallyCollectedPaymentResponse {
-}
-interface MarkOrderAsPaidRequest {
+    giftCardPaymentId?: string;
     /**
-     * Ecom order ID.
-     * @minLength 1
-     * @maxLength 100
+     * ID of the app that created the gift card.
+     * @format GUID
      */
-    ecomOrderId: string;
-}
-interface MarkOrderAsPaidResponse {
-    /** Updated order. */
-    order?: Order;
-}
-interface BulkMarkOrdersAsPaidRequest {
+    appId?: string;
     /**
-     * IDs of orders to mark as paid.
-     * @minSize 1
-     * @maxSize 100
-     * @minLength 1
-     * @maxLength 100
+     * Whether the gift card is voided.
+     * @readonly
      */
-    ecomOrderIds: string[];
+    voided?: boolean;
 }
-interface BulkMarkOrdersAsPaidResponse {
+interface MembershipPaymentDetails {
     /**
-     * Items updated by the bulk action.
-     * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
+     * Membership ID.
+     * @minLength 1
+     * @maxLength 100
      */
-    results?: BulkOrderResult[];
-    /** Bulk action metadata. */
-    bulkActionMetadata?: BulkActionMetadata;
-}
-interface BulkOrderResult {
-    /** Item metadata. */
-    itemMetadata?: ItemMetadata;
+    membershipId?: string;
     /**
-     * Updated order.
-     *
-     * Returned when `returnFullEntity = true`.
+     * ID of the line item this membership applies to.
+     * @minLength 1
+     * @maxLength 100
      */
-    item?: Order;
-}
-interface ItemMetadata {
-    /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
-    id?: string | null;
-    /** Index of the item within the request array. Allows for correlation between request and response items. */
-    originalIndex?: number;
-    /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
-    success?: boolean;
-    /** Details about the error in case of failure. */
-    error?: ApplicationError;
-}
-interface ApplicationError {
-    /** Error code. */
-    code?: string;
-    /** Description of the error. */
-    description?: string;
-    /** Data related to the error. */
-    data?: Record<string, any> | null;
-}
-interface BulkActionMetadata {
-    /** Number of items that were successfully processed. */
-    totalSuccesses?: number;
-    /** Number of items that couldn't be processed. */
-    totalFailures?: number;
-    /** Number of failures without details because detailed failure threshold was exceeded. */
-    undetailedFailures?: number;
-}
-interface GetRefundabilityStatusRequest {
+    lineItemId?: string;
+    /** Payment status. */
+    status?: MembershipPaymentStatusWithLiterals;
+    /** Membership name. */
+    name?: MembershipName;
     /**
-     * Order ID.
+     * The transaction ID in the membership system. Can be used to void the transaction.
      * @minLength 1
      * @maxLength 100
-     */
-    ecomOrderId: string;
-}
-interface GetRefundabilityStatusResponse {
+     */
+    externalTransactionId?: string | null;
     /**
-     * Refundability details.
-     * @maxSize 300
+     * Whether the membership is voided.
+     * @readonly
      */
-    refundabilities?: Refundability[];
+    voided?: boolean;
     /**
-     * Whether the order supports refunding per item.
-     * @deprecated
+     * ID of the application providing this payment option.
+     * @format GUID
      */
-    refundablePerItem?: boolean;
-}
-interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
-    /** Reason why payment is not refundable. */
-    nonRefundableReason?: NonRefundableReasonWithLiterals;
-    /** Reason why payment is only refundable manually. */
-    manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
-    /** Payment ID. */
-    paymentId?: string;
-    /** Payment refundability status. */
-    refundabilityStatus?: RefundableStatusWithLiterals;
-    /** Link to payment provider dashboard. */
-    providerLink?: string | null;
-}
-/** @oneof */
-interface RefundabilityAdditionalRefundabilityInfoOneOf {
-    /** Reason why payment is not refundable. */
-    nonRefundableReason?: NonRefundableReasonWithLiterals;
-    /** Reason why payment is only refundable manually. */
-    manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
-}
-declare enum RefundableStatus {
-    NOT_REFUNDABLE = "NOT_REFUNDABLE",
-    MANUAL = "MANUAL",
-    REFUNDABLE = "REFUNDABLE"
-}
-/** @enumType */
-type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
-declare enum NonRefundableReason {
-    NONE = "NONE",
-    ALREADY_REFUNDED = "ALREADY_REFUNDED",
-    PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
-    INTERNAL_ERROR = "INTERNAL_ERROR",
-    NOT_PAID = "NOT_PAID",
-    ACCESS_DENIED = "ACCESS_DENIED",
-    ZERO_PRICE = "ZERO_PRICE",
-    DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
-    PENDING_REFUND = "PENDING_REFUND",
-    FORBIDDEN = "FORBIDDEN",
-    TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
-    ORDER_IS_PENDING = "ORDER_IS_PENDING",
-    ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
+    providerAppId?: string;
 }
-/** @enumType */
-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';
-declare enum ManuallyRefundableReason {
-    EXPIRED = "EXPIRED",
-    NOT_SUPPORTED = "NOT_SUPPORTED",
-    OFFLINE = "OFFLINE",
-    REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
+declare enum MembershipPaymentStatus {
+    /** Payment was charged. */
+    CHARGED = "CHARGED",
+    /** The attempt to charge the payment failed, for example, due to lack of credits. */
+    CHARGE_FAILED = "CHARGE_FAILED",
+    /** Payment is pending. */
+    CHARGE_PENDING = "CHARGE_PENDING",
+    /** Payment was voided. */
+    VOIDED = "VOIDED"
 }
 /** @enumType */
-type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
-interface CreatePaymentGatewayOrderRequest {
+type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
+interface WixReceiptInfo {
     /**
-     * Ecom order ID.
+     * Receipt ID
+     * @format GUID
+     */
+    receiptId?: string;
+    /**
+     * Display number of receipt
      * @minLength 1
-     * @maxLength 100
+     * @maxLength 40
      */
-    ecomOrderId: string;
-    /** Information about the user who initiated the payment. */
-    chargedBy?: ChargedBy;
+    displayNumber?: string | null;
 }
-interface ChargedBy {
+interface ExternalReceiptInfo {
     /**
-     * ID - id of the user who initiated the payment
+     * External receipt ID
+     * @maxLength 100
+     */
+    receiptId?: string | null;
+    /**
+     * ID of the app providing the receipt
      * @format GUID
      */
-    id?: string;
+    appId?: string | null;
     /**
-     * Full name - name of the user who initiated the payment
+     * Display number of receipt
      * @minLength 1
-     * @maxLength 200
+     * @maxLength 40
      */
-    fullName?: string | null;
+    displayNumber?: string | null;
 }
-interface CreatePaymentGatewayOrderResponse {
-    /** ID of the order created in the payment gateway */
-    paymentGatewayOrderId?: string;
+interface CashRoundingDetails {
 }
-interface ChargeMembershipsRequest {
+declare enum PaymentStatus {
+    APPROVED = "APPROVED",
+    PENDING = "PENDING",
+    PENDING_MERCHANT = "PENDING_MERCHANT",
+    CANCELED = "CANCELED",
+    DECLINED = "DECLINED",
+    REFUNDED = "REFUNDED",
+    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
+    AUTHORIZED = "AUTHORIZED",
+    VOIDED = "VOIDED"
+}
+/** @enumType */
+type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
+interface Refund {
     /**
-     * Order ID.
-     * @minLength 1
-     * @maxLength 100
+     * Refund ID.
+     * @format GUID
+     * @readonly
      */
-    ecomOrderId: string;
+    id?: string;
     /**
-     * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
-     * but a user which is using the membership on behalf of the a member
-     * @format GUID
+     * List of transactions.
+     * @maxSize 50
      */
-    memberId: string;
+    transactions?: RefundTransaction[];
+    /** Refund business details. */
+    details?: RefundDetails;
     /**
-     * List of items to be paid by memberships
-     * @minSize 1
-     * @maxSize 300
+     * 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.
+     * @readonly
+     * @immutable
      */
-    membershipCharges?: MembershipChargeItem[];
-}
-interface MembershipChargeItem {
+    createdDate?: Date | null;
     /**
-     * The id of used membership
-     * @minLength 1
-     * @maxLength 100
+     * Aggregated refund summary.
+     * @readonly
      */
-    membershipId?: string;
+    summary?: AggregatedRefundSummary;
     /**
-     * ID of the application providing this payment option
+     * ID of the app that initiated this refund.
      * @format GUID
+     * @readonly
+     * @immutable
      */
-    appId?: string;
-    /** The name of used membership */
-    membershipName?: MembershipName;
-    /** Additional data about this membership */
-    membershipAdditionalData?: Record<string, any> | null;
-    /** Catalog and item reference info. */
-    catalogReference?: CatalogReference;
-    /** Properties of the service. When relevant, contains information such as date and number of participants. */
-    serviceProperties?: ServiceProperties;
+    requestingServiceAppId?: string | null;
+}
+interface RefundTransaction {
     /**
-     * Usually would be the same as catalogReference.catalogItemId
-     * For cases when these are not the same, this field would return the actual id of the item in the catalog
-     * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
-     * @minLength 1
-     * @maxLength 36
+     * ID of the payment associated with this refund.
+     * @format GUID
+     * @immutable
      */
-    rootCatalogItemId?: string | null;
+    paymentId?: string;
     /**
-     * line item id of Checkout/Order line item
-     * @minLength 1
-     * @maxLength 100
+     * Refund amount.
+     * @immutable
      */
-    lineItemId?: string;
+    amount?: Price;
+    /** Refund status. */
+    refundStatus?: RefundStatusWithLiterals;
+    /** Optional details of current refund status. */
+    refundStatusInfo?: RefundStatusInfo;
+    /**
+     * Payment gateway's refund ID.
+     * This field is only returned when the value of `external_refund` is `false`.
+     * @format GUID
+     */
+    gatewayRefundId?: string | null;
+    /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
+    providerRefundId?: string | null;
+    /**
+     * Whether refund was made externally and manually on the payment provider's side.
+     * @immutable
+     */
+    externalRefund?: boolean;
 }
-interface MembershipName {
+/** Refund transaction status. */
+declare enum RefundStatus {
+    /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
+    PENDING = "PENDING",
+    /** Refund transaction succeeded. */
+    SUCCEEDED = "SUCCEEDED",
+    /** Refund transaction failed. */
+    FAILED = "FAILED",
+    /** Refund request acknowledged, and will be executed soon. */
+    SCHEDULED = "SCHEDULED",
+    /** Refund was initiated on payment provider side. */
+    STARTED = "STARTED"
+}
+/** @enumType */
+type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
+interface RefundStatusInfo {
     /**
-     * Membership name.
-     * @maxLength 100
+     * Reason code for the refund's current status.
+     *
+     * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
+     * @minLength 1
+     * @maxLength 10
      */
-    original?: string;
+    paymentGatewayReasonCode?: string | null;
     /**
-     * Translated membership name. Defaults to `original` when not provided.
-     * @maxLength 100
+     * Free text explanation of current refund status.
+     * @minLength 1
+     * @maxLength 1000
      */
-    translated?: string | null;
+    description?: string | null;
 }
-interface ServiceProperties {
+interface AggregatedRefundSummary {
+    /** Total amount requested for refund. */
+    requestedRefund?: Price;
+    /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
+    pendingRefund?: Price;
+    /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
+    refunded?: Price;
+    /** Failed refund amount - the portion of `requestedRefund` that failed. */
+    failedRefundAmount?: Price;
+    /** Whether at least one refund transaction is still in `"PENDING"` status. */
+    pending?: boolean;
+    /** Breakdown of refunded items. Available only after refund is complete. */
+    breakdown?: RefundItemsBreakdown;
+}
+interface RefundItemsBreakdown {
     /**
-     * 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.
-     * For example, the start time of a class.
+     * Refunded line items and the amount refunded for each.
+     * @maxSize 300
      */
-    scheduledDate?: Date | null;
+    lineItems?: LineItemRefundSummary[];
+}
+interface LineItemRefundSummary {
     /**
-     * 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.
-     * @min 1
-     * @max 10000
+     * ID of the refunded line item.
+     * @format GUID
      */
-    numberOfParticipants?: number | null;
-}
-interface ChargeMembershipsResponse {
+    lineItemId?: string;
+    /** Total refunded amount for the line item. */
+    totalRefundedAmount?: Price;
 }
-interface TriggerRefundRequest {
+interface CalculateRefundRequest {
     /**
-     * The order this refund related to
+     * Order ID
      * @minLength 1
      * @maxLength 100
      */
-    ecomOrderId: string;
+    ecomOrderId?: string;
     /**
-     * Refund operations information
-     * @minSize 1
-     * @maxSize 1
+     * Refunded line items and quantity
+     * @maxSize 300
      */
-    payments: PaymentRefund[];
-    /** Business model of a refund */
-    details?: RefundDetails;
-    /** Side effect details related to refund */
-    sideEffects?: RefundSideEffects;
+    refundItems?: CalculateRefundItemRequest[];
+    /** Should include shipping in refund calculation */
+    refundShipping?: boolean;
 }
-interface PaymentRefund {
+interface CalculateRefundItemRequest {
     /**
-     * Specific payment within the order to refund
+     * ID of the line item being refunded
      * @format GUID
      */
-    paymentId?: string;
-    /** Refund amount. Not relevant for membership and gift card refunds. */
-    amount?: Price;
+    id?: string;
     /**
-     * Whether refund is made externally and manually (on the payment provider's side)
-     * 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.
-     * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
+     * How much of that line item is being refunded
+     * @min 1
+     * @max 100000
      */
-    externalRefund?: boolean;
+    quantity?: number;
 }
-interface RefundSideEffects {
-    /** Inventory restock details as part of this refund. */
-    restockInfo?: RestockInfo;
-    /** Whether to send a refund confirmation email to the customer. */
-    sendOrderRefundedEmail?: boolean;
+interface CalculateRefundResponse {
+    /** Total refundable amount */
+    total?: Price;
+    /** Tax cost of the order */
+    tax?: Price;
+    /** Discount given for this order */
+    discount?: Price;
+    /** Total cost of the order (without tax) */
+    subtotal?: Price;
+    /** Total shipping cost for order */
+    shipping?: Price;
+    /** Previous refund given on that order */
+    previouslyRefundedAmount?: Price;
     /**
-     * Custom message added to the refund confirmation email.
-     * @minLength 1
-     * @maxLength 1000
+     * The refundable items of that order
+     * @maxSize 300
      */
-    customMessage?: string | null;
+    items?: CalculateRefundItemResponse[];
 }
-interface RestockInfo {
-    /** Restock type. */
-    type?: RestockTypeWithLiterals;
+interface CalculateRefundItemResponse {
     /**
-     * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
-     * @maxSize 300
+     * Line item ID
+     * @format GUID
      */
-    items?: RestockItem[];
-}
-declare enum RestockType {
-    NO_ITEMS = "NO_ITEMS",
-    ALL_ITEMS = "ALL_ITEMS",
-    SOME_ITEMS = "SOME_ITEMS"
+    id?: string;
+    /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
+    price?: Price;
 }
-/** @enumType */
-type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
-interface RestockItem {
+interface VoidAuthorizedPaymentsRequest {
     /**
-     * ID of the line item being restocked.
-     * @format GUID
+     * Wix eCommerce order ID
+     * @minLength 1
+     * @maxLength 100
      */
-    lineItemId?: string;
+    ecomOrderId: string;
     /**
-     * Line item quantity being restocked.
-     * @min 1
-     * @max 100000
+     * Payment IDs
+     * @minSize 1
+     * @maxSize 100
+     * @format GUID
      */
-    quantity?: number;
+    paymentIds: string[];
 }
-interface TriggerRefundResponse {
-    /** All order's transactions after the refunds were added */
+interface VoidAuthorizedPaymentsResponse {
+    /** All order's transactions after the void was triggered */
     orderTransactions?: OrderTransactions;
-    /** Created refund ID */
-    refundId?: string | null;
-    /** Payment ID's that the refund execution had failed for */
-    failedPaymentIds?: ItemMetadata[];
 }
-/**
- * A record of all payments and refunds associated with an order.
- *
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
- */
-interface OrderTransactions {
+interface CaptureAuthorizedPaymentsRequest {
     /**
-     * Order ID.
-     * @format GUID
+     * Wix eCommerce order ID
+     * @minLength 1
+     * @maxLength 100
      */
-    orderId?: string;
+    ecomOrderId: string;
     /**
-     * Record of payments made to the merchant.
+     * Capture payments information
+     * @minSize 1
      * @maxSize 100
      */
-    payments?: Payment[];
-    /**
-     * Record of refunds made to the buyer.
-     * @maxSize 300
-     */
-    refunds?: Refund[];
+    payments: PaymentCapture[];
 }
-interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf {
-    /** Regular payment details. */
-    regularPaymentDetails?: RegularPaymentDetails;
-    /** Gift card payment details. */
-    giftcardPaymentDetails?: GiftCardPaymentDetails;
+interface PaymentCapture {
     /**
-     * Payment ID.
+     * Payment ID
      * @format GUID
-     * @readonly
      */
-    id?: string | null;
-    /** 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. */
-    createdDate?: Date | null;
+    paymentId?: string | null;
     /**
-     * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
-     * @readonly
+     * Capture amount.
+     * If not provided - full authorized amount will be captured.
      */
-    updatedDate?: Date | null;
-    /** Payment amount. */
     amount?: Price;
-    /**
-     * Whether refunds for this payment are disabled.
-     * + `true`: This payment is not refundable.
-     * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
-     */
-    refundDisabled?: boolean;
-}
-/** @oneof */
-interface PaymentPaymentDetailsOneOf {
-    /** Regular payment details. */
-    regularPaymentDetails?: RegularPaymentDetails;
-    /** Gift card payment details. */
-    giftcardPaymentDetails?: GiftCardPaymentDetails;
 }
-/** @oneof */
-interface PaymentReceiptInfoOneOf {
+interface CaptureAuthorizedPaymentsResponse {
+    /** All order's transactions after the capture was triggered */
+    orderTransactions?: OrderTransactions;
 }
-interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
-    /** Credit card details. */
-    creditCardDetails?: CreditCardPaymentMethodDetails;
-    /**
-     * Wix Payments order ID.
-     * @maxLength 100
-     */
-    paymentOrderId?: string | null;
+interface ChargeSavedPaymentMethodRequest {
     /**
-     * Payment gateway's transaction ID.
-     * This field is only returned when the value of `offline_payment` is `false`.
+     * Ecom Order ID.
+     * @minLength 1
      * @maxLength 100
      */
-    gatewayTransactionId?: string | null;
+    ecomOrderId?: string;
+    /** Amount to be charged */
+    amount?: Price;
+}
+interface ChargeSavedPaymentMethodResponse {
+    /** Payment gateway's order ID (e.g Wix Payments) */
+    paymentGatewayOrderId?: string;
+}
+interface SendBuyerConfirmationEmailRequest {
+    /** @format GUID */
+    orderId?: string;
+}
+interface SendBuyerConfirmationEmailResponse {
+}
+interface SendBuyerPaymentsReceivedEmailRequest {
     /**
-     * Payment method.
-     * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
-     * Non-exhaustive list of supported values:
-     * + `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`
+     * @minLength 1
      * @maxLength 100
-     * @deprecated Payment method.
-     * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
-     * Non-exhaustive list of supported values:
-     * + `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`
-     * @replacedBy payment_method_name
-     * @targetRemovalDate 2026-07-01
      */
-    paymentMethod?: string | null;
+    orderId?: string;
+}
+interface SendBuyerPaymentsReceivedEmailResponse {
+}
+interface SendBuyerPickupConfirmationEmailRequest {
     /**
-     * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
+     * @minLength 1
      * @maxLength 100
      */
-    providerTransactionId?: string | null;
-    /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
-    offlinePayment?: boolean;
-    /** Payment status. */
-    status?: TransactionStatusWithLiterals;
+    orderId?: string;
+}
+interface SendBuyerPickupConfirmationEmailResponse {
+}
+interface BulkSendBuyerPickupConfirmationEmailsRequest {
     /**
-     * Whether there is a payment agreement that allows for future charges.
-     * @immutable
+     * IDs of orders to send pickup emails for.
+     * @minSize 1
+     * @maxSize 300
      */
-    savedPaymentMethod?: boolean;
-    /** Authorization details. */
-    authorizationDetails?: AuthorizationDetails;
+    orderIds?: string[];
+}
+interface BulkSendBuyerPickupConfirmationEmailsResponse {
+}
+interface SendBuyerShippingConfirmationEmailRequest {
     /**
-     * Record of chargebacks made by the buyer.
-     * @maxSize 6
+     * @minLength 1
+     * @maxLength 100
      */
-    chargebacks?: Chargeback[];
-    /** Platform fee amount associated with this payment. */
-    platformFee?: Price;
+    orderId?: string;
+}
+interface SendBuyerShippingConfirmationEmailResponse {
+}
+interface BulkSendBuyerShippingConfirmationEmailsRequest {
     /**
-     * Payment method with buyer and optional owner translations.
-     * Non-exhaustive list of supported values:
-     * + `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`
+     * IDs of orders to send pickup emails for.
+     * @minSize 1
+     * @maxSize 300
      */
-    paymentMethodName?: PaymentMethodName;
-}
-/** @oneof */
-interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
-    /** Credit card details. */
-    creditCardDetails?: CreditCardPaymentMethodDetails;
+    orderIds?: string[];
 }
-declare enum TransactionStatus {
-    UNDEFINED = "UNDEFINED",
-    APPROVED = "APPROVED",
-    PENDING = "PENDING",
-    PENDING_MERCHANT = "PENDING_MERCHANT",
-    CANCELED = "CANCELED",
-    DECLINED = "DECLINED",
-    REFUNDED = "REFUNDED",
-    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
-    AUTHORIZED = "AUTHORIZED",
-    VOIDED = "VOIDED"
+interface BulkSendBuyerShippingConfirmationEmailsResponse {
 }
-/** @enumType */
-type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
-interface CreditCardPaymentMethodDetails {
+interface SendMerchantOrderReceivedNotificationRequest {
     /**
-     * The last 4 digits of the card number.
-     * @maxLength 4
+     * @minLength 1
+     * @maxLength 100
      */
-    lastFourDigits?: string | null;
+    orderId?: string;
+}
+interface SendMerchantOrderReceivedNotificationResponse {
+}
+interface SendCancelRefundEmailRequest {
     /**
-     * Card issuer's brand.
+     * The ID of order that is canceled/refunded
+     * @minLength 1
      * @maxLength 100
      */
-    brand?: string | null;
-}
-interface AuthorizationDetails {
+    orderId?: string;
     /**
-     * Whether the authorized payment is of a delayed capture.
-     * @readonly
+     * Personal note added to the email (optional)
+     * @minLength 1
+     * @maxLength 1000
      */
-    delayedCapture?: boolean;
-    /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    authorizedDate?: Date | null;
+    customMessage?: string | null;
+    /** Refund amount */
+    refundAmount?: Price;
     /**
-     * List of captures associated with payment
-     * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
-     * @maxSize 1
+     * Refund ID. (Optional)
+     * @format GUID
      */
-    captures?: AuthorizationCapture[];
-    /** Void associated with payment */
-    void?: AuthorizationVoid;
-    /** Scheduled action for this transaction */
-    scheduledAction?: V1ScheduledAction;
+    refundId?: string | null;
 }
-interface AuthorizationCapture {
+interface SendCancelRefundEmailResponse {
+}
+interface SendRefundEmailRequest {
     /**
-     * Capture ID.
+     * The ID of order that is refunded
      * @format GUID
-     * @readonly
      */
-    id?: string | null;
-    /** Status of this capture action */
-    status?: AuthorizationCaptureStatusWithLiterals;
+    orderId?: string;
     /**
-     * Amount of this capture
-     * @immutable
+     * Refund ID
+     * @format GUID
      */
-    amount?: Price;
-    /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    createdDate?: Date | null;
-    /** In case of status is FAILED may contain failure details */
-    failureDetails?: AuthorizationActionFailureDetails;
+    refundId?: string;
+    /**
+     * Personal note added to the email (optional)
+     * @minLength 1
+     * @maxLength 1000
+     */
+    customMessage?: string | null;
 }
-declare enum AuthorizationCaptureStatus {
-    /** Capture operation still in progress. */
-    PENDING = "PENDING",
-    /** Capture operation succeeded. */
-    SUCCEEDED = "SUCCEEDED",
-    /** Capture operation failed. */
-    FAILED = "FAILED"
+interface SendRefundEmailResponse {
 }
-/** @enumType */
-type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
-interface AuthorizationActionFailureDetails {
-    /** @maxLength 100 */
-    failureCode?: string;
+interface SendFulfillmentEmailRequest {
+    /** @format GUID */
+    orderId?: string;
+    /** @format GUID */
+    fulfillerId?: string;
 }
-interface AuthorizationVoid {
-    /** Status of this void action */
-    status?: AuthorizationVoidStatusWithLiterals;
-    /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
-    voidedDate?: Date | null;
-    /** In case of status is FAILED may contain failure details */
-    failureDetails?: AuthorizationActionFailureDetails;
-    /** Reason of void action */
-    reason?: ReasonWithLiterals;
+interface SendFulfillmentEmailResponse {
 }
-declare enum AuthorizationVoidStatus {
-    /** Void operation still in progress. */
-    PENDING = "PENDING",
-    /** Void operation succeeded. */
-    SUCCEEDED = "SUCCEEDED",
-    /** Void operation failed. */
-    FAILED = "FAILED"
+interface SendMerchantOrderReceivedPushRequest {
+    /**
+     * @minLength 1
+     * @maxLength 100
+     */
+    orderId?: string;
 }
-/** @enumType */
-type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
-/** Reason the authorization was voided. */
-declare enum Reason {
-    /** Authorization was voided by user. */
-    MANUAL = "MANUAL",
-    /** Authorization passed execution date. */
-    SCHEDULED = "SCHEDULED"
+interface SendMerchantOrderReceivedPushResponse {
 }
-/** @enumType */
-type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
-interface V1ScheduledAction {
-    /** Type of the action. */
-    actionType?: ActionTypeWithLiterals;
-    /** The date and time of the action. */
-    executionDate?: Date | null;
+interface PreviewEmailByTypeRequest {
+    emailType?: PreviewEmailTypeWithLiterals;
 }
-declare enum ActionType {
-    VOID = "VOID",
-    CAPTURE = "CAPTURE"
+declare enum PreviewEmailType {
+    ORDER_PLACED = "ORDER_PLACED",
+    DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
+    ORDER_SHIPPED = "ORDER_SHIPPED",
+    ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
 }
 /** @enumType */
-type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
-interface Chargeback {
-    /**
-     * Chargeback ID.
-     * @format GUID
-     * @readonly
-     * @immutable
-     */
-    id?: string;
-    /**
-     * 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.
-     * @readonly
-     * @immutable
-     */
-    createdDate?: Date | null;
-    /**
-     * 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.
-     * @readonly
-     */
-    updatedDate?: Date | null;
-    /**
-     * Amount.
-     * @readonly
-     * @immutable
-     */
-    amount?: Price;
+type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
+interface PreviewEmailByTypeResponse {
+    emailPreview?: string;
+}
+interface PreviewRefundEmailRequest {
     /**
-     * Reversal amount. Present only when status is REVERSED.
-     * @readonly
+     * @minLength 1
+     * @maxLength 100
      */
-    reversalAmount?: Price;
+    orderId?: string;
+    /** Refund amount */
+    refundAmount?: Price;
+    /** Refund business details */
+    details?: RefundDetails;
     /**
-     * Status.
-     *
-     * Default: `"APPROVED"`.
+     * Personal note added to the email (optional)
+     * @minLength 1
+     * @maxLength 1000
      */
-    status?: ChargebackStatusWithLiterals;
+    customMessage?: string | null;
     /**
-     * External chargeback ID.
+     * Refund ID. (Optional)
      * @format GUID
-     * @readonly
-     * @immutable
      */
-    externalId?: string | null;
+    refundId?: string | null;
 }
-declare enum ChargebackStatus {
-    /** Chargeback was approved. */
-    APPROVED = "APPROVED",
-    /** Chargeback was reversed. */
-    REVERSED = "REVERSED"
+interface PreviewRefundEmailResponse {
+    emailPreview?: string;
 }
-/** @enumType */
-type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
-interface PaymentMethodName {
-    /**
-     * Translated payment method name in buyer language.
-     * @maxLength 100
-     */
-    buyerLanguageName?: string | null;
+interface PreviewCancelEmailRequest {
     /**
-     * Translated payment method name in site owner language.
+     * @minLength 1
      * @maxLength 100
      */
-    siteLanguageName?: string | null;
+    orderId?: string;
     /**
-     * User-provided payment method name.
-     *
-     * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
+     * Personal note added to the email (optional)
+     * @minLength 1
+     * @maxLength 1000
      */
-    userDefinedName?: UserDefinedPaymentMethodName;
+    customMessage?: string | null;
 }
-interface GiftCardPaymentDetails {
+interface PreviewCancelEmailResponse {
+    emailPreview?: string;
+}
+interface PreviewCancelRefundEmailRequest {
     /**
-     * Gift card payment ID.
      * @minLength 1
      * @maxLength 100
      */
-    giftCardPaymentId?: string;
+    orderId?: string;
     /**
-     * ID of the app that created the gift card.
-     * @format GUID
+     * Personal note added to the email (optional)
+     * @minLength 1
+     * @maxLength 1000
      */
-    appId?: string;
+    customMessage?: string | null;
+    /** Refund amount */
+    refundAmount?: Price;
     /**
-     * Whether the gift card is voided.
-     * @readonly
+     * Refund ID. (Optional)
+     * @format GUID
      */
-    voided?: boolean;
+    refundId?: string | null;
 }
-interface MembershipPaymentDetails {
+interface PreviewCancelRefundEmailResponse {
+    emailPreview?: string;
+}
+interface PreviewBuyerPaymentsReceivedEmailRequest {
+}
+interface PreviewBuyerPaymentsReceivedEmailResponse {
+    emailPreview?: string;
+}
+interface PreviewBuyerConfirmationEmailRequest {
+}
+interface PreviewBuyerConfirmationEmailResponse {
+    emailPreview?: string;
+}
+interface PreviewBuyerPickupConfirmationEmailRequest {
+}
+interface PreviewBuyerPickupConfirmationEmailResponse {
+    emailPreview?: string;
+}
+interface PreviewShippingConfirmationEmailRequest {
+}
+interface PreviewShippingConfirmationEmailResponse {
+    emailPreview?: string;
+}
+interface PreviewResendDownloadLinksEmailRequest {
+}
+interface PreviewResendDownloadLinksEmailResponse {
+    emailPreview?: string;
+}
+interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
     /**
-     * Membership ID.
-     * @minLength 1
-     * @maxLength 100
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
      */
-    membershipId?: string;
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
+    /** Emitted when Odeditor is attached. */
+    odeditorAssigned?: OdeditorAssigned;
+    /** Emitted when Odeditor is detached. */
+    odeditorUnassigned?: OdeditorUnassigned;
+    /** Emitted when Picasso is attached. */
+    picassoAssigned?: PicassoAssigned;
+    /** Emitted when Picasso is detached. */
+    picassoUnassigned?: PicassoUnassigned;
+    /** Emitted when Wixel is attached. */
+    wixelAssigned?: WixelAssigned;
+    /** Emitted when Wixel is detached. */
+    wixelUnassigned?: WixelUnassigned;
+    /** Emitted when StudioTwo is attached. */
+    studioTwoAssigned?: StudioTwoAssigned;
+    /** Emitted when StudioTwo is detached. */
+    studioTwoUnassigned?: StudioTwoUnassigned;
+    /** Emitted when media from user domain is enabled. */
+    userDomainMediaEnabled?: UserDomainMediaEnabled;
+    /** Emitted when media from user domain is disabled. */
+    userDomainMediaDisabled?: UserDomainMediaDisabled;
+    /** Emitted when Editorless is attached. */
+    editorlessAssigned?: EditorlessAssigned;
+    /** Emitted when Editorless is detached. */
+    editorlessUnassigned?: EditorlessUnassigned;
     /**
-     * ID of the line item this membership applies to.
-     * @minLength 1
-     * @maxLength 100
+     * A meta site id.
+     * @format GUID
      */
-    lineItemId?: string;
-    /** Payment status. */
-    status?: MembershipPaymentStatusWithLiterals;
-    /** Membership name. */
-    name?: MembershipName;
+    metaSiteId?: string;
+    /** A meta site version. Monotonically increasing. */
+    version?: string;
+    /** A timestamp of the event. */
+    timestamp?: string;
     /**
-     * The transaction ID in the membership system. Can be used to void the transaction.
-     * @minLength 1
-     * @maxLength 100
+     * TODO(meta-site): Change validation once validations are disabled for consumers
+     * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
+     * @maxSize 4000
      */
-    externalTransactionId?: string | null;
+    assets?: Asset[];
+}
+/** @oneof */
+interface MetaSiteSpecialEventPayloadOneOf {
+    /** Emitted on a meta site creation. */
+    siteCreated?: SiteCreated;
+    /** Emitted on a meta site transfer completion. */
+    siteTransferred?: SiteTransferred;
+    /** Emitted on a meta site deletion. */
+    siteDeleted?: SiteDeleted;
+    /** Emitted on a meta site restoration. */
+    siteUndeleted?: SiteUndeleted;
+    /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
+    sitePublished?: SitePublished;
+    /** Emitted on a meta site unpublish. */
+    siteUnpublished?: SiteUnpublished;
+    /** Emitted when meta site is marked as template. */
+    siteMarkedAsTemplate?: SiteMarkedAsTemplate;
+    /** Emitted when meta site is marked as a WixSite. */
+    siteMarkedAsWixSite?: SiteMarkedAsWixSite;
+    /** Emitted when an application is provisioned (installed). */
+    serviceProvisioned?: ServiceProvisioned;
+    /** Emitted when an application is removed (uninstalled). */
+    serviceRemoved?: ServiceRemoved;
+    /** Emitted when meta site name (URL slug) is changed. */
+    siteRenamedPayload?: SiteRenamed;
+    /** Emitted when meta site was permanently deleted. */
+    hardDeleted?: SiteHardDeleted;
+    /** Emitted on a namespace change. */
+    namespaceChanged?: NamespaceChanged;
+    /** Emitted when Studio is attached. */
+    studioAssigned?: StudioAssigned;
+    /** Emitted when Studio is detached. */
+    studioUnassigned?: StudioUnassigned;
     /**
-     * Whether the membership is voided.
-     * @readonly
+     * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
+     * the actual URL.
+     *
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
+     * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
      */
-    voided?: boolean;
+    urlChanged?: SiteUrlChanged;
+    /** Site is marked as PurgedExternally */
+    sitePurgedExternally?: SitePurgedExternally;
+    /** Emitted when Odeditor is attached. */
+    odeditorAssigned?: OdeditorAssigned;
+    /** Emitted when Odeditor is detached. */
+    odeditorUnassigned?: OdeditorUnassigned;
+    /** Emitted when Picasso is attached. */
+    picassoAssigned?: PicassoAssigned;
+    /** Emitted when Picasso is detached. */
+    picassoUnassigned?: PicassoUnassigned;
+    /** Emitted when Wixel is attached. */
+    wixelAssigned?: WixelAssigned;
+    /** Emitted when Wixel is detached. */
+    wixelUnassigned?: WixelUnassigned;
+    /** Emitted when StudioTwo is attached. */
+    studioTwoAssigned?: StudioTwoAssigned;
+    /** Emitted when StudioTwo is detached. */
+    studioTwoUnassigned?: StudioTwoUnassigned;
+    /** Emitted when media from user domain is enabled. */
+    userDomainMediaEnabled?: UserDomainMediaEnabled;
+    /** Emitted when media from user domain is disabled. */
+    userDomainMediaDisabled?: UserDomainMediaDisabled;
+    /** Emitted when Editorless is attached. */
+    editorlessAssigned?: EditorlessAssigned;
+    /** Emitted when Editorless is detached. */
+    editorlessUnassigned?: EditorlessUnassigned;
+}
+interface Asset {
     /**
-     * ID of the application providing this payment option.
-     * @format GUID
+     * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
+     * @maxLength 36
      */
-    providerAppId?: string;
+    appDefId?: string;
+    /**
+     * An instance id. For legacy reasons may be UUID or a string.
+     * @maxLength 200
+     */
+    instanceId?: string;
+    /** An application state. */
+    state?: StateWithLiterals;
 }
-declare enum MembershipPaymentStatus {
-    /** Payment was charged. */
-    CHARGED = "CHARGED",
-    /** The attempt to charge the payment failed, for example, due to lack of credits. */
-    CHARGE_FAILED = "CHARGE_FAILED",
-    /** Payment is pending. */
-    CHARGE_PENDING = "CHARGE_PENDING",
-    /** Payment was voided. */
-    VOIDED = "VOIDED"
+declare enum State {
+    UNKNOWN = "UNKNOWN",
+    ENABLED = "ENABLED",
+    DISABLED = "DISABLED",
+    PENDING = "PENDING",
+    DEMO = "DEMO"
 }
 /** @enumType */
-type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
-interface WixReceiptInfo {
-    /**
-     * Receipt ID
-     * @format GUID
-     */
-    receiptId?: string;
+type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
+interface SiteCreated {
     /**
-     * Display number of receipt
-     * @minLength 1
-     * @maxLength 40
+     * A template identifier (empty if not created from a template).
+     * @maxLength 36
      */
-    displayNumber?: string | null;
-}
-interface ExternalReceiptInfo {
+    originTemplateId?: string;
     /**
-     * External receipt ID
-     * @maxLength 100
+     * An account id of the owner.
+     * @format GUID
      */
-    receiptId?: string | null;
+    ownerId?: string;
+    /** A context in which meta site was created. */
+    context?: SiteCreatedContextWithLiterals;
     /**
-     * ID of the app providing the receipt
+     * A meta site id from which this site was created.
+     *
+     * In case of a creation from a template it's a template id.
+     * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
      * @format GUID
      */
-    appId?: string | null;
+    originMetaSiteId?: string | null;
     /**
-     * Display number of receipt
-     * @minLength 1
-     * @maxLength 40
+     * A meta site name (URL slug).
+     * @maxLength 20
      */
-    displayNumber?: string | null;
-}
-interface CashRoundingDetails {
+    siteName?: string;
+    /** A namespace. */
+    namespace?: NamespaceWithLiterals;
 }
-declare enum PaymentStatus {
-    APPROVED = "APPROVED",
-    PENDING = "PENDING",
-    PENDING_MERCHANT = "PENDING_MERCHANT",
-    CANCELED = "CANCELED",
-    DECLINED = "DECLINED",
-    REFUNDED = "REFUNDED",
-    PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
-    AUTHORIZED = "AUTHORIZED",
-    VOIDED = "VOIDED"
+declare enum SiteCreatedContext {
+    /** A valid option, we don't expose all reasons why site might be created. */
+    OTHER = "OTHER",
+    /** A meta site was created from template. */
+    FROM_TEMPLATE = "FROM_TEMPLATE",
+    /** A meta site was created by copying of the transfferred meta site. */
+    DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
+    /** A copy of existing meta site. */
+    DUPLICATE = "DUPLICATE",
+    /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
+    OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
+    /** deprecated A meta site was created for Flash editor. */
+    FLASH = "FLASH"
 }
 /** @enumType */
-type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
-interface Refund {
-    /**
-     * Refund ID.
-     * @format GUID
-     * @readonly
-     */
-    id?: string;
+type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
+declare enum Namespace {
+    UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
+    /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
+    WIX = "WIX",
+    /** 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. */
+    SHOUT_OUT = "SHOUT_OUT",
+    /** 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. */
+    ALBUMS = "ALBUMS",
+    /** 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. */
+    WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
+    /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    HOTELS = "HOTELS",
+    /** 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. */
+    CLUBS = "CLUBS",
+    /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
+    /** AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_SITE = "DEV_SITE",
+    /** 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. */
+    LOGOS = "LOGOS",
+    /** 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. */
+    VIDEO_MAKER = "VIDEO_MAKER",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
+    /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
     /**
-     * List of transactions.
-     * @maxSize 50
+     * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
+     *
+     * Meta site with this namespace will *not* be shown in a user's site list by default.
      */
-    transactions?: RefundTransaction[];
-    /** Refund business details. */
-    details?: RefundDetails;
+    HTML_DRAFT = "HTML_DRAFT",
     /**
-     * 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.
-     * @readonly
-     * @immutable
+     * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
+     * Will be accessible from Site List and will not have a website app.
+     * Once the user attaches a site, the site will become a regular wixsite.
      */
-    createdDate?: Date | null;
+    SITELESS_BUSINESS = "SITELESS_BUSINESS",
+    /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
+    CREATOR_ECONOMY = "CREATOR_ECONOMY",
+    /** It is to be used in the Business First efforts. */
+    DASHBOARD_FIRST = "DASHBOARD_FIRST",
+    /** Bookings business flow with no site. */
+    ANYWHERE = "ANYWHERE",
+    /** Namespace for Headless Backoffice with no editor */
+    HEADLESS = "HEADLESS",
     /**
-     * Aggregated refund summary.
-     * @readonly
+     * Namespace for master site that will exist in parent account that will be referenced by subaccounts
+     * The site will be used for account level CSM feature for enterprise
      */
-    summary?: AggregatedRefundSummary;
+    ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
+    /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
+    RISE = "RISE",
     /**
-     * ID of the app that initiated this refund.
-     * @format GUID
-     * @readonly
-     * @immutable
+     * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
+     * There's a blank site behind the scene but it's blank).
+     * The Mobile company will be the owner of this namespace.
      */
-    requestingServiceAppId?: string | null;
-}
-interface RefundTransaction {
+    BRANDED_FIRST = "BRANDED_FIRST",
+    /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
+    NOWNIA = "NOWNIA",
     /**
-     * ID of the payment associated with this refund.
-     * @format GUID
-     * @immutable
+     * UGC Templates are templates that are created by users for personal use and to sale to other users.
+     * The Partners company owns this namespace.
      */
-    paymentId?: string;
+    UGC_TEMPLATE = "UGC_TEMPLATE",
+    /** Codux Headless Sites */
+    CODUX = "CODUX",
+    /** Bobb - AI Design Creator. */
+    MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
     /**
-     * Refund amount.
-     * @immutable
+     * Shared Blog Site is a unique single site across Enterprise account,
+     * This site will hold all Blog posts related to the Marketing product.
      */
-    amount?: Price;
-    /** Refund status. */
-    refundStatus?: RefundStatusWithLiterals;
-    /** Optional details of current refund status. */
-    refundStatusInfo?: RefundStatusInfo;
+    SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
+    /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_FORMS = "STANDALONE_FORMS",
+    /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
+    STANDALONE_EVENTS = "STANDALONE_EVENTS",
+    /** MIMIR - Siteless account for MIMIR Ai Job runner. */
+    MIMIR = "MIMIR",
+    /** Wix Twins platform. */
+    TWINS = "TWINS",
+    /** Wix Nano. */
+    NANO = "NANO",
+    /** Base44 headless sites. */
+    BASE44 = "BASE44",
+    /** Wix Channels Sites */
+    CHANNELS = "CHANNELS"
+}
+/** @enumType */
+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';
+/** Site transferred to another user. */
+interface SiteTransferred {
     /**
-     * Payment gateway's refund ID.
-     * This field is only returned when the value of `external_refund` is `false`.
+     * A previous owner id (user that transfers meta site).
      * @format GUID
      */
-    gatewayRefundId?: string | null;
-    /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
-    providerRefundId?: string | null;
+    oldOwnerId?: string;
     /**
-     * Whether refund was made externally and manually on the payment provider's side.
-     * @immutable
+     * A new owner id (user that accepts meta site).
+     * @format GUID
      */
-    externalRefund?: boolean;
+    newOwnerId?: string;
 }
-/** Refund transaction status. */
-declare enum RefundStatus {
-    /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
-    PENDING = "PENDING",
-    /** Refund transaction succeeded. */
-    SUCCEEDED = "SUCCEEDED",
-    /** Refund transaction failed. */
-    FAILED = "FAILED",
-    /** Refund request acknowledged, and will be executed soon. */
-    SCHEDULED = "SCHEDULED",
-    /** Refund was initiated on payment provider side. */
-    STARTED = "STARTED"
+/** Soft deletion of the meta site. Could be restored. */
+interface SiteDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
 }
-/** @enumType */
-type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
-interface RefundStatusInfo {
+interface DeleteContext {
+    /** When the meta site was deleted. */
+    dateDeleted?: Date | null;
+    /** A status. */
+    deleteStatus?: DeleteStatusWithLiterals;
     /**
-     * Reason code for the refund's current status.
-     *
-     * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
-     * @minLength 1
-     * @maxLength 10
+     * A reason (flow).
+     * @maxLength 255
      */
-    paymentGatewayReasonCode?: string | null;
+    deleteOrigin?: string;
     /**
-     * Free text explanation of current refund status.
-     * @minLength 1
-     * @maxLength 1000
+     * A service that deleted it.
+     * @maxLength 255
      */
-    description?: string | null;
+    initiatorId?: string | null;
 }
-interface AggregatedRefundSummary {
-    /** Total amount requested for refund. */
-    requestedRefund?: Price;
-    /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
-    pendingRefund?: Price;
-    /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
-    refunded?: Price;
-    /** Failed refund amount - the portion of `requestedRefund` that failed. */
-    failedRefundAmount?: Price;
-    /** Whether at least one refund transaction is still in `"PENDING"` status. */
-    pending?: boolean;
-    /** Breakdown of refunded items. Available only after refund is complete. */
-    breakdown?: RefundItemsBreakdown;
+declare enum DeleteStatus {
+    UNKNOWN = "UNKNOWN",
+    TRASH = "TRASH",
+    DELETED = "DELETED",
+    PENDING_PURGE = "PENDING_PURGE",
+    PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
 }
-interface RefundItemsBreakdown {
-    /**
-     * Refunded line items and the amount refunded for each.
-     * @maxSize 300
-     */
-    lineItems?: LineItemRefundSummary[];
+/** @enumType */
+type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
+/** Restoration of the meta site. */
+interface SiteUndeleted {
 }
-interface LineItemRefundSummary {
-    /**
-     * ID of the refunded line item.
-     * @format GUID
-     */
-    lineItemId?: string;
-    /** Total refunded amount for the line item. */
-    totalRefundedAmount?: Price;
+/** First publish of a meta site. Or subsequent publish after unpublish. */
+interface SitePublished {
 }
-interface CalculateRefundRequest {
+interface SiteUnpublished {
     /**
-     * Order ID
-     * @minLength 1
-     * @maxLength 100
+     * A list of URLs previously associated with the meta site.
+     * @maxLength 4000
+     * @maxSize 10000
      */
-    ecomOrderId?: string;
+    urls?: string[];
+}
+interface SiteMarkedAsTemplate {
+}
+interface SiteMarkedAsWixSite {
+}
+/**
+ * Represents a service provisioned a site.
+ *
+ * Note on `origin_instance_id`:
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
+ * This is because of the following scenario:
+ *
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
+ * such as a product catalog. When you create a site from this template, you inherit this
+ * default product catalog. However, if the template's product catalog is modified,
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
+ * your site remains consistent with what you initially received and does not include any
+ * changes made to the original template afterward.
+ * To ensure this, the TPA on the template gets a new instance_id.
+ */
+interface ServiceProvisioned {
     /**
-     * Refunded line items and quantity
-     * @maxSize 300
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
      */
-    refundItems?: CalculateRefundItemRequest[];
-    /** Should include shipping in refund calculation */
-    refundShipping?: boolean;
-}
-interface CalculateRefundItemRequest {
+    appDefId?: string;
     /**
-     * ID of the line item being refunded
-     * @format GUID
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
      */
-    id?: string;
+    instanceId?: string;
     /**
-     * How much of that line item is being refunded
-     * @min 1
-     * @max 100000
+     * An instance id from which this instance is originated.
+     * @maxLength 36
      */
-    quantity?: number;
-}
-interface CalculateRefundResponse {
-    /** Total refundable amount */
-    total?: Price;
-    /** Tax cost of the order */
-    tax?: Price;
-    /** Discount given for this order */
-    discount?: Price;
-    /** Total cost of the order (without tax) */
-    subtotal?: Price;
-    /** Total shipping cost for order */
-    shipping?: Price;
-    /** Previous refund given on that order */
-    previouslyRefundedAmount?: Price;
+    originInstanceId?: string;
     /**
-     * The refundable items of that order
-     * @maxSize 300
+     * A version.
+     * @maxLength 500
      */
-    items?: CalculateRefundItemResponse[];
-}
-interface CalculateRefundItemResponse {
+    version?: string | null;
     /**
-     * Line item ID
+     * The origin meta site id
      * @format GUID
      */
-    id?: string;
-    /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
-    price?: Price;
+    originMetaSiteId?: string | null;
 }
-interface VoidAuthorizedPaymentsRequest {
-    /**
-     * Wix eCommerce order ID
-     * @minLength 1
-     * @maxLength 100
-     */
-    ecomOrderId: string;
+interface ServiceRemoved {
     /**
-     * Payment IDs
-     * @minSize 1
-     * @maxSize 100
-     * @format GUID
+     * Either UUID or EmbeddedServiceType.
+     * @maxLength 36
      */
-    paymentIds: string[];
-}
-interface VoidAuthorizedPaymentsResponse {
-    /** All order's transactions after the void was triggered */
-    orderTransactions?: OrderTransactions;
-}
-interface CaptureAuthorizedPaymentsRequest {
+    appDefId?: string;
     /**
-     * Wix eCommerce order ID
-     * @minLength 1
-     * @maxLength 100
+     * Not only UUID. Something here could be something weird.
+     * @maxLength 36
      */
-    ecomOrderId: string;
+    instanceId?: string;
     /**
-     * Capture payments information
-     * @minSize 1
-     * @maxSize 100
+     * A version.
+     * @maxLength 500
      */
-    payments: PaymentCapture[];
+    version?: string | null;
 }
-interface PaymentCapture {
+/** Rename of the site. Meaning, free public url has been changed as well. */
+interface SiteRenamed {
     /**
-     * Payment ID
-     * @format GUID
+     * A new meta site name (URL slug).
+     * @maxLength 20
      */
-    paymentId?: string | null;
+    newSiteName?: string;
     /**
-     * Capture amount.
-     * If not provided - full authorized amount will be captured.
+     * A previous meta site name (URL slug).
+     * @maxLength 255
      */
-    amount?: Price;
+    oldSiteName?: string;
 }
-interface CaptureAuthorizedPaymentsResponse {
-    /** All order's transactions after the capture was triggered */
-    orderTransactions?: OrderTransactions;
+/**
+ * Hard deletion of the meta site.
+ *
+ * Could not be restored. Therefore it's desirable to cleanup data.
+ */
+interface SiteHardDeleted {
+    /** A deletion context. */
+    deleteContext?: DeleteContext;
 }
-interface ChargeSavedPaymentMethodRequest {
+interface NamespaceChanged {
+    /** A previous namespace. */
+    oldNamespace?: NamespaceWithLiterals;
+    /** A new namespace. */
+    newNamespace?: NamespaceWithLiterals;
+}
+/** Assigned Studio editor */
+interface StudioAssigned {
+}
+/** Unassigned Studio editor */
+interface StudioUnassigned {
+}
+/**
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
+ *
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
+ *
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
+ */
+interface SiteUrlChanged {
+}
+/**
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
+ * Consumed by other teams to remove relevant data.
+ */
+interface SitePurgedExternally {
     /**
-     * Ecom Order ID.
-     * @minLength 1
-     * @maxLength 100
+     * @maxLength 2048
+     * @maxSize 100
+     * @deprecated
+     * @targetRemovalDate 2025-04-15
      */
-    ecomOrderId?: string;
-    /** Amount to be charged */
-    amount?: Price;
+    appDefId?: string[];
 }
-interface ChargeSavedPaymentMethodResponse {
-    /** Payment gateway's order ID (e.g Wix Payments) */
-    paymentGatewayOrderId?: string;
+/** Assigned Odeditor */
+interface OdeditorAssigned {
+}
+/** Unassigned Odeditor */
+interface OdeditorUnassigned {
+}
+/** Assigned Picasso editor */
+interface PicassoAssigned {
+}
+/** Unassigned Picasso */
+interface PicassoUnassigned {
+}
+/** Assigned Wixel */
+interface WixelAssigned {
+}
+/** Unassigned Wixel */
+interface WixelUnassigned {
+}
+/** Assigned StudioTwo */
+interface StudioTwoAssigned {
+}
+/** Unassigned StudioTwo */
+interface StudioTwoUnassigned {
+}
+/** Media from user domain is enabled. */
+interface UserDomainMediaEnabled {
+}
+/** Media from user domain is disabled. */
+interface UserDomainMediaDisabled {
+}
+/** Assigned Editorless */
+interface EditorlessAssigned {
+}
+/** Unassigned Editorless */
+interface EditorlessUnassigned {
+}
+interface HasCustomEmailConfigurationsRequest {
+}
+interface HasCustomEmailConfigurationsResponse {
+    hasCustomConfigurations?: boolean;
+}
+interface AddToAutomationMigrationPopulationRequest {
+    /** When true, sends custom email configurations to automation system via email */
+    sendCustomEmailConfigs?: boolean;
+    /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
+    origin?: OriginWithLiterals;
+}
+declare enum Origin {
+    OPT_IN = "OPT_IN",
+    MIGRATION = "MIGRATION"
+}
+/** @enumType */
+type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
+interface AddToAutomationMigrationPopulationResponse {
+    success?: boolean;
+}
+interface IsInAutomationMigrationPopulationRequest {
+}
+interface IsInAutomationMigrationPopulationResponse {
+    inPopulation?: boolean;
 }
 interface DiffmatokyPayload {
     left?: string;