@wix/auto_sdk_ecom_orders 1.0.245 → 1.0.247

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