@wix/auto_sdk_ecom_orders 1.0.326 → 1.0.328

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-CioVnQwu.d.ts → ecom-v1-order-orders.universal-BmHEmYb8.d.ts} +1689 -1678
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +80 -82
  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 -82
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1689 -1678
  9. package/build/cjs/meta.js +80 -82
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-CioVnQwu.d.mts → ecom-v1-order-orders.universal-BmHEmYb8.d.mts} +1689 -1678
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +80 -82
  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 -82
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1689 -1678
  19. package/build/es/meta.mjs +80 -82
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-aVj7Mb1n.d.ts → ecom-v1-order-orders.universal-BAracj8P.d.ts} +1833 -1837
  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 +1828 -1841
  25. package/build/internal/es/{ecom-v1-order-orders.universal-aVj7Mb1n.d.mts → ecom-v1-order-orders.universal-BAracj8P.d.mts} +1833 -1837
  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 +1828 -1841
  29. package/package.json +4 -4
@@ -636,6 +636,8 @@ interface LineItemTaxInfo {
636
636
  * @maxSize 7
637
637
  */
638
638
  taxBreakdown?: LineItemTaxBreakdown[];
639
+ /** Amount of the line item price that was exempt from tax. */
640
+ exemptAmount?: Price;
639
641
  }
640
642
  /**
641
643
  * TaxBreakdown represents tax information for a line item.
@@ -672,6 +674,8 @@ interface LineItemTaxBreakdown {
672
674
  nonTaxableAmount?: Price;
673
675
  /** Taxable amount of the line item price. */
674
676
  taxableAmount?: Price;
677
+ /** Amount of the line item price that was exempt from this authority. */
678
+ exemptAmount?: Price;
675
679
  }
676
680
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
677
681
  declare enum JurisdictionType {
@@ -1627,6 +1631,11 @@ interface OrderTaxInfo {
1627
1631
  * @readonly
1628
1632
  */
1629
1633
  taxExempt?: boolean | null;
1634
+ /**
1635
+ * Total amount exempt from tax calculations.
1636
+ * @readonly
1637
+ */
1638
+ totalExempt?: Price;
1630
1639
  }
1631
1640
  /**
1632
1641
  * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
@@ -1658,6 +1667,8 @@ interface OrderTaxBreakdown {
1658
1667
  rate?: string;
1659
1668
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1660
1669
  aggregatedTaxAmount?: Price;
1670
+ /** Total amount exempt from this tax, summed across all line items. */
1671
+ aggregatedExemptAmount?: Price;
1661
1672
  }
1662
1673
  /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1663
