@wix/auto_sdk_ecom_orders 1.0.274 → 1.0.275

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