@wix/auto_sdk_ecom_orders 1.0.315 → 1.0.317

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-DXcKuMZ8.d.ts → ecom-v1-order-orders.universal-C1f2gjpe.d.ts} +1686 -1686
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +82 -80
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +82 -80
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1686 -1686
  9. package/build/cjs/meta.js +82 -80
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-DXcKuMZ8.d.mts → ecom-v1-order-orders.universal-C1f2gjpe.d.mts} +1686 -1686
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +82 -80
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +82 -80
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1686 -1686
  19. package/build/es/meta.mjs +82 -80
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-Cc6i2pkz.d.ts → ecom-v1-order-orders.universal-CQe1Ioz_.d.ts} +1825 -1813
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1825 -1813
  25. package/build/internal/es/{ecom-v1-order-orders.universal-Cc6i2pkz.d.mts → ecom-v1-order-orders.universal-CQe1Ioz_.d.mts} +1825 -1813
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1825 -1813
  29. package/package.json +2 -2
@@ -3915,163 +3915,461 @@ interface BulkDeleteImportedOrdersResponse {
3915
3915
  */
3916
3916
  jobId?: string;
3917
3917
  }
3918
- interface SendBuyerConfirmationEmailRequest {
3918
+ interface V1TriggerReindexRequest {
3919
3919
  /** @format GUID */
3920
- orderId?: string;
3921
- }
3922
- interface SendBuyerConfirmationEmailResponse {
3923
- }
3924
- interface SendBuyerPaymentsReceivedEmailRequest {
3920
+ metasiteId?: string;
3925
3921
  /**
3926
3922
  * @minLength 1
3927
3923
  * @maxLength 100
3924
+ * @maxSize 100
3928
3925
  */
3929
- orderId?: string;
3926
+ orderIds?: string[];
3930
3927
  }
3931
- interface SendBuyerPaymentsReceivedEmailResponse {
3928
+ interface V1TriggerReindexResponse {
3932
3929
  }
3933
- interface SendBuyerPickupConfirmationEmailRequest {
3930
+ interface V1TriggerReindexOrderRequest {
3931
+ /** @format GUID */
3932
+ metasiteId?: string;
3934
3933
  /**
3935
3934
  * @minLength 1
3936
3935
  * @maxLength 100
3937
3936
  */
3938
3937
  orderId?: string;
3939
3938
  }
3940
- interface SendBuyerPickupConfirmationEmailResponse {
3941
- }
3942
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
3943
- /**
3944
- * IDs of orders to send pickup emails for.
3945
- * @minSize 1
3946
- * @maxSize 300
3947
- */
3948
- orderIds?: string[];
3949
- }
3950
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
3951
- }
3952
- interface SendBuyerShippingConfirmationEmailRequest {
3939
+ interface PreparePaymentCollectionRequest {
3953
3940
  /**
3941
+ * Ecom order ID.
3954
3942
  * @minLength 1
3955
3943
  * @maxLength 100
3956
3944
  */
3957
- orderId?: string;
3958
- }
3959
- interface SendBuyerShippingConfirmationEmailResponse {
3960
- }
3961
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
3945
+ ecomOrderId: string;
3946
+ /** Amount to collect */
3947
+ amount: Price;
3962
3948
  /**
3963
- * IDs of orders to send pickup emails for.
3964
- * @minSize 1
3965
- * @maxSize 300
3949
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
3950
+ * Existing payment gateway order will be updated with a new amount.
3951
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
3966
3952
  */
3967
- orderIds?: string[];
3968
- }
3969
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
3970
- }
3971
- interface SendMerchantOrderReceivedNotificationRequest {
3953
+ paymentGatewayOrderId?: string | null;
3972
3954
  /**
3973
- * @minLength 1
3974
- * @maxLength 100
3955
+ * Whether to delay capture of the payment.
3956
+ * Default: false
3957
+ * @deprecated Whether to delay capture of the payment.
3958
+ * Default: false
3959
+ * @replacedBy delayed_capture_settings.scheduled_action
3960
+ * @targetRemovalDate 2024-09-30
3975
3961
  */
3976
- orderId?: string;
3977
- }
3978
- interface SendMerchantOrderReceivedNotificationResponse {
3962
+ delayedCapture?: boolean;
3963
+ /** Delayed capture payment settings */
3964
+ delayedCaptureSettings?: DelayedCaptureSettings;
3979
3965
  }