1674
  interface CrossBorderCalculation {
@@ -4096,461 +4107,163 @@ interface BulkDeleteImportedOrdersResponse {
4096
4107
  */
4097
4108
  jobId?: string;
4098
4109
  }
4099
- interface V1TriggerReindexRequest {
4110
+ interface SendBuyerConfirmationEmailRequest {
4100
4111
  /** @format GUID */
4101
- metasiteId?: string;
4102
- /**
4103
- * @minLength 1
4104
- * @maxLength 100
4105
- * @maxSize 100
4106
- */
4107
- orderIds?: string[];
4112
+ orderId?: string;
4108
4113
  }
4109
- interface V1TriggerReindexResponse {
4114
+ interface SendBuyerConfirmationEmailResponse {
4110
4115
  }
4111
- interface V1TriggerReindexOrderRequest {
4112
- /** @format GUID */
4113
- metasiteId?: string;
4116
+ interface SendBuyerPaymentsReceivedEmailRequest {
4114
4117
  /**
4115
4118
  * @minLength 1
4116
4119
  * @maxLength 100
4117
4120
  */
4118
4121
  orderId?: string;
4119
4122
  }
4120
- interface PreparePaymentCollectionRequest {
4123
+ interface SendBuyerPaymentsReceivedEmailResponse {
4124
+ }
4125
+ interface SendBuyerPickupConfirmationEmailRequest {
4121
4126
  /**
4122
- * Ecom order ID.
4123
4127
  * @minLength 1
4124
4128
  * @maxLength 100
4125
4129
  */
4126
- ecomOrderId: string;
4127
- /** Amount to collect */
4128
- amount: Price;
4129
- /**
4130
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4131
- * Existing payment gateway order will be updated with a new amount.
4132
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4133
- */
4134
- paymentGatewayOrderId?: string | null;
4135
- /**
4136
- * Whether to delay capture of the payment.
4137
- * Default: false
4138
- * @deprecated Whether to delay capture of the payment.
4139
- * Default: false
4140
- * @replacedBy delayed_capture_settings.scheduled_action
4141
- * @targetRemovalDate 2024-09-30
4142
- */
4143
- delayedCapture?: boolean;
4144
- /** Delayed capture payment settings */
4145
- delayedCaptureSettings?: DelayedCaptureSettings;
4130
+ orderId?: string;
4146
4131
  }
4147
- interface RedirectUrls {
4148
- /**
4149
- * URL to redirect buyer in case of approved (successful) transaction
4150
- * @format WEB_URL
4151
- */
4152
- successUrl?: string | null;
4153
- /**
4154
- * URL to redirect buyer in case of buyer canceled the transaction
4155
- * @format WEB_URL
4156
- */
4157
- cancelUrl?: string | null;
4132
+ interface SendBuyerPickupConfirmationEmailResponse {
4133
+ }
4134
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4158
4135
  /**
4159
- * URL to redirect buyer in case of failed/rejected transaction
4160
- * @format WEB_URL
4136
+ * IDs of orders to send pickup emails for.
4137
+ * @minSize 1
4138
+ * @maxSize 300
4161
4139
  */
4162
- errorUrl?: string | null;
4140
+ orderIds?: string[];
4141
+ }
4142
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4143
+ }
4144
+ interface SendBuyerShippingConfirmationEmailRequest {
4163
4145
  /**
4164
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4165
- * @format WEB_URL
4146
+ * @minLength 1
4147
+ * @maxLength 100
4166
4148
  */
4167
- pendingUrl?: string | null;
4168
- }
4169
- interface DelayedCaptureSettings {
4170
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4171
- scheduledAction?: ScheduledActionWithLiterals;
4172
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4173
- delayDuration?: Duration;
4149
+ orderId?: string;
4174
4150
  }
4175
- declare enum ScheduledAction {
4176
- /** Whether payment will be auto-voided when duration passes */
4177
- VOID = "VOID",
4178
- /** Whether payment will be auto-captured when duration passes */
4179
- CAPTURE = "CAPTURE"
4151
+ interface SendBuyerShippingConfirmationEmailResponse {
4180
4152
  }
4181
- /** @enumType */
4182
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4183
- interface Duration {
4153
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4184
4154
  /**
4185
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4186
- * @min 1
4155
+ * IDs of orders to send pickup emails for.
4156
+ * @minSize 1
4157
+ * @maxSize 300
4187
4158
  */
4188
- count?: number;
4189
- /** Duration unit: MINUTES, HOURS and DAYS */
4190
- unit?: DurationUnitWithLiterals;
4191
- }
4192
- declare enum DurationUnit {
4193
- MINUTES = "MINUTES",
4194
- HOURS = "HOURS",
4195
- DAYS = "DAYS"
4159
+ orderIds?: string[];
4196
4160
  }
4197
- /** @enumType */
4198
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4199
- interface PreparePaymentCollectionResponse {
4200
- /** Payment gateway order id which is associated with given payment */
4201
- paymentGatewayOrderId?: string;
4161
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4202
4162
  }
4203
- interface GetPaymentCollectabilityStatusRequest {
4163
+ interface SendMerchantOrderReceivedNotificationRequest {
4204
4164
  /**
4205
- * Ecom order ID.
4206
4165
  * @minLength 1
4207
4166
  * @maxLength 100
4208
4167
  */
4209
- ecomOrderId: string;
4210
- }
4211
- interface GetPaymentCollectabilityStatusResponse {
4212
- /** Payment collectability status */
4213
- status?: PaymentCollectabilityStatusWithLiterals;
4214
- /** Collectable order amount */
4215
- amount?: Price;
4168
+ orderId?: string;
4216
4169
  }
4217
- declare enum PaymentCollectabilityStatus {
4218
- UNKNOWN = "UNKNOWN",
4219
- COLLECTABLE = "COLLECTABLE",
4220
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4221
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4222
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4223
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4224
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4225
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4226
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4227
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4228
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4229
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4230
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4170
+ interface SendMerchantOrderReceivedNotificationResponse {
4231
4171
  }
4232
- /** @enumType */
4233
- 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';
4234
- interface RecordManuallyCollectedPaymentRequest {
4172
+ interface SendCancelRefundEmailRequest {
4235
4173
  /**
4236
- * Order ID.
4174
+ * The ID of order that is canceled/refunded
4237
4175
  * @minLength 1
4238
4176
  * @maxLength 100
4239
4177
  */
4240
- orderId: string;
4241
- /** Amount to be recorded as approved manual payment for given order */
4242
- amount: Price;
4243
- }
4244
- /**
4245
- * User-defined payment method name.
4246
- * Allows specifying either a predefined type or a custom name.
4247
- */
4248
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4249
- /** Predefined payment method. */
4250
- predefined?: PredefinedPaymentMethodWithLiterals;
4178
+ orderId?: string;
4251
4179
  /**
4252
- * Custom payment method name provided by user.
4253
- *
4254
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4180
+ * Personal note added to the email (optional)
4255
4181
  * @minLength 1
4256
- * @maxLength 150
4182
+ * @maxLength 1000
4257
4183
  */
4258
- custom?: string | null;
4184
+ customMessage?: string | null;
4185
+ /** Refund amount */
4186
+ refundAmount?: Price;
4187
+ /**
4188
+ * Refund ID. (Optional)
4189
+ * @format GUID
4190
+ */
4191
+ refundId?: string | null;
4259
4192
  }
4260
- /** @oneof */
4261
- interface UserDefinedPaymentMethodNameKindOneOf {
4262
- /** Predefined payment method. */
4263
- predefined?: PredefinedPaymentMethodWithLiterals;
4193
+ interface SendCancelRefundEmailResponse {
4194
+ }
4195
+ interface SendRefundEmailRequest {
4264
4196
  /**
4265
- * Custom payment method name provided by user.
4266
- *
4267
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4197
+ * The ID of order that is refunded
4198
+ * @format GUID
4199
+ */
4200
+ orderId?: string;
4201
+ /**
4202
+ * Refund ID
4203
+ * @format GUID
4204
+ */
4205
+ refundId?: string;
4206
+ /**
4207
+ * Personal note added to the email (optional)
4268
4208
  * @minLength 1
4269
- * @maxLength 150
4209
+ * @maxLength 1000
4270
4210
  */
4271
- custom?: string | null;
4211
+ customMessage?: string | null;
4272
4212
  }
4273
- /** Predefined payment method types for offline/manual payments. */
4274
- declare enum PredefinedPaymentMethod {
4275
- /** Cash payment. */
4276
- CASH = "CASH",
4277
- /** Bank transfer. */
4278
- BANK_TRANSFER = "BANK_TRANSFER",
4279
- /** Payment by check. */
4280
- CHECK = "CHECK"
4213
+ interface SendRefundEmailResponse {
4281
4214
  }
4282
- /** @enumType */
4283
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4284
- interface RecordManuallyCollectedPaymentResponse {
4215
+ interface SendFulfillmentEmailRequest {
4216
+ /** @format GUID */
4217
+ orderId?: string;
4218
+ /** @format GUID */
4219
+ fulfillerId?: string;
4285
4220
  }
4286
- interface MarkOrderAsPaidRequest {
4221
+ interface SendFulfillmentEmailResponse {
4222
+ }
4223
+ interface SendMerchantOrderReceivedPushRequest {
4287
4224
  /**
4288
- * Ecom order ID.
4289
4225
  * @minLength 1
4290
4226
  * @maxLength 100
4291
4227
  */
4292
- ecomOrderId: string;
4228
+ orderId?: string;
4293
4229
  }
4294
- interface MarkOrderAsPaidResponse {
4295
- /** Updated order. */
4296
- order?: Order;
4230
+ interface SendMerchantOrderReceivedPushResponse {
4297
4231
  }
4298
- interface BulkMarkOrdersAsPaidRequest {
4232
+ interface PreviewEmailByTypeRequest {
4233
+ emailType?: PreviewEmailTypeWithLiterals;
4234
+ }
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"
4240
+ }
4241
+ /** @enumType */
4242
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4243
+ interface PreviewEmailByTypeResponse {
4244
+ emailPreview?: string;
4245
+ }
4246
+ interface PreviewRefundEmailRequest {
4299
4247
  /**
4300
- * IDs of orders to mark as paid.
4301
- * @minSize 1
4302
- * @maxSize 100
4303
4248
  * @minLength 1
4304
4249
  * @maxLength 100
4305
4250
  */
4306
- ecomOrderIds: string[];
4307
- }
4308
- interface BulkMarkOrdersAsPaidResponse {
4251
+ orderId?: string;
4252
+ /** Refund amount */
4253
+ refundAmount?: Price;
4254
+ /** Refund business details */
4255
+ details?: RefundDetails;
4309
4256
  /**
4310
- * Items updated by the bulk action.
4311
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4257
+ * Personal note added to the email (optional)
4258
+ * @minLength 1
4259
+ * @maxLength 1000
4312
4260
  */
4313
- results?: BulkOrderResult[];
4314
- /** Bulk action metadata. */
4315
- bulkActionMetadata?: BulkActionMetadata;
4316
- }
4317
- interface BulkOrderResult {
4318
- /** Item metadata. */
4319
- itemMetadata?: ItemMetadata;
4320
- /**
4321
- * Updated order.
4322
- *
4323
- * Returned when `returnFullEntity = true`.
4324
- */
4325
- item?: Order;
4326
- }
4327
- interface ItemMetadata {
4328
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4329
- _id?: string | null;
4330
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4331
- originalIndex?: number;
4332
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4333
- success?: boolean;
4334
- /** Details about the error in case of failure. */
4335
- error?: ApplicationError;
4336
- }
4337
- interface ApplicationError {
4338
- /** Error code. */
4339
- code?: string;
4340
- /** Description of the error. */
4341
- description?: string;
4342
- /** Data related to the error. */
4343
- data?: Record<string, any> | null;
4344
- }
4345
- interface BulkActionMetadata {
4346
- /** Number of items that were successfully processed. */
4347
- totalSuccesses?: number;
4348
- /** Number of items that couldn't be processed. */
4349
- totalFailures?: number;
4350
- /** Number of failures without details because detailed failure threshold was exceeded. */
4351
- undetailedFailures?: number;
4352
- }
4353
- interface GetRefundabilityStatusRequest {
4354
- /**
4355
- * Order ID.
4356
- * @minLength 1
4357
- * @maxLength 100
4358
- */
4359
- ecomOrderId: string;
4360
- }
4361
- interface GetRefundabilityStatusResponse {
4362
- /**
4363
- * Refundability details.
4364
- * @maxSize 300
4365
- */
4366
- refundabilities?: Refundability[];
4367
- /**
4368
- * Whether the order supports refunding per item.
4369
- * @deprecated
4370
- */
4371
- refundablePerItem?: boolean;
4372
- }
4373
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4374
- /** Reason why payment is not refundable. */
4375
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4376
- /** Reason why payment is only refundable manually. */
4377
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4378
- /** Payment ID. */
4379
- paymentId?: string;
4380
- /** Payment refundability status. */
4381
- refundabilityStatus?: RefundableStatusWithLiterals;
4382
- /** Link to payment provider dashboard. */
4383
- providerLink?: string | null;
4384
- }
4385
- /** @oneof */
4386
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4387
- /** Reason why payment is not refundable. */
4388
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4389
- /** Reason why payment is only refundable manually. */
4390
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4391
- }
4392
- declare enum RefundableStatus {
4393
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4394
- MANUAL = "MANUAL",
4395
- REFUNDABLE = "REFUNDABLE"
4396
- }
4397
- /** @enumType */
4398
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4399
- declare enum NonRefundableReason {
4400
- NONE = "NONE",
4401
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4402
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4403
- INTERNAL_ERROR = "INTERNAL_ERROR",
4404
- NOT_PAID = "NOT_PAID",
4405
- ACCESS_DENIED = "ACCESS_DENIED",
4406
- ZERO_PRICE = "ZERO_PRICE",
4407
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4408
- PENDING_REFUND = "PENDING_REFUND",
4409
- FORBIDDEN = "FORBIDDEN",
4410
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4411
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4412
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4413
- }
4414
- /** @enumType */
4415
- 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';
4416
- declare enum ManuallyRefundableReason {
4417
- EXPIRED = "EXPIRED",
4418
- NOT_SUPPORTED = "NOT_SUPPORTED",
4419
- OFFLINE = "OFFLINE",
4420
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4421
- }
4422
- /** @enumType */
4423
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4424
- interface CreatePaymentGatewayOrderRequest {
4425
- /**
4426
- * Ecom order ID.
4427
- * @minLength 1
4428
- * @maxLength 100
4429
- */
4430
- ecomOrderId: string;
4431
- /** Information about the user who initiated the payment. */
4432
- chargedBy?: ChargedBy;
4433
- }
4434
- interface ChargedBy {
4435
- /**
4436
- * ID - id of the user who initiated the payment
4437
- * @format GUID
4438
- */
4439
- _id?: string;
4440
- /**
4441
- * Full name - name of the user who initiated the payment
4442
- * @minLength 1
4443
- * @maxLength 200
4444
- */
4445
- fullName?: string | null;
4446
- }
4447
- interface CreatePaymentGatewayOrderResponse {
4448
- /** ID of the order created in the payment gateway */
4449
- paymentGatewayOrderId?: string;
4450
- }
4451
- interface ChargeMembershipsRequest {
4452
- /**
4453
- * Order ID.
4454
- * @minLength 1
4455
- * @maxLength 100
4456
- */
4457
- ecomOrderId: string;
4458
- /**
4459
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4460
- * but a user which is using the membership on behalf of the a member
4461
- * @format GUID
4462
- */
4463
- memberId: string;
4464
- /**
4465
- * List of items to be paid by memberships
4466
- * @minSize 1
4467
- * @maxSize 300
4468
- */
4469
- membershipCharges?: MembershipChargeItem[];
4470
- }
4471
- interface MembershipChargeItem {
4472
- /**
4473
- * The id of used membership
4474
- * @minLength 1
4475
- * @maxLength 100
4476
- */
4477
- membershipId?: string;
4478
- /**
4479
- * ID of the application providing this payment option
4480
- * @format GUID
4481
- */
4482
- appId?: string;
4483
- /** The name of used membership */
4484
- membershipName?: MembershipName;
4485
- /** Additional data about this membership */
4486
- membershipAdditionalData?: Record<string, any> | null;
4487
- /** Catalog and item reference info. */
4488
- catalogReference?: CatalogReference;
4489
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4490
- serviceProperties?: ServiceProperties;
4491
- /**
4492
- * Usually would be the same as catalogReference.catalogItemId
4493
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4494
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4495
- * @minLength 1
4496
- * @maxLength 36
4497
- */
4498
- rootCatalogItemId?: string | null;
4499
- /**
4500
- * line item id of Checkout/Order line item
4501
- * @minLength 1
4502
- * @maxLength 100
4503
- */
4504
- lineItemId?: string;
4505
- }
4506
- interface MembershipName {
4507
- /**
4508
- * Membership name in the site's original language.
4509
- * @maxLength 100
4510
- */
4511
- original?: string;
4512
- /**
4513
- * Membership name translated into the buyer's language.
4514
- *
4515
- * Default: The value of `original`
4516
- * @maxLength 100
4517
- */
4518
- translated?: string | null;
4519
- }
4520
- interface ChargeMembershipsResponse {
4521
- }
4522
- interface TriggerRefundRequest {
4523
- /**
4524
- * The order this refund related to
4525
- * @minLength 1
4526
- * @maxLength 100
4527
- */
4528
- ecomOrderId: string;
4529
- /**
4530
- * Refund operations information
4531
- * @minSize 1
4532
- * @maxSize 1
4533
- */
4534
- payments: PaymentRefund[];
4535
- /** Business model of a refund */
4536
- details?: RefundDetails;
4537
- /** Side effect details related to refund */
4538
- sideEffects?: RefundSideEffects;
4539
- }
4540
- interface PaymentRefund {
4261
+ customMessage?: string | null;
4541
4262
  /**
4542
- * Specific payment within the order to refund
4263
+ * Refund ID. (Optional)
4543
4264
  * @format GUID
4544
4265
  */
4545
- paymentId?: string;
4546
- /** Refund amount. Not relevant for membership and gift card refunds. */
4547
- amount?: Price;
4548
- /**
4549
- * Whether refund is made externally and manually (on the payment provider's side)
4550
- * 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.
4551
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4552
- */
4553
- externalRefund?: boolean;
4266
+ refundId?: string | null;
4554
4267
  }
4555
4268
  /** Business model of a refund request */
4556
4269
  interface RefundDetails {
@@ -4627,1645 +4340,1943 @@ interface ShippingRefund {
4627
4340
  */
4628
4341
  amount?: Price;
4629
4342
  }
4630
- interface RefundSideEffects {
4631
- /** Inventory restock details as part of this refund. */
4632
- restockInfo?: RestockInfo;
4633
- /** Whether to send a refund confirmation email to the customer. */
4634
- sendOrderRefundedEmail?: boolean;
4343
+ interface PreviewRefundEmailResponse {
4344
+ emailPreview?: string;
4345
+ }
4346
+ interface PreviewCancelEmailRequest {
4635
4347
  /**
4636
- * Custom message added to the refund confirmation email.
4637
4348
  * @minLength 1
4638
- * @maxLength 1000
4349
+ * @maxLength 100
4639
4350
  */
4640
- customMessage?: string | null;
4641
- }
4642
- interface RestockInfo {
4643
- /** Restock type. */
4644
- type?: RestockTypeWithLiterals;
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",
4645
4642
  /**
4646
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4647
- * @maxSize 300
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).
4648
4645
  */
4649
- items?: RestockItem[];
4650
- }
4651
- declare enum RestockType {
4652
- NO_ITEMS = "NO_ITEMS",
4653
- ALL_ITEMS = "ALL_ITEMS",
4654
- SOME_ITEMS = "SOME_ITEMS"
4655
- }
4656
- /** @enumType */
4657
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4658
- interface RestockItem {
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",
4659
4655
  /**
4660
- * ID of the line item being restocked.
4661
- * @format GUID
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.
4662
4659
  */
4663
- lineItemId?: string;
4660
+ HTML_DRAFT = "HTML_DRAFT",
4664
4661
  /**
4665
- * Line item quantity being restocked.
4666
- * @min 1
4667
- * @max 100000
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.
4668
4665
  */
4669
- quantity?: number;
4670
- }
4671
- interface TriggerRefundResponse {
4672
- /** All order's transactions after the refunds were added */
4673
- orderTransactions?: OrderTransactions;
4674
- /** Created refund ID */
4675
- refundId?: string | null;
4676
- /** Payment ID's that the refund execution had failed for */
4677
- failedPaymentIds?: ItemMetadata[];
4678
- }
4679
- /**
4680
- * A record of all payments and refunds associated with an order.
4681
- *
4682
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4683
- */
4684
- interface OrderTransactions {
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",
4685
4675
  /**
4686
- * Order ID.
4687
- * @format GUID
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
4688
4678
  */
4689
- orderId?: string;
4679
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4680
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4681
+ RISE = "RISE",
4690
4682
  /**
4691
- * Record of payments made to the merchant.
4692
- * @maxSize 100
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.
4693
4686
  */
4694
- payments?: Payment[];
4687
+ BRANDED_FIRST = "BRANDED_FIRST",
4688
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4689
+ NOWNIA = "NOWNIA",
4695
4690
  /**
4696
- * Record of refunds made to the buyer.
4697
- * @maxSize 300
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.
4698
4693
  */
4699
- refunds?: Refund[];
4700
- }
4701
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4702
- /** Regular payment details. */
4703
- regularPaymentDetails?: RegularPaymentDetails;
4704
- /** Gift card payment details. */
4705
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4706
- /** Membership payment details. */
4707
- membershipPaymentDetails?: MembershipPaymentDetails;
4694
+ UGC_TEMPLATE = "UGC_TEMPLATE",
4695
+ /** Codux Headless Sites */
4696
+ CODUX = "CODUX",
4697
+ /** Bobb - AI Design Creator. */
4698
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4708
4699
  /**
4709
- * Payment ID.
4710
- * @format GUID
4711
- * @readonly
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.
4712
4702
  */
4713
- _id?: string | null;
4714
- /** 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. */
4715
- _createdDate?: Date | null;
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",
4716
4720
  /**
4717
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4718
- * @readonly
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.
4719
4723
  */
4720
- _updatedDate?: Date | null;
4721
- /** Payment amount. */
4722
- amount?: Price;
4724
+ SYMPHONY = "SYMPHONY",
4725
+ /** Nautilus platform app. */
4726
+ NAUTILUS_APPS = "NAUTILUS_APPS",
4723
4727
  /**
4724
- * Whether refunds for this payment are disabled.
4725
- * + `true`: This payment is not refundable.
4726
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
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.
4727
4730
  */
4728
- refundDisabled?: boolean;
4731
+ VIBU = "VIBU",
4729
4732
  /**
4730
- * Whether receipt generation is allowed for this payment.
4731
- * + `true`: This payment supports receipt generation.
4732
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4733
- * @readonly
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.
4734
4737
  */
4735
- supportReceiptGeneration?: boolean;
4736
- /** Details about cash rounding applied to this payment, when relevant. */
4737
- cashRounding?: CashRoundingDetails;
4738
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4738
4739
  /**
4739
- * Overall payment status.
4740
- *
4741
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
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.
4742
4742
  */
4743
- status?: PaymentStatusWithLiterals;
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 {
4744
4749
  /**
4745
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4750
+ * A previous owner id (user that transfers meta site).
4746
4751
  * @format GUID
4747
4752
  */
4748
- chargeCorrelationId?: string | null;
4753
+ oldOwnerId?: string;
4754
+ /**
4755
+ * A new owner id (user that accepts meta site).
4756
+ * @format GUID
4757
+ */
4758
+ newOwnerId?: string;
4749
4759
  }
4750
- /** @oneof */
4751
- interface PaymentPaymentDetailsOneOf {
4752
- /** Regular payment details. */
4753
- regularPaymentDetails?: RegularPaymentDetails;
4754
- /** Gift card payment details. */
4755
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4756
- /** Membership payment details. */
4757
- membershipPaymentDetails?: MembershipPaymentDetails;
4760
+ /** Soft deletion of the meta site. Could be restored. */
4761
+ interface SiteDeleted {
4762
+ /** A deletion context. */
4763
+ deleteContext?: DeleteContext;
4758
4764
  }
4759
- /** @oneof */
4760
- interface PaymentReceiptInfoOneOf {
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;
4761
4780
  }
4762
- /** @oneof */
4763
- interface PaymentStatusDetailsOneOf {
4781
+ declare enum DeleteStatus {
4782
+ UNKNOWN = "UNKNOWN",
4783
+ TRASH = "TRASH",
4784
+ DELETED = "DELETED",
4785
+ PENDING_PURGE = "PENDING_PURGE",
4786
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4764
4787
  }
4765
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4766
- /** Credit card details. */
4767
- creditCardDetails?: CreditCardPaymentMethodDetails;
4788
+ /** @enumType */
4789
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4790
+ /** Restoration of the meta site. */
4791
+ interface SiteUndeleted {
4792
+ }
4793
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
4794
+ interface SitePublished {
4795
+ }
4796
+ interface SiteUnpublished {
4768
4797
  /**
4769
- * Wix Payments order ID.
4770
- * @maxLength 100
4798
+ * A list of URLs previously associated with the meta site.
4799
+ * @maxLength 4000
4800
+ * @maxSize 10000
4771
4801
  */
4772
- paymentOrderId?: string | null;
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 {
4773
4824
  /**
4774
- * Payment gateway's transaction ID.
4775
- * This field is only returned when the value of `offline_payment` is `false`.
4776
- * @maxLength 100
4825
+ * Either UUID or EmbeddedServiceType.
4826
+ * @maxLength 36
4777
4827
  */
4778
- gatewayTransactionId?: string | null;
4828
+ appDefId?: string;
4779
4829
  /**
4780
- * Payment method.
4781
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4782
- * Non-exhaustive list of supported values:
4783
- * + `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`
4784
- * @maxLength 150
4785
- * @deprecated Payment method.
4786
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4787
- * Non-exhaustive list of supported values:
4788
- * + `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`
4789
- * @replacedBy payment_method_name
4790
- * @targetRemovalDate 2026-07-01
4830
+ * Not only UUID. Something here could be something weird.
4831
+ * @maxLength 36
4791
4832
  */
4792
- paymentMethod?: string | null;
4833
+ instanceId?: string;
4793
4834
  /**
4794
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4795
- * @maxLength 100
4835
+ * An instance id from which this instance is originated.
4836
+ * @maxLength 36
4796
4837
  */
4797
- providerTransactionId?: string | null;
4798
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4799
- offlinePayment?: boolean;
4838
+ originInstanceId?: string;
4800
4839
  /**
4801
- * Payment status.
4802
- * @deprecated Payment status.
4803
- * @replacedBy payment.status
4804
- * @targetRemovalDate 2026-11-01
4840
+ * A version.
4841
+ * @maxLength 500
4805
4842
  */
4806
- status?: TransactionStatusWithLiterals;
4807
- /** Whether there is a payment agreement that allows for future charges. */
4808
- savedPaymentMethod?: boolean;
4809
- /** Authorization details. */
4810
- authorizationDetails?: AuthorizationDetails;
4843
+ version?: string | null;
4811
4844
  /**
4812
- * Record of chargebacks made by the buyer.
4813
- * @maxSize 6
4845
+ * The origin meta site id
4846
+ * @format GUID
4814
4847
  */
4815
- chargebacks?: Chargeback[];
4816
- /** Platform fee amount associated with this payment. */
4817
- platformFee?: Price;
4848
+ originMetaSiteId?: string | null;
4849
+ }
4850
+ interface ServiceRemoved {
4818
4851
  /**
4819
- * Payment method with buyer and optional owner translations.
4820
- * Non-exhaustive list of supported values:
4821
- * + `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`
4852
+ * Either UUID or EmbeddedServiceType.
4853
+ * @maxLength 36
4822
4854
  */
4823
- paymentMethodName?: PaymentMethodName;
4824
- }
4825
- /** @oneof */
4826
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4827
- /** Credit card details. */
4828
- creditCardDetails?: CreditCardPaymentMethodDetails;
4829
- }
4830
- declare enum TransactionStatus {
4831
- UNDEFINED = "UNDEFINED",
4832
- APPROVED = "APPROVED",
4833
- PENDING = "PENDING",
4834
- PENDING_MERCHANT = "PENDING_MERCHANT",
4835
- CANCELED = "CANCELED",
4836
- DECLINED = "DECLINED",
4837
- REFUNDED = "REFUNDED",
4838
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4839
- AUTHORIZED = "AUTHORIZED",
4840
- VOIDED = "VOIDED"
4841
- }
4842
- /** @enumType */
4843
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4844
- interface CreditCardPaymentMethodDetails {
4855
+ appDefId?: string;
4845
4856
  /**
4846
- * The last 4 digits of the card number.
4847
- * @maxLength 4
4857
+ * Not only UUID. Something here could be something weird.
4858
+ * @maxLength 36
4848
4859
  */
4849
- lastFourDigits?: string | null;
4860
+ instanceId?: string;
4850
4861
  /**
4851
- * Card issuer's brand.
4852
- * @maxLength 100
4862
+ * A version.
4863
+ * @maxLength 500
4853
4864
  */
4854
- brand?: string | null;
4865
+ version?: string | null;
4855
4866
  }
4856
- interface AuthorizationDetails {
4867
+ /** Rename of the site. Meaning, free public url has been changed as well. */
4868
+ interface SiteRenamed {
4857
4869
  /**
4858
- * Whether the authorized payment is of a delayed capture.
4859
- * @readonly
4870
+ * A new meta site name (URL slug).
4871
+ * @maxLength 20
4860
4872
  */
4861
- delayedCapture?: boolean;
4862
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4863
- authorizedDate?: Date | null;
4873
+ newSiteName?: string;
4864
4874
  /**
4865
- * List of captures associated with payment
4866
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4867
- * @maxSize 1
4875
+ * A previous meta site name (URL slug).
4876
+ * @maxLength 255
4868
4877
  */
4869
- captures?: AuthorizationCapture[];
4870
- /** Void associated with payment */
4871
- void?: AuthorizationVoid;
4872
- /** Scheduled action for this transaction */
4873
- scheduledAction?: V1ScheduledAction;
4878
+ oldSiteName?: string;
4874
4879
  }
4875
- interface AuthorizationCapture {
4876
- /**
4877
- * Capture ID.
4878
- * @format GUID
4879
- * @readonly
4880
- */
4881
- _id?: string | null;
4882
- /** Status of this capture action */
4883
- status?: AuthorizationCaptureStatusWithLiterals;
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 {
4910
+ }
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 {
4884
4916
  /**
4885
- * Amount of this capture
4886
- * @immutable
4917
+ * @maxLength 2048
4918
+ * @maxSize 100
4919
+ * @deprecated
4920
+ * @targetRemovalDate 2025-04-15
4887
4921
  */
4888
- amount?: Price;
4889
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4890
- _createdDate?: Date | null;
4891
- /** In case of status is FAILED may contain failure details */
4892
- failureDetails?: AuthorizationActionFailureDetails;
4922
+ appDefId?: string[];
4893
4923
  }
4894
- declare enum AuthorizationCaptureStatus {
4895
- /** Capture operation still in progress. */
4896
- PENDING = "PENDING",
4897
- /** Capture operation succeeded. */
4898
- SUCCEEDED = "SUCCEEDED",
4899
- /** Capture operation failed. */
4900
- FAILED = "FAILED"
4924
+ /** Assigned Odeditor */
4925
+ interface OdeditorAssigned {
4901
4926
  }
4902
- /** @enumType */
4903
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4904
- interface AuthorizationActionFailureDetails {
4905
- /** @maxLength 100 */
4906
- failureCode?: string;
4927
+ /** Unassigned Odeditor */
4928
+ interface OdeditorUnassigned {
4907
4929
  }
4908
- interface AuthorizationVoid {
4909
- /** Status of this void action */
4910
- status?: AuthorizationVoidStatusWithLiterals;
4911
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4912
- voidedDate?: Date | null;
4913
- /** In case of status is FAILED may contain failure details */
4914
- failureDetails?: AuthorizationActionFailureDetails;
4915
- /** Reason of void action */
4916
- reason?: ReasonWithLiterals;
4930
+ /** Assigned Picasso editor */
4931
+ interface PicassoAssigned {
4917
4932
  }
4918
- declare enum AuthorizationVoidStatus {
4919
- /** Void operation still in progress. */
4920
- PENDING = "PENDING",
4921
- /** Void operation succeeded. */
4922
- SUCCEEDED = "SUCCEEDED",
4923
- /** Void operation failed. */
4924
- FAILED = "FAILED"
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 {
4959
+ }
4960
+ interface HasCustomEmailConfigurationsRequest {
4961
+ }
4962
+ interface HasCustomEmailConfigurationsResponse {
4963
+ hasCustomConfigurations?: boolean;
4964
+ }
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;
4970
+ }
4971
+ declare enum Origin {
4972
+ OPT_IN = "OPT_IN",
4973
+ MIGRATION = "MIGRATION"
4925
4974
  }
4926
4975
  /** @enumType */
4927
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4928
- /** Reason the authorization was voided. */
4929
- declare enum Reason {
4930
- /** Authorization was voided by user. */
4931
- MANUAL = "MANUAL",
4932
- /** Authorization passed execution date. */
4933
- SCHEDULED = "SCHEDULED"
4976
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4977
+ interface AddToAutomationMigrationPopulationResponse {
4978
+ success?: boolean;
4934
4979
  }
4935
- /** @enumType */
4936
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4937
- interface V1ScheduledAction {
4938
- /** Type of the action. */
4939
- actionType?: ActionTypeWithLiterals;
4940
- /** The date and time of the action. */
4941
- executionDate?: Date | null;
4980
+ interface IsInAutomationMigrationPopulationRequest {
4942
4981
  }
4943
- declare enum ActionType {
4944
- VOID = "VOID",
4945
- CAPTURE = "CAPTURE"
4982
+ interface IsInAutomationMigrationPopulationResponse {
4983
+ inPopulation?: boolean;
4946
4984
  }
4947
- /** @enumType */
4948
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4949
- interface Chargeback {
4985
+ interface PreparePaymentCollectionRequest {
4950
4986
  /**
4951
- * Chargeback ID.
4952
- * @format GUID
4953
- * @readonly
4954
- * @immutable
4987
+ * Ecom order ID.
4988
+ * @minLength 1
4989
+ * @maxLength 100
4955
4990
  */
4956
- _id?: string;
4991
+ ecomOrderId: string;
4992
+ /** Amount to collect */
4993
+ amount: Price;
4957
4994
  /**
4958
- * 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.
4959
- * @readonly
4960
- * @immutable
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.
4961
4998
  */
4962
- _createdDate?: Date | null;
4999
+ paymentGatewayOrderId?: string | null;
4963
5000
  /**
4964
- * 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.
4965
- * @readonly
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
4966
5007
  */
4967
- _updatedDate?: Date | null;
5008
+ delayedCapture?: boolean;
5009
+ /** Delayed capture payment settings */
5010
+ delayedCaptureSettings?: DelayedCaptureSettings;
5011
+ }
5012
+ interface RedirectUrls {
4968
5013
  /**
4969
- * Amount.
4970
- * @readonly
4971
- * @immutable
5014
+ * URL to redirect buyer in case of approved (successful) transaction
5015
+ * @format WEB_URL
4972
5016
  */
4973
- amount?: Price;
5017
+ successUrl?: string | null;
4974
5018
  /**
4975
- * Reversal amount. Present only when status is REVERSED.
4976
- * @readonly
5019
+ * URL to redirect buyer in case of buyer canceled the transaction
5020
+ * @format WEB_URL
4977
5021
  */
4978
- reversalAmount?: Price;
5022
+ cancelUrl?: string | null;
4979
5023
  /**
4980
- * Status.
4981
- *
4982
- * Default: `"APPROVED"`.
5024
+ * URL to redirect buyer in case of failed/rejected transaction
5025
+ * @format WEB_URL
4983
5026
  */
4984
- status?: ChargebackStatusWithLiterals;
5027
+ errorUrl?: string | null;
4985
5028
  /**
4986
- * External chargeback ID.
4987
- * @format GUID
4988
- * @readonly
4989
- * @immutable
5029
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5030
+ * @format WEB_URL
4990
5031
  */
4991
- externalId?: string | null;
5032
+ pendingUrl?: string | null;
4992
5033
  }
4993
- declare enum ChargebackStatus {
4994
- /** Chargeback was approved. */
4995
- APPROVED = "APPROVED",
4996
- /** Chargeback was reversed. */
4997
- REVERSED = "REVERSED"
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"
4998
5045
  }
4999
5046
  /** @enumType */
5000
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5001
- interface PaymentMethodName {
5002
- /**
5003
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5004
- * @maxLength 150
5005
- */
5006
- buyerLanguageName?: string | null;
5007
- /**
5008
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5009
- *
5010
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5011
- * @maxLength 150
5012
- */
5013
- siteLanguageName?: string | null;
5047
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5048
+ interface Duration {
5014
5049
  /**
5015
- * User-provided payment method name.
5016
- *
5017
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5050
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5051
+ * @min 1
5018
5052
  */
5019
- userDefinedName?: UserDefinedPaymentMethodName;
5053
+ count?: number;
5054
+ /** Duration unit: MINUTES, HOURS and DAYS */
5055
+ unit?: DurationUnitWithLiterals;
5020
5056
  }
5021
- interface GiftCardPaymentDetails {
5022
- /**
5023
- * Gift card payment ID.
5024
- * @maxLength 100
5025
- */
5026
- giftCardPaymentId?: string;
5027
- /**
5028
- * ID of the app that created the gift card.
5029
- * @format GUID
5030
- */
5031
- appId?: string;
5032
- /**
5033
- * Whether the gift card is voided.
5034
- * @readonly
5035
- * @deprecated Whether the gift card is voided.
5036
- * @replacedBy payment.status
5037
- * @targetRemovalDate 2026-11-01
5038
- */
5039
- voided?: boolean;
5040
- /**
5041
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5042
- * @maxLength 30
5043
- * @immutable
5044
- */
5045
- obfuscatedCode?: string | null;
5057
+ declare enum DurationUnit {
5058
+ MINUTES = "MINUTES",
5059
+ HOURS = "HOURS",
5060
+ DAYS = "DAYS"
5046
5061
  }
5047
- interface MembershipPaymentDetails {
5048
- /**
5049
- * Membership ID.
5050
- * @maxLength 200
5051
- */
5052
- membershipId?: string;
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 {
5053
5069
  /**
5054
- * ID of the line item this membership applies to.
5070
+ * Ecom order ID.
5055
5071
  * @minLength 1
5056
5072
  * @maxLength 100
5057
5073
  */
5058
- lineItemId?: string;
5059
- /**
5060
- * Payment status.
5061
- * @deprecated Payment status.
5062
- * @replacedBy payment.status
5063
- * @targetRemovalDate 2026-11-01
5064
- */
5065
- status?: MembershipPaymentStatusWithLiterals;
5066
- /** Membership name. */
5067
- name?: MembershipName;
5074
+ ecomOrderId: string;
5075
+ }
5076
+ interface GetPaymentCollectabilityStatusResponse {
5077
+ /** Payment collectability status */
5078
+ status?: PaymentCollectabilityStatusWithLiterals;
5079
+ /** Collectable order amount */
5080
+ amount?: Price;
5081
+ }
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"
5096
+ }
5097
+ /** @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 {
5068
5100
  /**
5069
- * The transaction ID in the membership system. Can be used to void the transaction.
5101
+ * Order ID.
5070
5102
  * @minLength 1
5071
5103
  * @maxLength 100
5072
5104
  */
5073
- externalTransactionId?: string | null;
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;
5074
5116
  /**
5075
- * Whether the membership is voided.
5076
- * @readonly
5077
- * @deprecated Whether the membership is voided.
5078
- * @replacedBy payment.status
5079
- * @targetRemovalDate 2026-11-01
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
5121
+ * @maxLength 150
5080
5122
  */
5081
- voided?: boolean;
5123
+ custom?: string | null;
5124
+ }
5125
+ /** @oneof */
5126
+ interface UserDefinedPaymentMethodNameKindOneOf {
5127
+ /** Predefined payment method. */
5128
+ predefined?: PredefinedPaymentMethodWithLiterals;
5082
5129
  /**
5083
- * ID of the application providing this payment option.
5084
- * @format GUID
5130
+ * Custom payment method name provided by user.
5131
+ *
5132
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5133
+ * @minLength 1
5134
+ * @maxLength 150
5085
5135
  */
5086
- providerAppId?: string;
5087
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5088
- futureMembership?: FutureMembershipDetails;
5136
+ custom?: string | null;
5089
5137
  }
5090
- declare enum MembershipPaymentStatus {
5091
- /** Payment was charged. */
5092
- CHARGED = "CHARGED",
5093
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5094
- CHARGE_FAILED = "CHARGE_FAILED",
5095
- /** Payment is pending. */
5096
- CHARGE_PENDING = "CHARGE_PENDING",
5097
- /** Payment was voided. */
5098
- VOIDED = "VOIDED"
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"
5099
5146
  }
5100
5147
  /** @enumType */
5101
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5102
- interface FutureMembershipDetails {
5103
- /**
5104
- * ID of the plan line item in the order from which the membership will be created.
5105
- * @format GUID
5106
- */
5107
- lineItemId?: string;
5108
- /**
5109
- * ID of the benefit the future membership will grant.
5110
- * @maxLength 200
5111
- */
5112
- benefitId?: string;
5148
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5149
+ interface RecordManuallyCollectedPaymentResponse {
5113
5150
  }
5114
- interface WixReceiptInfo {
5151
+ interface MarkOrderAsPaidRequest {
5115
5152
  /**
5116
- * Receipt ID
5117
- * @format GUID
5153
+ * Ecom order ID.
5154
+ * @minLength 1
5155
+ * @maxLength 100
5118
5156
  */
5119
- receiptId?: string;
5157
+ ecomOrderId: string;
5158
+ }
5159
+ interface MarkOrderAsPaidResponse {
5160
+ /** Updated order. */
5161
+ order?: Order;
5162
+ }
5163
+ interface BulkMarkOrdersAsPaidRequest {
5120
5164
  /**
5121
- * Display number of receipt
5165
+ * IDs of orders to mark as paid.
5166
+ * @minSize 1
5167
+ * @maxSize 100
5122
5168
  * @minLength 1
5123
- * @maxLength 40
5169
+ * @maxLength 100
5124
5170
  */
5125
- displayNumber?: string | null;
5171
+ ecomOrderIds: string[];
5126
5172
  }
5127
- interface ExternalReceiptInfo {
5173
+ interface BulkMarkOrdersAsPaidResponse {
5128
5174
  /**
5129
- * External receipt ID
5130
- * @maxLength 100
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.
5131
5177
  */
5132
- receiptId?: string | null;
5178
+ results?: BulkOrderResult[];
5179
+ /** Bulk action metadata. */
5180
+ bulkActionMetadata?: BulkActionMetadata;
5181
+ }
5182
+ interface BulkOrderResult {
5183
+ /** Item metadata. */
5184
+ itemMetadata?: ItemMetadata;
5133
5185
  /**
5134
- * ID of the app providing the receipt
5135
- * @format GUID
5186
+ * Updated order.
5187
+ *
5188
+ * Returned when `returnFullEntity = true`.
5136
5189
  */
5137
- appId?: string | null;
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;
5217
+ }
5218
+ interface GetRefundabilityStatusRequest {
5138
5219
  /**
5139
- * Display number of receipt
5220
+ * Order ID.
5140
5221
  * @minLength 1
5141
- * @maxLength 40
5222
+ * @maxLength 100
5142
5223
  */
5143
- displayNumber?: string | null;
5224
+ ecomOrderId: string;
5144
5225
  }
5145
- interface CashRoundingDetails {
5226
+ interface GetRefundabilityStatusResponse {
5146
5227
  /**
5147
- * Payment amount before cash rounding was applied.
5148
- * When provided, balance and status calculations use this value instead of `amount`
5149
- * to prevent false overpayment or underpayment due to rounding.
5228
+ * Refundability details.
5229
+ * @maxSize 300
5150
5230
  */
5151
- unroundedAmount?: Price;
5231
+ refundabilities?: Refundability[];
5152
5232
  /**
5153
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5154
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5155
- * @readonly
5233
+ * Whether the order supports refunding per item.
5234
+ * @deprecated
5156
5235
  */
5157
- roundingAdjustment?: CashRounding;
5236
+ refundablePerItem?: boolean;
5158
5237
  }
5159
- declare enum PaymentStatus {
5160
- /** Payment was charged successfully. */
5161
- APPROVED = "APPROVED",
5162
- /** Payment is being processed and hasn't been confirmed yet. */
5163
- PENDING = "PENDING",
5164
- /** 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. */
5165
- PENDING_MERCHANT = "PENDING_MERCHANT",
5166
- /** Payment was canceled before it was charged. */
5167
- CANCELED = "CANCELED",
5168
- /** Payment was declined by the payment provider. */
5169
- DECLINED = "DECLINED",
5170
- /** Payment was fully refunded. */
5171
- REFUNDED = "REFUNDED",
5172
- /** Part of the payment amount was refunded. */
5173
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5174
- /** 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. */
5175
- AUTHORIZED = "AUTHORIZED",
5176
- /**
5177
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5178
- *
5179
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5180
- */
5181
- VOIDED = "VOIDED"
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;
5182
5249
  }
5183
- /** @enumType */
5184
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5185
- interface CanceledStatusDetails {
5186
- reason?: CanceledReasonWithLiterals;
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;
5187
5256
  }
5188
- declare enum CanceledReason {
5189
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5190
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5191
- /** Payment was not completed by user and expired. */
5192
- EXPIRED = "EXPIRED"
5257
+ declare enum RefundableStatus {
5258
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5259
+ MANUAL = "MANUAL",
5260
+ REFUNDABLE = "REFUNDABLE"
5193
5261
  }
5194
5262
  /** @enumType */
5195
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5196
- interface DeclinedStatusDetails {
5197
- reason?: DeclinedReasonWithLiterals;
5198
- }
5199
- declare enum DeclinedReason {
5200
- /** Corresponding charge failed. */
5201
- CHARGE_FAILED = "CHARGE_FAILED",
5202
- /** Payment details expired. */
5203
- EXPIRED = "EXPIRED",
5204
- /** Insufficient funds. */
5205
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5206
- /** Gift card was disabled before charge was attempted. */
5207
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
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"
5208
5278
  }
5209
5279
  /** @enumType */
5210
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5211
- interface VoidedStatusDetails {
5212
- reason?: VoidedReasonWithLiterals;
5213
- }
5214
- declare enum VoidedReason {
5215
- /** Payment was voided by merchant request. */
5216
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5217
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5218
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
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"
5219
5286
  }
5220
5287
  /** @enumType */
5221
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5222
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5223
- }
5224
- /** @oneof */
5225
- interface PaymentStatusDetailsStatusDetailsOneOf {
5288
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5289
+ interface CreatePaymentGatewayOrderRequest {
5290
+ /**
5291
+ * Ecom order ID.
5292
+ * @minLength 1
5293
+ * @maxLength 100
5294
+ */
5295
+ ecomOrderId: string;
5296
+ /** Information about the user who initiated the payment. */
5297
+ chargedBy?: ChargedBy;
5226
5298
  }
5227
- interface Refund {
5299
+ interface ChargedBy {
5228
5300
  /**
5229
- * Refund ID.
5301
+ * ID - id of the user who initiated the payment
5230
5302
  * @format GUID
5231
- * @readonly
5232
5303
  */
5233
5304
  _id?: string;
5234
5305
  /**
5235
- * List of transactions.
5236
- * @maxSize 50
5306
+ * Full name - name of the user who initiated the payment
5307
+ * @minLength 1
5308
+ * @maxLength 200
5237
5309
  */
5238
- transactions?: RefundTransaction[];
5239
- /** Refund business details. */
5240
- details?: RefundDetails;
5310
+ fullName?: string | null;
5311
+ }
5312
+ interface CreatePaymentGatewayOrderResponse {
5313
+ /** ID of the order created in the payment gateway */
5314
+ paymentGatewayOrderId?: string;
5315
+ }
5316
+ interface ChargeMembershipsRequest {
5241
5317
  /**
5242
- * 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.
5243
- * @readonly
5244
- * @immutable
5318
+ * Order ID.
5319
+ * @minLength 1
5320
+ * @maxLength 100
5321
+ */
5322
+ ecomOrderId: string;
5323
+ /**
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
5326
+ * @format GUID
5327
+ */
5328
+ memberId: string;
5329
+ /**
5330
+ * List of items to be paid by memberships
5331
+ * @minSize 1
5332
+ * @maxSize 300
5245
5333
  */
5246
- _createdDate?: Date | null;
5334
+ membershipCharges?: MembershipChargeItem[];
5335
+ }
5336
+ interface MembershipChargeItem {
5247
5337
  /**
5248
- * Aggregated refund summary.
5249
- * @readonly
5338
+ * The id of used membership
5339
+ * @minLength 1
5340
+ * @maxLength 100
5250
5341
  */
5251
- summary?: AggregatedRefundSummary;
5342
+ membershipId?: string;
5252
5343
  /**
5253
- * ID of the app that initiated this refund.
5344
+ * ID of the application providing this payment option
5254
5345
  * @format GUID
5255
- * @readonly
5256
- * @immutable
5257
5346
  */
5258
- requestingServiceAppId?: string | null;
5259
- }
5260
- interface RefundTransaction {
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;
5261
5356
  /**
5262
- * ID of the payment associated with this refund.
5263
- * @format GUID
5264
- * @immutable
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
5265
5362
  */
5266
- paymentId?: string;
5363
+ rootCatalogItemId?: string | null;
5267
5364
  /**
5268
- * Refund amount.
5269
- * @immutable
5365
+ * line item id of Checkout/Order line item
5366
+ * @minLength 1
5367
+ * @maxLength 100
5270
5368
  */
5271
- amount?: Price;
5272
- /** Refund status. */
5273
- refundStatus?: RefundStatusWithLiterals;
5274
- /** Optional details of current refund status. */
5275
- refundStatusInfo?: RefundStatusInfo;
5369
+ lineItemId?: string;
5370
+ }
5371
+ interface MembershipName {
5276
5372
  /**
5277
- * Payment gateway's refund ID.
5278
- * This field is only returned when the value of `external_refund` is `false`.
5279
- * @format GUID
5373
+ * Membership name in the site's original language.
5374
+ * @maxLength 100
5280
5375
  */
5281
- gatewayRefundId?: string | null;
5282
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5283
- providerRefundId?: string | null;
5376
+ original?: string;
5284
5377
  /**
5285
- * Whether refund was made externally and manually on the payment provider's side.
5286
- * @immutable
5378
+ * Membership name translated into the buyer's language.
5379
+ *
5380
+ * Default: The value of `original`
5381
+ * @maxLength 100
5287
5382
  */
5288
- externalRefund?: boolean;
5383
+ translated?: string | null;
5289
5384
  }
5290
- /** Refund transaction status. */
5291
- declare enum RefundStatus {
5292
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5293
- PENDING = "PENDING",
5294
- /** Refund transaction succeeded. */
5295
- SUCCEEDED = "SUCCEEDED",
5296
- /** Refund transaction failed. */
5297
- FAILED = "FAILED",
5298
- /** Refund request acknowledged, and will be executed soon. */
5299
- SCHEDULED = "SCHEDULED",
5300
- /** Refund was initiated on payment provider side. */
5301
- STARTED = "STARTED"
5385
+ interface ChargeMembershipsResponse {
5302
5386
  }
5303
- /** @enumType */
5304
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5305
- interface RefundStatusInfo {
5387
+ interface TriggerRefundRequest {
5306
5388
  /**
5307
- * Reason code for the refund's current status.
5308
- *
5309
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5389
+ * The order this refund related to
5310
5390
  * @minLength 1
5311
- * @maxLength 10
5391
+ * @maxLength 100
5312
5392
  */
5313
- paymentGatewayReasonCode?: string | null;
5393
+ ecomOrderId: string;
5314
5394
  /**
5315
- * Free text explanation of current refund status.
5316
- * @minLength 1
5317
- * @maxLength 1000
5395
+ * Refund operations information
5396
+ * @minSize 1
5397
+ * @maxSize 1
5318
5398
  */
5319
- description?: string | null;
5320
- }
5321
- interface AggregatedRefundSummary {
5322
- /** Total amount requested for refund. */
5323
- requestedRefund?: Price;
5324
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5325
- pendingRefund?: Price;
5326
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5327
- refunded?: Price;
5328
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5329
- failedRefundAmount?: Price;
5330
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5331
- pending?: boolean;
5332
- /** Breakdown of refunded items. Available only after refund is complete. */
5333
- breakdown?: RefundItemsBreakdown;
5399
+ payments: PaymentRefund[];
5400
+ /** Business model of a refund */
5401
+ details?: RefundDetails;
5402
+ /** Side effect details related to refund */
5403
+ sideEffects?: RefundSideEffects;
5334
5404
  }
5335
- interface RefundItemsBreakdown {
5405
+ interface PaymentRefund {
5336
5406
  /**
5337
- * Refunded line items and the amount refunded for each.
5338
- * @maxSize 300
5407
+ * Specific payment within the order to refund
5408
+ * @format GUID
5339
5409
  */
5340
- lineItems?: LineItemRefundSummary[];
5341
- }
5342
- interface LineItemRefundSummary {
5410
+ paymentId?: string;
5411
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5412
+ amount?: Price;
5343
5413
  /**
5344
- * ID of the refunded line item.
5345
- * @format GUID
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.
5346
5417
  */
5347
- lineItemId?: string;
5348
- /** Total refunded amount for the line item. */
5349
- totalRefundedAmount?: Price;
5418
+ externalRefund?: boolean;
5350
5419
  }
5351
- interface CalculateRefundRequest {
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;
5352
5425
  /**
5353
- * Order ID
5426
+ * Custom message added to the refund confirmation email.
5354
5427
  * @minLength 1
5355
- * @maxLength 100
5428
+ * @maxLength 1000
5356
5429
  */
5357
- ecomOrderId?: string;
5430
+ customMessage?: string | null;
5431
+ }
5432
+ interface RestockInfo {
5433
+ /** Restock type. */
5434
+ type?: RestockTypeWithLiterals;
5358
5435
  /**
5359
- * Refunded line items and quantity
5436
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5360
5437
  * @maxSize 300
5361
5438
  */
5362
- refundItems?: CalculateRefundItemRequest[];
5363
- /** Should include shipping in refund calculation */
5364
- refundShipping?: boolean;
5439
+ items?: RestockItem[];
5365
5440
  }
5366
- interface CalculateRefundItemRequest {
5441
+ declare enum RestockType {
5442
+ NO_ITEMS = "NO_ITEMS",
5443
+ ALL_ITEMS = "ALL_ITEMS",
5444
+ SOME_ITEMS = "SOME_ITEMS"
5445
+ }
5446
+ /** @enumType */
5447
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5448
+ interface RestockItem {
5367
5449
  /**
5368
- * ID of the line item being refunded
5450
+ * ID of the line item being restocked.
5369
5451
  * @format GUID
5370
5452
  */
5371
- _id?: string;
5453
+ lineItemId?: string;
5372
5454
  /**
5373
- * How much of that line item is being refunded
5455
+ * Line item quantity being restocked.
5374
5456
  * @min 1
5375
5457
  * @max 100000
5376
5458
  */
5377
5459
  quantity?: number;
5378
5460
  }
5379
- interface CalculateRefundResponse {
5380
- /** Total refundable amount */
5381
- total?: Price;
5382
- /** Tax cost of the order */
5383
- tax?: Price;
5384
- /** Discount given for this order */
5385
- discount?: Price;
5386
- /** Total cost of the order (without tax) */
5387
- subtotal?: Price;
5388
- /** Total shipping cost for order */
5389
- shipping?: Price;
5390
- /** Previous refund given on that order */
5391
- previouslyRefundedAmount?: Price;
5392
- /**
5393
- * The refundable items of that order
5394
- * @maxSize 300
5395
- */
5396
- items?: CalculateRefundItemResponse[];
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[];
5397
5468
  }
5398
- interface CalculateRefundItemResponse {
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 {
5399
5475
  /**
5400
- * Line item ID
5476
+ * Order ID.
5401
5477
  * @format GUID
5402
5478
  */
5403
- _id?: string;
5404
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5405
- price?: Price;
5406
- }
5407
- interface VoidAuthorizedPaymentsRequest {
5479
+ orderId?: string;
5408
5480
  /**
5409
- * Wix eCommerce order ID
5410
- * @minLength 1
5411
- * @maxLength 100
5481
+ * Record of payments made to the merchant.
5482
+ * @maxSize 100
5412
5483
  */
5413
- ecomOrderId: string;
5484
+ payments?: Payment[];
5414
5485
  /**
5415
- * Payment IDs
5416
- * @minSize 1
5417
- * @maxSize 100
5418
- * @format GUID
5486
+ * Record of refunds made to the buyer.
5487
+ * @maxSize 300
5419
5488
  */
5420
- paymentIds: string[];
5421
- }
5422
- interface VoidAuthorizedPaymentsResponse {
5423
- /** All order's transactions after the void was triggered */
5424
- orderTransactions?: OrderTransactions;
5489
+ refunds?: Refund[];
5425
5490
  }
5426
- interface CaptureAuthorizedPaymentsRequest {
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;
5427
5498
  /**
5428
- * Wix eCommerce order ID
5429
- * @minLength 1
5430
- * @maxLength 100
5499
+ * Payment ID.
5500
+ * @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
5431
5509
  */
5432
- ecomOrderId: string;
5510
+ _updatedDate?: Date | null;
5511
+ /** Payment amount. */
5512
+ amount?: Price;
5433
5513
  /**
5434
- * Capture payments information
5435
- * @minSize 1
5436
- * @maxSize 100
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.
5437
5517
  */
5438
- payments: PaymentCapture[];
5439
- }
5440
- interface PaymentCapture {
5518
+ refundDisabled?: boolean;
5441
5519
  /**
5442
- * Payment ID
5443
- * @format GUID
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
5444
5524
  */
5445
- paymentId?: string | null;
5525
+ supportReceiptGeneration?: boolean;
5526
+ /** Details about cash rounding applied to this payment, when relevant. */
5527
+ cashRounding?: CashRoundingDetails;
5446
5528
  /**
5447
- * Capture amount.
5448
- * If not provided - full authorized amount will be captured.
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.
5449
5532
  */
5450
- amount?: Price;
5451
- }
5452
- interface CaptureAuthorizedPaymentsResponse {
5453
- /** All order's transactions after the capture was triggered */
5454
- orderTransactions?: OrderTransactions;
5455
- }
5456
- interface ChargeSavedPaymentMethodRequest {
5533
+ status?: PaymentStatusWithLiterals;
5457
5534
  /**
5458
- * Ecom Order ID.
5459
- * @minLength 1
5460
- * @maxLength 100
5535
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5536
+ * @format GUID
5461
5537
  */
5462
- ecomOrderId?: string;
5463
- /** Amount to be charged */
5464
- amount?: Price;
5538
+ chargeCorrelationId?: string | null;
5465
5539
  }
5466
- interface ChargeSavedPaymentMethodResponse {
5467
- /** Payment gateway's order ID (e.g Wix Payments) */
5468
- paymentGatewayOrderId?: string;
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;
5469
5548
  }
5470
- interface SendBuyerConfirmationEmailRequest {
5471
- /** @format GUID */
5472
- orderId?: string;
5549
+ /** @oneof */
5550
+ interface PaymentReceiptInfoOneOf {
5473
5551
  }
5474
- interface SendBuyerConfirmationEmailResponse {
5552
+ /** @oneof */
5553
+ interface PaymentStatusDetailsOneOf {
5475
5554
  }
5476
- interface SendBuyerPaymentsReceivedEmailRequest {
5555
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5556
+ /** Credit card details. */
5557
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5477
5558
  /**
5478
- * @minLength 1
5559
+ * Wix Payments order ID.
5479
5560
  * @maxLength 100
5480
5561
  */
5481
- orderId?: string;
5482
- }
5483
- interface SendBuyerPaymentsReceivedEmailResponse {
5484
- }
5485
- interface SendBuyerPickupConfirmationEmailRequest {
5562
+ paymentOrderId?: string | null;
5486
5563
  /**
5487
- * @minLength 1
5564
+ * Payment gateway's transaction ID.
5565
+ * This field is only returned when the value of `offline_payment` is `false`.
5488
5566
  * @maxLength 100
5489
5567
  */
5490
- orderId?: string;
5491
- }
5492
- interface SendBuyerPickupConfirmationEmailResponse {
5493
- }
5494
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
5568
+ gatewayTransactionId?: string | null;
5495
5569
  /**
5496
- * IDs of orders to send pickup emails for.
5497
- * @minSize 1
5498
- * @maxSize 300
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
5499
5581
  */
5500
- orderIds?: string[];
5501
- }
5502
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
5503
- }
5504
- interface SendBuyerShippingConfirmationEmailRequest {
5582
+ paymentMethod?: string | null;
5505
5583
  /**
5506
- * @minLength 1
5584
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5507
5585
  * @maxLength 100
5508
5586
  */
5509
- orderId?: string;
5510
- }
5511
- interface SendBuyerShippingConfirmationEmailResponse {
5512
- }
5513
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
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;
5514
5590
  /**
5515
- * IDs of orders to send pickup emails for.
5516
- * @minSize 1
5517
- * @maxSize 300
5591
+ * Payment status.
5592
+ * @deprecated Payment status.
5593
+ * @replacedBy payment.status
5594
+ * @targetRemovalDate 2026-11-01
5518
5595
  */
5519
- orderIds?: string[];
5596
+ status?: TransactionStatusWithLiterals;
5597
+ /** Whether there is a payment agreement that allows for future charges. */
5598
+ savedPaymentMethod?: boolean;
5599
+ /** Authorization details. */
5600
+ authorizationDetails?: AuthorizationDetails;
5601
+ /**
5602
+ * Record of chargebacks made by the buyer.
5603
+ * @maxSize 6
5604
+ */
5605
+ chargebacks?: Chargeback[];
5606
+ /** Platform fee amount associated with this payment. */
5607
+ platformFee?: Price;
5608
+ /**
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`
5612
+ */
5613
+ paymentMethodName?: PaymentMethodName;
5520
5614
  }
5521
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
5615
+ /** @oneof */
5616
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5617
+ /** Credit card details. */
5618
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5522
5619
  }
5523
- interface SendMerchantOrderReceivedNotificationRequest {
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"
5631
+ }
5632
+ /** @enumType */
5633
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5634
+ interface CreditCardPaymentMethodDetails {
5524
5635
  /**
5525
- * @minLength 1
5636
+ * The last 4 digits of the card number.
5637
+ * @maxLength 4
5638
+ */
5639
+ lastFourDigits?: string | null;
5640
+ /**
5641
+ * Card issuer's brand.
5526
5642
  * @maxLength 100
5527
5643
  */
5528
- orderId?: string;
5529
- }
5530
- interface SendMerchantOrderReceivedNotificationResponse {
5644
+ brand?: string | null;
5531
5645
  }
5532
- interface SendCancelRefundEmailRequest {
5646
+ interface AuthorizationDetails {
5533
5647
  /**
5534
- * The ID of order that is canceled/refunded
5535
- * @minLength 1
5536
- * @maxLength 100
5648
+ * Whether the authorized payment is of a delayed capture.
5649
+ * @readonly
5537
5650
  */
5538
- orderId?: string;
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;
5539
5654
  /**
5540
- * Personal note added to the email (optional)
5541
- * @minLength 1
5542
- * @maxLength 1000
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
5543
5658
  */
5544
- customMessage?: string | null;
5545
- /** Refund amount */
5546
- refundAmount?: Price;
5659
+ captures?: AuthorizationCapture[];
5660
+ /** Void associated with payment */
5661
+ void?: AuthorizationVoid;
5662
+ /** Scheduled action for this transaction */
5663
+ scheduledAction?: V1ScheduledAction;
5664
+ }
5665
+ interface AuthorizationCapture {
5547
5666
  /**
5548
- * Refund ID. (Optional)
5667
+ * Capture ID.
5549
5668
  * @format GUID
5669
+ * @readonly
5550
5670
  */
5551
- refundId?: string | null;
5671
+ _id?: string | null;
5672
+ /** Status of this capture action */
5673
+ status?: AuthorizationCaptureStatusWithLiterals;
5674
+ /**
5675
+ * Amount of this capture
5676
+ * @immutable
5677
+ */
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;
5683
+ }
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"
5691
+ }
5692
+ /** @enumType */
5693
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5694
+ interface AuthorizationActionFailureDetails {
5695
+ /** @maxLength 100 */
5696
+ failureCode?: string;
5697
+ }
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;
5707
+ }
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"
5715
+ }
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"
5552
5724
  }
5553
- interface SendCancelRefundEmailResponse {
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;
5554
5732
  }
5555
- interface SendRefundEmailRequest {
5733
+ declare enum ActionType {
5734
+ VOID = "VOID",
5735
+ CAPTURE = "CAPTURE"
5736
+ }
5737
+ /** @enumType */
5738
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5739
+ interface Chargeback {
5556
5740
  /**
5557
- * The ID of order that is refunded
5741
+ * Chargeback ID.
5558
5742
  * @format GUID
5743
+ * @readonly
5744
+ * @immutable
5559
5745
  */
5560
- orderId?: string;
5746
+ _id?: string;
5561
5747
  /**
5562
- * Refund ID
5563
- * @format GUID
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
5564
5751
  */
5565
- refundId?: string;
5752
+ _createdDate?: Date | null;
5566
5753
  /**
5567
- * Personal note added to the email (optional)
5568
- * @minLength 1
5569
- * @maxLength 1000
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
5570
5756
  */
5571
- customMessage?: string | null;
5572
- }
5573
- interface SendRefundEmailResponse {
5574
- }
5575
- interface SendFulfillmentEmailRequest {
5576
- /** @format GUID */
5577
- orderId?: string;
5578
- /** @format GUID */
5579
- fulfillerId?: string;
5580
- }
5581
- interface SendFulfillmentEmailResponse {
5582
- }
5583
- interface SendMerchantOrderReceivedPushRequest {
5757
+ _updatedDate?: Date | null;
5584
5758
  /**
5585
- * @minLength 1
5586
- * @maxLength 100
5759
+ * Amount.
5760
+ * @readonly
5761
+ * @immutable
5587
5762
  */
5588
- orderId?: string;
5589
- }
5590
- interface SendMerchantOrderReceivedPushResponse {
5591
- }
5592
- interface PreviewEmailByTypeRequest {
5593
- emailType?: PreviewEmailTypeWithLiterals;
5594
- }
5595
- declare enum PreviewEmailType {
5596
- ORDER_PLACED = "ORDER_PLACED",
5597
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5598
- ORDER_SHIPPED = "ORDER_SHIPPED",
5599
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5600
- }
5601
- /** @enumType */
5602
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5603
- interface PreviewEmailByTypeResponse {
5604
- emailPreview?: string;
5605
- }
5606
- interface PreviewRefundEmailRequest {
5763
+ amount?: Price;
5607
5764
  /**
5608
- * @minLength 1
5609
- * @maxLength 100
5765
+ * Reversal amount. Present only when status is REVERSED.
5766
+ * @readonly
5610
5767
  */
5611
- orderId?: string;
5612
- /** Refund amount */
5613
- refundAmount?: Price;
5614
- /** Refund business details */
5615
- details?: RefundDetails;
5768
+ reversalAmount?: Price;
5616
5769
  /**
5617
- * Personal note added to the email (optional)
5618
- * @minLength 1
5619
- * @maxLength 1000
5770
+ * Status.
5771
+ *
5772
+ * Default: `"APPROVED"`.
5620
5773
  */
5621
- customMessage?: string | null;
5774
+ status?: ChargebackStatusWithLiterals;
5622
5775
  /**
5623
- * Refund ID. (Optional)
5776
+ * External chargeback ID.
5624
5777
  * @format GUID
5778
+ * @readonly
5779
+ * @immutable
5625
5780
  */
5626
- refundId?: string | null;
5781
+ externalId?: string | null;
5627
5782
  }
5628
- interface PreviewRefundEmailResponse {
5629
- emailPreview?: string;
5783
+ declare enum ChargebackStatus {
5784
+ /** Chargeback was approved. */
5785
+ APPROVED = "APPROVED",
5786
+ /** Chargeback was reversed. */
5787
+ REVERSED = "REVERSED"
5630
5788
  }
5631
- interface PreviewCancelEmailRequest {
5789
+ /** @enumType */
5790
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5791
+ interface PaymentMethodName {
5632
5792
  /**
5633
- * @minLength 1
5634
- * @maxLength 100
5793
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5794
+ * @maxLength 150
5635
5795
  */
5636
- orderId?: string;
5796
+ buyerLanguageName?: string | null;
5637
5797
  /**
5638
- * Personal note added to the email (optional)
5639
- * @minLength 1
5640
- * @maxLength 1000
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
5641
5802
  */
5642
- customMessage?: string | null;
5643
- }
5644
- interface PreviewCancelEmailResponse {
5645
- emailPreview?: string;
5646
- }
5647
- interface PreviewCancelRefundEmailRequest {
5803
+ siteLanguageName?: string | null;
5648
5804
  /**
5649
- * @minLength 1
5650
- * @maxLength 100
5805
+ * User-provided payment method name.
5806
+ *
5807
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5651
5808
  */
5652
- orderId?: string;
5809
+ userDefinedName?: UserDefinedPaymentMethodName;
5810
+ }
5811
+ interface GiftCardPaymentDetails {
5653
5812
  /**
5654
- * Personal note added to the email (optional)
5655
- * @minLength 1
5656
- * @maxLength 1000
5813
+ * Gift card payment ID.
5814
+ * @maxLength 100
5657
5815
  */
5658
- customMessage?: string | null;
5659
- /** Refund amount */
5660
- refundAmount?: Price;
5816
+ giftCardPaymentId?: string;
5661
5817
  /**
5662
- * Refund ID. (Optional)
5818
+ * ID of the app that created the gift card.
5663
5819
  * @format GUID
5664
5820
  */
5665
- refundId?: string | null;
5666
- }
5667
- interface PreviewCancelRefundEmailResponse {
5668
- emailPreview?: string;
5669
- }
5670
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5671
- }
5672
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5673
- emailPreview?: string;
5674
- }
5675
- interface PreviewBuyerConfirmationEmailRequest {
5676
- }
5677
- interface PreviewBuyerConfirmationEmailResponse {
5678
- emailPreview?: string;
5679
- }
5680
- interface PreviewBuyerPickupConfirmationEmailRequest {
5681
- }
5682
- interface PreviewBuyerPickupConfirmationEmailResponse {
5683
- emailPreview?: string;
5684
- }
5685
- interface PreviewShippingConfirmationEmailRequest {
5686
- }
5687
- interface PreviewShippingConfirmationEmailResponse {
5688
- emailPreview?: string;
5689
- }
5690
- interface PreviewResendDownloadLinksEmailRequest {
5691
- }
5692
- interface PreviewResendDownloadLinksEmailResponse {
5693
- emailPreview?: string;
5694
- }
5695
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5696
- /** Emitted on a meta site creation. */
5697
- siteCreated?: SiteCreated;
5698
- /** Emitted on a meta site transfer completion. */
5699
- siteTransferred?: SiteTransferred;
5700
- /** Emitted on a meta site deletion. */
5701
- siteDeleted?: SiteDeleted;
5702
- /** Emitted on a meta site restoration. */
5703
- siteUndeleted?: SiteUndeleted;
5704
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5705
- sitePublished?: SitePublished;
5706
- /** Emitted on a meta site unpublish. */
5707
- siteUnpublished?: SiteUnpublished;
5708
- /** Emitted when meta site is marked as template. */
5709
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5710
- /** Emitted when meta site is marked as a WixSite. */
5711
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5712
- /** Emitted when an application is provisioned (installed). */
5713
- serviceProvisioned?: ServiceProvisioned;
5714
- /** Emitted when an application is removed (uninstalled). */
5715
- serviceRemoved?: ServiceRemoved;
5716
- /** Emitted when meta site name (URL slug) is changed. */
5717
- siteRenamedPayload?: SiteRenamed;
5718
- /** Emitted when meta site was permanently deleted. */
5719
- hardDeleted?: SiteHardDeleted;
5720
- /** Emitted on a namespace change. */
5721
- namespaceChanged?: NamespaceChanged;
5722
- /** Emitted when Studio is attached. */
5723
- studioAssigned?: StudioAssigned;
5724
- /** Emitted when Studio is detached. */
5725
- studioUnassigned?: StudioUnassigned;
5726
- /**
5727
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5728
- * the actual URL.
5729
- *
5730
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5731
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5732
- */
5733
- urlChanged?: SiteUrlChanged;
5734
- /** Site is marked as PurgedExternally */
5735
- sitePurgedExternally?: SitePurgedExternally;
5736
- /** Emitted when Odeditor is attached. */
5737
- odeditorAssigned?: OdeditorAssigned;
5738
- /** Emitted when Odeditor is detached. */
5739
- odeditorUnassigned?: OdeditorUnassigned;
5740
- /** Emitted when Picasso is attached. */
5741
- picassoAssigned?: PicassoAssigned;
5742
- /** Emitted when Picasso is detached. */
5743
- picassoUnassigned?: PicassoUnassigned;
5744
- /** Emitted when Wixel is attached. */
5745
- wixelAssigned?: WixelAssigned;
5746
- /** Emitted when Wixel is detached. */
5747
- wixelUnassigned?: WixelUnassigned;
5748
- /** Emitted when StudioTwo is attached. */
5749
- studioTwoAssigned?: StudioTwoAssigned;
5750
- /** Emitted when StudioTwo is detached. */
5751
- studioTwoUnassigned?: StudioTwoUnassigned;
5752
- /** Emitted when media from user domain is enabled. */
5753
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5754
- /** Emitted when media from user domain is disabled. */
5755
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5756
- /** Emitted when Editorless is attached. */
5757
- editorlessAssigned?: EditorlessAssigned;
5758
- /** Emitted when Editorless is detached. */
5759
- editorlessUnassigned?: EditorlessUnassigned;
5821
+ appId?: string;
5760
5822
  /**
5761
- * A meta site id.
5762
- * @format GUID
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
5763
5828
  */
5764
- metaSiteId?: string;
5765
- /** A meta site version. Monotonically increasing. */
5766
- version?: string;
5767
- /** A timestamp of the event. */
5768
- timestamp?: string;
5829
+ voided?: boolean;
5769
5830
  /**
5770
- * TODO(meta-site): Change validation once validations are disabled for consumers
5771
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5772
- * @maxSize 4000
5831
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5832
+ * @maxLength 30
5833
+ * @immutable
5773
5834
  */
5774
- assets?: Asset[];
5835
+ obfuscatedCode?: string | null;
5775
5836
  }
5776
- /** @oneof */
5777
- interface MetaSiteSpecialEventPayloadOneOf {
5778
- /** Emitted on a meta site creation. */
5779
- siteCreated?: SiteCreated;
5780
- /** Emitted on a meta site transfer completion. */
5781
- siteTransferred?: SiteTransferred;
5782
- /** Emitted on a meta site deletion. */
5783
- siteDeleted?: SiteDeleted;
5784
- /** Emitted on a meta site restoration. */
5785
- siteUndeleted?: SiteUndeleted;
5786
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5787
- sitePublished?: SitePublished;
5788
- /** Emitted on a meta site unpublish. */
5789
- siteUnpublished?: SiteUnpublished;
5790
- /** Emitted when meta site is marked as template. */
5791
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5792
- /** Emitted when meta site is marked as a WixSite. */
5793
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5794
- /** Emitted when an application is provisioned (installed). */
5795
- serviceProvisioned?: ServiceProvisioned;
5796
- /** Emitted when an application is removed (uninstalled). */
5797
- serviceRemoved?: ServiceRemoved;
5798
- /** Emitted when meta site name (URL slug) is changed. */
5799
- siteRenamedPayload?: SiteRenamed;
5800
- /** Emitted when meta site was permanently deleted. */
5801
- hardDeleted?: SiteHardDeleted;
5802
- /** Emitted on a namespace change. */
5803
- namespaceChanged?: NamespaceChanged;
5804
- /** Emitted when Studio is attached. */
5805
- studioAssigned?: StudioAssigned;
5806
- /** Emitted when Studio is detached. */
5807
- studioUnassigned?: StudioUnassigned;
5837
+ interface MembershipPaymentDetails {
5808
5838
  /**
5809
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5810
- * the actual URL.
5811
- *
5812
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5813
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5839
+ * Membership ID.
5840
+ * @maxLength 200
5814
5841
  */
5815
- urlChanged?: SiteUrlChanged;
5816
- /** Site is marked as PurgedExternally */
5817
- sitePurgedExternally?: SitePurgedExternally;
5818
- /** Emitted when Odeditor is attached. */
5819
- odeditorAssigned?: OdeditorAssigned;
5820
- /** Emitted when Odeditor is detached. */
5821
- odeditorUnassigned?: OdeditorUnassigned;
5822
- /** Emitted when Picasso is attached. */
5823
- picassoAssigned?: PicassoAssigned;
5824
- /** Emitted when Picasso is detached. */
5825
- picassoUnassigned?: PicassoUnassigned;
5826
- /** Emitted when Wixel is attached. */
5827
- wixelAssigned?: WixelAssigned;
5828
- /** Emitted when Wixel is detached. */
5829
- wixelUnassigned?: WixelUnassigned;
5830
- /** Emitted when StudioTwo is attached. */
5831
- studioTwoAssigned?: StudioTwoAssigned;
5832
- /** Emitted when StudioTwo is detached. */
5833
- studioTwoUnassigned?: StudioTwoUnassigned;
5834
- /** Emitted when media from user domain is enabled. */
5835
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5836
- /** Emitted when media from user domain is disabled. */
5837
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5838
- /** Emitted when Editorless is attached. */
5839
- editorlessAssigned?: EditorlessAssigned;
5840
- /** Emitted when Editorless is detached. */
5841
- editorlessUnassigned?: EditorlessUnassigned;
5842
- }
5843
- interface Asset {
5842
+ membershipId?: string;
5844
5843
  /**
5845
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5846
- * @maxLength 36
5844
+ * ID of the line item this membership applies to.
5845
+ * @minLength 1
5846
+ * @maxLength 100
5847
5847
  */
5848
- appDefId?: string;
5848
+ lineItemId?: string;
5849
5849
  /**
5850
- * An instance id. For legacy reasons may be UUID or a string.
5851
- * @maxLength 200
5850
+ * Payment status.
5851
+ * @deprecated Payment status.
5852
+ * @replacedBy payment.status
5853
+ * @targetRemovalDate 2026-11-01
5852
5854
  */
5853
- instanceId?: string;
5854
- /** An application state. */
5855
- state?: StateWithLiterals;
5855
+ status?: MembershipPaymentStatusWithLiterals;
5856
+ /** Membership name. */
5857
+ name?: MembershipName;
5858
+ /**
5859
+ * The transaction ID in the membership system. Can be used to void the transaction.
5860
+ * @minLength 1
5861
+ * @maxLength 100
5862
+ */
5863
+ externalTransactionId?: string | null;
5864
+ /**
5865
+ * Whether the membership is voided.
5866
+ * @readonly
5867
+ * @deprecated Whether the membership is voided.
5868
+ * @replacedBy payment.status
5869
+ * @targetRemovalDate 2026-11-01
5870
+ */
5871
+ voided?: boolean;
5872
+ /**
5873
+ * ID of the application providing this payment option.
5874
+ * @format GUID
5875
+ */
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;
5856
5879
  }
5857
- declare enum State {
5858
- UNKNOWN = "UNKNOWN",
5859
- ENABLED = "ENABLED",
5860
- DISABLED = "DISABLED",
5861
- PENDING = "PENDING",
5862
- DEMO = "DEMO"
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"
5863
5889
  }
5864
5890
  /** @enumType */
5865
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5866
- interface SiteCreated {
5891
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5892
+ interface FutureMembershipDetails {
5867
5893
  /**
5868
- * A template identifier (empty if not created from a template).
5869
- * @maxLength 36
5894
+ * ID of the plan line item in the order from which the membership will be created.
5895
+ * @format GUID
5870
5896
  */
5871
- originTemplateId?: string;
5897
+ lineItemId?: string;
5872
5898
  /**
5873
- * An account id of the owner.
5874
- * @format GUID
5899
+ * ID of the benefit the future membership will grant.
5900
+ * @maxLength 200
5875
5901
  */
5876
- ownerId?: string;
5877
- /** A context in which meta site was created. */
5878
- context?: SiteCreatedContextWithLiterals;
5902
+ benefitId?: string;
5903
+ }
5904
+ interface WixReceiptInfo {
5879
5905
  /**
5880
- * A meta site id from which this site was created.
5881
- *
5882
- * In case of a creation from a template it's a template id.
5883
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5906
+ * Receipt ID
5884
5907
  * @format GUID
5885
5908
  */
5886
- originMetaSiteId?: string | null;
5909
+ receiptId?: string;
5887
5910
  /**
5888
- * A meta site name (URL slug).
5889
- * @maxLength 20
5911
+ * Display number of receipt
5912
+ * @minLength 1
5913
+ * @maxLength 40
5890
5914
  */
5891
- siteName?: string;
5892
- /** A namespace. */
5893
- namespace?: NamespaceWithLiterals;
5894
- }
5895
- declare enum SiteCreatedContext {
5896
- /** A valid option, we don't expose all reasons why site might be created. */
5897
- OTHER = "OTHER",
5898
- /** A meta site was created from template. */
5899
- FROM_TEMPLATE = "FROM_TEMPLATE",
5900
- /** A meta site was created by copying of the transfferred meta site. */
5901
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5902
- /** A copy of existing meta site. */
5903
- DUPLICATE = "DUPLICATE",
5904
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5905
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5906
- /** deprecated A meta site was created for Flash editor. */
5907
- FLASH = "FLASH"
5915
+ displayNumber?: string | null;
5908
5916
  }
5909
- /** @enumType */
5910
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5911
- declare enum Namespace {
5912
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5913
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5914
- WIX = "WIX",
5915
- /** 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. */
5916
- SHOUT_OUT = "SHOUT_OUT",
5917
- /** 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. */
5918
- ALBUMS = "ALBUMS",
5919
- /** 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. */
5920
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5921
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5922
- HOTELS = "HOTELS",
5923
- /** 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. */
5924
- CLUBS = "CLUBS",
5925
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5926
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5917
+ interface ExternalReceiptInfo {
5927
5918
  /**
5928
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5929
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5919
+ * External receipt ID
5920
+ * @maxLength 100
5930
5921
  */
5931
- DEV_SITE = "DEV_SITE",
5932
- /** 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. */
5933
- LOGOS = "LOGOS",
5934
- /** 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. */
5935
- VIDEO_MAKER = "VIDEO_MAKER",
5936
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5937
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5938
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5939
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5922
+ receiptId?: string | null;
5940
5923
  /**
5941
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5942
- *
5943
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5924
+ * ID of the app providing the receipt
5925
+ * @format GUID
5944
5926
  */
5945
- HTML_DRAFT = "HTML_DRAFT",
5927
+ appId?: string | null;
5946
5928
  /**
5947
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5948
- * Will be accessible from Site List and will not have a website app.
5949
- * Once the user attaches a site, the site will become a regular wixsite.
5929
+ * Display number of receipt
5930
+ * @minLength 1
5931
+ * @maxLength 40
5950
5932
  */
5951
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5952
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5953
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5954
- /** It is to be used in the Business First efforts. */
5955
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5956
- /** Bookings business flow with no site. */
5957
- ANYWHERE = "ANYWHERE",
5958
- /** Namespace for Headless Backoffice with no editor */
5959
- HEADLESS = "HEADLESS",
5933
+ displayNumber?: string | null;
5934
+ }
5935
+ interface CashRoundingDetails {
5960
5936
  /**
5961
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5962
- * The site will be used for account level CSM feature for enterprise
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.
5963
5940
  */
5964
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5965
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5966
- RISE = "RISE",
5941
+ unroundedAmount?: Price;
5967
5942
  /**
5968
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5969
- * There's a blank site behind the scene but it's blank).
5970
- * The Mobile company will be the owner of this namespace.
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
5971
5946
  */
5972
- BRANDED_FIRST = "BRANDED_FIRST",
5973
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5974
- NOWNIA = "NOWNIA",
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",
5975
5966
  /**
5976
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5977
- * The Partners company owns this namespace.
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`.
5978
5970
  */
5979
- UGC_TEMPLATE = "UGC_TEMPLATE",
5980
- /** Codux Headless Sites */
5981
- CODUX = "CODUX",
5982
- /** Bobb - AI Design Creator. */
5983
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
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 {
5984
6018
  /**
5985
- * Shared Blog Site is a unique single site across Enterprise account,
5986
- * This site will hold all Blog posts related to the Marketing product.
6019
+ * Refund ID.
6020
+ * @format GUID
6021
+ * @readonly
5987
6022
  */
5988
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5989
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5990
- STANDALONE_FORMS = "STANDALONE_FORMS",
5991
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5992
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5993
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5994
- MIMIR = "MIMIR",
5995
- /** Wix Twins platform. */
5996
- TWINS = "TWINS",
5997
- /** Wix Nano. */
5998
- NANO = "NANO",
5999
- /** Base44 headless sites. */
6000
- BASE44 = "BASE44",
6001
- /** Wix Channels Sites */
6002
- CHANNELS = "CHANNELS",
6003
- /** Nautilus platform. */
6004
- NAUTILUS = "NAUTILUS",
6023
+ _id?: string;
6005
6024
  /**
6006
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6007
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6025
+ * List of transactions.
6026
+ * @maxSize 50
6008
6027
  */
6009
- SYMPHONY = "SYMPHONY",
6010
- /** Nautilus platform app. */
6011
- NAUTILUS_APPS = "NAUTILUS_APPS",
6028
+ transactions?: RefundTransaction[];
6029
+ /** Refund business details. */
6030
+ details?: RefundDetails;
6012
6031
  /**
6013
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6014
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
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
6015
6035
  */
6016
- VIBU = "VIBU",
6036
+ _createdDate?: Date | null;
6017
6037
  /**
6018
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6019
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6020
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6021
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6038
+ * Aggregated refund summary.
6039
+ * @readonly
6022
6040
  */
6023
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6041
+ summary?: AggregatedRefundSummary;
6024
6042
  /**
6025
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6026
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6043
+ * ID of the app that initiated this refund.
6044
+ * @format GUID
6045
+ * @readonly
6046
+ * @immutable
6027
6047
  */
6028
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6048
+ requestingServiceAppId?: string | null;
6029
6049
  }
6030
- /** @enumType */
6031
- 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';
6032
- /** Site transferred to another user. */
6033
- interface SiteTransferred {
6050
+ interface RefundTransaction {
6034
6051
  /**
6035
- * A previous owner id (user that transfers meta site).
6052
+ * ID of the payment associated with this refund.
6036
6053
  * @format GUID
6054
+ * @immutable
6037
6055
  */
6038
- oldOwnerId?: string;
6056
+ paymentId?: string;
6039
6057
  /**
6040
- * A new owner id (user that accepts meta site).
6041
- * @format GUID
6058
+ * Refund amount.
6059
+ * @immutable
6042
6060
  */
6043
- newOwnerId?: string;
6044
- }
6045
- /** Soft deletion of the meta site. Could be restored. */
6046
- interface SiteDeleted {
6047
- /** A deletion context. */
6048
- deleteContext?: DeleteContext;
6049
- }
6050
- interface DeleteContext {
6051
- /** When the meta site was deleted. */
6052
- dateDeleted?: Date | null;
6053
- /** A status. */
6054
- deleteStatus?: DeleteStatusWithLiterals;
6061
+ amount?: Price;
6062
+ /** Refund status. */
6063
+ refundStatus?: RefundStatusWithLiterals;
6064
+ /** Optional details of current refund status. */
6065
+ refundStatusInfo?: RefundStatusInfo;
6055
6066
  /**
6056
- * A reason (flow).
6057
- * @maxLength 255
6067
+ * Payment gateway's refund ID.
6068
+ * This field is only returned when the value of `external_refund` is `false`.
6069
+ * @format GUID
6058
6070
  */
6059
- deleteOrigin?: string;
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;
6060
6074
  /**
6061
- * A service that deleted it.
6062
- * @maxLength 255
6075
+ * Whether refund was made externally and manually on the payment provider's side.
6076
+ * @immutable
6063
6077
  */
6064
- initiatorId?: string | null;
6078
+ externalRefund?: boolean;
6065
6079
  }
6066
- declare enum DeleteStatus {
6067
- UNKNOWN = "UNKNOWN",
6068
- TRASH = "TRASH",
6069
- DELETED = "DELETED",
6070
- PENDING_PURGE = "PENDING_PURGE",
6071
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
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"
6072
6092
  }
6073
6093
  /** @enumType */
6074
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6075
- /** Restoration of the meta site. */
6076
- interface SiteUndeleted {
6077
- }
6078
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6079
- interface SitePublished {
6080
- }
6081
- interface SiteUnpublished {
6094
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6095
+ interface RefundStatusInfo {
6082
6096
  /**
6083
- * A list of URLs previously associated with the meta site.
6084
- * @maxLength 4000
6085
- * @maxSize 10000
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
6086
6102
  */
6087
- urls?: string[];
6088
- }
6089
- interface SiteMarkedAsTemplate {
6090
- }
6091
- interface SiteMarkedAsWixSite {
6103
+ paymentGatewayReasonCode?: string | null;
6104
+ /**
6105
+ * Free text explanation of current refund status.
6106
+ * @minLength 1
6107
+ * @maxLength 1000
6108
+ */
6109
+ description?: string | null;
6092
6110
  }
6093
- /**
6094
- * Represents a service provisioned a site.
6095
- *
6096
- * Note on `origin_instance_id`:
6097
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6098
- * This is because of the following scenario:
6099
- *
6100
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6101
- * such as a product catalog. When you create a site from this template, you inherit this
6102
- * default product catalog. However, if the template's product catalog is modified,
6103
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6104
- * your site remains consistent with what you initially received and does not include any
6105
- * changes made to the original template afterward.
6106
- * To ensure this, the TPA on the template gets a new instance_id.
6107
- */
6108
- interface ServiceProvisioned {
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;
6124
+ }
6125
+ interface RefundItemsBreakdown {
6109
6126
  /**
6110
- * Either UUID or EmbeddedServiceType.
6111
- * @maxLength 36
6127
+ * Refunded line items and the amount refunded for each.
6128
+ * @maxSize 300
6112
6129
  */
6113
- appDefId?: string;
6130
+ lineItems?: LineItemRefundSummary[];
6131
+ }
6132
+ interface LineItemRefundSummary {
6114
6133
  /**
6115
- * Not only UUID. Something here could be something weird.
6116
- * @maxLength 36
6134
+ * ID of the refunded line item.
6135
+ * @format GUID
6117
6136
  */
6118
- instanceId?: string;
6137
+ lineItemId?: string;
6138
+ /** Total refunded amount for the line item. */
6139
+ totalRefundedAmount?: Price;
6140
+ }
6141
+ interface CalculateRefundRequest {
6119
6142
  /**
6120
- * An instance id from which this instance is originated.
6121
- * @maxLength 36
6143
+ * Order ID
6144
+ * @minLength 1
6145
+ * @maxLength 100
6122
6146
  */
6123
- originInstanceId?: string;
6147
+ ecomOrderId?: string;
6124
6148
  /**
6125
- * A version.
6126
- * @maxLength 500
6149
+ * Refunded line items and quantity
6150
+ * @maxSize 300
6127
6151
  */
6128
- version?: string | null;
6152
+ refundItems?: CalculateRefundItemRequest[];
6153
+ /** Should include shipping in refund calculation */
6154
+ refundShipping?: boolean;
6155
+ }
6156
+ interface CalculateRefundItemRequest {
6129
6157
  /**
6130
- * The origin meta site id
6158
+ * ID of the line item being refunded
6131
6159
  * @format GUID
6132
6160
  */
6133
- originMetaSiteId?: string | null;
6134
- }
6135
- interface ServiceRemoved {
6161
+ _id?: string;
6136
6162
  /**
6137
- * Either UUID or EmbeddedServiceType.
6138
- * @maxLength 36
6163
+ * How much of that line item is being refunded
6164
+ * @min 1
6165
+ * @max 100000
6139
6166
  */
6140
- appDefId?: string;
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;
6141
6182
  /**
6142
- * Not only UUID. Something here could be something weird.
6143
- * @maxLength 36
6183
+ * The refundable items of that order
6184
+ * @maxSize 300
6144
6185
  */
6145
- instanceId?: string;
6186
+ items?: CalculateRefundItemResponse[];
6187
+ }
6188
+ interface CalculateRefundItemResponse {
6146
6189
  /**
6147
- * A version.
6148
- * @maxLength 500
6190
+ * Line item ID
6191
+ * @format GUID
6149
6192
  */
6150
- version?: string | null;
6193
+ _id?: string;
6194
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6195
+ price?: Price;
6151
6196
  }
6152
- /** Rename of the site. Meaning, free public url has been changed as well. */
6153
- interface SiteRenamed {
6197
+ interface VoidAuthorizedPaymentsRequest {
6154
6198
  /**
6155
- * A new meta site name (URL slug).
6156
- * @maxLength 20
6199
+ * Wix eCommerce order ID
6200
+ * @minLength 1
6201
+ * @maxLength 100
6157
6202
  */
6158
- newSiteName?: string;
6203
+ ecomOrderId: string;
6159
6204
  /**
6160
- * A previous meta site name (URL slug).
6161
- * @maxLength 255
6205
+ * Payment IDs
6206
+ * @minSize 1
6207
+ * @maxSize 100
6208
+ * @format GUID
6162
6209
  */
6163
- oldSiteName?: string;
6164
- }
6165
- /**
6166
- * Hard deletion of the meta site.
6167
- *
6168
- * Could not be restored. Therefore it's desirable to cleanup data.
6169
- */
6170
- interface SiteHardDeleted {
6171
- /** A deletion context. */
6172
- deleteContext?: DeleteContext;
6173
- }
6174
- interface NamespaceChanged {
6175
- /** A previous namespace. */
6176
- oldNamespace?: NamespaceWithLiterals;
6177
- /** A new namespace. */
6178
- newNamespace?: NamespaceWithLiterals;
6179
- }
6180
- /** Assigned Studio editor */
6181
- interface StudioAssigned {
6182
- }
6183
- /** Unassigned Studio editor */
6184
- interface StudioUnassigned {
6210
+ paymentIds: string[];
6185
6211
  }
6186
- /**
6187
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6188
- *
6189
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6190
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6191
- *
6192
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6193
- */
6194
- interface SiteUrlChanged {
6212
+ interface VoidAuthorizedPaymentsResponse {
6213
+ /** All order's transactions after the void was triggered */
6214
+ orderTransactions?: OrderTransactions;
6195
6215
  }
6196
- /**
6197
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6198
- * Consumed by other teams to remove relevant data.
6199
- */
6200
- interface SitePurgedExternally {
6216
+ interface CaptureAuthorizedPaymentsRequest {
6201
6217
  /**
6202
- * @maxLength 2048
6218
+ * Wix eCommerce order ID
6219
+ * @minLength 1
6220
+ * @maxLength 100
6221
+ */
6222
+ ecomOrderId: string;
6223
+ /**
6224
+ * Capture payments information
6225
+ * @minSize 1
6203
6226
  * @maxSize 100
6204
- * @deprecated
6205
- * @targetRemovalDate 2025-04-15
6206
6227
  */
6207
- appDefId?: string[];
6208
- }
6209
- /** Assigned Odeditor */
6210
- interface OdeditorAssigned {
6211
- }
6212
- /** Unassigned Odeditor */
6213
- interface OdeditorUnassigned {
6214
- }
6215
- /** Assigned Picasso editor */
6216
- interface PicassoAssigned {
6217
- }
6218
- /** Unassigned Picasso */
6219
- interface PicassoUnassigned {
6220
- }
6221
- /** Assigned Wixel */
6222
- interface WixelAssigned {
6223
- }
6224
- /** Unassigned Wixel */
6225
- interface WixelUnassigned {
6226
- }
6227
- /** Assigned StudioTwo */
6228
- interface StudioTwoAssigned {
6229
- }
6230
- /** Unassigned StudioTwo */
6231
- interface StudioTwoUnassigned {
6232
- }
6233
- /** Media from user domain is enabled. */
6234
- interface UserDomainMediaEnabled {
6235
- }
6236
- /** Media from user domain is disabled. */
6237
- interface UserDomainMediaDisabled {
6238
- }
6239
- /** Assigned Editorless */
6240
- interface EditorlessAssigned {
6241
- }
6242
- /** Unassigned Editorless */
6243
- interface EditorlessUnassigned {
6228
+ payments: PaymentCapture[];
6244
6229
  }
6245
- interface HasCustomEmailConfigurationsRequest {
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;
6246
6241
  }
6247
- interface HasCustomEmailConfigurationsResponse {
6248
- hasCustomConfigurations?: boolean;
6242
+ interface CaptureAuthorizedPaymentsResponse {
6243
+ /** All order's transactions after the capture was triggered */
6244
+ orderTransactions?: OrderTransactions;
6249
6245
  }
6250
- interface AddToAutomationMigrationPopulationRequest {
6251
- /** When true, sends custom email configurations to automation system via email */
6252
- sendCustomEmailConfigs?: boolean;
6253
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6254
- origin?: OriginWithLiterals;
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;
6255
6255
  }
6256
- declare enum Origin {
6257
- OPT_IN = "OPT_IN",
6258
- MIGRATION = "MIGRATION"
6256
+ interface ChargeSavedPaymentMethodResponse {
6257
+ /** Payment gateway's order ID (e.g Wix Payments) */
6258
+ paymentGatewayOrderId?: string;
6259
6259
  }
6260
- /** @enumType */
6261
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6262
- interface AddToAutomationMigrationPopulationResponse {
6263
- success?: boolean;
6260
+ interface V1TriggerReindexRequest {
6261
+ /** @format GUID */
6262
+ metasiteId?: string;
6263
+ /**
6264
+ * @minLength 1
6265
+ * @maxLength 100
6266
+ * @maxSize 100
6267
+ */
6268
+ orderIds?: string[];
6264
6269
  }
6265
- interface IsInAutomationMigrationPopulationRequest {
6270
+ interface V1TriggerReindexResponse {
6266
6271
  }
6267
- interface IsInAutomationMigrationPopulationResponse {
6268
- inPopulation?: boolean;
6272
+ interface V1TriggerReindexOrderRequest {
6273
+ /** @format GUID */
6274
+ metasiteId?: string;
6275
+ /**
6276
+ * @minLength 1
6277
+ * @maxLength 100
6278
+ */
6279
+ orderId?: string;
6269
6280
  }
6270
6281
  interface DiffmatokyPayload {
6271
6282
  left?: string;
@@ -9501,4 +9512,4 @@ interface BulkUpdateOrderTagsOptions {
9501
9512
  unassignTags?: TagsTags;
9502
9513
  }
9503
9514
 
9504
- 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 };
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 };