@wix/auto_sdk_ecom_orders 1.0.248 → 1.0.249

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