@wix/auto_sdk_ecom_orders 1.0.238 → 1.0.239

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