@wix/auto_sdk_ecom_orders 1.0.321 → 1.0.323

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