@wix/auto_sdk_ecom_orders 1.0.316 → 1.0.318

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