@wix/auto_sdk_ecom_orders 1.0.328 → 1.0.329

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