@wix/auto_sdk_ecom_orders 1.0.252 → 1.0.254

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