3980
- interface SendCancelRefundEmailRequest {
3966
+ interface RedirectUrls {
3981
3967
  /**
3982
- * The ID of order that is canceled/refunded
3983
- * @minLength 1
3984
- * @maxLength 100
3968
+ * URL to redirect buyer in case of approved (successful) transaction
3969
+ * @format WEB_URL
3985
3970
  */
3986
- orderId?: string;
3971
+ successUrl?: string | null;
3987
3972
  /**
3988
- * Personal note added to the email (optional)
3989
- * @minLength 1
3990
- * @maxLength 1000
3973
+ * URL to redirect buyer in case of buyer canceled the transaction
3974
+ * @format WEB_URL
3991
3975
  */
3992
- customMessage?: string | null;
3993
- /** Refund amount */
3994
- refundAmount?: Price;
3976
+ cancelUrl?: string | null;
3995
3977
  /**
3996
- * Refund ID. (Optional)
3997
- * @format GUID
3978
+ * URL to redirect buyer in case of failed/rejected transaction
3979
+ * @format WEB_URL
3998
3980
  */
3999
- refundId?: string | null;
4000
- }
4001
- interface SendCancelRefundEmailResponse {
4002
- }
4003
- interface SendRefundEmailRequest {
3981
+ errorUrl?: string | null;
4004
3982
  /**
4005
- * The ID of order that is refunded
4006
- * @format GUID
3983
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
3984
+ * @format WEB_URL
4007
3985
  */
4008
- orderId?: string;
3986
+ pendingUrl?: string | null;
3987
+ }
3988
+ interface DelayedCaptureSettings {
3989
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
3990
+ scheduledAction?: ScheduledActionWithLiterals;
3991
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
3992
+ delayDuration?: Duration;
3993
+ }
3994
+ declare enum ScheduledAction {
3995
+ /** Whether payment will be auto-voided when duration passes */
3996
+ VOID = "VOID",
3997
+ /** Whether payment will be auto-captured when duration passes */
3998
+ CAPTURE = "CAPTURE"
3999
+ }
4000
+ /** @enumType */
4001
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4002
+ interface Duration {
4009
4003
  /**
4010
- * Refund ID
4011
- * @format GUID
4004
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4005
+ * @min 1
4012
4006
  */
4013
- refundId?: string;
4007
+ count?: number;
4008
+ /** Duration unit: MINUTES, HOURS and DAYS */
4009
+ unit?: DurationUnitWithLiterals;
4010
+ }
4011
+ declare enum DurationUnit {
4012
+ MINUTES = "MINUTES",
4013
+ HOURS = "HOURS",
4014
+ DAYS = "DAYS"
4015
+ }
4016
+ /** @enumType */
4017
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4018
+ interface PreparePaymentCollectionResponse {
4019
+ /** Payment gateway order id which is associated with given payment */
4020
+ paymentGatewayOrderId?: string;
4021
+ }
4022
+ interface GetPaymentCollectabilityStatusRequest {
4014
4023
  /**
4015
- * Personal note added to the email (optional)
4024
+ * Ecom order ID.
4016
4025
  * @minLength 1
4017
- * @maxLength 1000
4026
+ * @maxLength 100
4018
4027
  */
4019
- customMessage?: string | null;
4020
- }
4021
- interface SendRefundEmailResponse {
4028
+ ecomOrderId: string;
4022
4029
  }
4023
- interface SendFulfillmentEmailRequest {
4024
- /** @format GUID */
4025
- orderId?: string;
4026
- /** @format GUID */
4027
- fulfillerId?: string;
4030
+ interface GetPaymentCollectabilityStatusResponse {
4031
+ /** Payment collectability status */
4032
+ status?: PaymentCollectabilityStatusWithLiterals;
4033
+ /** Collectable order amount */
4034
+ amount?: Price;
4028
4035
  }
4029
- interface SendFulfillmentEmailResponse {
4036
+ declare enum PaymentCollectabilityStatus {
4037
+ UNKNOWN = "UNKNOWN",
4038
+ COLLECTABLE = "COLLECTABLE",
4039
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4040
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4041
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4042
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4043
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4044
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4045
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4046
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4047
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4048
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4049
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4030
4050
  }
4031
- interface SendMerchantOrderReceivedPushRequest {
4051
+ /** @enumType */
4052
+ type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
4053
+ interface RecordManuallyCollectedPaymentRequest {
4032
4054
  /**
4055
+ * Order ID.
4033
4056
  * @minLength 1
4034
4057
  * @maxLength 100
4035
4058
  */
4036
- orderId?: string;
4059
+ orderId: string;
4060
+ /** Amount to be recorded as approved manual payment for given order */
4061
+ amount: Price;
4037
4062
  }
4038
- interface SendMerchantOrderReceivedPushResponse {
4063
+ /**
4064
+ * User-defined payment method name.
4065
+ * Allows specifying either a predefined type or a custom name.
4066
+ */
4067
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4068
+ /** Predefined payment method. */
4069
+ predefined?: PredefinedPaymentMethodWithLiterals;
4070
+ /**
4071
+ * Custom payment method name provided by user.
4072
+ *
4073
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4074
+ * @minLength 1
4075
+ * @maxLength 150
4076
+ */
4077
+ custom?: string | null;
4039
4078
  }
4040
- interface PreviewEmailByTypeRequest {
4041
- emailType?: PreviewEmailTypeWithLiterals;
4079
+ /** @oneof */
4080
+ interface UserDefinedPaymentMethodNameKindOneOf {
4081
+ /** Predefined payment method. */
4082
+ predefined?: PredefinedPaymentMethodWithLiterals;
4083
+ /**
4084
+ * Custom payment method name provided by user.
4085
+ *
4086
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4087
+ * @minLength 1
4088
+ * @maxLength 150
4089
+ */
4090
+ custom?: string | null;
4042
4091
  }
4043
- declare enum PreviewEmailType {
4044
- ORDER_PLACED = "ORDER_PLACED",
4045
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4046
- ORDER_SHIPPED = "ORDER_SHIPPED",
4047
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4092
+ /** Predefined payment method types for offline/manual payments. */
4093
+ declare enum PredefinedPaymentMethod {
4094
+ /** Cash payment. */
4095
+ CASH = "CASH",
4096
+ /** Bank transfer. */
4097
+ BANK_TRANSFER = "BANK_TRANSFER",
4098
+ /** Payment by check. */
4099
+ CHECK = "CHECK"
4048
4100
  }
4049
4101
  /** @enumType */
4050
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4051
- interface PreviewEmailByTypeResponse {
4052
- emailPreview?: string;
4102
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4103
+ interface RecordManuallyCollectedPaymentResponse {
4053
4104
  }
4054
- interface PreviewRefundEmailRequest {
4105
+ interface MarkOrderAsPaidRequest {
4055
4106
  /**
4107
+ * Ecom order ID.
4056
4108
  * @minLength 1
4057
4109
  * @maxLength 100
4058
4110
  */
4059
- orderId?: string;
4060
- /** Refund amount */
4061
- refundAmount?: Price;
4062
- /** Refund business details */
4063
- details?: RefundDetails;
4111
+ ecomOrderId: string;
4112
+ }
4113
+ interface MarkOrderAsPaidResponse {
4114
+ /** Updated order. */
4115
+ order?: Order;
4116
+ }
4117
+ interface BulkMarkOrdersAsPaidRequest {
4064
4118
  /**
4065
- * Personal note added to the email (optional)
4119
+ * IDs of orders to mark as paid.
4120
+ * @minSize 1
4121
+ * @maxSize 100
4066
4122
  * @minLength 1
4067
- * @maxLength 1000
4123
+ * @maxLength 100
4068
4124
  */
4069
- customMessage?: string | null;
4125
+ ecomOrderIds: string[];
4126
+ }
4127
+ interface BulkMarkOrdersAsPaidResponse {
4070
4128
  /**
4071
- * Refund ID. (Optional)
4072
- * @format GUID
4129
+ * Items updated by the bulk action.
4130
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4073
4131
  */
4074
- refundId?: string | null;
4132
+ results?: BulkOrderResult[];
4133
+ /** Bulk action metadata. */
4134
+ bulkActionMetadata?: BulkActionMetadata;
4135
+ }
4136
+ interface BulkOrderResult {
4137
+ /** Item metadata. */
4138
+ itemMetadata?: ItemMetadata;
4139
+ /**
4140
+ * Updated order.
4141
+ *
4142
+ * Returned when `returnFullEntity = true`.
4143
+ */
4144
+ item?: Order;
4145
+ }
4146
+ interface ItemMetadata {
4147
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4148
+ _id?: string | null;
4149
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4150
+ originalIndex?: number;
4151
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4152
+ success?: boolean;
4153
+ /** Details about the error in case of failure. */
4154
+ error?: ApplicationError;
4155
+ }
4156
+ interface ApplicationError {
4157
+ /** Error code. */
4158
+ code?: string;
4159
+ /** Description of the error. */
4160
+ description?: string;
4161
+ /** Data related to the error. */
4162
+ data?: Record<string, any> | null;
4163
+ }
4164
+ interface BulkActionMetadata {
4165
+ /** Number of items that were successfully processed. */
4166
+ totalSuccesses?: number;
4167
+ /** Number of items that couldn't be processed. */
4168
+ totalFailures?: number;
4169
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4170
+ undetailedFailures?: number;
4171
+ }
4172
+ interface GetRefundabilityStatusRequest {
4173
+ /**
4174
+ * Order ID.
4175
+ * @minLength 1
4176
+ * @maxLength 100
4177
+ */
4178
+ ecomOrderId: string;
4179
+ }
4180
+ interface GetRefundabilityStatusResponse {
4181
+ /**
4182
+ * Refundability details.
4183
+ * @maxSize 300
4184
+ */
4185
+ refundabilities?: Refundability[];
4186
+ /**
4187
+ * Whether the order supports refunding per item.
4188
+ * @deprecated
4189
+ */
4190
+ refundablePerItem?: boolean;
4191
+ }
4192
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4193
+ /** Reason why payment is not refundable. */
4194
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4195
+ /** Reason why payment is only refundable manually. */
4196
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4197
+ /** Payment ID. */
4198
+ paymentId?: string;
4199
+ /** Payment refundability status. */
4200
+ refundabilityStatus?: RefundableStatusWithLiterals;
4201
+ /** Link to payment provider dashboard. */
4202
+ providerLink?: string | null;
4203
+ }
4204
+ /** @oneof */
4205
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4206
+ /** Reason why payment is not refundable. */
4207
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4208
+ /** Reason why payment is only refundable manually. */
4209
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4210
+ }
4211
+ declare enum RefundableStatus {
4212
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4213
+ MANUAL = "MANUAL",
4214
+ REFUNDABLE = "REFUNDABLE"
4215
+ }
4216
+ /** @enumType */
4217
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4218
+ declare enum NonRefundableReason {
4219
+ NONE = "NONE",
4220
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4221
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4222
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4223
+ NOT_PAID = "NOT_PAID",
4224
+ ACCESS_DENIED = "ACCESS_DENIED",
4225
+ ZERO_PRICE = "ZERO_PRICE",
4226
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4227
+ PENDING_REFUND = "PENDING_REFUND",
4228
+ FORBIDDEN = "FORBIDDEN",
4229
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4230
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4231
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4232
+ }
4233
+ /** @enumType */
4234
+ 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';
4235
+ declare enum ManuallyRefundableReason {
4236
+ EXPIRED = "EXPIRED",
4237
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4238
+ OFFLINE = "OFFLINE",
4239
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4240
+ }
4241
+ /** @enumType */
4242
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4243
+ interface CreatePaymentGatewayOrderRequest {
4244
+ /**
4245
+ * Ecom order ID.
4246
+ * @minLength 1
4247
+ * @maxLength 100
4248
+ */
4249
+ ecomOrderId: string;
4250
+ /** Information about the user who initiated the payment. */
4251
+ chargedBy?: ChargedBy;
4252
+ }
4253
+ interface ChargedBy {
4254
+ /**
4255
+ * ID - id of the user who initiated the payment
4256
+ * @format GUID
4257
+ */
4258
+ _id?: string;
4259
+ /**
4260
+ * Full name - name of the user who initiated the payment
4261
+ * @minLength 1
4262
+ * @maxLength 200
4263
+ */
4264
+ fullName?: string | null;
4265
+ }
4266
+ interface CreatePaymentGatewayOrderResponse {
4267
+ /** ID of the order created in the payment gateway */
4268
+ paymentGatewayOrderId?: string;
4269
+ }
4270
+ interface ChargeMembershipsRequest {
4271
+ /**
4272
+ * Order ID.
4273
+ * @minLength 1
4274
+ * @maxLength 100
4275
+ */
4276
+ ecomOrderId: string;
4277
+ /**
4278
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4279
+ * but a user which is using the membership on behalf of the a member
4280
+ * @format GUID
4281
+ */
4282
+ memberId: string;
4283
+ /**
4284
+ * List of items to be paid by memberships
4285
+ * @minSize 1
4286
+ * @maxSize 300
4287
+ */
4288
+ membershipCharges?: MembershipChargeItem[];
4289
+ }
4290
+ interface MembershipChargeItem {
4291
+ /**
4292
+ * The id of used membership
4293
+ * @minLength 1
4294
+ * @maxLength 100
4295
+ */
4296
+ membershipId?: string;
4297
+ /**
4298
+ * ID of the application providing this payment option
4299
+ * @format GUID
4300
+ */
4301
+ appId?: string;
4302
+ /** The name of used membership */
4303
+ membershipName?: MembershipName;
4304
+ /** Additional data about this membership */
4305
+ membershipAdditionalData?: Record<string, any> | null;
4306
+ /** Catalog and item reference info. */
4307
+ catalogReference?: CatalogReference;
4308
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
4309
+ serviceProperties?: ServiceProperties;
4310
+ /**
4311
+ * Usually would be the same as catalogReference.catalogItemId
4312
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
4313
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4314
+ * @minLength 1
4315
+ * @maxLength 36
4316
+ */
4317
+ rootCatalogItemId?: string | null;
4318
+ /**
4319
+ * line item id of Checkout/Order line item
4320
+ * @minLength 1
4321
+ * @maxLength 100
4322
+ */
4323
+ lineItemId?: string;
4324
+ }
4325
+ interface MembershipName {
4326
+ /**
4327
+ * Membership name in the site's original language.
4328
+ * @maxLength 100
4329
+ */
4330
+ original?: string;
4331
+ /**
4332
+ * Membership name translated into the buyer's language.
4333
+ *
4334
+ * Default: The value of `original`
4335
+ * @maxLength 100
4336
+ */
4337
+ translated?: string | null;
4338
+ }
4339
+ interface ChargeMembershipsResponse {
4340
+ }
4341
+ interface TriggerRefundRequest {
4342
+ /**
4343
+ * The order this refund related to
4344
+ * @minLength 1
4345
+ * @maxLength 100
4346
+ */
4347
+ ecomOrderId: string;
4348
+ /**
4349
+ * Refund operations information
4350
+ * @minSize 1
4351
+ * @maxSize 1
4352
+ */
4353
+ payments: PaymentRefund[];
4354
+ /** Business model of a refund */
4355
+ details?: RefundDetails;
4356
+ /** Side effect details related to refund */
4357
+ sideEffects?: RefundSideEffects;
4358
+ }
4359
+ interface PaymentRefund {
4360
+ /**
4361
+ * Specific payment within the order to refund
4362
+ * @format GUID
4363
+ */
4364
+ paymentId?: string;
4365
+ /** Refund amount. Not relevant for membership and gift card refunds. */
4366
+ amount?: Price;
4367
+ /**
4368
+ * Whether refund is made externally and manually (on the payment provider's side)
4369
+ * 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.
4370
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4371
+ */
4372
+ externalRefund?: boolean;
4075
4373
  }
4076
4374
  /** Business model of a refund request */
4077
4375
  interface RefundDetails {
@@ -4148,1943 +4446,1645 @@ interface ShippingRefund {
4148
4446
  */
4149
4447
  amount?: Price;
4150
4448
  }
4151
- interface PreviewRefundEmailResponse {
4152
- emailPreview?: string;
4153
- }
4154
- interface PreviewCancelEmailRequest {
4449
+ interface RefundSideEffects {
4450
+ /** Inventory restock details as part of this refund. */
4451
+ restockInfo?: RestockInfo;
4452
+ /** Whether to send a refund confirmation email to the customer. */
4453
+ sendOrderRefundedEmail?: boolean;
4155
4454
  /**
4455
+ * Custom message added to the refund confirmation email.
4156
4456
  * @minLength 1
4157
- * @maxLength 100
4457
+ * @maxLength 1000
4158
4458
  */
4159
- orderId?: string;
4160
- /**
4161
- * Personal note added to the email (optional)
4162
- * @minLength 1
4163
- * @maxLength 1000
4164
- */
4165
- customMessage?: string | null;
4166
- }
4167
- interface PreviewCancelEmailResponse {
4168
- emailPreview?: string;
4169
- }
4170
- interface PreviewCancelRefundEmailRequest {
4171
- /**
4172
- * @minLength 1
4173
- * @maxLength 100
4174
- */
4175
- orderId?: string;
4176
- /**
4177
- * Personal note added to the email (optional)
4178
- * @minLength 1
4179
- * @maxLength 1000
4180
- */
4181
- customMessage?: string | null;
4182
- /** Refund amount */
4183
- refundAmount?: Price;
4184
- /**
4185
- * Refund ID. (Optional)
4186
- * @format GUID
4187
- */
4188
- refundId?: string | null;
4189
- }
4190
- interface PreviewCancelRefundEmailResponse {
4191
- emailPreview?: string;
4192
- }
4193
- interface PreviewBuyerPaymentsReceivedEmailRequest {
4194
- }
4195
- interface PreviewBuyerPaymentsReceivedEmailResponse {
4196
- emailPreview?: string;
4197
- }
4198
- interface PreviewBuyerConfirmationEmailRequest {
4199
- }
4200
- interface PreviewBuyerConfirmationEmailResponse {
4201
- emailPreview?: string;
4202
- }
4203
- interface PreviewBuyerPickupConfirmationEmailRequest {
4204
- }
4205
- interface PreviewBuyerPickupConfirmationEmailResponse {
4206
- emailPreview?: string;
4207
- }
4208
- interface PreviewShippingConfirmationEmailRequest {
4209
- }
4210
- interface PreviewShippingConfirmationEmailResponse {
4211
- emailPreview?: string;
4212
- }
4213
- interface PreviewResendDownloadLinksEmailRequest {
4214
- }
4215
- interface PreviewResendDownloadLinksEmailResponse {
4216
- emailPreview?: string;
4217
- }
4218
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4219
- /** Emitted on a meta site creation. */
4220
- siteCreated?: SiteCreated;
4221
- /** Emitted on a meta site transfer completion. */
4222
- siteTransferred?: SiteTransferred;
4223
- /** Emitted on a meta site deletion. */
4224
- siteDeleted?: SiteDeleted;
4225
- /** Emitted on a meta site restoration. */
4226
- siteUndeleted?: SiteUndeleted;
4227
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4228
- sitePublished?: SitePublished;
4229
- /** Emitted on a meta site unpublish. */
4230
- siteUnpublished?: SiteUnpublished;
4231
- /** Emitted when meta site is marked as template. */
4232
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4233
- /** Emitted when meta site is marked as a WixSite. */
4234
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4235
- /** Emitted when an application is provisioned (installed). */
4236
- serviceProvisioned?: ServiceProvisioned;
4237
- /** Emitted when an application is removed (uninstalled). */
4238
- serviceRemoved?: ServiceRemoved;
4239
- /** Emitted when meta site name (URL slug) is changed. */
4240
- siteRenamedPayload?: SiteRenamed;
4241
- /** Emitted when meta site was permanently deleted. */
4242
- hardDeleted?: SiteHardDeleted;
4243
- /** Emitted on a namespace change. */
4244
- namespaceChanged?: NamespaceChanged;
4245
- /** Emitted when Studio is attached. */
4246
- studioAssigned?: StudioAssigned;
4247
- /** Emitted when Studio is detached. */
4248
- studioUnassigned?: StudioUnassigned;
4249
- /**
4250
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4251
- * the actual URL.
4252
- *
4253
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4254
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4255
- */
4256
- urlChanged?: SiteUrlChanged;
4257
- /** Site is marked as PurgedExternally */
4258
- sitePurgedExternally?: SitePurgedExternally;
4259
- /** Emitted when Odeditor is attached. */
4260
- odeditorAssigned?: OdeditorAssigned;
4261
- /** Emitted when Odeditor is detached. */
4262
- odeditorUnassigned?: OdeditorUnassigned;
4263
- /** Emitted when Picasso is attached. */
4264
- picassoAssigned?: PicassoAssigned;
4265
- /** Emitted when Picasso is detached. */
4266
- picassoUnassigned?: PicassoUnassigned;
4267
- /** Emitted when Wixel is attached. */
4268
- wixelAssigned?: WixelAssigned;
4269
- /** Emitted when Wixel is detached. */
4270
- wixelUnassigned?: WixelUnassigned;
4271
- /** Emitted when StudioTwo is attached. */
4272
- studioTwoAssigned?: StudioTwoAssigned;
4273
- /** Emitted when StudioTwo is detached. */
4274
- studioTwoUnassigned?: StudioTwoUnassigned;
4275
- /** Emitted when media from user domain is enabled. */
4276
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4277
- /** Emitted when media from user domain is disabled. */
4278
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4279
- /** Emitted when Editorless is attached. */
4280
- editorlessAssigned?: EditorlessAssigned;
4281
- /** Emitted when Editorless is detached. */
4282
- editorlessUnassigned?: EditorlessUnassigned;
4283
- /**
4284
- * A meta site id.
4285
- * @format GUID
4286
- */
4287
- metaSiteId?: string;
4288
- /** A meta site version. Monotonically increasing. */
4289
- version?: string;
4290
- /** A timestamp of the event. */
4291
- timestamp?: string;
4292
- /**
4293
- * TODO(meta-site): Change validation once validations are disabled for consumers
4294
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4295
- * @maxSize 4000
4296
- */
4297
- assets?: Asset[];
4298
- }
4299
- /** @oneof */
4300
- interface MetaSiteSpecialEventPayloadOneOf {
4301
- /** Emitted on a meta site creation. */
4302
- siteCreated?: SiteCreated;
4303
- /** Emitted on a meta site transfer completion. */
4304
- siteTransferred?: SiteTransferred;
4305
- /** Emitted on a meta site deletion. */
4306
- siteDeleted?: SiteDeleted;
4307
- /** Emitted on a meta site restoration. */
4308
- siteUndeleted?: SiteUndeleted;
4309
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4310
- sitePublished?: SitePublished;
4311
- /** Emitted on a meta site unpublish. */
4312
- siteUnpublished?: SiteUnpublished;
4313
- /** Emitted when meta site is marked as template. */
4314
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4315
- /** Emitted when meta site is marked as a WixSite. */
4316
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4317
- /** Emitted when an application is provisioned (installed). */
4318
- serviceProvisioned?: ServiceProvisioned;
4319
- /** Emitted when an application is removed (uninstalled). */
4320
- serviceRemoved?: ServiceRemoved;
4321
- /** Emitted when meta site name (URL slug) is changed. */
4322
- siteRenamedPayload?: SiteRenamed;
4323
- /** Emitted when meta site was permanently deleted. */
4324
- hardDeleted?: SiteHardDeleted;
4325
- /** Emitted on a namespace change. */
4326
- namespaceChanged?: NamespaceChanged;
4327
- /** Emitted when Studio is attached. */
4328
- studioAssigned?: StudioAssigned;
4329
- /** Emitted when Studio is detached. */
4330
- studioUnassigned?: StudioUnassigned;
4331
- /**
4332
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4333
- * the actual URL.
4334
- *
4335
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4336
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4337
- */
4338
- urlChanged?: SiteUrlChanged;
4339
- /** Site is marked as PurgedExternally */
4340
- sitePurgedExternally?: SitePurgedExternally;
4341
- /** Emitted when Odeditor is attached. */
4342
- odeditorAssigned?: OdeditorAssigned;
4343
- /** Emitted when Odeditor is detached. */
4344
- odeditorUnassigned?: OdeditorUnassigned;
4345
- /** Emitted when Picasso is attached. */
4346
- picassoAssigned?: PicassoAssigned;
4347
- /** Emitted when Picasso is detached. */
4348
- picassoUnassigned?: PicassoUnassigned;
4349
- /** Emitted when Wixel is attached. */
4350
- wixelAssigned?: WixelAssigned;
4351
- /** Emitted when Wixel is detached. */
4352
- wixelUnassigned?: WixelUnassigned;
4353
- /** Emitted when StudioTwo is attached. */
4354
- studioTwoAssigned?: StudioTwoAssigned;
4355
- /** Emitted when StudioTwo is detached. */
4356
- studioTwoUnassigned?: StudioTwoUnassigned;
4357
- /** Emitted when media from user domain is enabled. */
4358
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4359
- /** Emitted when media from user domain is disabled. */
4360
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4361
- /** Emitted when Editorless is attached. */
4362
- editorlessAssigned?: EditorlessAssigned;
4363
- /** Emitted when Editorless is detached. */
4364
- editorlessUnassigned?: EditorlessUnassigned;
4365
- }
4366
- interface Asset {
4367
- /**
4368
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4369
- * @maxLength 36
4370
- */
4371
- appDefId?: string;
4372
- /**
4373
- * An instance id. For legacy reasons may be UUID or a string.
4374
- * @maxLength 200
4375
- */
4376
- instanceId?: string;
4377
- /** An application state. */
4378
- state?: StateWithLiterals;
4379
- }
4380
- declare enum State {
4381
- UNKNOWN = "UNKNOWN",
4382
- ENABLED = "ENABLED",
4383
- DISABLED = "DISABLED",
4384
- PENDING = "PENDING",
4385
- DEMO = "DEMO"
4386
- }
4387
- /** @enumType */
4388
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4389
- interface SiteCreated {
4390
- /**
4391
- * A template identifier (empty if not created from a template).
4392
- * @maxLength 36
4393
- */
4394
- originTemplateId?: string;
4395
- /**
4396
- * An account id of the owner.
4397
- * @format GUID
4398
- */
4399
- ownerId?: string;
4400
- /** A context in which meta site was created. */
4401
- context?: SiteCreatedContextWithLiterals;
4402
- /**
4403
- * A meta site id from which this site was created.
4404
- *
4405
- * In case of a creation from a template it's a template id.
4406
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4407
- * @format GUID
4408
- */
4409
- originMetaSiteId?: string | null;
4410
- /**
4411
- * A meta site name (URL slug).
4412
- * @maxLength 20
4413
- */
4414
- siteName?: string;
4415
- /** A namespace. */
4416
- namespace?: NamespaceWithLiterals;
4417
- }
4418
- declare enum SiteCreatedContext {
4419
- /** A valid option, we don't expose all reasons why site might be created. */
4420
- OTHER = "OTHER",
4421
- /** A meta site was created from template. */
4422
- FROM_TEMPLATE = "FROM_TEMPLATE",
4423
- /** A meta site was created by copying of the transfferred meta site. */
4424
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4425
- /** A copy of existing meta site. */
4426
- DUPLICATE = "DUPLICATE",
4427
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4428
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4429
- /** deprecated A meta site was created for Flash editor. */
4430
- FLASH = "FLASH"
4431
- }
4432
- /** @enumType */
4433
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4434
- declare enum Namespace {
4435
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4436
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4437
- WIX = "WIX",
4438
- /** 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. */
4439
- SHOUT_OUT = "SHOUT_OUT",
4440
- /** 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. */
4441
- ALBUMS = "ALBUMS",
4442
- /** 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. */
4443
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4444
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4445
- HOTELS = "HOTELS",
4446
- /** 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. */
4447
- CLUBS = "CLUBS",
4448
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4449
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4450
- /**
4451
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4452
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4453
- */
4454
- DEV_SITE = "DEV_SITE",
4455
- /** 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. */
4456
- LOGOS = "LOGOS",
4457
- /** 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. */
4458
- VIDEO_MAKER = "VIDEO_MAKER",
4459
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4460
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4461
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4462
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4459
+ customMessage?: string | null;
4460
+ }
4461
+ interface RestockInfo {
4462
+ /** Restock type. */
4463
+ type?: RestockTypeWithLiterals;
4463
4464
  /**
4464
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4465
- *
4466
- * Meta site with this namespace will *not* be shown in a user's site list by default.
4465
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4466
+ * @maxSize 300
4467
4467
  */
4468
- HTML_DRAFT = "HTML_DRAFT",
4468
+ items?: RestockItem[];
4469
+ }
4470
+ declare enum RestockType {
4471
+ NO_ITEMS = "NO_ITEMS",
4472
+ ALL_ITEMS = "ALL_ITEMS",
4473
+ SOME_ITEMS = "SOME_ITEMS"
4474
+ }
4475
+ /** @enumType */
4476
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4477
+ interface RestockItem {
4469
4478
  /**
4470
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4471
- * Will be accessible from Site List and will not have a website app.
4472
- * Once the user attaches a site, the site will become a regular wixsite.
4479
+ * ID of the line item being restocked.
4480
+ * @format GUID
4473
4481
  */
4474
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
4475
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4476
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
4477
- /** It is to be used in the Business First efforts. */
4478
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
4479
- /** Bookings business flow with no site. */
4480
- ANYWHERE = "ANYWHERE",
4481
- /** Namespace for Headless Backoffice with no editor */
4482
- HEADLESS = "HEADLESS",
4482
+ lineItemId?: string;
4483
4483
  /**
4484
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4485
- * The site will be used for account level CSM feature for enterprise
4484
+ * Line item quantity being restocked.
4485
+ * @min 1
4486
+ * @max 100000
4486
4487
  */
4487
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4488
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4489
- RISE = "RISE",
4488
+ quantity?: number;
4489
+ }
4490
+ interface TriggerRefundResponse {
4491
+ /** All order's transactions after the refunds were added */
4492
+ orderTransactions?: OrderTransactions;
4493
+ /** Created refund ID */
4494
+ refundId?: string | null;
4495
+ /** Payment ID's that the refund execution had failed for */
4496
+ failedPaymentIds?: ItemMetadata[];
4497
+ }
4498
+ /**
4499
+ * A record of all payments and refunds associated with an order.
4500
+ *
4501
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4502
+ */
4503
+ interface OrderTransactions {
4490
4504
  /**
4491
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4492
- * There's a blank site behind the scene but it's blank).
4493
- * The Mobile company will be the owner of this namespace.
4505
+ * Order ID.
4506
+ * @format GUID
4494
4507
  */
4495
- BRANDED_FIRST = "BRANDED_FIRST",
4496
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4497
- NOWNIA = "NOWNIA",
4508
+ orderId?: string;
4498
4509
  /**
4499
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
4500
- * The Partners company owns this namespace.
4510
+ * Record of payments made to the merchant.
4511
+ * @maxSize 100
4501
4512
  */
4502
- UGC_TEMPLATE = "UGC_TEMPLATE",
4503
- /** Codux Headless Sites */
4504
- CODUX = "CODUX",
4505
- /** Bobb - AI Design Creator. */
4506
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4513
+ payments?: Payment[];
4507
4514
  /**
4508
- * Shared Blog Site is a unique single site across Enterprise account,
4509
- * This site will hold all Blog posts related to the Marketing product.
4515
+ * Record of refunds made to the buyer.
4516
+ * @maxSize 300
4510
4517
  */
4511
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4512
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4513
- STANDALONE_FORMS = "STANDALONE_FORMS",
4514
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4515
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
4516
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4517
- MIMIR = "MIMIR",
4518
- /** Wix Twins platform. */
4519
- TWINS = "TWINS",
4520
- /** Wix Nano. */
4521
- NANO = "NANO",
4522
- /** Base44 headless sites. */
4523
- BASE44 = "BASE44",
4524
- /** Wix Channels Sites */
4525
- CHANNELS = "CHANNELS",
4526
- /** Nautilus platform. */
4527
- NAUTILUS = "NAUTILUS",
4518
+ refunds?: Refund[];
4519
+ }
4520
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4521
+ /** Regular payment details. */
4522
+ regularPaymentDetails?: RegularPaymentDetails;
4523
+ /** Gift card payment details. */
4524
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4525
+ /** Membership payment details. */
4526
+ membershipPaymentDetails?: MembershipPaymentDetails;
4528
4527
  /**
4529
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4530
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4528
+ * Payment ID.
4529
+ * @format GUID
4530
+ * @readonly
4531
4531
  */
4532
- SYMPHONY = "SYMPHONY",
4533
- /** Nautilus platform app. */
4534
- NAUTILUS_APPS = "NAUTILUS_APPS",
4532
+ _id?: string | null;
4533
+ /** 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. */
4534
+ _createdDate?: Date | null;
4535
4535
  /**
4536
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
4537
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
4536
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4537
+ * @readonly
4538
4538
  */
4539
- VIBU = "VIBU",
4539
+ _updatedDate?: Date | null;
4540
+ /** Payment amount. */
4541
+ amount?: Price;
4540
4542
  /**
4541
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
4542
- * (an Enterprise account may have several), holding that BrandKit's brand definition
4543
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
4544
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
4543
+ * Whether refunds for this payment are disabled.
4544
+ * + `true`: This payment is not refundable.
4545
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4545
4546
  */
4546
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4547
+ refundDisabled?: boolean;
4547
4548
  /**
4548
- * Dev-center development sites (com.wixpress.devcenter.dsm).
4549
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
4549
+ * Whether receipt generation is allowed for this payment.
4550
+ * + `true`: This payment supports receipt generation.
4551
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4552
+ * @readonly
4550
4553
  */
4551
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
4552
- }
4553
- /** @enumType */
4554
- type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
4555
- /** Site transferred to another user. */
4556
- interface SiteTransferred {
4554
+ supportReceiptGeneration?: boolean;
4555
+ /** Details about cash rounding applied to this payment, when relevant. */
4556
+ cashRounding?: CashRoundingDetails;
4557
4557
  /**
4558
- * A previous owner id (user that transfers meta site).
4559
- * @format GUID
4558
+ * Overall payment status.
4559
+ *
4560
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
4560
4561
  */
4561
- oldOwnerId?: string;
4562
+ status?: PaymentStatusWithLiterals;
4562
4563
  /**
4563
- * A new owner id (user that accepts meta site).
4564
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4564
4565
  * @format GUID
4565
4566
  */
4566
- newOwnerId?: string;
4567
- }
4568
- /** Soft deletion of the meta site. Could be restored. */
4569
- interface SiteDeleted {
4570
- /** A deletion context. */
4571
- deleteContext?: DeleteContext;
4572
- }
4573
- interface DeleteContext {
4574
- /** When the meta site was deleted. */
4575
- dateDeleted?: Date | null;
4576
- /** A status. */
4577
- deleteStatus?: DeleteStatusWithLiterals;
4578
- /**
4579
- * A reason (flow).
4580
- * @maxLength 255
4581
- */
4582
- deleteOrigin?: string;
4583
- /**
4584
- * A service that deleted it.
4585
- * @maxLength 255
4586
- */
4587
- initiatorId?: string | null;
4567
+ chargeCorrelationId?: string | null;
4588
4568
  }
4589
- declare enum DeleteStatus {
4590
- UNKNOWN = "UNKNOWN",
4591
- TRASH = "TRASH",
4592
- DELETED = "DELETED",
4593
- PENDING_PURGE = "PENDING_PURGE",
4594
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4569
+ /** @oneof */
4570
+ interface PaymentPaymentDetailsOneOf {
4571
+ /** Regular payment details. */
4572
+ regularPaymentDetails?: RegularPaymentDetails;
4573
+ /** Gift card payment details. */
4574
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4575
+ /** Membership payment details. */
4576
+ membershipPaymentDetails?: MembershipPaymentDetails;
4595
4577
  }
4596
- /** @enumType */
4597
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4598
- /** Restoration of the meta site. */
4599
- interface SiteUndeleted {
4578
+ /** @oneof */
4579
+ interface PaymentReceiptInfoOneOf {
4600
4580
  }
4601
- /** First publish of a meta site. Or subsequent publish after unpublish. */
4602
- interface SitePublished {
4581
+ /** @oneof */
4582
+ interface PaymentStatusDetailsOneOf {
4603
4583
  }
4604
- interface SiteUnpublished {
4584
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4585
+ /** Credit card details. */
4586
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4605
4587
  /**
4606
- * A list of URLs previously associated with the meta site.
4607
- * @maxLength 4000
4608
- * @maxSize 10000
4588
+ * Wix Payments order ID.
4589
+ * @maxLength 100
4609
4590
  */
4610
- urls?: string[];
4611
- }
4612
- interface SiteMarkedAsTemplate {
4613
- }
4614
- interface SiteMarkedAsWixSite {
4615
- }
4616
- /**
4617
- * Represents a service provisioned a site.
4618
- *
4619
- * Note on `origin_instance_id`:
4620
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4621
- * This is because of the following scenario:
4622
- *
4623
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
4624
- * such as a product catalog. When you create a site from this template, you inherit this
4625
- * default product catalog. However, if the template's product catalog is modified,
4626
- * your site will retain the catalog as it was at the time of site creation. This ensures that
4627
- * your site remains consistent with what you initially received and does not include any
4628
- * changes made to the original template afterward.
4629
- * To ensure this, the TPA on the template gets a new instance_id.
4630
- */
4631
- interface ServiceProvisioned {
4591
+ paymentOrderId?: string | null;
4632
4592
  /**
4633
- * Either UUID or EmbeddedServiceType.
4634
- * @maxLength 36
4593
+ * Payment gateway's transaction ID.
4594
+ * This field is only returned when the value of `offline_payment` is `false`.
4595
+ * @maxLength 100
4596
+ */
4597
+ gatewayTransactionId?: string | null;
4598
+ /**
4599
+ * Payment method.
4600
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4601
+ * Non-exhaustive list of supported values:
4602
+ * + `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`
4603
+ * @maxLength 150
4604
+ * @deprecated Payment method.
4605
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4606
+ * Non-exhaustive list of supported values:
4607
+ * + `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`
4608
+ * @replacedBy payment_method_name
4609
+ * @targetRemovalDate 2026-07-01
4635
4610
  */
4636
- appDefId?: string;
4611
+ paymentMethod?: string | null;
4637
4612
  /**
4638
- * Not only UUID. Something here could be something weird.
4639
- * @maxLength 36
4613
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4614
+ * @maxLength 100
4640
4615
  */
4641
- instanceId?: string;
4616
+ providerTransactionId?: string | null;
4617
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4618
+ offlinePayment?: boolean;
4642
4619
  /**
4643
- * An instance id from which this instance is originated.
4644
- * @maxLength 36
4620
+ * Payment status.
4621
+ * @deprecated Payment status.
4622
+ * @replacedBy payment.status
4623
+ * @targetRemovalDate 2026-11-01
4645
4624
  */
4646
- originInstanceId?: string;
4625
+ status?: TransactionStatusWithLiterals;
4626
+ /** Whether there is a payment agreement that allows for future charges. */
4627
+ savedPaymentMethod?: boolean;
4628
+ /** Authorization details. */
4629
+ authorizationDetails?: AuthorizationDetails;
4647
4630
  /**
4648
- * A version.
4649
- * @maxLength 500
4631
+ * Record of chargebacks made by the buyer.
4632
+ * @maxSize 6
4650
4633
  */
4651
- version?: string | null;
4634
+ chargebacks?: Chargeback[];
4635
+ /** Platform fee amount associated with this payment. */
4636
+ platformFee?: Price;
4652
4637
  /**
4653
- * The origin meta site id
4654
- * @format GUID
4638
+ * Payment method with buyer and optional owner translations.
4639
+ * Non-exhaustive list of supported values:
4640
+ * + `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
4641
  */
4656
- originMetaSiteId?: string | null;
4642
+ paymentMethodName?: PaymentMethodName;
4657
4643
  }
4658
- interface ServiceRemoved {
4659
- /**
4660
- * Either UUID or EmbeddedServiceType.
4661
- * @maxLength 36
4662
- */
4663
- appDefId?: string;
4644
+ /** @oneof */
4645
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4646
+ /** Credit card details. */
4647
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4648
+ }
4649
+ declare enum TransactionStatus {
4650
+ UNDEFINED = "UNDEFINED",
4651
+ APPROVED = "APPROVED",
4652
+ PENDING = "PENDING",
4653
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4654
+ CANCELED = "CANCELED",
4655
+ DECLINED = "DECLINED",
4656
+ REFUNDED = "REFUNDED",
4657
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4658
+ AUTHORIZED = "AUTHORIZED",
4659
+ VOIDED = "VOIDED"
4660
+ }
4661
+ /** @enumType */
4662
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4663
+ interface CreditCardPaymentMethodDetails {
4664
4664
  /**
4665
- * Not only UUID. Something here could be something weird.
4666
- * @maxLength 36
4665
+ * The last 4 digits of the card number.
4666
+ * @maxLength 4
4667
4667
  */
4668
- instanceId?: string;
4668
+ lastFourDigits?: string | null;
4669
4669
  /**
4670
- * A version.
4671
- * @maxLength 500
4670
+ * Card issuer's brand.
4671
+ * @maxLength 100
4672
4672
  */
4673
- version?: string | null;
4673
+ brand?: string | null;
4674
4674
  }
4675
- /** Rename of the site. Meaning, free public url has been changed as well. */
4676
- interface SiteRenamed {
4675
+ interface AuthorizationDetails {
4677
4676
  /**
4678
- * A new meta site name (URL slug).
4679
- * @maxLength 20
4677
+ * Whether the authorized payment is of a delayed capture.
4678
+ * @readonly
4680
4679
  */
4681
- newSiteName?: string;
4680
+ delayedCapture?: boolean;
4681
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4682
+ authorizedDate?: Date | null;
4682
4683
  /**
4683
- * A previous meta site name (URL slug).
4684
- * @maxLength 255
4684
+ * List of captures associated with payment
4685
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4686
+ * @maxSize 1
4685
4687
  */
4686
- oldSiteName?: string;
4687
- }
4688
- /**
4689
- * Hard deletion of the meta site.
4690
- *
4691
- * Could not be restored. Therefore it's desirable to cleanup data.
4692
- */
4693
- interface SiteHardDeleted {
4694
- /** A deletion context. */
4695
- deleteContext?: DeleteContext;
4696
- }
4697
- interface NamespaceChanged {
4698
- /** A previous namespace. */
4699
- oldNamespace?: NamespaceWithLiterals;
4700
- /** A new namespace. */
4701
- newNamespace?: NamespaceWithLiterals;
4702
- }
4703
- /** Assigned Studio editor */
4704
- interface StudioAssigned {
4705
- }
4706
- /** Unassigned Studio editor */
4707
- interface StudioUnassigned {
4708
- }
4709
- /**
4710
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4711
- *
4712
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4713
- * with sites and its urls, you need to listen to another topic/event. Read about it:
4714
- *
4715
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4716
- */
4717
- interface SiteUrlChanged {
4688
+ captures?: AuthorizationCapture[];
4689
+ /** Void associated with payment */
4690
+ void?: AuthorizationVoid;
4691
+ /** Scheduled action for this transaction */
4692
+ scheduledAction?: V1ScheduledAction;
4718
4693
  }
4719
- /**
4720
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4721
- * Consumed by other teams to remove relevant data.
4722
- */
4723
- interface SitePurgedExternally {
4694
+ interface AuthorizationCapture {
4724
4695
  /**
4725
- * @maxLength 2048
4726
- * @maxSize 100
4727
- * @deprecated
4728
- * @targetRemovalDate 2025-04-15
4696
+ * Capture ID.
4697
+ * @format GUID
4698
+ * @readonly
4729
4699
  */
4730
- appDefId?: string[];
4731
- }
4732
- /** Assigned Odeditor */
4733
- interface OdeditorAssigned {
4734
- }
4735
- /** Unassigned Odeditor */
4736
- interface OdeditorUnassigned {
4737
- }
4738
- /** Assigned Picasso editor */
4739
- interface PicassoAssigned {
4740
- }
4741
- /** Unassigned Picasso */
4742
- interface PicassoUnassigned {
4743
- }
4744
- /** Assigned Wixel */
4745
- interface WixelAssigned {
4746
- }
4747
- /** Unassigned Wixel */
4748
- interface WixelUnassigned {
4749
- }
4750
- /** Assigned StudioTwo */
4751
- interface StudioTwoAssigned {
4752
- }
4753
- /** Unassigned StudioTwo */
4754
- interface StudioTwoUnassigned {
4755
- }
4756
- /** Media from user domain is enabled. */
4757
- interface UserDomainMediaEnabled {
4758
- }
4759
- /** Media from user domain is disabled. */
4760
- interface UserDomainMediaDisabled {
4761
- }
4762
- /** Assigned Editorless */
4763
- interface EditorlessAssigned {
4764
- }
4765
- /** Unassigned Editorless */
4766
- interface EditorlessUnassigned {
4700
+ _id?: string | null;
4701
+ /** Status of this capture action */
4702
+ status?: AuthorizationCaptureStatusWithLiterals;
4703
+ /**
4704
+ * Amount of this capture
4705
+ * @immutable
4706
+ */
4707
+ amount?: Price;
4708
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4709
+ _createdDate?: Date | null;
4710
+ /** In case of status is FAILED may contain failure details */
4711
+ failureDetails?: AuthorizationActionFailureDetails;
4767
4712
  }
4768
- interface HasCustomEmailConfigurationsRequest {
4713
+ declare enum AuthorizationCaptureStatus {
4714
+ /** Capture operation still in progress. */
4715
+ PENDING = "PENDING",
4716
+ /** Capture operation succeeded. */
4717
+ SUCCEEDED = "SUCCEEDED",
4718
+ /** Capture operation failed. */
4719
+ FAILED = "FAILED"
4769
4720
  }
4770
- interface HasCustomEmailConfigurationsResponse {
4771
- hasCustomConfigurations?: boolean;
4721
+ /** @enumType */
4722
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4723
+ interface AuthorizationActionFailureDetails {
4724
+ /** @maxLength 100 */
4725
+ failureCode?: string;
4772
4726
  }
4773
- interface AddToAutomationMigrationPopulationRequest {
4774
- /** When true, sends custom email configurations to automation system via email */
4775
- sendCustomEmailConfigs?: boolean;
4776
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4777
- origin?: OriginWithLiterals;
4727
+ interface AuthorizationVoid {
4728
+ /** Status of this void action */
4729
+ status?: AuthorizationVoidStatusWithLiterals;
4730
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4731
+ voidedDate?: Date | null;
4732
+ /** In case of status is FAILED may contain failure details */
4733
+ failureDetails?: AuthorizationActionFailureDetails;
4734
+ /** Reason of void action */
4735
+ reason?: ReasonWithLiterals;
4778
4736
  }
4779
- declare enum Origin {
4780
- OPT_IN = "OPT_IN",
4781
- MIGRATION = "MIGRATION"
4737
+ declare enum AuthorizationVoidStatus {
4738
+ /** Void operation still in progress. */
4739
+ PENDING = "PENDING",
4740
+ /** Void operation succeeded. */
4741
+ SUCCEEDED = "SUCCEEDED",
4742
+ /** Void operation failed. */
4743
+ FAILED = "FAILED"
4782
4744
  }
4783
4745
  /** @enumType */
4784
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4785
- interface AddToAutomationMigrationPopulationResponse {
4786
- success?: boolean;
4746
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4747
+ /** Reason the authorization was voided. */
4748
+ declare enum Reason {
4749
+ /** Authorization was voided by user. */
4750
+ MANUAL = "MANUAL",
4751
+ /** Authorization passed execution date. */
4752
+ SCHEDULED = "SCHEDULED"
4787
4753
  }
4788
- interface IsInAutomationMigrationPopulationRequest {
4754
+ /** @enumType */
4755
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4756
+ interface V1ScheduledAction {
4757
+ /** Type of the action. */
4758
+ actionType?: ActionTypeWithLiterals;
4759
+ /** The date and time of the action. */
4760
+ executionDate?: Date | null;
4789
4761
  }
4790
- interface IsInAutomationMigrationPopulationResponse {
4791
- inPopulation?: boolean;
4762
+ declare enum ActionType {
4763
+ VOID = "VOID",
4764
+ CAPTURE = "CAPTURE"
4792
4765
  }
4793
- interface PreparePaymentCollectionRequest {
4794
- /**
4795
- * Ecom order ID.
4796
- * @minLength 1
4797
- * @maxLength 100
4798
- */
4799
- ecomOrderId: string;
4800
- /** Amount to collect */
4801
- amount: Price;
4802
- /**
4803
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4804
- * Existing payment gateway order will be updated with a new amount.
4805
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4806
- */
4807
- paymentGatewayOrderId?: string | null;
4766
+ /** @enumType */
4767
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4768
+ interface Chargeback {
4808
4769
  /**
4809
- * Whether to delay capture of the payment.
4810
- * Default: false
4811
- * @deprecated Whether to delay capture of the payment.
4812
- * Default: false
4813
- * @replacedBy delayed_capture_settings.scheduled_action
4814
- * @targetRemovalDate 2024-09-30
4770
+ * Chargeback ID.
4771
+ * @format GUID
4772
+ * @readonly
4773
+ * @immutable
4815
4774
  */
4816
- delayedCapture?: boolean;
4817
- /** Delayed capture payment settings */
4818
- delayedCaptureSettings?: DelayedCaptureSettings;
4819
- }
4820
- interface RedirectUrls {
4775
+ _id?: string;
4821
4776
  /**
4822
- * URL to redirect buyer in case of approved (successful) transaction
4823
- * @format WEB_URL
4777
+ * 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.
4778
+ * @readonly
4779
+ * @immutable
4824
4780
  */
4825
- successUrl?: string | null;
4781
+ _createdDate?: Date | null;
4826
4782
  /**
4827
- * URL to redirect buyer in case of buyer canceled the transaction
4828
- * @format WEB_URL
4783
+ * 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.
4784
+ * @readonly
4829
4785
  */
4830
- cancelUrl?: string | null;
4786
+ _updatedDate?: Date | null;
4831
4787
  /**
4832
- * URL to redirect buyer in case of failed/rejected transaction
4833
- * @format WEB_URL
4788
+ * Amount.
4789
+ * @readonly
4790
+ * @immutable
4834
4791
  */
4835
- errorUrl?: string | null;
4792
+ amount?: Price;
4836
4793
  /**
4837
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4838
- * @format WEB_URL
4794
+ * Reversal amount. Present only when status is REVERSED.
4795
+ * @readonly
4839
4796
  */
4840
- pendingUrl?: string | null;
4841
- }
4842
- interface DelayedCaptureSettings {
4843
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4844
- scheduledAction?: ScheduledActionWithLiterals;
4845
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4846
- delayDuration?: Duration;
4847
- }
4848
- declare enum ScheduledAction {
4849
- /** Whether payment will be auto-voided when duration passes */
4850
- VOID = "VOID",
4851
- /** Whether payment will be auto-captured when duration passes */
4852
- CAPTURE = "CAPTURE"
4853
- }
4854
- /** @enumType */
4855
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4856
- interface Duration {
4797
+ reversalAmount?: Price;
4857
4798
  /**
4858
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4859
- * @min 1
4799
+ * Status.
4800
+ *
4801
+ * Default: `"APPROVED"`.
4860
4802
  */
4861
- count?: number;
4862
- /** Duration unit: MINUTES, HOURS and DAYS */
4863
- unit?: DurationUnitWithLiterals;
4864
- }
4865
- declare enum DurationUnit {
4866
- MINUTES = "MINUTES",
4867
- HOURS = "HOURS",
4868
- DAYS = "DAYS"
4869
- }
4870
- /** @enumType */
4871
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4872
- interface PreparePaymentCollectionResponse {
4873
- /** Payment gateway order id which is associated with given payment */
4874
- paymentGatewayOrderId?: string;
4875
- }
4876
- interface GetPaymentCollectabilityStatusRequest {
4803
+ status?: ChargebackStatusWithLiterals;
4877
4804
  /**
4878
- * Ecom order ID.
4879
- * @minLength 1
4880
- * @maxLength 100
4805
+ * External chargeback ID.
4806
+ * @format GUID
4807
+ * @readonly
4808
+ * @immutable
4881
4809
  */
4882
- ecomOrderId: string;
4883
- }
4884
- interface GetPaymentCollectabilityStatusResponse {
4885
- /** Payment collectability status */
4886
- status?: PaymentCollectabilityStatusWithLiterals;
4887
- /** Collectable order amount */
4888
- amount?: Price;
4810
+ externalId?: string | null;
4889
4811
  }
4890
- declare enum PaymentCollectabilityStatus {
4891
- UNKNOWN = "UNKNOWN",
4892
- COLLECTABLE = "COLLECTABLE",
4893
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4894
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4895
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4896
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4897
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4898
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4899
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4900
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4901
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4902
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4903
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4812
+ declare enum ChargebackStatus {
4813
+ /** Chargeback was approved. */
4814
+ APPROVED = "APPROVED",
4815
+ /** Chargeback was reversed. */
4816
+ REVERSED = "REVERSED"
4904
4817
  }
4905
4818
  /** @enumType */
4906
- type PaymentCollectabilityStatusWithLiterals = PaymentCollectabilityStatus | 'UNKNOWN' | 'COLLECTABLE' | 'NONCOLLECTABLE_ORDER_IS_CANCELLED' | 'NONCOLLECTABLE_ORDER_IS_PAID' | 'NONCOLLECTABLE_MISSING_PAYMENT_METHOD' | 'NONCOLLECTABLE_ORDER_IS_PENDING' | 'NONCOLLECTABLE_ORDER_IS_REJECTED' | 'NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS' | 'NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS' | 'NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED' | 'NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION' | 'NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED' | 'NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST';
4907
- interface RecordManuallyCollectedPaymentRequest {
4908
- /**
4909
- * Order ID.
4910
- * @minLength 1
4911
- * @maxLength 100
4912
- */
4913
- orderId: string;
4914
- /** Amount to be recorded as approved manual payment for given order */
4915
- amount: Price;
4916
- }
4917
- /**
4918
- * User-defined payment method name.
4919
- * Allows specifying either a predefined type or a custom name.
4920
- */
4921
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4922
- /** Predefined payment method. */
4923
- predefined?: PredefinedPaymentMethodWithLiterals;
4819
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4820
+ interface PaymentMethodName {
4924
4821
  /**
4925
- * Custom payment method name provided by user.
4926
- *
4927
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4928
- * @minLength 1
4822
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
4929
4823
  * @maxLength 150
4930
4824
  */
4931
- custom?: string | null;
4932
- }
4933
- /** @oneof */
4934
- interface UserDefinedPaymentMethodNameKindOneOf {
4935
- /** Predefined payment method. */
4936
- predefined?: PredefinedPaymentMethodWithLiterals;
4825
+ buyerLanguageName?: string | null;
4937
4826
  /**
4938
- * Custom payment method name provided by user.
4827
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
4939
4828
  *
4940
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4941
- * @minLength 1
4829
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
4942
4830
  * @maxLength 150
4943
4831
  */
4944
- custom?: string | null;
4945
- }
4946
- /** Predefined payment method types for offline/manual payments. */
4947
- declare enum PredefinedPaymentMethod {
4948
- /** Cash payment. */
4949
- CASH = "CASH",
4950
- /** Bank transfer. */
4951
- BANK_TRANSFER = "BANK_TRANSFER",
4952
- /** Payment by check. */
4953
- CHECK = "CHECK"
4954
- }
4955
- /** @enumType */
4956
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4957
- interface RecordManuallyCollectedPaymentResponse {
4958
- }
4959
- interface MarkOrderAsPaidRequest {
4832
+ siteLanguageName?: string | null;
4960
4833
  /**
4961
- * Ecom order ID.
4962
- * @minLength 1
4963
- * @maxLength 100
4834
+ * User-provided payment method name.
4835
+ *
4836
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
4964
4837
  */
4965
- ecomOrderId: string;
4966
- }
4967
- interface MarkOrderAsPaidResponse {
4968
- /** Updated order. */
4969
- order?: Order;
4838
+ userDefinedName?: UserDefinedPaymentMethodName;
4970
4839
  }
4971
- interface BulkMarkOrdersAsPaidRequest {
4840
+ interface GiftCardPaymentDetails {
4972
4841
  /**
4973
- * IDs of orders to mark as paid.
4974
- * @minSize 1
4975
- * @maxSize 100
4976
- * @minLength 1
4842
+ * Gift card payment ID.
4977
4843
  * @maxLength 100
4978
4844
  */
4979
- ecomOrderIds: string[];
4980
- }
4981
- interface BulkMarkOrdersAsPaidResponse {
4845
+ giftCardPaymentId?: string;
4982
4846
  /**
4983
- * Items updated by the bulk action.
4984
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4847
+ * ID of the app that created the gift card.
4848
+ * @format GUID
4985
4849
  */
4986
- results?: BulkOrderResult[];
4987
- /** Bulk action metadata. */
4988
- bulkActionMetadata?: BulkActionMetadata;
4989
- }
4990
- interface BulkOrderResult {
4991
- /** Item metadata. */
4992
- itemMetadata?: ItemMetadata;
4850
+ appId?: string;
4993
4851
  /**
4994
- * Updated order.
4995
- *
4996
- * Returned when `returnFullEntity = true`.
4997
- */
4998
- item?: Order;
4999
- }
5000
- interface ItemMetadata {
5001
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5002
- _id?: string | null;
5003
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5004
- originalIndex?: number;
5005
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5006
- success?: boolean;
5007
- /** Details about the error in case of failure. */
5008
- error?: ApplicationError;
5009
- }
5010
- interface ApplicationError {
5011
- /** Error code. */
5012
- code?: string;
5013
- /** Description of the error. */
5014
- description?: string;
5015
- /** Data related to the error. */
5016
- data?: Record<string, any> | null;
5017
- }
5018
- interface BulkActionMetadata {
5019
- /** Number of items that were successfully processed. */
5020
- totalSuccesses?: number;
5021
- /** Number of items that couldn't be processed. */
5022
- totalFailures?: number;
5023
- /** Number of failures without details because detailed failure threshold was exceeded. */
5024
- undetailedFailures?: number;
4852
+ * Whether the gift card is voided.
4853
+ * @readonly
4854
+ * @deprecated Whether the gift card is voided.
4855
+ * @replacedBy payment.status
4856
+ * @targetRemovalDate 2026-11-01
4857
+ */
4858
+ voided?: boolean;
4859
+ /**
4860
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
4861
+ * @maxLength 30
4862
+ * @immutable
4863
+ */
4864
+ obfuscatedCode?: string | null;
5025
4865
  }
5026
- interface GetRefundabilityStatusRequest {
4866
+ interface MembershipPaymentDetails {
5027
4867
  /**
5028
- * Order ID.
4868
+ * Membership ID.
4869
+ * @maxLength 200
4870
+ */
4871
+ membershipId?: string;
4872
+ /**
4873
+ * ID of the line item this membership applies to.
5029
4874
  * @minLength 1
5030
4875
  * @maxLength 100
5031
4876
  */
5032
- ecomOrderId: string;
5033
- }
5034
- interface GetRefundabilityStatusResponse {
4877
+ lineItemId?: string;
5035
4878
  /**
5036
- * Refundability details.
5037
- * @maxSize 300
4879
+ * Payment status.
4880
+ * @deprecated Payment status.
4881
+ * @replacedBy payment.status
4882
+ * @targetRemovalDate 2026-11-01
5038
4883
  */
5039
- refundabilities?: Refundability[];
4884
+ status?: MembershipPaymentStatusWithLiterals;
4885
+ /** Membership name. */
4886
+ name?: MembershipName;
5040
4887
  /**
5041
- * Whether the order supports refunding per item.
5042
- * @deprecated
4888
+ * The transaction ID in the membership system. Can be used to void the transaction.
4889
+ * @minLength 1
4890
+ * @maxLength 100
5043
4891
  */
5044
- refundablePerItem?: boolean;
5045
- }
5046
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5047
- /** Reason why payment is not refundable. */
5048
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5049
- /** Reason why payment is only refundable manually. */
5050
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5051
- /** Payment ID. */
5052
- paymentId?: string;
5053
- /** Payment refundability status. */
5054
- refundabilityStatus?: RefundableStatusWithLiterals;
5055
- /** Link to payment provider dashboard. */
5056
- providerLink?: string | null;
5057
- }
5058
- /** @oneof */
5059
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5060
- /** Reason why payment is not refundable. */
5061
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5062
- /** Reason why payment is only refundable manually. */
5063
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5064
- }
5065
- declare enum RefundableStatus {
5066
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5067
- MANUAL = "MANUAL",
5068
- REFUNDABLE = "REFUNDABLE"
5069
- }
5070
- /** @enumType */
5071
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5072
- declare enum NonRefundableReason {
5073
- NONE = "NONE",
5074
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5075
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5076
- INTERNAL_ERROR = "INTERNAL_ERROR",
5077
- NOT_PAID = "NOT_PAID",
5078
- ACCESS_DENIED = "ACCESS_DENIED",
5079
- ZERO_PRICE = "ZERO_PRICE",
5080
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5081
- PENDING_REFUND = "PENDING_REFUND",
5082
- FORBIDDEN = "FORBIDDEN",
5083
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5084
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5085
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4892
+ externalTransactionId?: string | null;
4893
+ /**
4894
+ * Whether the membership is voided.
4895
+ * @readonly
4896
+ * @deprecated Whether the membership is voided.
4897
+ * @replacedBy payment.status
4898
+ * @targetRemovalDate 2026-11-01
4899
+ */
4900
+ voided?: boolean;
4901
+ /**
4902
+ * ID of the application providing this payment option.
4903
+ * @format GUID
4904
+ */
4905
+ providerAppId?: string;
4906
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
4907
+ futureMembership?: FutureMembershipDetails;
5086
4908
  }
5087
- /** @enumType */
5088
- 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';
5089
- declare enum ManuallyRefundableReason {
5090
- EXPIRED = "EXPIRED",
5091
- NOT_SUPPORTED = "NOT_SUPPORTED",
5092
- OFFLINE = "OFFLINE",
5093
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4909
+ declare enum MembershipPaymentStatus {
4910
+ /** Payment was charged. */
4911
+ CHARGED = "CHARGED",
4912
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
4913
+ CHARGE_FAILED = "CHARGE_FAILED",
4914
+ /** Payment is pending. */
4915
+ CHARGE_PENDING = "CHARGE_PENDING",
4916
+ /** Payment was voided. */
4917
+ VOIDED = "VOIDED"
5094
4918
  }
5095
4919
  /** @enumType */
5096
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5097
- interface CreatePaymentGatewayOrderRequest {
4920
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
4921
+ interface FutureMembershipDetails {
5098
4922
  /**
5099
- * Ecom order ID.
5100
- * @minLength 1
5101
- * @maxLength 100
4923
+ * ID of the plan line item in the order from which the membership will be created.
4924
+ * @format GUID
5102
4925
  */
5103
- ecomOrderId: string;
5104
- /** Information about the user who initiated the payment. */
5105
- chargedBy?: ChargedBy;
4926
+ lineItemId?: string;
4927
+ /**
4928
+ * ID of the benefit the future membership will grant.
4929
+ * @maxLength 200
4930
+ */
4931
+ benefitId?: string;
5106
4932
  }
5107
- interface ChargedBy {
4933
+ interface WixReceiptInfo {
5108
4934
  /**
5109
- * ID - id of the user who initiated the payment
4935
+ * Receipt ID
5110
4936
  * @format GUID
5111
4937
  */
5112
- _id?: string;
4938
+ receiptId?: string;
5113
4939
  /**
5114
- * Full name - name of the user who initiated the payment
4940
+ * Display number of receipt
5115
4941
  * @minLength 1
5116
- * @maxLength 200
4942
+ * @maxLength 40
5117
4943
  */
5118
- fullName?: string | null;
5119
- }
5120
- interface CreatePaymentGatewayOrderResponse {
5121
- /** ID of the order created in the payment gateway */
5122
- paymentGatewayOrderId?: string;
4944
+ displayNumber?: string | null;
5123
4945
  }
5124
- interface ChargeMembershipsRequest {
4946
+ interface ExternalReceiptInfo {
5125
4947
  /**
5126
- * Order ID.
5127
- * @minLength 1
4948
+ * External receipt ID
5128
4949
  * @maxLength 100
5129
4950
  */
5130
- ecomOrderId: string;
4951
+ receiptId?: string | null;
5131
4952
  /**
5132
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5133
- * but a user which is using the membership on behalf of the a member
4953
+ * ID of the app providing the receipt
5134
4954
  * @format GUID
5135
4955
  */
5136
- memberId: string;
4956
+ appId?: string | null;
5137
4957
  /**
5138
- * List of items to be paid by memberships
5139
- * @minSize 1
5140
- * @maxSize 300
4958
+ * Display number of receipt
4959
+ * @minLength 1
4960
+ * @maxLength 40
5141
4961
  */
5142
- membershipCharges?: MembershipChargeItem[];
4962
+ displayNumber?: string | null;
5143
4963
  }
5144
- interface MembershipChargeItem {
4964
+ interface CashRoundingDetails {
5145
4965
  /**
5146
- * The id of used membership
5147
- * @minLength 1
5148
- * @maxLength 100
4966
+ * Payment amount before cash rounding was applied.
4967
+ * When provided, balance and status calculations use this value instead of `amount`
4968
+ * to prevent false overpayment or underpayment due to rounding.
5149
4969
  */
5150
- membershipId?: string;
4970
+ unroundedAmount?: Price;
5151
4971
  /**
5152
- * ID of the application providing this payment option
4972
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
4973
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
4974
+ * @readonly
4975
+ */
4976
+ roundingAdjustment?: CashRounding;
4977
+ }
4978
+ declare enum PaymentStatus {
4979
+ /** Payment was charged successfully. */
4980
+ APPROVED = "APPROVED",
4981
+ /** Payment is being processed and hasn't been confirmed yet. */
4982
+ PENDING = "PENDING",
4983
+ /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
4984
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4985
+ /** Payment was canceled before it was charged. */
4986
+ CANCELED = "CANCELED",
4987
+ /** Payment was declined by the payment provider. */
4988
+ DECLINED = "DECLINED",
4989
+ /** Payment was fully refunded. */
4990
+ REFUNDED = "REFUNDED",
4991
+ /** Part of the payment amount was refunded. */
4992
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4993
+ /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
4994
+ AUTHORIZED = "AUTHORIZED",
4995
+ /**
4996
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
4997
+ *
4998
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
4999
+ */
5000
+ VOIDED = "VOIDED"
5001
+ }
5002
+ /** @enumType */
5003
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5004
+ interface CanceledStatusDetails {
5005
+ reason?: CanceledReasonWithLiterals;
5006
+ }
5007
+ declare enum CanceledReason {
5008
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5009
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5010
+ /** Payment was not completed by user and expired. */
5011
+ EXPIRED = "EXPIRED"
5012
+ }
5013
+ /** @enumType */
5014
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5015
+ interface DeclinedStatusDetails {
5016
+ reason?: DeclinedReasonWithLiterals;
5017
+ }
5018
+ declare enum DeclinedReason {
5019
+ /** Corresponding charge failed. */
5020
+ CHARGE_FAILED = "CHARGE_FAILED",
5021
+ /** Payment details expired. */
5022
+ EXPIRED = "EXPIRED",
5023
+ /** Insufficient funds. */
5024
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5025
+ /** Gift card was disabled before charge was attempted. */
5026
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5027
+ }
5028
+ /** @enumType */
5029
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5030
+ interface VoidedStatusDetails {
5031
+ reason?: VoidedReasonWithLiterals;
5032
+ }
5033
+ declare enum VoidedReason {
5034
+ /** Payment was voided by merchant request. */
5035
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5036
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5037
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5038
+ }
5039
+ /** @enumType */
5040
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5041
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5042
+ }
5043
+ /** @oneof */
5044
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5045
+ }
5046
+ interface Refund {
5047
+ /**
5048
+ * Refund ID.
5153
5049
  * @format GUID
5050
+ * @readonly
5154
5051
  */
5155
- appId?: string;
5156
- /** The name of used membership */
5157
- membershipName?: MembershipName;
5158
- /** Additional data about this membership */
5159
- membershipAdditionalData?: Record<string, any> | null;
5160
- /** Catalog and item reference info. */
5161
- catalogReference?: CatalogReference;
5162
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5163
- serviceProperties?: ServiceProperties;
5052
+ _id?: string;
5164
5053
  /**
5165
- * Usually would be the same as catalogReference.catalogItemId
5166
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5167
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5168
- * @minLength 1
5169
- * @maxLength 36
5054
+ * List of transactions.
5055
+ * @maxSize 50
5170
5056
  */
5171
- rootCatalogItemId?: string | null;
5057
+ transactions?: RefundTransaction[];
5058
+ /** Refund business details. */
5059
+ details?: RefundDetails;
5172
5060
  /**
5173
- * line item id of Checkout/Order line item
5174
- * @minLength 1
5175
- * @maxLength 100
5061
+ * 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.
5062
+ * @readonly
5063
+ * @immutable
5176
5064
  */
5177
- lineItemId?: string;
5178
- }
5179
- interface MembershipName {
5065
+ _createdDate?: Date | null;
5180
5066
  /**
5181
- * Membership name in the site's original language.
5182
- * @maxLength 100
5067
+ * Aggregated refund summary.
5068
+ * @readonly
5183
5069
  */
5184
- original?: string;
5070
+ summary?: AggregatedRefundSummary;
5185
5071
  /**
5186
- * Membership name translated into the buyer's language.
5187
- *
5188
- * Default: The value of `original`
5189
- * @maxLength 100
5072
+ * ID of the app that initiated this refund.
5073
+ * @format GUID
5074
+ * @readonly
5075
+ * @immutable
5190
5076
  */
5191
- translated?: string | null;
5192
- }
5193
- interface ChargeMembershipsResponse {
5077
+ requestingServiceAppId?: string | null;
5194
5078
  }
5195
- interface TriggerRefundRequest {
5079
+ interface RefundTransaction {
5196
5080
  /**
5197
- * The order this refund related to
5198
- * @minLength 1
5199
- * @maxLength 100
5081
+ * ID of the payment associated with this refund.
5082
+ * @format GUID
5083
+ * @immutable
5200
5084
  */
5201
- ecomOrderId: string;
5085
+ paymentId?: string;
5202
5086
  /**
5203
- * Refund operations information
5204
- * @minSize 1
5205
- * @maxSize 1
5087
+ * Refund amount.
5088
+ * @immutable
5206
5089
  */
5207
- payments: PaymentRefund[];
5208
- /** Business model of a refund */
5209
- details?: RefundDetails;
5210
- /** Side effect details related to refund */
5211
- sideEffects?: RefundSideEffects;
5212
- }
5213
- interface PaymentRefund {
5090
+ amount?: Price;
5091
+ /** Refund status. */
5092
+ refundStatus?: RefundStatusWithLiterals;
5093
+ /** Optional details of current refund status. */
5094
+ refundStatusInfo?: RefundStatusInfo;
5214
5095
  /**
5215
- * Specific payment within the order to refund
5096
+ * Payment gateway's refund ID.
5097
+ * This field is only returned when the value of `external_refund` is `false`.
5216
5098
  * @format GUID
5217
5099
  */
5218
- paymentId?: string;
5219
- /** Refund amount. Not relevant for membership and gift card refunds. */
5220
- amount?: Price;
5100
+ gatewayRefundId?: string | null;
5101
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5102
+ providerRefundId?: string | null;
5221
5103
  /**
5222
- * Whether refund is made externally and manually (on the payment provider's side)
5223
- * 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.
5224
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5104
+ * Whether refund was made externally and manually on the payment provider's side.
5105
+ * @immutable
5225
5106
  */
5226
5107
  externalRefund?: boolean;
5227
5108
  }
5228
- interface RefundSideEffects {
5229
- /** Inventory restock details as part of this refund. */
5230
- restockInfo?: RestockInfo;
5231
- /** Whether to send a refund confirmation email to the customer. */
5232
- sendOrderRefundedEmail?: boolean;
5109
+ /** Refund transaction status. */
5110
+ declare enum RefundStatus {
5111
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5112
+ PENDING = "PENDING",
5113
+ /** Refund transaction succeeded. */
5114
+ SUCCEEDED = "SUCCEEDED",
5115
+ /** Refund transaction failed. */
5116
+ FAILED = "FAILED",
5117
+ /** Refund request acknowledged, and will be executed soon. */
5118
+ SCHEDULED = "SCHEDULED",
5119
+ /** Refund was initiated on payment provider side. */
5120
+ STARTED = "STARTED"
5121
+ }
5122
+ /** @enumType */
5123
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5124
+ interface RefundStatusInfo {
5233
5125
  /**
5234
- * Custom message added to the refund confirmation email.
5126
+ * Reason code for the refund's current status.
5127
+ *
5128
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5129
+ * @minLength 1
5130
+ * @maxLength 10
5131
+ */
5132
+ paymentGatewayReasonCode?: string | null;
5133
+ /**
5134
+ * Free text explanation of current refund status.
5235
5135
  * @minLength 1
5236
5136
  * @maxLength 1000
5237
5137
  */
5238
- customMessage?: string | null;
5138
+ description?: string | null;
5239
5139
  }
5240
- interface RestockInfo {
5241
- /** Restock type. */
5242
- type?: RestockTypeWithLiterals;
5140
+ interface AggregatedRefundSummary {
5141
+ /** Total amount requested for refund. */
5142
+ requestedRefund?: Price;
5143
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5144
+ pendingRefund?: Price;
5145
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5146
+ refunded?: Price;
5147
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
5148
+ failedRefundAmount?: Price;
5149
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
5150
+ pending?: boolean;
5151
+ /** Breakdown of refunded items. Available only after refund is complete. */
5152
+ breakdown?: RefundItemsBreakdown;
5153
+ }
5154
+ interface RefundItemsBreakdown {
5243
5155
  /**
5244
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5156
+ * Refunded line items and the amount refunded for each.
5245
5157
  * @maxSize 300
5246
5158
  */
5247
- items?: RestockItem[];
5248
- }
5249
- declare enum RestockType {
5250
- NO_ITEMS = "NO_ITEMS",
5251
- ALL_ITEMS = "ALL_ITEMS",
5252
- SOME_ITEMS = "SOME_ITEMS"
5159
+ lineItems?: LineItemRefundSummary[];
5253
5160
  }
5254
- /** @enumType */
5255
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5256
- interface RestockItem {
5161
+ interface LineItemRefundSummary {
5257
5162
  /**
5258
- * ID of the line item being restocked.
5163
+ * ID of the refunded line item.
5259
5164
  * @format GUID
5260
5165
  */
5261
5166
  lineItemId?: string;
5262
- /**
5263
- * Line item quantity being restocked.
5264
- * @min 1
5265
- * @max 100000
5266
- */
5267
- quantity?: number;
5268
- }
5269
- interface TriggerRefundResponse {
5270
- /** All order's transactions after the refunds were added */
5271
- orderTransactions?: OrderTransactions;
5272
- /** Created refund ID */
5273
- refundId?: string | null;
5274
- /** Payment ID's that the refund execution had failed for */
5275
- failedPaymentIds?: ItemMetadata[];
5167
+ /** Total refunded amount for the line item. */
5168
+ totalRefundedAmount?: Price;
5276
5169
  }
5277
- /**
5278
- * A record of all payments and refunds associated with an order.
5279
- *
5280
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5281
- */
5282
- interface OrderTransactions {
5283
- /**
5284
- * Order ID.
5285
- * @format GUID
5286
- */
5287
- orderId?: string;
5170
+ interface CalculateRefundRequest {
5288
5171
  /**
5289
- * Record of payments made to the merchant.
5290
- * @maxSize 100
5172
+ * Order ID
5173
+ * @minLength 1
5174
+ * @maxLength 100
5291
5175
  */
5292
- payments?: Payment[];
5176
+ ecomOrderId?: string;
5293
5177
  /**
5294
- * Record of refunds made to the buyer.
5178
+ * Refunded line items and quantity
5295
5179
  * @maxSize 300
5296
5180
  */
5297
- refunds?: Refund[];
5181
+ refundItems?: CalculateRefundItemRequest[];
5182
+ /** Should include shipping in refund calculation */
5183
+ refundShipping?: boolean;
5298
5184
  }
5299
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5300
- /** Regular payment details. */
5301
- regularPaymentDetails?: RegularPaymentDetails;
5302
- /** Gift card payment details. */
5303
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5304
- /** Membership payment details. */
5305
- membershipPaymentDetails?: MembershipPaymentDetails;
5185
+ interface CalculateRefundItemRequest {
5306
5186
  /**
5307
- * Payment ID.
5187
+ * ID of the line item being refunded
5308
5188
  * @format GUID
5309
- * @readonly
5310
- */
5311
- _id?: string | null;
5312
- /** 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. */
5313
- _createdDate?: Date | null;
5314
- /**
5315
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5316
- * @readonly
5317
- */
5318
- _updatedDate?: Date | null;
5319
- /** Payment amount. */
5320
- amount?: Price;
5321
- /**
5322
- * Whether refunds for this payment are disabled.
5323
- * + `true`: This payment is not refundable.
5324
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5325
5189
  */
5326
- refundDisabled?: boolean;
5327
- /**
5328
- * Whether receipt generation is allowed for this payment.
5329
- * + `true`: This payment supports receipt generation.
5330
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5331
- * @readonly
5332
- */
5333
- supportReceiptGeneration?: boolean;
5334
- /** Details about cash rounding applied to this payment, when relevant. */
5335
- cashRounding?: CashRoundingDetails;
5190
+ _id?: string;
5336
5191
  /**
5337
- * Overall payment status.
5338
- *
5339
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5192
+ * How much of that line item is being refunded
5193
+ * @min 1
5194
+ * @max 100000
5340
5195
  */
5341
- status?: PaymentStatusWithLiterals;
5196
+ quantity?: number;
5197
+ }
5198
+ interface CalculateRefundResponse {
5199
+ /** Total refundable amount */
5200
+ total?: Price;
5201
+ /** Tax cost of the order */
5202
+ tax?: Price;
5203
+ /** Discount given for this order */
5204
+ discount?: Price;
5205
+ /** Total cost of the order (without tax) */
5206
+ subtotal?: Price;
5207
+ /** Total shipping cost for order */
5208
+ shipping?: Price;
5209
+ /** Previous refund given on that order */
5210
+ previouslyRefundedAmount?: Price;
5342
5211
  /**
5343
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5344
- * @format GUID
5212
+ * The refundable items of that order
5213
+ * @maxSize 300
5345
5214
  */
5346
- chargeCorrelationId?: string | null;
5347
- }
5348
- /** @oneof */
5349
- interface PaymentPaymentDetailsOneOf {
5350
- /** Regular payment details. */
5351
- regularPaymentDetails?: RegularPaymentDetails;
5352
- /** Gift card payment details. */
5353
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5354
- /** Membership payment details. */
5355
- membershipPaymentDetails?: MembershipPaymentDetails;
5356
- }
5357
- /** @oneof */
5358
- interface PaymentReceiptInfoOneOf {
5359
- }
5360
- /** @oneof */
5361
- interface PaymentStatusDetailsOneOf {
5215
+ items?: CalculateRefundItemResponse[];
5362
5216
  }
5363
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5364
- /** Credit card details. */
5365
- creditCardDetails?: CreditCardPaymentMethodDetails;
5217
+ interface CalculateRefundItemResponse {
5366
5218
  /**
5367
- * Wix Payments order ID.
5368
- * @maxLength 100
5219
+ * Line item ID
5220
+ * @format GUID
5369
5221
  */
5370
- paymentOrderId?: string | null;
5222
+ _id?: string;
5223
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5224
+ price?: Price;
5225
+ }
5226
+ interface VoidAuthorizedPaymentsRequest {
5371
5227
  /**
5372
- * Payment gateway's transaction ID.
5373
- * This field is only returned when the value of `offline_payment` is `false`.
5228
+ * Wix eCommerce order ID
5229
+ * @minLength 1
5374
5230
  * @maxLength 100
5375
5231
  */
5376
- gatewayTransactionId?: string | null;
5232
+ ecomOrderId: string;
5377
5233
  /**
5378
- * Payment method.
5379
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5380
- * Non-exhaustive list of supported values:
5381
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5382
- * @maxLength 150
5383
- * @deprecated Payment method.
5384
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5385
- * Non-exhaustive list of supported values:
5386
- * + `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`
5387
- * @replacedBy payment_method_name
5388
- * @targetRemovalDate 2026-07-01
5234
+ * Payment IDs
5235
+ * @minSize 1
5236
+ * @maxSize 100
5237
+ * @format GUID
5389
5238
  */
5390
- paymentMethod?: string | null;
5239
+ paymentIds: string[];
5240
+ }
5241
+ interface VoidAuthorizedPaymentsResponse {
5242
+ /** All order's transactions after the void was triggered */
5243
+ orderTransactions?: OrderTransactions;
5244
+ }
5245
+ interface CaptureAuthorizedPaymentsRequest {
5391
5246
  /**
5392
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5247
+ * Wix eCommerce order ID
5248
+ * @minLength 1
5393
5249
  * @maxLength 100
5394
5250
  */
5395
- providerTransactionId?: string | null;
5396
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5397
- offlinePayment?: boolean;
5251
+ ecomOrderId: string;
5398
5252
  /**
5399
- * Payment status.
5400
- * @deprecated Payment status.
5401
- * @replacedBy payment.status
5402
- * @targetRemovalDate 2026-11-01
5253
+ * Capture payments information
5254
+ * @minSize 1
5255
+ * @maxSize 100
5403
5256
  */
5404
- status?: TransactionStatusWithLiterals;
5405
- /** Whether there is a payment agreement that allows for future charges. */
5406
- savedPaymentMethod?: boolean;
5407
- /** Authorization details. */
5408
- authorizationDetails?: AuthorizationDetails;
5257
+ payments: PaymentCapture[];
5258
+ }
5259
+ interface PaymentCapture {
5409
5260
  /**
5410
- * Record of chargebacks made by the buyer.
5411
- * @maxSize 6
5261
+ * Payment ID
5262
+ * @format GUID
5412
5263
  */
5413
- chargebacks?: Chargeback[];
5414
- /** Platform fee amount associated with this payment. */
5415
- platformFee?: Price;
5264
+ paymentId?: string | null;
5416
5265
  /**
5417
- * Payment method with buyer and optional owner translations.
5418
- * Non-exhaustive list of supported values:
5419
- * + `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`
5266
+ * Capture amount.
5267
+ * If not provided - full authorized amount will be captured.
5420
5268
  */
5421
- paymentMethodName?: PaymentMethodName;
5422
- }
5423
- /** @oneof */
5424
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5425
- /** Credit card details. */
5426
- creditCardDetails?: CreditCardPaymentMethodDetails;
5269
+ amount?: Price;
5427
5270
  }
5428
- declare enum TransactionStatus {
5429
- UNDEFINED = "UNDEFINED",
5430
- APPROVED = "APPROVED",
5431
- PENDING = "PENDING",
5432
- PENDING_MERCHANT = "PENDING_MERCHANT",
5433
- CANCELED = "CANCELED",
5434
- DECLINED = "DECLINED",
5435
- REFUNDED = "REFUNDED",
5436
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5437
- AUTHORIZED = "AUTHORIZED",
5438
- VOIDED = "VOIDED"
5271
+ interface CaptureAuthorizedPaymentsResponse {
5272
+ /** All order's transactions after the capture was triggered */
5273
+ orderTransactions?: OrderTransactions;
5439
5274
  }
5440
- /** @enumType */
5441
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5442
- interface CreditCardPaymentMethodDetails {
5443
- /**
5444
- * The last 4 digits of the card number.
5445
- * @maxLength 4
5446
- */
5447
- lastFourDigits?: string | null;
5275
+ interface ChargeSavedPaymentMethodRequest {
5448
5276
  /**
5449
- * Card issuer's brand.
5277
+ * Ecom Order ID.
5278
+ * @minLength 1
5450
5279
  * @maxLength 100
5451
5280
  */
5452
- brand?: string | null;
5281
+ ecomOrderId?: string;
5282
+ /** Amount to be charged */
5283
+ amount?: Price;
5453
5284
  }
5454
- interface AuthorizationDetails {
5455
- /**
5456
- * Whether the authorized payment is of a delayed capture.
5457
- * @readonly
5458
- */
5459
- delayedCapture?: boolean;
5460
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5461
- authorizedDate?: Date | null;
5285
+ interface ChargeSavedPaymentMethodResponse {
5286
+ /** Payment gateway's order ID (e.g Wix Payments) */
5287
+ paymentGatewayOrderId?: string;
5288
+ }
5289
+ interface SendBuyerConfirmationEmailRequest {
5290
+ /** @format GUID */
5291
+ orderId?: string;
5292
+ }
5293
+ interface SendBuyerConfirmationEmailResponse {
5294
+ }
5295
+ interface SendBuyerPaymentsReceivedEmailRequest {
5462
5296
  /**
5463
- * List of captures associated with payment
5464
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5465
- * @maxSize 1
5297
+ * @minLength 1
5298
+ * @maxLength 100
5466
5299
  */
5467
- captures?: AuthorizationCapture[];
5468
- /** Void associated with payment */
5469
- void?: AuthorizationVoid;
5470
- /** Scheduled action for this transaction */
5471
- scheduledAction?: V1ScheduledAction;
5300
+ orderId?: string;
5472
5301
  }
5473
- interface AuthorizationCapture {
5302
+ interface SendBuyerPaymentsReceivedEmailResponse {
5303
+ }
5304
+ interface SendBuyerPickupConfirmationEmailRequest {
5474
5305
  /**
5475
- * Capture ID.
5476
- * @format GUID
5477
- * @readonly
5306
+ * @minLength 1
5307
+ * @maxLength 100
5478
5308
  */
5479
- _id?: string | null;
5480
- /** Status of this capture action */
5481
- status?: AuthorizationCaptureStatusWithLiterals;
5309
+ orderId?: string;
5310
+ }
5311
+ interface SendBuyerPickupConfirmationEmailResponse {
5312
+ }
5313
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
5482
5314
  /**
5483
- * Amount of this capture
5484
- * @immutable
5315
+ * IDs of orders to send pickup emails for.
5316
+ * @minSize 1
5317
+ * @maxSize 300
5485
5318
  */
5486
- amount?: Price;
5487
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5488
- _createdDate?: Date | null;
5489
- /** In case of status is FAILED may contain failure details */
5490
- failureDetails?: AuthorizationActionFailureDetails;
5319
+ orderIds?: string[];
5491
5320
  }
5492
- declare enum AuthorizationCaptureStatus {
5493
- /** Capture operation still in progress. */
5494
- PENDING = "PENDING",
5495
- /** Capture operation succeeded. */
5496
- SUCCEEDED = "SUCCEEDED",
5497
- /** Capture operation failed. */
5498
- FAILED = "FAILED"
5321
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
5499
5322
  }
5500
- /** @enumType */
5501
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5502
- interface AuthorizationActionFailureDetails {
5503
- /** @maxLength 100 */
5504
- failureCode?: string;
5323
+ interface SendBuyerShippingConfirmationEmailRequest {
5324
+ /**
5325
+ * @minLength 1
5326
+ * @maxLength 100
5327
+ */
5328
+ orderId?: string;
5505
5329
  }
5506
- interface AuthorizationVoid {
5507
- /** Status of this void action */
5508
- status?: AuthorizationVoidStatusWithLiterals;
5509
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5510
- voidedDate?: Date | null;
5511
- /** In case of status is FAILED may contain failure details */
5512
- failureDetails?: AuthorizationActionFailureDetails;
5513
- /** Reason of void action */
5514
- reason?: ReasonWithLiterals;
5330
+ interface SendBuyerShippingConfirmationEmailResponse {
5515
5331
  }
5516
- declare enum AuthorizationVoidStatus {
5517
- /** Void operation still in progress. */
5518
- PENDING = "PENDING",
5519
- /** Void operation succeeded. */
5520
- SUCCEEDED = "SUCCEEDED",
5521
- /** Void operation failed. */
5522
- FAILED = "FAILED"
5332
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
5333
+ /**
5334
+ * IDs of orders to send pickup emails for.
5335
+ * @minSize 1
5336
+ * @maxSize 300
5337
+ */
5338
+ orderIds?: string[];
5523
5339
  }
5524
- /** @enumType */
5525
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5526
- /** Reason the authorization was voided. */
5527
- declare enum Reason {
5528
- /** Authorization was voided by user. */
5529
- MANUAL = "MANUAL",
5530
- /** Authorization passed execution date. */
5531
- SCHEDULED = "SCHEDULED"
5340
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
5532
5341
  }
5533
- /** @enumType */
5534
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5535
- interface V1ScheduledAction {
5536
- /** Type of the action. */
5537
- actionType?: ActionTypeWithLiterals;
5538
- /** The date and time of the action. */
5539
- executionDate?: Date | null;
5342
+ interface SendMerchantOrderReceivedNotificationRequest {
5343
+ /**
5344
+ * @minLength 1
5345
+ * @maxLength 100
5346
+ */
5347
+ orderId?: string;
5540
5348
  }
5541
- declare enum ActionType {
5542
- VOID = "VOID",
5543
- CAPTURE = "CAPTURE"
5349
+ interface SendMerchantOrderReceivedNotificationResponse {
5544
5350
  }
5545
- /** @enumType */
5546
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5547
- interface Chargeback {
5351
+ interface SendCancelRefundEmailRequest {
5548
5352
  /**
5549
- * Chargeback ID.
5550
- * @format GUID
5551
- * @readonly
5552
- * @immutable
5353
+ * The ID of order that is canceled/refunded
5354
+ * @minLength 1
5355
+ * @maxLength 100
5553
5356
  */
5554
- _id?: string;
5357
+ orderId?: string;
5555
5358
  /**
5556
- * 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.
5557
- * @readonly
5558
- * @immutable
5359
+ * Personal note added to the email (optional)
5360
+ * @minLength 1
5361
+ * @maxLength 1000
5559
5362
  */
5560
- _createdDate?: Date | null;
5363
+ customMessage?: string | null;
5364
+ /** Refund amount */
5365
+ refundAmount?: Price;
5561
5366
  /**
5562
- * 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.
5563
- * @readonly
5367
+ * Refund ID. (Optional)
5368
+ * @format GUID
5564
5369
  */
5565
- _updatedDate?: Date | null;
5370
+ refundId?: string | null;
5371
+ }
5372
+ interface SendCancelRefundEmailResponse {
5373
+ }
5374
+ interface SendRefundEmailRequest {
5566
5375
  /**
5567
- * Amount.
5568
- * @readonly
5569
- * @immutable
5376
+ * The ID of order that is refunded
5377
+ * @format GUID
5570
5378
  */
5571
- amount?: Price;
5379
+ orderId?: string;
5572
5380
  /**
5573
- * Reversal amount. Present only when status is REVERSED.
5574
- * @readonly
5381
+ * Refund ID
5382
+ * @format GUID
5575
5383
  */
5576
- reversalAmount?: Price;
5384
+ refundId?: string;
5577
5385
  /**
5578
- * Status.
5579
- *
5580
- * Default: `"APPROVED"`.
5386
+ * Personal note added to the email (optional)
5387
+ * @minLength 1
5388
+ * @maxLength 1000
5581
5389
  */
5582
- status?: ChargebackStatusWithLiterals;
5390
+ customMessage?: string | null;
5391
+ }
5392
+ interface SendRefundEmailResponse {
5393
+ }
5394
+ interface SendFulfillmentEmailRequest {
5395
+ /** @format GUID */
5396
+ orderId?: string;
5397
+ /** @format GUID */
5398
+ fulfillerId?: string;
5399
+ }
5400
+ interface SendFulfillmentEmailResponse {
5401
+ }
5402
+ interface SendMerchantOrderReceivedPushRequest {
5583
5403
  /**
5584
- * External chargeback ID.
5585
- * @format GUID
5586
- * @readonly
5587
- * @immutable
5404
+ * @minLength 1
5405
+ * @maxLength 100
5588
5406
  */
5589
- externalId?: string | null;
5407
+ orderId?: string;
5590
5408
  }
5591
- declare enum ChargebackStatus {
5592
- /** Chargeback was approved. */
5593
- APPROVED = "APPROVED",
5594
- /** Chargeback was reversed. */
5595
- REVERSED = "REVERSED"
5409
+ interface SendMerchantOrderReceivedPushResponse {
5410
+ }
5411
+ interface PreviewEmailByTypeRequest {
5412
+ emailType?: PreviewEmailTypeWithLiterals;
5413
+ }
5414
+ declare enum PreviewEmailType {
5415
+ ORDER_PLACED = "ORDER_PLACED",
5416
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5417
+ ORDER_SHIPPED = "ORDER_SHIPPED",
5418
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5596
5419
  }
5597
5420
  /** @enumType */
5598
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5599
- interface PaymentMethodName {
5421
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5422
+ interface PreviewEmailByTypeResponse {
5423
+ emailPreview?: string;
5424
+ }
5425
+ interface PreviewRefundEmailRequest {
5600
5426
  /**
5601
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5602
- * @maxLength 150
5427
+ * @minLength 1
5428
+ * @maxLength 100
5603
5429
  */
5604
- buyerLanguageName?: string | null;
5430
+ orderId?: string;
5431
+ /** Refund amount */
5432
+ refundAmount?: Price;
5433
+ /** Refund business details */
5434
+ details?: RefundDetails;
5605
5435
  /**
5606
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5607
- *
5608
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5609
- * @maxLength 150
5436
+ * Personal note added to the email (optional)
5437
+ * @minLength 1
5438
+ * @maxLength 1000
5610
5439
  */
5611
- siteLanguageName?: string | null;
5440
+ customMessage?: string | null;
5612
5441
  /**
5613
- * User-provided payment method name.
5614
- *
5615
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5442
+ * Refund ID. (Optional)
5443
+ * @format GUID
5616
5444
  */
5617
- userDefinedName?: UserDefinedPaymentMethodName;
5445
+ refundId?: string | null;
5618
5446
  }
5619
- interface GiftCardPaymentDetails {
5447
+ interface PreviewRefundEmailResponse {
5448
+ emailPreview?: string;
5449
+ }
5450
+ interface PreviewCancelEmailRequest {
5620
5451
  /**
5621
- * Gift card payment ID.
5452
+ * @minLength 1
5622
5453
  * @maxLength 100
5623
5454
  */
5624
- giftCardPaymentId?: string;
5455
+ orderId?: string;
5625
5456
  /**
5626
- * ID of the app that created the gift card.
5627
- * @format GUID
5457
+ * Personal note added to the email (optional)
5458
+ * @minLength 1
5459
+ * @maxLength 1000
5628
5460
  */
5629
- appId?: string;
5461
+ customMessage?: string | null;
5462
+ }
5463
+ interface PreviewCancelEmailResponse {
5464
+ emailPreview?: string;
5465
+ }
5466
+ interface PreviewCancelRefundEmailRequest {
5630
5467
  /**
5631
- * Whether the gift card is voided.
5632
- * @readonly
5633
- * @deprecated Whether the gift card is voided.
5634
- * @replacedBy payment.status
5635
- * @targetRemovalDate 2026-11-01
5468
+ * @minLength 1
5469
+ * @maxLength 100
5636
5470
  */
5637
- voided?: boolean;
5471
+ orderId?: string;
5638
5472
  /**
5639
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5640
- * @maxLength 30
5641
- * @immutable
5473
+ * Personal note added to the email (optional)
5474
+ * @minLength 1
5475
+ * @maxLength 1000
5642
5476
  */
5643
- obfuscatedCode?: string | null;
5477
+ customMessage?: string | null;
5478
+ /** Refund amount */
5479
+ refundAmount?: Price;
5480
+ /**
5481
+ * Refund ID. (Optional)
5482
+ * @format GUID
5483
+ */
5484
+ refundId?: string | null;
5644
5485
  }
5645
- interface MembershipPaymentDetails {
5486
+ interface PreviewCancelRefundEmailResponse {
5487
+ emailPreview?: string;
5488
+ }
5489
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5490
+ }
5491
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5492
+ emailPreview?: string;
5493
+ }
5494
+ interface PreviewBuyerConfirmationEmailRequest {
5495
+ }
5496
+ interface PreviewBuyerConfirmationEmailResponse {
5497
+ emailPreview?: string;
5498
+ }
5499
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5500
+ }
5501
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5502
+ emailPreview?: string;
5503
+ }
5504
+ interface PreviewShippingConfirmationEmailRequest {
5505
+ }
5506
+ interface PreviewShippingConfirmationEmailResponse {
5507
+ emailPreview?: string;
5508
+ }
5509
+ interface PreviewResendDownloadLinksEmailRequest {
5510
+ }
5511
+ interface PreviewResendDownloadLinksEmailResponse {
5512
+ emailPreview?: string;
5513
+ }
5514
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5515
+ /** Emitted on a meta site creation. */
5516
+ siteCreated?: SiteCreated;
5517
+ /** Emitted on a meta site transfer completion. */
5518
+ siteTransferred?: SiteTransferred;
5519
+ /** Emitted on a meta site deletion. */
5520
+ siteDeleted?: SiteDeleted;
5521
+ /** Emitted on a meta site restoration. */
5522
+ siteUndeleted?: SiteUndeleted;
5523
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5524
+ sitePublished?: SitePublished;
5525
+ /** Emitted on a meta site unpublish. */
5526
+ siteUnpublished?: SiteUnpublished;
5527
+ /** Emitted when meta site is marked as template. */
5528
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5529
+ /** Emitted when meta site is marked as a WixSite. */
5530
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5531
+ /** Emitted when an application is provisioned (installed). */
5532
+ serviceProvisioned?: ServiceProvisioned;
5533
+ /** Emitted when an application is removed (uninstalled). */
5534
+ serviceRemoved?: ServiceRemoved;
5535
+ /** Emitted when meta site name (URL slug) is changed. */
5536
+ siteRenamedPayload?: SiteRenamed;
5537
+ /** Emitted when meta site was permanently deleted. */
5538
+ hardDeleted?: SiteHardDeleted;
5539
+ /** Emitted on a namespace change. */
5540
+ namespaceChanged?: NamespaceChanged;
5541
+ /** Emitted when Studio is attached. */
5542
+ studioAssigned?: StudioAssigned;
5543
+ /** Emitted when Studio is detached. */
5544
+ studioUnassigned?: StudioUnassigned;
5646
5545
  /**
5647
- * Membership ID.
5648
- * @maxLength 200
5546
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5547
+ * the actual URL.
5548
+ *
5549
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5550
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5649
5551
  */
5650
- membershipId?: string;
5552
+ urlChanged?: SiteUrlChanged;
5553
+ /** Site is marked as PurgedExternally */
5554
+ sitePurgedExternally?: SitePurgedExternally;
5555
+ /** Emitted when Odeditor is attached. */
5556
+ odeditorAssigned?: OdeditorAssigned;
5557
+ /** Emitted when Odeditor is detached. */
5558
+ odeditorUnassigned?: OdeditorUnassigned;
5559
+ /** Emitted when Picasso is attached. */
5560
+ picassoAssigned?: PicassoAssigned;
5561
+ /** Emitted when Picasso is detached. */
5562
+ picassoUnassigned?: PicassoUnassigned;
5563
+ /** Emitted when Wixel is attached. */
5564
+ wixelAssigned?: WixelAssigned;
5565
+ /** Emitted when Wixel is detached. */
5566
+ wixelUnassigned?: WixelUnassigned;
5567
+ /** Emitted when StudioTwo is attached. */
5568
+ studioTwoAssigned?: StudioTwoAssigned;
5569
+ /** Emitted when StudioTwo is detached. */
5570
+ studioTwoUnassigned?: StudioTwoUnassigned;
5571
+ /** Emitted when media from user domain is enabled. */
5572
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5573
+ /** Emitted when media from user domain is disabled. */
5574
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5575
+ /** Emitted when Editorless is attached. */
5576
+ editorlessAssigned?: EditorlessAssigned;
5577
+ /** Emitted when Editorless is detached. */
5578
+ editorlessUnassigned?: EditorlessUnassigned;
5651
5579
  /**
5652
- * ID of the line item this membership applies to.
5653
- * @minLength 1
5654
- * @maxLength 100
5580
+ * A meta site id.
5581
+ * @format GUID
5655
5582
  */
5656
- lineItemId?: string;
5583
+ metaSiteId?: string;
5584
+ /** A meta site version. Monotonically increasing. */
5585
+ version?: string;
5586
+ /** A timestamp of the event. */
5587
+ timestamp?: string;
5657
5588
  /**
5658
- * Payment status.
5659
- * @deprecated Payment status.
5660
- * @replacedBy payment.status
5661
- * @targetRemovalDate 2026-11-01
5589
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5590
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5591
+ * @maxSize 4000
5662
5592
  */
5663
- status?: MembershipPaymentStatusWithLiterals;
5664
- /** Membership name. */
5665
- name?: MembershipName;
5593
+ assets?: Asset[];
5594
+ }
5595
+ /** @oneof */
5596
+ interface MetaSiteSpecialEventPayloadOneOf {
5597
+ /** Emitted on a meta site creation. */
5598
+ siteCreated?: SiteCreated;
5599
+ /** Emitted on a meta site transfer completion. */
5600
+ siteTransferred?: SiteTransferred;
5601
+ /** Emitted on a meta site deletion. */
5602
+ siteDeleted?: SiteDeleted;
5603
+ /** Emitted on a meta site restoration. */
5604
+ siteUndeleted?: SiteUndeleted;
5605
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5606
+ sitePublished?: SitePublished;
5607
+ /** Emitted on a meta site unpublish. */
5608
+ siteUnpublished?: SiteUnpublished;
5609
+ /** Emitted when meta site is marked as template. */
5610
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5611
+ /** Emitted when meta site is marked as a WixSite. */
5612
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5613
+ /** Emitted when an application is provisioned (installed). */
5614
+ serviceProvisioned?: ServiceProvisioned;
5615
+ /** Emitted when an application is removed (uninstalled). */
5616
+ serviceRemoved?: ServiceRemoved;
5617
+ /** Emitted when meta site name (URL slug) is changed. */
5618
+ siteRenamedPayload?: SiteRenamed;
5619
+ /** Emitted when meta site was permanently deleted. */
5620
+ hardDeleted?: SiteHardDeleted;
5621
+ /** Emitted on a namespace change. */
5622
+ namespaceChanged?: NamespaceChanged;
5623
+ /** Emitted when Studio is attached. */
5624
+ studioAssigned?: StudioAssigned;
5625
+ /** Emitted when Studio is detached. */
5626
+ studioUnassigned?: StudioUnassigned;
5666
5627
  /**
5667
- * The transaction ID in the membership system. Can be used to void the transaction.
5668
- * @minLength 1
5669
- * @maxLength 100
5628
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5629
+ * the actual URL.
5630
+ *
5631
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5632
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5670
5633
  */
5671
- externalTransactionId?: string | null;
5634
+ urlChanged?: SiteUrlChanged;
5635
+ /** Site is marked as PurgedExternally */
5636
+ sitePurgedExternally?: SitePurgedExternally;
5637
+ /** Emitted when Odeditor is attached. */
5638
+ odeditorAssigned?: OdeditorAssigned;
5639
+ /** Emitted when Odeditor is detached. */
5640
+ odeditorUnassigned?: OdeditorUnassigned;
5641
+ /** Emitted when Picasso is attached. */
5642
+ picassoAssigned?: PicassoAssigned;
5643
+ /** Emitted when Picasso is detached. */
5644
+ picassoUnassigned?: PicassoUnassigned;
5645
+ /** Emitted when Wixel is attached. */
5646
+ wixelAssigned?: WixelAssigned;
5647
+ /** Emitted when Wixel is detached. */
5648
+ wixelUnassigned?: WixelUnassigned;
5649
+ /** Emitted when StudioTwo is attached. */
5650
+ studioTwoAssigned?: StudioTwoAssigned;
5651
+ /** Emitted when StudioTwo is detached. */
5652
+ studioTwoUnassigned?: StudioTwoUnassigned;
5653
+ /** Emitted when media from user domain is enabled. */
5654
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5655
+ /** Emitted when media from user domain is disabled. */
5656
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5657
+ /** Emitted when Editorless is attached. */
5658
+ editorlessAssigned?: EditorlessAssigned;
5659
+ /** Emitted when Editorless is detached. */
5660
+ editorlessUnassigned?: EditorlessUnassigned;
5661
+ }
5662
+ interface Asset {
5672
5663
  /**
5673
- * Whether the membership is voided.
5674
- * @readonly
5675
- * @deprecated Whether the membership is voided.
5676
- * @replacedBy payment.status
5677
- * @targetRemovalDate 2026-11-01
5664
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5665
+ * @maxLength 36
5678
5666
  */
5679
- voided?: boolean;
5667
+ appDefId?: string;
5680
5668
  /**
5681
- * ID of the application providing this payment option.
5682
- * @format GUID
5669
+ * An instance id. For legacy reasons may be UUID or a string.
5670
+ * @maxLength 200
5683
5671
  */
5684
- providerAppId?: string;
5685
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5686
- futureMembership?: FutureMembershipDetails;
5672
+ instanceId?: string;
5673
+ /** An application state. */
5674
+ state?: StateWithLiterals;
5687
5675
  }
5688
- declare enum MembershipPaymentStatus {
5689
- /** Payment was charged. */
5690
- CHARGED = "CHARGED",
5691
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5692
- CHARGE_FAILED = "CHARGE_FAILED",
5693
- /** Payment is pending. */
5694
- CHARGE_PENDING = "CHARGE_PENDING",
5695
- /** Payment was voided. */
5696
- VOIDED = "VOIDED"
5676
+ declare enum State {
5677
+ UNKNOWN = "UNKNOWN",
5678
+ ENABLED = "ENABLED",
5679
+ DISABLED = "DISABLED",
5680
+ PENDING = "PENDING",
5681
+ DEMO = "DEMO"
5697
5682
  }
5698
5683
  /** @enumType */
5699
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5700
- interface FutureMembershipDetails {
5684
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5685
+ interface SiteCreated {
5701
5686
  /**
5702
- * ID of the plan line item in the order from which the membership will be created.
5703
- * @format GUID
5687
+ * A template identifier (empty if not created from a template).
5688
+ * @maxLength 36
5704
5689
  */
5705
- lineItemId?: string;
5690
+ originTemplateId?: string;
5706
5691
  /**
5707
- * ID of the benefit the future membership will grant.
5708
- * @maxLength 200
5692
+ * An account id of the owner.
5693
+ * @format GUID
5709
5694
  */
5710
- benefitId?: string;
5711
- }
5712
- interface WixReceiptInfo {
5695
+ ownerId?: string;
5696
+ /** A context in which meta site was created. */
5697
+ context?: SiteCreatedContextWithLiterals;
5713
5698
  /**
5714
- * Receipt ID
5699
+ * A meta site id from which this site was created.
5700
+ *
5701
+ * In case of a creation from a template it's a template id.
5702
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5715
5703
  * @format GUID
5716
5704
  */
5717
- receiptId?: string;
5705
+ originMetaSiteId?: string | null;
5718
5706
  /**
5719
- * Display number of receipt
5720
- * @minLength 1
5721
- * @maxLength 40
5707
+ * A meta site name (URL slug).
5708
+ * @maxLength 20
5722
5709
  */
5723
- displayNumber?: string | null;
5710
+ siteName?: string;
5711
+ /** A namespace. */
5712
+ namespace?: NamespaceWithLiterals;
5724
5713
  }
5725
- interface ExternalReceiptInfo {
5714
+ declare enum SiteCreatedContext {
5715
+ /** A valid option, we don't expose all reasons why site might be created. */
5716
+ OTHER = "OTHER",
5717
+ /** A meta site was created from template. */
5718
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5719
+ /** A meta site was created by copying of the transfferred meta site. */
5720
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5721
+ /** A copy of existing meta site. */
5722
+ DUPLICATE = "DUPLICATE",
5723
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5724
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5725
+ /** deprecated A meta site was created for Flash editor. */
5726
+ FLASH = "FLASH"
5727
+ }
5728
+ /** @enumType */
5729
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5730
+ declare enum Namespace {
5731
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5732
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5733
+ WIX = "WIX",
5734
+ /** 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. */
5735
+ SHOUT_OUT = "SHOUT_OUT",
5736
+ /** 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. */
5737
+ ALBUMS = "ALBUMS",
5738
+ /** 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. */
5739
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5740
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5741
+ HOTELS = "HOTELS",
5742
+ /** 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. */
5743
+ CLUBS = "CLUBS",
5744
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5745
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5726
5746
  /**
5727
- * External receipt ID
5728
- * @maxLength 100
5747
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5748
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5729
5749
  */
5730
- receiptId?: string | null;
5750
+ DEV_SITE = "DEV_SITE",
5751
+ /** 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. */
5752
+ LOGOS = "LOGOS",
5753
+ /** 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. */
5754
+ VIDEO_MAKER = "VIDEO_MAKER",
5755
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5756
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5757
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5758
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5731
5759
  /**
5732
- * ID of the app providing the receipt
5733
- * @format GUID
5760
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5761
+ *
5762
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5734
5763
  */
5735
- appId?: string | null;
5764
+ HTML_DRAFT = "HTML_DRAFT",
5736
5765
  /**
5737
- * Display number of receipt
5738
- * @minLength 1
5739
- * @maxLength 40
5766
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5767
+ * Will be accessible from Site List and will not have a website app.
5768
+ * Once the user attaches a site, the site will become a regular wixsite.
5740
5769
  */
5741
- displayNumber?: string | null;
5742
- }
5743
- interface CashRoundingDetails {
5770
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5771
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5772
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5773
+ /** It is to be used in the Business First efforts. */
5774
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5775
+ /** Bookings business flow with no site. */
5776
+ ANYWHERE = "ANYWHERE",
5777
+ /** Namespace for Headless Backoffice with no editor */
5778
+ HEADLESS = "HEADLESS",
5744
5779
  /**
5745
- * Payment amount before cash rounding was applied.
5746
- * When provided, balance and status calculations use this value instead of `amount`
5747
- * to prevent false overpayment or underpayment due to rounding.
5780
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5781
+ * The site will be used for account level CSM feature for enterprise
5748
5782
  */
5749
- unroundedAmount?: Price;
5783
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5784
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5785
+ RISE = "RISE",
5750
5786
  /**
5751
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5752
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5753
- * @readonly
5787
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5788
+ * There's a blank site behind the scene but it's blank).
5789
+ * The Mobile company will be the owner of this namespace.
5754
5790
  */
5755
- roundingAdjustment?: CashRounding;
5756
- }
5757
- declare enum PaymentStatus {
5758
- /** Payment was charged successfully. */
5759
- APPROVED = "APPROVED",
5760
- /** Payment is being processed and hasn't been confirmed yet. */
5761
- PENDING = "PENDING",
5762
- /** Payment is awaiting confirmation. For an offline payment, the merchant must confirm they received it. For an online payment, the payment provider hasn't confirmed it, which typically means the merchant's provider account setup isn't complete. */
5763
- PENDING_MERCHANT = "PENDING_MERCHANT",
5764
- /** Payment was canceled before it was charged. */
5765
- CANCELED = "CANCELED",
5766
- /** Payment was declined by the payment provider. */
5767
- DECLINED = "DECLINED",
5768
- /** Payment was fully refunded. */
5769
- REFUNDED = "REFUNDED",
5770
- /** Part of the payment amount was refunded. */
5771
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5772
- /** Funds are held on the buyer's payment method but haven't been captured. Capture them with [Capture Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/capture-authorized-payments) or release them with [Void Authorized Payments](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/orders/order-billing/void-authorized-payments). An authorized payment can't be refunded until it's captured. */
5773
- AUTHORIZED = "AUTHORIZED",
5791
+ BRANDED_FIRST = "BRANDED_FIRST",
5792
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5793
+ NOWNIA = "NOWNIA",
5774
5794
  /**
5775
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5776
- *
5777
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5795
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5796
+ * The Partners company owns this namespace.
5778
5797
  */
5779
- VOIDED = "VOIDED"
5780
- }
5781
- /** @enumType */
5782
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5783
- interface CanceledStatusDetails {
5784
- reason?: CanceledReasonWithLiterals;
5785
- }
5786
- declare enum CanceledReason {
5787
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5788
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5789
- /** Payment was not completed by user and expired. */
5790
- EXPIRED = "EXPIRED"
5791
- }
5792
- /** @enumType */
5793
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5794
- interface DeclinedStatusDetails {
5795
- reason?: DeclinedReasonWithLiterals;
5796
- }
5797
- declare enum DeclinedReason {
5798
- /** Corresponding charge failed. */
5799
- CHARGE_FAILED = "CHARGE_FAILED",
5800
- /** Payment details expired. */
5801
- EXPIRED = "EXPIRED",
5802
- /** Insufficient funds. */
5803
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5804
- /** Gift card was disabled before charge was attempted. */
5805
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5806
- }
5807
- /** @enumType */
5808
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5809
- interface VoidedStatusDetails {
5810
- reason?: VoidedReasonWithLiterals;
5811
- }
5812
- declare enum VoidedReason {
5813
- /** Payment was voided by merchant request. */
5814
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5815
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5816
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5817
- }
5818
- /** @enumType */
5819
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5820
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5821
- }
5822
- /** @oneof */
5823
- interface PaymentStatusDetailsStatusDetailsOneOf {
5824
- }
5825
- interface Refund {
5798
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5799
+ /** Codux Headless Sites */
5800
+ CODUX = "CODUX",
5801
+ /** Bobb - AI Design Creator. */
5802
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5826
5803
  /**
5827
- * Refund ID.
5828
- * @format GUID
5829
- * @readonly
5804
+ * Shared Blog Site is a unique single site across Enterprise account,
5805
+ * This site will hold all Blog posts related to the Marketing product.
5830
5806
  */
5831
- _id?: string;
5807
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5808
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5809
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5810
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5811
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5812
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5813
+ MIMIR = "MIMIR",
5814
+ /** Wix Twins platform. */
5815
+ TWINS = "TWINS",
5816
+ /** Wix Nano. */
5817
+ NANO = "NANO",
5818
+ /** Base44 headless sites. */
5819
+ BASE44 = "BASE44",
5820
+ /** Wix Channels Sites */
5821
+ CHANNELS = "CHANNELS",
5822
+ /** Nautilus platform. */
5823
+ NAUTILUS = "NAUTILUS",
5832
5824
  /**
5833
- * List of transactions.
5834
- * @maxSize 50
5825
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5826
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5835
5827
  */
5836
- transactions?: RefundTransaction[];
5837
- /** Refund business details. */
5838
- details?: RefundDetails;
5828
+ SYMPHONY = "SYMPHONY",
5829
+ /** Nautilus platform app. */
5830
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5839
5831
  /**
5840
- * 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.
5841
- * @readonly
5842
- * @immutable
5832
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5833
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5843
5834
  */
5844
- _createdDate?: Date | null;
5835
+ VIBU = "VIBU",
5845
5836
  /**
5846
- * Aggregated refund summary.
5847
- * @readonly
5837
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5838
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5839
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5840
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5848
5841
  */
5849
- summary?: AggregatedRefundSummary;
5842
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5850
5843
  /**
5851
- * ID of the app that initiated this refund.
5852
- * @format GUID
5853
- * @readonly
5854
- * @immutable
5844
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5845
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5855
5846
  */
5856
- requestingServiceAppId?: string | null;
5847
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5857
5848
  }
5858
- interface RefundTransaction {
5849
+ /** @enumType */
5850
+ type NamespaceWithLiterals = Namespace | 'UNKNOWN_NAMESPACE' | 'WIX' | 'SHOUT_OUT' | 'ALBUMS' | 'WIX_STORES_TEST_DRIVE' | 'HOTELS' | 'CLUBS' | 'ONBOARDING_DRAFT' | 'DEV_SITE' | 'LOGOS' | 'VIDEO_MAKER' | 'PARTNER_DASHBOARD' | 'DEV_CENTER_COMPANY' | 'HTML_DRAFT' | 'SITELESS_BUSINESS' | 'CREATOR_ECONOMY' | 'DASHBOARD_FIRST' | 'ANYWHERE' | 'HEADLESS' | 'ACCOUNT_MASTER_CMS' | 'RISE' | 'BRANDED_FIRST' | 'NOWNIA' | 'UGC_TEMPLATE' | 'CODUX' | 'MEDIA_DESIGN_CREATOR' | 'SHARED_BLOG_ENTERPRISE' | 'STANDALONE_FORMS' | 'STANDALONE_EVENTS' | 'MIMIR' | 'TWINS' | 'NANO' | 'BASE44' | 'CHANNELS' | 'NAUTILUS' | 'SYMPHONY' | 'NAUTILUS_APPS' | 'VIBU' | 'ENTERPRISE_BRAND_KIT' | 'DEV_CENTER_DEV_SITE';
5851
+ /** Site transferred to another user. */
5852
+ interface SiteTransferred {
5859
5853
  /**
5860
- * ID of the payment associated with this refund.
5854
+ * A previous owner id (user that transfers meta site).
5861
5855
  * @format GUID
5862
- * @immutable
5863
5856
  */
5864
- paymentId?: string;
5857
+ oldOwnerId?: string;
5865
5858
  /**
5866
- * Refund amount.
5867
- * @immutable
5859
+ * A new owner id (user that accepts meta site).
5860
+ * @format GUID
5868
5861
  */
5869
- amount?: Price;
5870
- /** Refund status. */
5871
- refundStatus?: RefundStatusWithLiterals;
5872
- /** Optional details of current refund status. */
5873
- refundStatusInfo?: RefundStatusInfo;
5862
+ newOwnerId?: string;
5863
+ }
5864
+ /** Soft deletion of the meta site. Could be restored. */
5865
+ interface SiteDeleted {
5866
+ /** A deletion context. */
5867
+ deleteContext?: DeleteContext;
5868
+ }
5869
+ interface DeleteContext {
5870
+ /** When the meta site was deleted. */
5871
+ dateDeleted?: Date | null;
5872
+ /** A status. */
5873
+ deleteStatus?: DeleteStatusWithLiterals;
5874
5874
  /**
5875
- * Payment gateway's refund ID.
5876
- * This field is only returned when the value of `external_refund` is `false`.
5877
- * @format GUID
5875
+ * A reason (flow).
5876
+ * @maxLength 255
5878
5877
  */
5879
- gatewayRefundId?: string | null;
5880
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5881
- providerRefundId?: string | null;
5878
+ deleteOrigin?: string;
5882
5879
  /**
5883
- * Whether refund was made externally and manually on the payment provider's side.
5884
- * @immutable
5880
+ * A service that deleted it.
5881
+ * @maxLength 255
5885
5882
  */
5886
- externalRefund?: boolean;
5883
+ initiatorId?: string | null;
5887
5884
  }
5888
- /** Refund transaction status. */
5889
- declare enum RefundStatus {
5890
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5891
- PENDING = "PENDING",
5892
- /** Refund transaction succeeded. */
5893
- SUCCEEDED = "SUCCEEDED",
5894
- /** Refund transaction failed. */
5895
- FAILED = "FAILED",
5896
- /** Refund request acknowledged, and will be executed soon. */
5897
- SCHEDULED = "SCHEDULED",
5898
- /** Refund was initiated on payment provider side. */
5899
- STARTED = "STARTED"
5885
+ declare enum DeleteStatus {
5886
+ UNKNOWN = "UNKNOWN",
5887
+ TRASH = "TRASH",
5888
+ DELETED = "DELETED",
5889
+ PENDING_PURGE = "PENDING_PURGE",
5890
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5900
5891
  }
5901
5892
  /** @enumType */
5902
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5903
- interface RefundStatusInfo {
5904
- /**
5905
- * Reason code for the refund's current status.
5906
- *
5907
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5908
- * @minLength 1
5909
- * @maxLength 10
5910
- */
5911
- paymentGatewayReasonCode?: string | null;
5893
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5894
+ /** Restoration of the meta site. */
5895
+ interface SiteUndeleted {
5896
+ }
5897
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5898
+ interface SitePublished {
5899
+ }
5900
+ interface SiteUnpublished {
5912
5901
  /**
5913
- * Free text explanation of current refund status.
5914
- * @minLength 1
5915
- * @maxLength 1000
5902
+ * A list of URLs previously associated with the meta site.
5903
+ * @maxLength 4000
5904
+ * @maxSize 10000
5916
5905
  */
5917
- description?: string | null;
5906
+ urls?: string[];
5918
5907
  }
5919
- interface AggregatedRefundSummary {
5920
- /** Total amount requested for refund. */
5921
- requestedRefund?: Price;
5922
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5923
- pendingRefund?: Price;
5924
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5925
- refunded?: Price;
5926
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5927
- failedRefundAmount?: Price;
5928
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5929
- pending?: boolean;
5930
- /** Breakdown of refunded items. Available only after refund is complete. */
5931
- breakdown?: RefundItemsBreakdown;
5908
+ interface SiteMarkedAsTemplate {
5932
5909
  }
5933
- interface RefundItemsBreakdown {
5910
+ interface SiteMarkedAsWixSite {
5911
+ }
5912
+ /**
5913
+ * Represents a service provisioned a site.
5914
+ *
5915
+ * Note on `origin_instance_id`:
5916
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5917
+ * This is because of the following scenario:
5918
+ *
5919
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5920
+ * such as a product catalog. When you create a site from this template, you inherit this
5921
+ * default product catalog. However, if the template's product catalog is modified,
5922
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5923
+ * your site remains consistent with what you initially received and does not include any
5924
+ * changes made to the original template afterward.
5925
+ * To ensure this, the TPA on the template gets a new instance_id.
5926
+ */
5927
+ interface ServiceProvisioned {
5934
5928
  /**
5935
- * Refunded line items and the amount refunded for each.
5936
- * @maxSize 300
5929
+ * Either UUID or EmbeddedServiceType.
5930
+ * @maxLength 36
5937
5931
  */
5938
- lineItems?: LineItemRefundSummary[];
5939
- }
5940
- interface LineItemRefundSummary {
5932
+ appDefId?: string;
5941
5933
  /**
5942
- * ID of the refunded line item.
5943
- * @format GUID
5934
+ * Not only UUID. Something here could be something weird.
5935
+ * @maxLength 36
5944
5936
  */
5945
- lineItemId?: string;
5946
- /** Total refunded amount for the line item. */
5947
- totalRefundedAmount?: Price;
5948
- }
5949
- interface CalculateRefundRequest {
5937
+ instanceId?: string;
5950
5938
  /**
5951
- * Order ID
5952
- * @minLength 1
5953
- * @maxLength 100
5939
+ * An instance id from which this instance is originated.
5940
+ * @maxLength 36
5954
5941
  */
5955
- ecomOrderId?: string;
5942
+ originInstanceId?: string;
5956
5943
  /**
5957
- * Refunded line items and quantity
5958
- * @maxSize 300
5944
+ * A version.
5945
+ * @maxLength 500
5959
5946
  */
5960
- refundItems?: CalculateRefundItemRequest[];
5961
- /** Should include shipping in refund calculation */
5962
- refundShipping?: boolean;
5963
- }
5964
- interface CalculateRefundItemRequest {
5947
+ version?: string | null;
5965
5948
  /**
5966
- * ID of the line item being refunded
5949
+ * The origin meta site id
5967
5950
  * @format GUID
5968
5951
  */
5969
- _id?: string;
5952
+ originMetaSiteId?: string | null;
5953
+ }
5954
+ interface ServiceRemoved {
5970
5955
  /**
5971
- * How much of that line item is being refunded
5972
- * @min 1
5973
- * @max 100000
5956
+ * Either UUID or EmbeddedServiceType.
5957
+ * @maxLength 36
5974
5958
  */
5975
- quantity?: number;
5976
- }
5977
- interface CalculateRefundResponse {
5978
- /** Total refundable amount */
5979
- total?: Price;
5980
- /** Tax cost of the order */
5981
- tax?: Price;
5982
- /** Discount given for this order */
5983
- discount?: Price;
5984
- /** Total cost of the order (without tax) */
5985
- subtotal?: Price;
5986
- /** Total shipping cost for order */
5987
- shipping?: Price;
5988
- /** Previous refund given on that order */
5989
- previouslyRefundedAmount?: Price;
5959
+ appDefId?: string;
5990
5960
  /**
5991
- * The refundable items of that order
5992
- * @maxSize 300
5961
+ * Not only UUID. Something here could be something weird.
5962
+ * @maxLength 36
5993
5963
  */
5994
- items?: CalculateRefundItemResponse[];
5995
- }
5996
- interface CalculateRefundItemResponse {
5964
+ instanceId?: string;
5997
5965
  /**
5998
- * Line item ID
5999
- * @format GUID
5966
+ * A version.
5967
+ * @maxLength 500
6000
5968
  */
6001
- _id?: string;
6002
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6003
- price?: Price;
5969
+ version?: string | null;
6004
5970
  }
6005
- interface VoidAuthorizedPaymentsRequest {
5971
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5972
+ interface SiteRenamed {
6006
5973
  /**
6007
- * Wix eCommerce order ID
6008
- * @minLength 1
6009
- * @maxLength 100
5974
+ * A new meta site name (URL slug).
5975
+ * @maxLength 20
6010
5976
  */
6011
- ecomOrderId: string;
5977
+ newSiteName?: string;
6012
5978
  /**
6013
- * Payment IDs
6014
- * @minSize 1
6015
- * @maxSize 100
6016
- * @format GUID
5979
+ * A previous meta site name (URL slug).
5980
+ * @maxLength 255
6017
5981
  */
6018
- paymentIds: string[];
5982
+ oldSiteName?: string;
6019
5983
  }
6020
- interface VoidAuthorizedPaymentsResponse {
6021
- /** All order's transactions after the void was triggered */
6022
- orderTransactions?: OrderTransactions;
5984
+ /**
5985
+ * Hard deletion of the meta site.
5986
+ *
5987
+ * Could not be restored. Therefore it's desirable to cleanup data.
5988
+ */
5989
+ interface SiteHardDeleted {
5990
+ /** A deletion context. */
5991
+ deleteContext?: DeleteContext;
6023
5992
  }
6024
- interface CaptureAuthorizedPaymentsRequest {
6025
- /**
6026
- * Wix eCommerce order ID
6027
- * @minLength 1
6028
- * @maxLength 100
6029
- */
6030
- ecomOrderId: string;
5993
+ interface NamespaceChanged {
5994
+ /** A previous namespace. */
5995
+ oldNamespace?: NamespaceWithLiterals;
5996
+ /** A new namespace. */
5997
+ newNamespace?: NamespaceWithLiterals;
5998
+ }
5999
+ /** Assigned Studio editor */
6000
+ interface StudioAssigned {
6001
+ }
6002
+ /** Unassigned Studio editor */
6003
+ interface StudioUnassigned {
6004
+ }
6005
+ /**
6006
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6007
+ *
6008
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6009
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
6010
+ *
6011
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6012
+ */
6013
+ interface SiteUrlChanged {
6014
+ }
6015
+ /**
6016
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6017
+ * Consumed by other teams to remove relevant data.
6018
+ */
6019
+ interface SitePurgedExternally {
6031
6020
  /**
6032
- * Capture payments information
6033
- * @minSize 1
6021
+ * @maxLength 2048
6034
6022
  * @maxSize 100
6023
+ * @deprecated
6024
+ * @targetRemovalDate 2025-04-15
6035
6025
  */
6036
- payments: PaymentCapture[];
6026
+ appDefId?: string[];
6037
6027
  }
6038
- interface PaymentCapture {
6039
- /**
6040
- * Payment ID
6041
- * @format GUID
6042
- */
6043
- paymentId?: string | null;
6044
- /**
6045
- * Capture amount.
6046
- * If not provided - full authorized amount will be captured.
6047
- */
6048
- amount?: Price;
6028
+ /** Assigned Odeditor */
6029
+ interface OdeditorAssigned {
6049
6030
  }
6050
- interface CaptureAuthorizedPaymentsResponse {
6051
- /** All order's transactions after the capture was triggered */
6052
- orderTransactions?: OrderTransactions;
6031
+ /** Unassigned Odeditor */
6032
+ interface OdeditorUnassigned {
6053
6033
  }
6054
- interface ChargeSavedPaymentMethodRequest {
6055
- /**
6056
- * Ecom Order ID.
6057
- * @minLength 1
6058
- * @maxLength 100
6059
- */
6060
- ecomOrderId?: string;
6061
- /** Amount to be charged */
6062
- amount?: Price;
6034
+ /** Assigned Picasso editor */
6035
+ interface PicassoAssigned {
6063
6036
  }
6064
- interface ChargeSavedPaymentMethodResponse {
6065
- /** Payment gateway's order ID (e.g Wix Payments) */
6066
- paymentGatewayOrderId?: string;
6037
+ /** Unassigned Picasso */
6038
+ interface PicassoUnassigned {
6067
6039
  }
6068
- interface V1TriggerReindexRequest {
6069
- /** @format GUID */
6070
- metasiteId?: string;
6071
- /**
6072
- * @minLength 1
6073
- * @maxLength 100
6074
- * @maxSize 100
6075
- */
6076
- orderIds?: string[];
6040
+ /** Assigned Wixel */
6041
+ interface WixelAssigned {
6077
6042
  }
6078
- interface V1TriggerReindexResponse {
6043
+ /** Unassigned Wixel */
6044
+ interface WixelUnassigned {
6079
6045
  }
6080
- interface V1TriggerReindexOrderRequest {
6081
- /** @format GUID */
6082
- metasiteId?: string;
6083
- /**
6084
- * @minLength 1
6085
- * @maxLength 100
6086
- */
6087
- orderId?: string;
6046
+ /** Assigned StudioTwo */
6047
+ interface StudioTwoAssigned {
6048
+ }
6049
+ /** Unassigned StudioTwo */
6050
+ interface StudioTwoUnassigned {
6051
+ }
6052
+ /** Media from user domain is enabled. */
6053
+ interface UserDomainMediaEnabled {
6054
+ }
6055
+ /** Media from user domain is disabled. */
6056
+ interface UserDomainMediaDisabled {
6057
+ }
6058
+ /** Assigned Editorless */
6059
+ interface EditorlessAssigned {
6060
+ }
6061
+ /** Unassigned Editorless */
6062
+ interface EditorlessUnassigned {
6063
+ }
6064
+ interface HasCustomEmailConfigurationsRequest {
6065
+ }
6066
+ interface HasCustomEmailConfigurationsResponse {
6067
+ hasCustomConfigurations?: boolean;
6068
+ }
6069
+ interface AddToAutomationMigrationPopulationRequest {
6070
+ /** When true, sends custom email configurations to automation system via email */
6071
+ sendCustomEmailConfigs?: boolean;
6072
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6073
+ origin?: OriginWithLiterals;
6074
+ }
6075
+ declare enum Origin {
6076
+ OPT_IN = "OPT_IN",
6077
+ MIGRATION = "MIGRATION"
6078
+ }
6079
+ /** @enumType */
6080
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6081
+ interface AddToAutomationMigrationPopulationResponse {
6082
+ success?: boolean;
6083
+ }
6084
+ interface IsInAutomationMigrationPopulationRequest {
6085
+ }
6086
+ interface IsInAutomationMigrationPopulationResponse {
6087
+ inPopulation?: boolean;
6088
6088
  }
6089
6089
  interface DiffmatokyPayload {
6090
6090
  left?: string;
@@ -9320,4 +9320,4 @@ interface BulkUpdateOrderTagsOptions {
9320
9320
  unassignTags?: TagsTags;
9321
9321
  }
9322
9322
 
9323
- export { PaymentStatusEnumPaymentStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type Color as a$, FulfillmentStatus as a0, WeightUnit as a1, VatType as a2, PickupMethod as a3, OrderStatus as a4, DiscountType as a5, DiscountReason as a6, LineItemQuantityChangeType as a7, ActivityType as a8, OrderActivityTypeEnumActivityType as a9, AuthorizationVoidStatus as aA, Reason as aB, ActionType as aC, ChargebackStatus as aD, MembershipPaymentStatus as aE, PaymentStatus as aF, CanceledReason as aG, DeclinedReason as aH, VoidedReason as aI, RefundStatus as aJ, SortOrder as aK, OrderApprovalStrategy as aL, Placement as aM, SubdivisionType as aN, SourceType as aO, CustomFieldGroup as aP, ValueType as aQ, DepositType as aR, InvoiceStatus as aS, type OrderLineItem as aT, type ProductName as aU, type CatalogReference as aV, type DescriptionLine as aW, type DescriptionLineValueOneOf as aX, type DescriptionLineDescriptionLineValueOneOf as aY, type DescriptionLineName as aZ, type PlainTextValue as a_, AttributionSource as aa, ChannelType as ab, AdditionalFeeSource as ac, OrderActionType as ad, SpecificItemsCouponBehavior as ae, ChargeType as af, VersioningMode as ag, DeltaPaymentOptionType as ah, InventoryAction as ai, WebhookIdentityType as aj, PreviewEmailType as ak, State as al, SiteCreatedContext as am, Namespace as an, DeleteStatus as ao, Origin as ap, ScheduledAction as aq, DurationUnit as ar, PaymentCollectabilityStatus as as, PredefinedPaymentMethod as at, RefundableStatus as au, NonRefundableReason as av, ManuallyRefundableReason as aw, RestockType as ax, TransactionStatus as ay, AuthorizationCaptureStatus as az, type SetOrderNumberCounterResponse as b, type CustomActivity as b$, type FocalPoint as b0, type PhysicalProperties as b1, type Dimensions as b2, type ItemType as b3, type ItemTypeItemTypeDataOneOf as b4, type RestockLocation as b5, type ItemTaxFullDetails as b6, type LineItemTaxInfo as b7, type LineItemTaxBreakdown as b8, type DigitalFile as b9, type StreetAddress as bA, type AddressLocation as bB, type FullAddressContactDetails as bC, type VatId as bD, type V1ShippingInformation as bE, type DeliveryLogistics as bF, type DeliveryLogisticsAddressOneOf as bG, type PickupDetails as bH, type PickupAddress as bI, type DeliveryTimeSlot as bJ, type ShippingPrice as bK, type ShippingRegion as bL, type TaxSummary as bM, type OrderTaxInfo as bN, type OrderTaxBreakdown as bO, type AppliedDiscount as bP, type AppliedDiscountDiscountSourceOneOf as bQ, type Coupon as bR, type MerchantDiscount as bS, type MerchantDiscountMerchantDiscountReasonOneOf as bT, type DiscountRule as bU, type DiscountRuleName as bV, type LineItemDiscount as bW, type ItemCombination as bX, type ItemCombinationLineItem as bY, type Activity as bZ, type ActivityContentOneOf as b_, type SubscriptionInfo as ba, type SubscriptionTitle as bb, type SubscriptionDescription as bc, type SubscriptionSettings as bd, type FreeTrialPeriod as be, type BillingSettings as bf, type BillingAdjustment as bg, type BillingAdjustmentPriceSummary as bh, type CyclePriceOverride as bi, type PriceDescription as bj, type LocationAndQuantity as bk, type TaxableAddress as bl, type TaxableAddressTaxableAddressDataOneOf as bm, type DecimalQuantity as bn, type DecimalQuantityUnitOneOf as bo, type TranslatableString as bp, type ExtendedFields as bq, type ModifierGroup as br, type ItemModifier as bs, type ServiceProperties as bt, type BuyerInfo as bu, type BuyerInfoIdOneOf as bv, type CurrencyConversionDetails as bw, type PriceSummary as bx, type AddressWithContact as by, type Address as bz, type SetOrderNumberCounterApplicationErrors as c, type Location as c$, type MerchantComment as c0, type OrderRefunded as c1, type OrderCreatedFromExchange as c2, type NewExchangeOrderCreated as c3, type LineItemExchangeData as c4, type DraftOrderChangesApplied as c5, type OrderChange as c6, type OrderChangeValueOneOf as c7, type LineItemChanges as c8, type LineItemQuantityChange as c9, type PaymentPendingPaymentDetailsOneOf as cA, type RegularPayment as cB, type RegularPaymentPaymentMethodDetailsOneOf as cC, type CreditCardDetails as cD, type PaymentCanceled as cE, type PaymentCanceledPaymentDetailsOneOf as cF, type PaymentDeclined as cG, type PaymentDeclinedPaymentDetailsOneOf as cH, type ReceiptCreated as cI, type ReceiptCreatedReceiptInfoOneOf as cJ, type WixReceipt as cK, type ExternalReceipt as cL, type ReceiptSent as cM, type ReceiptSentReceiptInfoOneOf as cN, type ChargebackCreated as cO, type ChargebackReversed as cP, type CreatedBy as cQ, type CreatedByStringOneOf as cR, type ChannelInfo as cS, type CustomField as cT, type BalanceSummary as cU, type Balance as cV, type CashRounding as cW, type AdditionalFee as cX, type FulfillmentStatusesAggregate as cY, type Tags as cZ, type TagList as c_, type LineItemPriceChange as ca, type LineItemProductNameChange as cb, type LineItemDescriptionLineChange as cc, type LineItemModifiersChange as cd, type ManagedLineItem as ce, type ManagedDiscount as cf, type TranslatedValue as cg, type LineItemAmount as ch, type ManagedAdditionalFee as ci, type TotalPriceChange as cj, type ShippingInformationChange as ck, type ShippingInformation as cl, type SavedPaymentMethod as cm, type AuthorizedPaymentCreated as cn, type AuthorizedPaymentCaptured as co, type AuthorizedPaymentVoided as cp, type RefundInitiated as cq, type RefundedPayment as cr, type RefundedPaymentKindOneOf as cs, type RegularPaymentRefund as ct, type GiftCardPaymentRefund as cu, type MembershipPaymentRefund as cv, type PaymentRefunded as cw, type PaymentRefundFailed as cx, type RefundedAsStoreCredit as cy, type PaymentPending as cz, type PreparePaymentCollectionOptions as d, type SendBuyerConfirmationEmailRequest as d$, type OrderSettings as d0, type OrderSettingsAllowedActionsOneOf as d1, type OrderSettingsEditableByOneOf as d2, type CustomAllowedActions as d3, type OwnerApps as d4, type FormInfo as d5, type FormIdentifier as d6, type PlatformFeeSummary as d7, type PlatformFee as d8, type UpdateInternalDocumentsEvent as d9, type DecimalQuantityUpdate as dA, type LineItemDelta as dB, type LineItemDeltaDeltaOneOf as dC, type AppliedDiscountDelta as dD, type AppliedDiscountDeltaDeltaOneOf as dE, type AdditionalFeeDelta as dF, type AdditionalFeeDeltaDeltaOneOf as dG, type DraftOrderCommitSettings as dH, type InventoryUpdateDetails as dI, type TriggerReindexRequest as dJ, type TriggerReindexResponse as dK, type DomainEvent as dL, type DomainEventBodyOneOf as dM, type EntityCreatedEvent as dN, type RestoreInfo as dO, type EntityUpdatedEvent as dP, type EntityDeletedEvent as dQ, type ActionEvent as dR, type Empty as dS, type TriggerReindexOrderRequest as dT, type MessageEnvelope as dU, type IdentificationData as dV, type IdentificationDataIdOneOf as dW, type AccountInfo as dX, type ImportOrderRequest as dY, type SetOrderNumberCounterRequest as dZ, type BulkDeleteImportedOrdersRequest as d_, type UpdateInternalDocumentsEventOperationOneOf as da, type InternalDocument as db, type InternalDocumentUpdateOperation as dc, type DeleteByIdsOperation as dd, type DeleteByFilterOperation as de, type InternalDocumentUpdateByFilterOperation as df, type InternalUpdateExistingOperation as dg, type VersionedDocumentUpdateOperation as dh, type VersionedDeleteByIdsOperation as di, type VersionedDocumentId as dj, type OrderApproved as dk, type OrdersExperiments as dl, type OrderRejectedEventOrderRejected as dm, type OrderItemsRestocked as dn, type V1RestockItem as dp, type OrderImported as dq, type ImportedOrderDeleted as dr, type PaymentStatusUpdated as ds, type FulfillmentStatusUpdated as dt, type OrderCanceledEventOrderCanceled as du, type OrderDeltasCommitted as dv, type CommittedDiffs as dw, type CommittedDiffsShippingUpdateInfoOneOf as dx, type ItemChangedDetails as dy, type OrderLineItemChangedDetails as dz, type PreparePaymentCollectionResponse as e, type SiteUrlChanged as e$, type SendBuyerConfirmationEmailResponse as e0, type SendBuyerPaymentsReceivedEmailRequest as e1, type SendBuyerPaymentsReceivedEmailResponse as e2, type SendBuyerPickupConfirmationEmailRequest as e3, type SendBuyerPickupConfirmationEmailResponse as e4, type BulkSendBuyerPickupConfirmationEmailsRequest as e5, type BulkSendBuyerPickupConfirmationEmailsResponse as e6, type SendBuyerShippingConfirmationEmailRequest as e7, type SendBuyerShippingConfirmationEmailResponse as e8, type BulkSendBuyerShippingConfirmationEmailsRequest as e9, type PreviewBuyerConfirmationEmailRequest as eA, type PreviewBuyerConfirmationEmailResponse as eB, type PreviewBuyerPickupConfirmationEmailRequest as eC, type PreviewBuyerPickupConfirmationEmailResponse as eD, type PreviewShippingConfirmationEmailRequest as eE, type PreviewShippingConfirmationEmailResponse as eF, type PreviewResendDownloadLinksEmailRequest as eG, type PreviewResendDownloadLinksEmailResponse as eH, type MetaSiteSpecialEvent as eI, type MetaSiteSpecialEventPayloadOneOf as eJ, type Asset as eK, type SiteCreated as eL, type SiteTransferred as eM, type SiteDeleted as eN, type DeleteContext as eO, type SiteUndeleted as eP, type SitePublished as eQ, type SiteUnpublished as eR, type SiteMarkedAsTemplate as eS, type SiteMarkedAsWixSite as eT, type ServiceProvisioned as eU, type ServiceRemoved as eV, type SiteRenamed as eW, type SiteHardDeleted as eX, type NamespaceChanged as eY, type StudioAssigned as eZ, type StudioUnassigned as e_, type BulkSendBuyerShippingConfirmationEmailsResponse as ea, type SendMerchantOrderReceivedNotificationRequest as eb, type SendMerchantOrderReceivedNotificationResponse as ec, type SendCancelRefundEmailRequest as ed, type SendCancelRefundEmailResponse as ee, type SendRefundEmailRequest as ef, type SendRefundEmailResponse as eg, type SendFulfillmentEmailRequest as eh, type SendFulfillmentEmailResponse as ei, type SendMerchantOrderReceivedPushRequest as ej, type SendMerchantOrderReceivedPushResponse as ek, type PreviewEmailByTypeRequest as el, type PreviewEmailByTypeResponse as em, type PreviewRefundEmailRequest as en, type RefundDetails as eo, type RefundItem as ep, type LineItemRefund as eq, type AdditionalFeeRefund as er, type ShippingRefund as es, type PreviewRefundEmailResponse as et, type PreviewCancelEmailRequest as eu, type PreviewCancelEmailResponse as ev, type PreviewCancelRefundEmailRequest as ew, type PreviewCancelRefundEmailResponse as ex, type PreviewBuyerPaymentsReceivedEmailRequest as ey, type PreviewBuyerPaymentsReceivedEmailResponse as ez, type PreparePaymentCollectionApplicationErrors as f, type AuthorizationActionFailureDetails as f$, type SitePurgedExternally as f0, type OdeditorAssigned as f1, type OdeditorUnassigned as f2, type PicassoAssigned as f3, type PicassoUnassigned as f4, type WixelAssigned as f5, type WixelUnassigned as f6, type StudioTwoAssigned as f7, type StudioTwoUnassigned as f8, type UserDomainMediaEnabled as f9, type GetRefundabilityStatusRequest as fA, type GetRefundabilityStatusResponse as fB, type Refundability as fC, type RefundabilityAdditionalRefundabilityInfoOneOf as fD, type CreatePaymentGatewayOrderRequest as fE, type ChargedBy as fF, type CreatePaymentGatewayOrderResponse as fG, type ChargeMembershipsRequest as fH, type MembershipChargeItem as fI, type MembershipName as fJ, type ChargeMembershipsResponse as fK, type TriggerRefundRequest as fL, type PaymentRefund as fM, type RefundSideEffects as fN, type RestockInfo as fO, type RestockItem as fP, type TriggerRefundResponse as fQ, type OrderTransactions as fR, type Payment as fS, type PaymentPaymentDetailsOneOf as fT, type PaymentReceiptInfoOneOf as fU, type PaymentStatusDetailsOneOf as fV, type RegularPaymentDetails as fW, type RegularPaymentDetailsPaymentMethodDetailsOneOf as fX, type CreditCardPaymentMethodDetails as fY, type AuthorizationDetails as fZ, type AuthorizationCapture as f_, type UserDomainMediaDisabled as fa, type EditorlessAssigned as fb, type EditorlessUnassigned as fc, type HasCustomEmailConfigurationsRequest as fd, type HasCustomEmailConfigurationsResponse as fe, type AddToAutomationMigrationPopulationRequest as ff, type AddToAutomationMigrationPopulationResponse as fg, type IsInAutomationMigrationPopulationRequest as fh, type IsInAutomationMigrationPopulationResponse as fi, type PreparePaymentCollectionRequest as fj, type RedirectUrls as fk, type DelayedCaptureSettings as fl, type Duration as fm, type GetPaymentCollectabilityStatusRequest as fn, type RecordManuallyCollectedPaymentRequest as fo, type UserDefinedPaymentMethodName as fp, type UserDefinedPaymentMethodNameKindOneOf as fq, type RecordManuallyCollectedPaymentResponse as fr, type MarkOrderAsPaidRequest as fs, type MarkOrderAsPaidResponse as ft, type BulkMarkOrdersAsPaidRequest as fu, type BulkMarkOrdersAsPaidResponse as fv, type BulkOrderResult as fw, type ItemMetadata as fx, type ApplicationError as fy, type BulkActionMetadata as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type DraftOrderDiffsBillingUpdateInfoOneOf as g$, type AuthorizationVoid as g0, type V1ScheduledAction as g1, type Chargeback as g2, type PaymentMethodName as g3, type GiftCardPaymentDetails as g4, type MembershipPaymentDetails as g5, type FutureMembershipDetails as g6, type WixReceiptInfo as g7, type ExternalReceiptInfo as g8, type CashRoundingDetails as g9, type InternalQueryOrdersRequest as gA, type PlatformQuery as gB, type PlatformQueryPagingMethodOneOf as gC, type Sorting as gD, type PlatformPaging as gE, type CursorPaging as gF, type InternalQueryOrdersResponse as gG, type PlatformPagingMetadata as gH, type Cursors as gI, type QueryOrderRequest as gJ, type QueryOrderResponse as gK, type SearchOrdersRequest as gL, type CursorSearch as gM, type CursorSearchPagingMethodOneOf as gN, type CursorPagingMetadata as gO, type CreateOrderRequest as gP, type OrderCreationSettings as gQ, type OrderCreationSettingsEditableByOneOf as gR, type OrderCreateNotifications as gS, type CreateOrderResponse as gT, type UpdateOrderRequest as gU, type UpdateOrderResponse as gV, type BulkUpdateOrdersRequest as gW, type CommitDeltasRequest as gX, type DraftOrderDiffs as gY, type DraftOrderDiffsShippingUpdateInfoOneOf as gZ, type DraftOrderDiffsBuyerUpdateInfoOneOf as g_, type CanceledStatusDetails as ga, type DeclinedStatusDetails as gb, type VoidedStatusDetails as gc, type PaymentStatusDetails as gd, type PaymentStatusDetailsStatusDetailsOneOf as ge, type Refund as gf, type RefundTransaction as gg, type RefundStatusInfo as gh, type AggregatedRefundSummary as gi, type RefundItemsBreakdown as gj, type LineItemRefundSummary as gk, type CalculateRefundRequest as gl, type CalculateRefundItemRequest as gm, type CalculateRefundResponse as gn, type CalculateRefundItemResponse as go, type VoidAuthorizedPaymentsRequest as gp, type CaptureAuthorizedPaymentsRequest as gq, type ChargeSavedPaymentMethodRequest as gr, type ChargeSavedPaymentMethodResponse as gs, type V1TriggerReindexRequest as gt, type V1TriggerReindexResponse as gu, type V1TriggerReindexOrderRequest as gv, type DiffmatokyPayload as gw, type ErrorInformation as gx, type GetOrderRequest as gy, type GetOrderResponse as gz, type PaymentCapture as h, type LineItemUpdate as h$, type DraftOrderDiffsRecipientUpdateInfoOneOf as h0, type V1LineItemDelta as h1, type V1LineItemDeltaDeltaOneOf as h2, type CommitDeltasResponse as h3, type ArchiveOrderRequest as h4, type ArchiveOrderResponse as h5, type BulkArchiveOrdersRequest as h6, type BulkArchiveOrdersResponse as h7, type BulkArchiveOrdersByFilterRequest as h8, type BulkArchiveOrdersByFilterResponse as h9, type OrderNotFulfilled as hA, type OrderCanceled as hB, type DownloadLinkSent as hC, type TrackingNumberAdded as hD, type TrackingNumberEdited as hE, type TrackingLinkAdded as hF, type ShippingConfirmationEmailSent as hG, type InvoiceAdded as hH, type InvoiceSent as hI, type FulfillerEmailSent as hJ, type ShippingAddressEdited as hK, type EmailEdited as hL, type PickupReadyEmailSent as hM, type OrderPartiallyPaid as hN, type OrderPending as hO, type OrderRejected as hP, type AddInternalActivityResponse as hQ, type AddActivityRequest as hR, type PublicActivity as hS, type PublicActivityContentOneOf as hT, type AddActivityResponse as hU, type AddActivitiesRequest as hV, type UpdateActivityRequest as hW, type UpdateActivityResponse as hX, type DeleteActivityRequest as hY, type DeleteActivityResponse as hZ, type UpdateLineItemsDescriptionLinesRequest as h_, type UnArchiveOrderRequest as ha, type UnArchiveOrderResponse as hb, type BulkUnArchiveOrdersRequest as hc, type BulkUnArchiveOrdersResponse as hd, type BulkUnArchiveOrdersByFilterRequest as he, type BulkUnArchiveOrdersByFilterResponse as hf, type UpdateBuyerInfoRequest as hg, type BuyerInfoUpdate as hh, type UpdateBuyerInfoResponse as hi, type UpdateBuyerEmailRequest as hj, type UpdateBuyerEmailResponse as hk, type UpdateOrderShippingAddressRequest as hl, type UpdateOrderShippingAddressResponse as hm, type UpdateBillingContactDetailsRequest as hn, type UpdateBillingContactDetailsResponse as ho, type UpdateOrderLineItemRequest as hp, type UpdateOrderLineItemResponse as hq, type UpdateOrderLineItemsRequest as hr, type MaskedOrderLineItem as hs, type UpdateOrderLineItemsResponse as ht, type AddInternalActivityRequest as hu, type InternalActivity as hv, type InternalActivityContentOneOf as hw, type OrderPlaced as hx, type OrderPaid as hy, type OrderFulfilled as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceDates as i$, type UpdateLineItemsDescriptionLinesResponse as i0, type MarkOrderAsSeenByHumanRequest as i1, type MarkOrderAsSeenByHumanResponse as i2, type CancelOrderRequest as i3, type UpdateOrderStatusRequest as i4, type UpdateOrderStatusResponse as i5, type MarkAsFulfilledRequest as i6, type MarkAsFulfilledResponse as i7, type BulkMarkAsFulfilledRequest as i8, type BulkMarkAsFulfilledResponse as i9, type BulkUpdateOrderTagsRequest as iA, type TagsTags as iB, type TagsTagList as iC, type BulkUpdateOrderTagsResult as iD, type SendOrderUpdatedDomainEventRequest as iE, type SendOrderUpdatedDomainEventResponse as iF, type Task as iG, type TaskKey as iH, type TaskAction as iI, type TaskActionActionOneOf as iJ, type Complete as iK, type Cancel as iL, type Reschedule as iM, type InvoiceSentEvent as iN, type IdAndVersion as iO, type InvoiceFields as iP, type Customer as iQ, type Email as iR, type QuotesAddress as iS, type AddressDescription as iT, type Phone as iU, type Company as iV, type CommonAddress as iW, type CommonAddressStreetOneOf as iX, type Subdivision as iY, type StandardDetails as iZ, type ShippingContactDetails as i_, type BulkMarkAsFulfilledByFilterRequest as ia, type BulkMarkAsFulfilledByFilterResponse as ib, type MarkAsUnfulfilledRequest as ic, type MarkAsUnfulfilledResponse as id, type BulkMarkAsUnfulfilledRequest as ie, type BulkMarkAsUnfulfilledResponse as ig, type BulkMarkAsUnfulfilledByFilterRequest as ih, type BulkMarkAsUnfulfilledByFilterResponse as ii, type BulkSetBusinessLocationRequest as ij, type BulkSetBusinessLocationResponse as ik, type BulkSetBusinessLocationResult as il, type V1MarkOrderAsPaidRequest as im, type V1MarkOrderAsPaidResponse as io, type V1BulkMarkOrdersAsPaidRequest as ip, type V1BulkMarkOrdersAsPaidResponse as iq, type V1CreatePaymentGatewayOrderRequest as ir, type V1CreatePaymentGatewayOrderResponse as is, type GetShipmentsRequest as it, type GetShipmentsResponse as iu, type AggregateOrdersRequest as iv, type AggregateOrdersResponse as iw, type DecrementItemsQuantityRequest as ix, type DecrementData as iy, type DecrementItemsQuantityResponse as iz, type GetOrderApplicationErrors as j, type DeltaPaymentOptionTypeWithLiterals as j$, type LineItems as j0, type LineItem as j1, type BigDecimalWrapper as j2, type LineItemTax as j3, type Source as j4, type LineItemMetaData as j5, type Locale as j6, type TotalPrice as j7, type ItemizedFee as j8, type Discount as j9, type DimensionsUnitWithLiterals as jA, type ItemTypePresetWithLiterals as jB, type PaymentOptionTypeWithLiterals as jC, type JurisdictionTypeWithLiterals as jD, type SubscriptionFrequencyWithLiterals as jE, type ProductPeriodAlignmentWithLiterals as jF, type AdjustmentTypeWithLiterals as jG, type TaxableAddressTypeWithLiterals as jH, type MeasurementUnitWithLiterals as jI, type PaymentStatusEnumPaymentStatusWithLiterals as jJ, type FulfillmentStatusWithLiterals as jK, type WeightUnitWithLiterals as jL, type VatTypeWithLiterals as jM, type PickupMethodWithLiterals as jN, type OrderStatusWithLiterals as jO, type DiscountTypeWithLiterals as jP, type DiscountReasonWithLiterals as jQ, type LineItemQuantityChangeTypeWithLiterals as jR, type ActivityTypeWithLiterals as jS, type OrderActivityTypeEnumActivityTypeWithLiterals as jT, type AttributionSourceWithLiterals as jU, type ChannelTypeWithLiterals as jV, type AdditionalFeeSourceWithLiterals as jW, type OrderActionTypeWithLiterals as jX, type SpecificItemsCouponBehaviorWithLiterals as jY, type ChargeTypeWithLiterals as jZ, type VersioningModeWithLiterals as j_, type DiscountOneDiscountTypeOneOf as ja, type CalculatedTaxes as jb, type CalculatedTax as jc, type Payments as jd, type InvoicesPayment as je, type MetaData as jf, type InvoiceDynamicPriceTotals as jg, type CustomFieldValue as jh, type Value as ji, type Deposit as jj, type BaseEventMetadata as jk, type EventMetadata as jl, type AccountInfoMetadata as jm, type RecordManuallyCollectedPaymentOptions as jn, type PaymentCollectionMarkOrderAsPaidOptions as jo, type PaymentCollectionCreatePaymentGatewayOrderOptions as jp, type ChargeMembershipsOptions as jq, type TriggerRefundOptions as jr, type OrderSearchSpec as js, type UpdateOrderLineItemIdentifiers as jt, type UpdateOrderLineItem as ju, type UpdateActivityIdentifiers as jv, type DeleteActivityIdentifiers as jw, type AggregateOrdersOptions as jx, utils as jy, type DescriptionLineTypeWithLiterals as jz, type OrderSearch as k, addActivities as k$, type InventoryActionWithLiterals as k0, type WebhookIdentityTypeWithLiterals as k1, type PreviewEmailTypeWithLiterals as k2, type StateWithLiterals as k3, type SiteCreatedContextWithLiterals as k4, type NamespaceWithLiterals as k5, type DeleteStatusWithLiterals as k6, type OriginWithLiterals as k7, type ScheduledActionWithLiterals as k8, type DurationUnitWithLiterals as k9, type InvoiceStatusWithLiterals as kA, type RecordManuallyCollectedPaymentApplicationErrors as kB, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kC, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kD, type TriggerRefundApplicationErrors as kE, type UpdateOrderStatusApplicationErrors as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, voidAuthorizedPayments as kV, captureAuthorizedPayments as kW, getOrder as kX, createOrder as kY, updateOrder as kZ, bulkUpdateOrders as k_, type PaymentCollectabilityStatusWithLiterals as ka, type PredefinedPaymentMethodWithLiterals as kb, type RefundableStatusWithLiterals as kc, type NonRefundableReasonWithLiterals as kd, type ManuallyRefundableReasonWithLiterals as ke, type RestockTypeWithLiterals as kf, type TransactionStatusWithLiterals as kg, type AuthorizationCaptureStatusWithLiterals as kh, type AuthorizationVoidStatusWithLiterals as ki, type ReasonWithLiterals as kj, type ActionTypeWithLiterals as kk, type ChargebackStatusWithLiterals as kl, type MembershipPaymentStatusWithLiterals as km, type PaymentStatusWithLiterals as kn, type CanceledReasonWithLiterals as ko, type DeclinedReasonWithLiterals as kp, type VoidedReasonWithLiterals as kq, type RefundStatusWithLiterals as kr, type SortOrderWithLiterals as ks, type OrderApprovalStrategyWithLiterals as kt, type PlacementWithLiterals as ku, type SubdivisionTypeWithLiterals as kv, type SourceTypeWithLiterals as kw, type CustomFieldGroupWithLiterals as kx, type ValueTypeWithLiterals as ky, type DepositTypeWithLiterals as kz, type SearchOrdersResponse as l, cancelOrder as l0, bulkUpdateOrderTags as l1, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };
9323
+ export { PaymentStatusEnumPaymentStatus as $, type AddActivitiesOptions as A, type BulkDeleteImportedOrdersResponse as B, type CaptureAuthorizedPaymentsResponse as C, type OrderCreatedEnvelope as D, type OrderFulfilledEnvelope as E, type OrderImportedEnvelope as F, type GetPaymentCollectabilityStatusResponse as G, type OrderImportedOrderDeletedEnvelope as H, type ImportOrderResponse as I, type OrderPaymentStatusUpdatedEnvelope as J, type OrderUpdatedEnvelope as K, DescriptionLineType as L, type MaskedOrder as M, DimensionsUnit as N, type Order as O, type Price as P, ItemTypePreset as Q, PaymentOptionType as R, type SetOrderNumberCounterOptions as S, JurisdictionType as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, SubscriptionFrequency as W, ProductPeriodAlignment as X, AdjustmentType as Y, TaxableAddressType as Z, MeasurementUnit as _, type ImportOrderApplicationErrors as a, type Color as a$, FulfillmentStatus as a0, WeightUnit as a1, VatType as a2, PickupMethod as a3, OrderStatus as a4, DiscountType as a5, DiscountReason as a6, LineItemQuantityChangeType as a7, ActivityType as a8, OrderActivityTypeEnumActivityType as a9, CanceledReason as aA, DeclinedReason as aB, VoidedReason as aC, RefundStatus as aD, PreviewEmailType as aE, State as aF, SiteCreatedContext as aG, Namespace as aH, DeleteStatus as aI, Origin as aJ, SortOrder as aK, OrderApprovalStrategy as aL, Placement as aM, SubdivisionType as aN, SourceType as aO, CustomFieldGroup as aP, ValueType as aQ, DepositType as aR, InvoiceStatus as aS, type OrderLineItem as aT, type ProductName as aU, type CatalogReference as aV, type DescriptionLine as aW, type DescriptionLineValueOneOf as aX, type DescriptionLineDescriptionLineValueOneOf as aY, type DescriptionLineName as aZ, type PlainTextValue as a_, AttributionSource as aa, ChannelType as ab, AdditionalFeeSource as ac, OrderActionType as ad, SpecificItemsCouponBehavior as ae, ChargeType as af, VersioningMode as ag, DeltaPaymentOptionType as ah, InventoryAction as ai, WebhookIdentityType as aj, ScheduledAction as ak, DurationUnit as al, PaymentCollectabilityStatus as am, PredefinedPaymentMethod as an, RefundableStatus as ao, NonRefundableReason as ap, ManuallyRefundableReason as aq, RestockType as ar, TransactionStatus as as, AuthorizationCaptureStatus as at, AuthorizationVoidStatus as au, Reason as av, ActionType as aw, ChargebackStatus as ax, MembershipPaymentStatus as ay, PaymentStatus as az, type SetOrderNumberCounterResponse as b, type CustomActivity as b$, type FocalPoint as b0, type PhysicalProperties as b1, type Dimensions as b2, type ItemType as b3, type ItemTypeItemTypeDataOneOf as b4, type RestockLocation as b5, type ItemTaxFullDetails as b6, type LineItemTaxInfo as b7, type LineItemTaxBreakdown as b8, type DigitalFile as b9, type StreetAddress as bA, type AddressLocation as bB, type FullAddressContactDetails as bC, type VatId as bD, type V1ShippingInformation as bE, type DeliveryLogistics as bF, type DeliveryLogisticsAddressOneOf as bG, type PickupDetails as bH, type PickupAddress as bI, type DeliveryTimeSlot as bJ, type ShippingPrice as bK, type ShippingRegion as bL, type TaxSummary as bM, type OrderTaxInfo as bN, type OrderTaxBreakdown as bO, type AppliedDiscount as bP, type AppliedDiscountDiscountSourceOneOf as bQ, type Coupon as bR, type MerchantDiscount as bS, type MerchantDiscountMerchantDiscountReasonOneOf as bT, type DiscountRule as bU, type DiscountRuleName as bV, type LineItemDiscount as bW, type ItemCombination as bX, type ItemCombinationLineItem as bY, type Activity as bZ, type ActivityContentOneOf as b_, type SubscriptionInfo as ba, type SubscriptionTitle as bb, type SubscriptionDescription as bc, type SubscriptionSettings as bd, type FreeTrialPeriod as be, type BillingSettings as bf, type BillingAdjustment as bg, type BillingAdjustmentPriceSummary as bh, type CyclePriceOverride as bi, type PriceDescription as bj, type LocationAndQuantity as bk, type TaxableAddress as bl, type TaxableAddressTaxableAddressDataOneOf as bm, type DecimalQuantity as bn, type DecimalQuantityUnitOneOf as bo, type TranslatableString as bp, type ExtendedFields as bq, type ModifierGroup as br, type ItemModifier as bs, type ServiceProperties as bt, type BuyerInfo as bu, type BuyerInfoIdOneOf as bv, type CurrencyConversionDetails as bw, type PriceSummary as bx, type AddressWithContact as by, type Address as bz, type SetOrderNumberCounterApplicationErrors as c, type Location as c$, type MerchantComment as c0, type OrderRefunded as c1, type OrderCreatedFromExchange as c2, type NewExchangeOrderCreated as c3, type LineItemExchangeData as c4, type DraftOrderChangesApplied as c5, type OrderChange as c6, type OrderChangeValueOneOf as c7, type LineItemChanges as c8, type LineItemQuantityChange as c9, type PaymentPendingPaymentDetailsOneOf as cA, type RegularPayment as cB, type RegularPaymentPaymentMethodDetailsOneOf as cC, type CreditCardDetails as cD, type PaymentCanceled as cE, type PaymentCanceledPaymentDetailsOneOf as cF, type PaymentDeclined as cG, type PaymentDeclinedPaymentDetailsOneOf as cH, type ReceiptCreated as cI, type ReceiptCreatedReceiptInfoOneOf as cJ, type WixReceipt as cK, type ExternalReceipt as cL, type ReceiptSent as cM, type ReceiptSentReceiptInfoOneOf as cN, type ChargebackCreated as cO, type ChargebackReversed as cP, type CreatedBy as cQ, type CreatedByStringOneOf as cR, type ChannelInfo as cS, type CustomField as cT, type BalanceSummary as cU, type Balance as cV, type CashRounding as cW, type AdditionalFee as cX, type FulfillmentStatusesAggregate as cY, type Tags as cZ, type TagList as c_, type LineItemPriceChange as ca, type LineItemProductNameChange as cb, type LineItemDescriptionLineChange as cc, type LineItemModifiersChange as cd, type ManagedLineItem as ce, type ManagedDiscount as cf, type TranslatedValue as cg, type LineItemAmount as ch, type ManagedAdditionalFee as ci, type TotalPriceChange as cj, type ShippingInformationChange as ck, type ShippingInformation as cl, type SavedPaymentMethod as cm, type AuthorizedPaymentCreated as cn, type AuthorizedPaymentCaptured as co, type AuthorizedPaymentVoided as cp, type RefundInitiated as cq, type RefundedPayment as cr, type RefundedPaymentKindOneOf as cs, type RegularPaymentRefund as ct, type GiftCardPaymentRefund as cu, type MembershipPaymentRefund as cv, type PaymentRefunded as cw, type PaymentRefundFailed as cx, type RefundedAsStoreCredit as cy, type PaymentPending as cz, type PreparePaymentCollectionOptions as d, type V1TriggerReindexRequest as d$, type OrderSettings as d0, type OrderSettingsAllowedActionsOneOf as d1, type OrderSettingsEditableByOneOf as d2, type CustomAllowedActions as d3, type OwnerApps as d4, type FormInfo as d5, type FormIdentifier as d6, type PlatformFeeSummary as d7, type PlatformFee as d8, type UpdateInternalDocumentsEvent as d9, type DecimalQuantityUpdate as dA, type LineItemDelta as dB, type LineItemDeltaDeltaOneOf as dC, type AppliedDiscountDelta as dD, type AppliedDiscountDeltaDeltaOneOf as dE, type AdditionalFeeDelta as dF, type AdditionalFeeDeltaDeltaOneOf as dG, type DraftOrderCommitSettings as dH, type InventoryUpdateDetails as dI, type TriggerReindexRequest as dJ, type TriggerReindexResponse as dK, type DomainEvent as dL, type DomainEventBodyOneOf as dM, type EntityCreatedEvent as dN, type RestoreInfo as dO, type EntityUpdatedEvent as dP, type EntityDeletedEvent as dQ, type ActionEvent as dR, type Empty as dS, type TriggerReindexOrderRequest as dT, type MessageEnvelope as dU, type IdentificationData as dV, type IdentificationDataIdOneOf as dW, type AccountInfo as dX, type ImportOrderRequest as dY, type SetOrderNumberCounterRequest as dZ, type BulkDeleteImportedOrdersRequest as d_, type UpdateInternalDocumentsEventOperationOneOf as da, type InternalDocument as db, type InternalDocumentUpdateOperation as dc, type DeleteByIdsOperation as dd, type DeleteByFilterOperation as de, type InternalDocumentUpdateByFilterOperation as df, type InternalUpdateExistingOperation as dg, type VersionedDocumentUpdateOperation as dh, type VersionedDeleteByIdsOperation as di, type VersionedDocumentId as dj, type OrderApproved as dk, type OrdersExperiments as dl, type OrderRejectedEventOrderRejected as dm, type OrderItemsRestocked as dn, type V1RestockItem as dp, type OrderImported as dq, type ImportedOrderDeleted as dr, type PaymentStatusUpdated as ds, type FulfillmentStatusUpdated as dt, type OrderCanceledEventOrderCanceled as du, type OrderDeltasCommitted as dv, type CommittedDiffs as dw, type CommittedDiffsShippingUpdateInfoOneOf as dx, type ItemChangedDetails as dy, type OrderLineItemChangedDetails as dz, type PreparePaymentCollectionResponse as e, type DeclinedStatusDetails as e$, type V1TriggerReindexResponse as e0, type V1TriggerReindexOrderRequest as e1, type PreparePaymentCollectionRequest as e2, type RedirectUrls as e3, type DelayedCaptureSettings as e4, type Duration as e5, type GetPaymentCollectabilityStatusRequest as e6, type RecordManuallyCollectedPaymentRequest as e7, type UserDefinedPaymentMethodName as e8, type UserDefinedPaymentMethodNameKindOneOf as e9, type ShippingRefund as eA, type RefundSideEffects as eB, type RestockInfo as eC, type RestockItem as eD, type TriggerRefundResponse as eE, type OrderTransactions as eF, type Payment as eG, type PaymentPaymentDetailsOneOf as eH, type PaymentReceiptInfoOneOf as eI, type PaymentStatusDetailsOneOf as eJ, type RegularPaymentDetails as eK, type RegularPaymentDetailsPaymentMethodDetailsOneOf as eL, type CreditCardPaymentMethodDetails as eM, type AuthorizationDetails as eN, type AuthorizationCapture as eO, type AuthorizationActionFailureDetails as eP, type AuthorizationVoid as eQ, type V1ScheduledAction as eR, type Chargeback as eS, type PaymentMethodName as eT, type GiftCardPaymentDetails as eU, type MembershipPaymentDetails as eV, type FutureMembershipDetails as eW, type WixReceiptInfo as eX, type ExternalReceiptInfo as eY, type CashRoundingDetails as eZ, type CanceledStatusDetails as e_, type RecordManuallyCollectedPaymentResponse as ea, type MarkOrderAsPaidRequest as eb, type MarkOrderAsPaidResponse as ec, type BulkMarkOrdersAsPaidRequest as ed, type BulkMarkOrdersAsPaidResponse as ee, type BulkOrderResult as ef, type ItemMetadata as eg, type ApplicationError as eh, type BulkActionMetadata as ei, type GetRefundabilityStatusRequest as ej, type GetRefundabilityStatusResponse as ek, type Refundability as el, type RefundabilityAdditionalRefundabilityInfoOneOf as em, type CreatePaymentGatewayOrderRequest as en, type ChargedBy as eo, type CreatePaymentGatewayOrderResponse as ep, type ChargeMembershipsRequest as eq, type MembershipChargeItem as er, type MembershipName as es, type ChargeMembershipsResponse as et, type TriggerRefundRequest as eu, type PaymentRefund as ev, type RefundDetails as ew, type RefundItem as ex, type LineItemRefund as ey, type AdditionalFeeRefund as ez, type PreparePaymentCollectionApplicationErrors as f, type DeleteContext as f$, type VoidedStatusDetails as f0, type PaymentStatusDetails as f1, type PaymentStatusDetailsStatusDetailsOneOf as f2, type Refund as f3, type RefundTransaction as f4, type RefundStatusInfo as f5, type AggregatedRefundSummary as f6, type RefundItemsBreakdown as f7, type LineItemRefundSummary as f8, type CalculateRefundRequest as f9, type SendFulfillmentEmailResponse as fA, type SendMerchantOrderReceivedPushRequest as fB, type SendMerchantOrderReceivedPushResponse as fC, type PreviewEmailByTypeRequest as fD, type PreviewEmailByTypeResponse as fE, type PreviewRefundEmailRequest as fF, type PreviewRefundEmailResponse as fG, type PreviewCancelEmailRequest as fH, type PreviewCancelEmailResponse as fI, type PreviewCancelRefundEmailRequest as fJ, type PreviewCancelRefundEmailResponse as fK, type PreviewBuyerPaymentsReceivedEmailRequest as fL, type PreviewBuyerPaymentsReceivedEmailResponse as fM, type PreviewBuyerConfirmationEmailRequest as fN, type PreviewBuyerConfirmationEmailResponse as fO, type PreviewBuyerPickupConfirmationEmailRequest as fP, type PreviewBuyerPickupConfirmationEmailResponse as fQ, type PreviewShippingConfirmationEmailRequest as fR, type PreviewShippingConfirmationEmailResponse as fS, type PreviewResendDownloadLinksEmailRequest as fT, type PreviewResendDownloadLinksEmailResponse as fU, type MetaSiteSpecialEvent as fV, type MetaSiteSpecialEventPayloadOneOf as fW, type Asset as fX, type SiteCreated as fY, type SiteTransferred as fZ, type SiteDeleted as f_, type CalculateRefundItemRequest as fa, type CalculateRefundResponse as fb, type CalculateRefundItemResponse as fc, type VoidAuthorizedPaymentsRequest as fd, type CaptureAuthorizedPaymentsRequest as fe, type ChargeSavedPaymentMethodRequest as ff, type ChargeSavedPaymentMethodResponse as fg, type SendBuyerConfirmationEmailRequest as fh, type SendBuyerConfirmationEmailResponse as fi, type SendBuyerPaymentsReceivedEmailRequest as fj, type SendBuyerPaymentsReceivedEmailResponse as fk, type SendBuyerPickupConfirmationEmailRequest as fl, type SendBuyerPickupConfirmationEmailResponse as fm, type BulkSendBuyerPickupConfirmationEmailsRequest as fn, type BulkSendBuyerPickupConfirmationEmailsResponse as fo, type SendBuyerShippingConfirmationEmailRequest as fp, type SendBuyerShippingConfirmationEmailResponse as fq, type BulkSendBuyerShippingConfirmationEmailsRequest as fr, type BulkSendBuyerShippingConfirmationEmailsResponse as fs, type SendMerchantOrderReceivedNotificationRequest as ft, type SendMerchantOrderReceivedNotificationResponse as fu, type SendCancelRefundEmailRequest as fv, type SendCancelRefundEmailResponse as fw, type SendRefundEmailRequest as fx, type SendRefundEmailResponse as fy, type SendFulfillmentEmailRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type DraftOrderDiffsBillingUpdateInfoOneOf as g$, type SiteUndeleted as g0, type SitePublished as g1, type SiteUnpublished as g2, type SiteMarkedAsTemplate as g3, type SiteMarkedAsWixSite as g4, type ServiceProvisioned as g5, type ServiceRemoved as g6, type SiteRenamed as g7, type SiteHardDeleted as g8, type NamespaceChanged as g9, type InternalQueryOrdersRequest as gA, type PlatformQuery as gB, type PlatformQueryPagingMethodOneOf as gC, type Sorting as gD, type PlatformPaging as gE, type CursorPaging as gF, type InternalQueryOrdersResponse as gG, type PlatformPagingMetadata as gH, type Cursors as gI, type QueryOrderRequest as gJ, type QueryOrderResponse as gK, type SearchOrdersRequest as gL, type CursorSearch as gM, type CursorSearchPagingMethodOneOf as gN, type CursorPagingMetadata as gO, type CreateOrderRequest as gP, type OrderCreationSettings as gQ, type OrderCreationSettingsEditableByOneOf as gR, type OrderCreateNotifications as gS, type CreateOrderResponse as gT, type UpdateOrderRequest as gU, type UpdateOrderResponse as gV, type BulkUpdateOrdersRequest as gW, type CommitDeltasRequest as gX, type DraftOrderDiffs as gY, type DraftOrderDiffsShippingUpdateInfoOneOf as gZ, type DraftOrderDiffsBuyerUpdateInfoOneOf as g_, type StudioAssigned as ga, type StudioUnassigned as gb, type SiteUrlChanged as gc, type SitePurgedExternally as gd, type OdeditorAssigned as ge, type OdeditorUnassigned as gf, type PicassoAssigned as gg, type PicassoUnassigned as gh, type WixelAssigned as gi, type WixelUnassigned as gj, type StudioTwoAssigned as gk, type StudioTwoUnassigned as gl, type UserDomainMediaEnabled as gm, type UserDomainMediaDisabled as gn, type EditorlessAssigned as go, type EditorlessUnassigned as gp, type HasCustomEmailConfigurationsRequest as gq, type HasCustomEmailConfigurationsResponse as gr, type AddToAutomationMigrationPopulationRequest as gs, type AddToAutomationMigrationPopulationResponse as gt, type IsInAutomationMigrationPopulationRequest as gu, type IsInAutomationMigrationPopulationResponse as gv, type DiffmatokyPayload as gw, type ErrorInformation as gx, type GetOrderRequest as gy, type GetOrderResponse as gz, type PaymentCapture as h, type LineItemUpdate as h$, type DraftOrderDiffsRecipientUpdateInfoOneOf as h0, type V1LineItemDelta as h1, type V1LineItemDeltaDeltaOneOf as h2, type CommitDeltasResponse as h3, type ArchiveOrderRequest as h4, type ArchiveOrderResponse as h5, type BulkArchiveOrdersRequest as h6, type BulkArchiveOrdersResponse as h7, type BulkArchiveOrdersByFilterRequest as h8, type BulkArchiveOrdersByFilterResponse as h9, type OrderNotFulfilled as hA, type OrderCanceled as hB, type DownloadLinkSent as hC, type TrackingNumberAdded as hD, type TrackingNumberEdited as hE, type TrackingLinkAdded as hF, type ShippingConfirmationEmailSent as hG, type InvoiceAdded as hH, type InvoiceSent as hI, type FulfillerEmailSent as hJ, type ShippingAddressEdited as hK, type EmailEdited as hL, type PickupReadyEmailSent as hM, type OrderPartiallyPaid as hN, type OrderPending as hO, type OrderRejected as hP, type AddInternalActivityResponse as hQ, type AddActivityRequest as hR, type PublicActivity as hS, type PublicActivityContentOneOf as hT, type AddActivityResponse as hU, type AddActivitiesRequest as hV, type UpdateActivityRequest as hW, type UpdateActivityResponse as hX, type DeleteActivityRequest as hY, type DeleteActivityResponse as hZ, type UpdateLineItemsDescriptionLinesRequest as h_, type UnArchiveOrderRequest as ha, type UnArchiveOrderResponse as hb, type BulkUnArchiveOrdersRequest as hc, type BulkUnArchiveOrdersResponse as hd, type BulkUnArchiveOrdersByFilterRequest as he, type BulkUnArchiveOrdersByFilterResponse as hf, type UpdateBuyerInfoRequest as hg, type BuyerInfoUpdate as hh, type UpdateBuyerInfoResponse as hi, type UpdateBuyerEmailRequest as hj, type UpdateBuyerEmailResponse as hk, type UpdateOrderShippingAddressRequest as hl, type UpdateOrderShippingAddressResponse as hm, type UpdateBillingContactDetailsRequest as hn, type UpdateBillingContactDetailsResponse as ho, type UpdateOrderLineItemRequest as hp, type UpdateOrderLineItemResponse as hq, type UpdateOrderLineItemsRequest as hr, type MaskedOrderLineItem as hs, type UpdateOrderLineItemsResponse as ht, type AddInternalActivityRequest as hu, type InternalActivity as hv, type InternalActivityContentOneOf as hw, type OrderPlaced as hx, type OrderPaid as hy, type OrderFulfilled as hz, type CaptureAuthorizedPaymentsApplicationErrors as i, type InvoiceDates as i$, type UpdateLineItemsDescriptionLinesResponse as i0, type MarkOrderAsSeenByHumanRequest as i1, type MarkOrderAsSeenByHumanResponse as i2, type CancelOrderRequest as i3, type UpdateOrderStatusRequest as i4, type UpdateOrderStatusResponse as i5, type MarkAsFulfilledRequest as i6, type MarkAsFulfilledResponse as i7, type BulkMarkAsFulfilledRequest as i8, type BulkMarkAsFulfilledResponse as i9, type BulkUpdateOrderTagsRequest as iA, type TagsTags as iB, type TagsTagList as iC, type BulkUpdateOrderTagsResult as iD, type SendOrderUpdatedDomainEventRequest as iE, type SendOrderUpdatedDomainEventResponse as iF, type Task as iG, type TaskKey as iH, type TaskAction as iI, type TaskActionActionOneOf as iJ, type Complete as iK, type Cancel as iL, type Reschedule as iM, type InvoiceSentEvent as iN, type IdAndVersion as iO, type InvoiceFields as iP, type Customer as iQ, type Email as iR, type QuotesAddress as iS, type AddressDescription as iT, type Phone as iU, type Company as iV, type CommonAddress as iW, type CommonAddressStreetOneOf as iX, type Subdivision as iY, type StandardDetails as iZ, type ShippingContactDetails as i_, type BulkMarkAsFulfilledByFilterRequest as ia, type BulkMarkAsFulfilledByFilterResponse as ib, type MarkAsUnfulfilledRequest as ic, type MarkAsUnfulfilledResponse as id, type BulkMarkAsUnfulfilledRequest as ie, type BulkMarkAsUnfulfilledResponse as ig, type BulkMarkAsUnfulfilledByFilterRequest as ih, type BulkMarkAsUnfulfilledByFilterResponse as ii, type BulkSetBusinessLocationRequest as ij, type BulkSetBusinessLocationResponse as ik, type BulkSetBusinessLocationResult as il, type V1MarkOrderAsPaidRequest as im, type V1MarkOrderAsPaidResponse as io, type V1BulkMarkOrdersAsPaidRequest as ip, type V1BulkMarkOrdersAsPaidResponse as iq, type V1CreatePaymentGatewayOrderRequest as ir, type V1CreatePaymentGatewayOrderResponse as is, type GetShipmentsRequest as it, type GetShipmentsResponse as iu, type AggregateOrdersRequest as iv, type AggregateOrdersResponse as iw, type DecrementItemsQuantityRequest as ix, type DecrementData as iy, type DecrementItemsQuantityResponse as iz, type GetOrderApplicationErrors as j, type DeltaPaymentOptionTypeWithLiterals as j$, type LineItems as j0, type LineItem as j1, type BigDecimalWrapper as j2, type LineItemTax as j3, type Source as j4, type LineItemMetaData as j5, type Locale as j6, type TotalPrice as j7, type ItemizedFee as j8, type Discount as j9, type DimensionsUnitWithLiterals as jA, type ItemTypePresetWithLiterals as jB, type PaymentOptionTypeWithLiterals as jC, type JurisdictionTypeWithLiterals as jD, type SubscriptionFrequencyWithLiterals as jE, type ProductPeriodAlignmentWithLiterals as jF, type AdjustmentTypeWithLiterals as jG, type TaxableAddressTypeWithLiterals as jH, type MeasurementUnitWithLiterals as jI, type PaymentStatusEnumPaymentStatusWithLiterals as jJ, type FulfillmentStatusWithLiterals as jK, type WeightUnitWithLiterals as jL, type VatTypeWithLiterals as jM, type PickupMethodWithLiterals as jN, type OrderStatusWithLiterals as jO, type DiscountTypeWithLiterals as jP, type DiscountReasonWithLiterals as jQ, type LineItemQuantityChangeTypeWithLiterals as jR, type ActivityTypeWithLiterals as jS, type OrderActivityTypeEnumActivityTypeWithLiterals as jT, type AttributionSourceWithLiterals as jU, type ChannelTypeWithLiterals as jV, type AdditionalFeeSourceWithLiterals as jW, type OrderActionTypeWithLiterals as jX, type SpecificItemsCouponBehaviorWithLiterals as jY, type ChargeTypeWithLiterals as jZ, type VersioningModeWithLiterals as j_, type DiscountOneDiscountTypeOneOf as ja, type CalculatedTaxes as jb, type CalculatedTax as jc, type Payments as jd, type InvoicesPayment as je, type MetaData as jf, type InvoiceDynamicPriceTotals as jg, type CustomFieldValue as jh, type Value as ji, type Deposit as jj, type BaseEventMetadata as jk, type EventMetadata as jl, type AccountInfoMetadata as jm, type RecordManuallyCollectedPaymentOptions as jn, type PaymentCollectionMarkOrderAsPaidOptions as jo, type PaymentCollectionCreatePaymentGatewayOrderOptions as jp, type ChargeMembershipsOptions as jq, type TriggerRefundOptions as jr, type OrderSearchSpec as js, type UpdateOrderLineItemIdentifiers as jt, type UpdateOrderLineItem as ju, type UpdateActivityIdentifiers as jv, type DeleteActivityIdentifiers as jw, type AggregateOrdersOptions as jx, utils as jy, type DescriptionLineTypeWithLiterals as jz, type OrderSearch as k, addActivities as k$, type InventoryActionWithLiterals as k0, type WebhookIdentityTypeWithLiterals as k1, type ScheduledActionWithLiterals as k2, type DurationUnitWithLiterals as k3, type PaymentCollectabilityStatusWithLiterals as k4, type PredefinedPaymentMethodWithLiterals as k5, type RefundableStatusWithLiterals as k6, type NonRefundableReasonWithLiterals as k7, type ManuallyRefundableReasonWithLiterals as k8, type RestockTypeWithLiterals as k9, type InvoiceStatusWithLiterals as kA, type RecordManuallyCollectedPaymentApplicationErrors as kB, type PaymentCollectionMarkOrderAsPaidApplicationErrors as kC, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as kD, type TriggerRefundApplicationErrors as kE, type UpdateOrderStatusApplicationErrors as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, voidAuthorizedPayments as kV, captureAuthorizedPayments as kW, getOrder as kX, createOrder as kY, updateOrder as kZ, bulkUpdateOrders as k_, type TransactionStatusWithLiterals as ka, type AuthorizationCaptureStatusWithLiterals as kb, type AuthorizationVoidStatusWithLiterals as kc, type ReasonWithLiterals as kd, type ActionTypeWithLiterals as ke, type ChargebackStatusWithLiterals as kf, type MembershipPaymentStatusWithLiterals as kg, type PaymentStatusWithLiterals as kh, type CanceledReasonWithLiterals as ki, type DeclinedReasonWithLiterals as kj, type VoidedReasonWithLiterals as kk, type RefundStatusWithLiterals as kl, type PreviewEmailTypeWithLiterals as km, type StateWithLiterals as kn, type SiteCreatedContextWithLiterals as ko, type NamespaceWithLiterals as kp, type DeleteStatusWithLiterals as kq, type OriginWithLiterals as kr, type SortOrderWithLiterals as ks, type OrderApprovalStrategyWithLiterals as kt, type PlacementWithLiterals as ku, type SubdivisionTypeWithLiterals as kv, type SourceTypeWithLiterals as kw, type CustomFieldGroupWithLiterals as kx, type ValueTypeWithLiterals as ky, type DepositTypeWithLiterals as kz, type SearchOrdersResponse as l, cancelOrder as l0, bulkUpdateOrderTags as l1, type CreateOrderOptions as m, type CreateOrderApplicationErrors as n, type UpdateOrderApplicationErrors as o, type BulkUpdateOrdersOptions as p, type BulkUpdateOrdersResponse as q, type AddActivitiesResponse as r, type CancelOrderOptions as s, type CancelOrderResponse as t, type CancelOrderApplicationErrors as u, type BulkUpdateOrderTagsOptions as v, type BulkUpdateOrderTagsResponse as w, type OrderApprovedEnvelope as x, type OrderCanceledEnvelope as y, type OrderCommittedEnvelope as z };