@wix/auto_sdk_ecom_orders 1.0.322 → 1.0.324

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