@wix/auto_sdk_ecom_orders 1.0.245 → 1.0.246

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