@wix/auto_sdk_ecom_orders 1.0.317 → 1.0.319

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-C1f2gjpe.d.ts → ecom-v1-order-orders.universal-DkuT45RM.d.ts} +1847 -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 +1848 -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-C1f2gjpe.d.mts → ecom-v1-order-orders.universal-DkuT45RM.d.mts} +1847 -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 +1848 -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-CQe1Ioz_.d.ts → ecom-v1-order-orders.universal-CaKWoBtD.d.ts} +2010 -1803
  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 +2024 -1830
  25. package/build/internal/es/{ecom-v1-order-orders.universal-CQe1Ioz_.d.mts → ecom-v1-order-orders.universal-CaKWoBtD.d.mts} +2010 -1803
  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 +2024 -1830
  29. package/package.json +2 -2
@@ -707,10 +707,16 @@ interface DigitalFile {
707
707
  interface SubscriptionInfo {
708
708
  /**
709
709
  * Subscription ID.
710
+ *
711
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
712
+ * To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
710
713
  * @format GUID
711
714
  */
712
715
  _id?: string | null;
713
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
716
+ /**
717
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
718
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
719
+ */
714
720
  cycleNumber?: number;
715
721
  /**
716
722
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -765,7 +771,7 @@ interface SubscriptionDescription {
765
771
  translated?: string | null;
766
772
  }
767
773
  interface SubscriptionSettings {
768
- /** Frequency of recurring payment. */
774
+ /** Frequency unit of the billing cycle. */
769
775
  frequency?: SubscriptionFrequencyWithLiterals;
770
776
  /**
771
777
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -773,16 +779,20 @@ interface SubscriptionSettings {
773
779
  * @max 3650
774
780
  */
775
781
  interval?: number | null;
776
- /** Whether subscription is renewed automatically at the end of each period. */
782
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
777
783
  autoRenewal?: boolean;
778
784
  /**
779
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
785
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
780
786
  * @min 1
781
787
  */
782
788
  billingCycles?: number | null;
783
- /** Whether to allow the customer to cancel the subscription. */
789
+ /** Whether the buyer can cancel the subscription. */
784
790
  enableCustomerCancellation?: boolean;
785
- /** Period until first cycle starts. If None => no free trial */
791
+ /**
792
+ * Free trial period before the first billing cycle starts.
793
+ *
794
+ * Returned only when the subscription has a free trial.
795
+ */
786
796
  freeTrialPeriod?: FreeTrialPeriod;
787
797
  }
788
798
  /** Frequency unit of recurring payment */
@@ -796,7 +806,7 @@ declare enum SubscriptionFrequency {
796
806
  /** @enumType */
797
807
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
798
808
  interface FreeTrialPeriod {
799
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
809
+ /** Frequency unit of the free trial period. */
800
810
  frequency?: SubscriptionFrequencyWithLiterals;
801
811
  /**
802
812
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -1075,6 +1085,76 @@ interface ServiceProperties {
1075
1085
  */
1076
1086
  numberOfParticipants?: number | null;
1077
1087
  }
1088
+ /**
1089
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1090
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1091
+ *
1092
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1093
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1094
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1095
+ */
1096
+ interface CrossBorderPriceAdjustment {
1097
+ /**
1098
+ * ID of the tax region whose tax is built into the catalog prices.
1099
+ * @format GUID
1100
+ */
1101
+ baseTaxRegionId?: string;
1102
+ /**
1103
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1104
+ * @format GUID
1105
+ */
1106
+ destinationTaxRegionId?: string | null;
1107
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1108
+ catalogPrice?: Price;
1109
+ /** 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. */
1110
+ baseTaxAmount?: Price;
1111
+ /** Outcome of the repricing for this line. */
1112
+ status?: RepriceStatusWithLiterals;
1113
+ /** 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`. */
1114
+ baseRateSource?: BaseRateSourceWithLiterals;
1115
+ /**
1116
+ * 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.
1117
+ * @format DECIMAL_VALUE
1118
+ * @decimalValue options { gte:0, maxScale:6 }
1119
+ */
1120
+ baseRate?: string | null;
1121
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1122
+ baseRateCapturedDate?: Date | null;
1123
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1124
+ destinationTaxIncluded?: boolean | null;
1125
+ }
1126
+ /** Outcome of the repricing for one line. */
1127
+ declare enum RepriceStatus {
1128
+ /** Base tax removed and the destination's tax applied. */
1129
+ APPLIED = "APPLIED",
1130
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1131
+ KEPT = "KEPT",
1132
+ /** 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`. */
1133
+ STRIP_ONLY = "STRIP_ONLY",
1134
+ /** The destination is the base region. Nothing was removed. */
1135
+ SAME_REGION = "SAME_REGION",
1136
+ /** 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. */
1137
+ SAME_COUNTRY = "SAME_COUNTRY",
1138
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1139
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1140
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1141
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1142
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1143
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1144
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1145
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1146
+ }
1147
+ /** @enumType */
1148
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1149
+ /** Where the base region's rate came from. */
1150
+ declare enum BaseRateSource {
1151
+ /** The manual tax calculator computed the base tax for this calculation. */
1152
+ MANUAL_SPI = "MANUAL_SPI",
1153
+ /** The rate captured from Avalara by the embedded-rate probe. */
1154
+ AVALARA_PROBE = "AVALARA_PROBE"
1155
+ }
1156
+ /** @enumType */
1157
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1078
1158
  /** Buyer information. */
1079
1159
  interface BuyerInfo extends BuyerInfoIdOneOf {
1080
1160
  /**
@@ -1198,6 +1278,25 @@ interface CurrencyConversionDetails {
1198
1278
  */
1199
1279
  conversionRate?: string | null;
1200
1280
  }
1281
+ /** 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`. */
1282
+ interface CrossBorderRepricing {
1283
+ /**
1284
+ * 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.
1285
+ *
1286
+ * Default: `false`
1287
+ */
1288
+ enabled?: boolean;
1289
+ /**
1290
+ * ID of the tax region whose tax is built into the catalog prices, as used for this order.
1291
+ * @format GUID
1292
+ */
1293
+ baseTaxRegionId?: string | null;
1294
+ /**
1295
+ * ID of the base region's tax calculator when the order was placed.
1296
+ * @format GUID
1297
+ */
1298
+ baseCalculatorId?: string | null;
1299
+ }
1201
1300
  interface PriceSummary {
1202
1301
  /** Subtotal of all line items, before discounts and before tax. */
1203
1302
  subtotal?: Price;
@@ -1560,6 +1659,56 @@ interface OrderTaxBreakdown {
1560
1659
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1561
1660
  aggregatedTaxAmount?: Price;
1562
1661
  }
1662
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1663
+ interface CrossBorderCalculation {
1664
+ /** Whether the calculation repriced the lines for the destination's tax. */
1665
+ applied?: boolean;
1666
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1667
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1668
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1669
+ mode?: CrossBorderRepricingModeWithLiterals;
1670
+ /**
1671
+ * Request ID of the calculation, for log correlation.
1672
+ * @maxLength 100
1673
+ */
1674
+ requestId?: string | null;
1675
+ }
1676
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1677
+ declare enum CrossBorderNotApplicableReason {
1678
+ /** The repricing feature toggle is off. */
1679
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1680
+ /** The site hasn't opted in to cross-border repricing. */
1681
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1682
+ /** The site's prices no longer include tax. */
1683
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
1684
+ /** The base tax region doesn't exist on the site. */
1685
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
1686
+ /** The base region uses the manual calculator and has no tax mapping. */
1687
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
1688
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
1689
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
1690
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
1691
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
1692
+ /** The line items were repriced. Repricing the shipping option failed. */
1693
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
1694
+ /** The line items were repriced. Repricing the additional fees failed. */
1695
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
1696
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
1697
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
1698
+ }
1699
+ /** @enumType */
1700
+ 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';
1701
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
1702
+ declare enum CrossBorderRepricingMode {
1703
+ /** Nothing is repriced. */
1704
+ DISABLED = "DISABLED",
1705
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
1706
+ STRIP_ONLY = "STRIP_ONLY",
1707
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
1708
+ FULL = "FULL"
1709
+ }
1710
+ /** @enumType */
1711
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1563
1712
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1564
1713
  /** Coupon applied by the customer. */
1565
1714
  coupon?: Coupon;
@@ -3617,6 +3766,8 @@ declare enum DeltaPaymentOptionType {
3617
3766
  type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
3618
3767
  interface DecimalQuantityUpdate {
3619
3768
  }
3769
+ interface CrossBorderAdjustmentUpdate {
3770
+ }
3620
3771
  interface LineItemDelta extends LineItemDeltaDeltaOneOf {
3621
3772
  lineItemAdded?: boolean;
3622
3773
  changedDetails?: ItemChangedDetails;
@@ -3915,2176 +4066,2176 @@ interface BulkDeleteImportedOrdersResponse {
3915
4066
  */
3916
4067
  jobId?: string;
3917
4068
  }
3918
- interface V1TriggerReindexRequest {
4069
+ interface SendBuyerConfirmationEmailRequest {
3919
4070
  /** @format GUID */
3920
- metasiteId?: string;
4071
+ orderId?: string;
4072
+ }
4073
+ interface SendBuyerConfirmationEmailResponse {
4074
+ }
4075
+ interface SendBuyerPaymentsReceivedEmailRequest {
3921
4076
  /**
3922
4077
  * @minLength 1
3923
4078
  * @maxLength 100
3924
- * @maxSize 100
3925
4079
  */
3926
- orderIds?: string[];
4080
+ orderId?: string;
3927
4081
  }
3928
- interface V1TriggerReindexResponse {
4082
+ interface SendBuyerPaymentsReceivedEmailResponse {
3929
4083
  }
3930
- interface V1TriggerReindexOrderRequest {
3931
- /** @format GUID */
3932
- metasiteId?: string;
4084
+ interface SendBuyerPickupConfirmationEmailRequest {
3933
4085
  /**
3934
4086
  * @minLength 1
3935
4087
  * @maxLength 100
3936
4088
  */
3937
4089
  orderId?: string;
3938
4090
  }
3939
- interface PreparePaymentCollectionRequest {
4091
+ interface SendBuyerPickupConfirmationEmailResponse {
4092
+ }
4093
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
3940
4094
  /**
3941
- * Ecom order ID.
3942
- * @minLength 1
3943
- * @maxLength 100
4095
+ * IDs of orders to send pickup emails for.
4096
+ * @minSize 1
4097
+ * @maxSize 300
3944
4098
  */
3945
- ecomOrderId: string;
3946
- /** Amount to collect */
3947
- amount: Price;
4099
+ orderIds?: string[];
4100
+ }
4101
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4102
+ }
4103
+ interface SendBuyerShippingConfirmationEmailRequest {
3948
4104
  /**
3949
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
3950
- * Existing payment gateway order will be updated with a new amount.
3951
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4105
+ * @minLength 1
4106
+ * @maxLength 100
3952
4107
  */
3953
- paymentGatewayOrderId?: string | null;
4108
+ orderId?: string;
4109
+ }
4110
+ interface SendBuyerShippingConfirmationEmailResponse {
4111
+ }
4112
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
3954
4113
  /**
3955
- * Whether to delay capture of the payment.
3956
- * Default: false
3957
- * @deprecated Whether to delay capture of the payment.
3958
- * Default: false
3959
- * @replacedBy delayed_capture_settings.scheduled_action
3960
- * @targetRemovalDate 2024-09-30
4114
+ * IDs of orders to send pickup emails for.
4115
+ * @minSize 1
4116
+ * @maxSize 300
3961
4117
  */
3962
- delayedCapture?: boolean;
3963
- /** Delayed capture payment settings */
3964
- delayedCaptureSettings?: DelayedCaptureSettings;
4118
+ orderIds?: string[];
3965
4119
  }
3966
- interface RedirectUrls {
4120
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4121
+ }
4122
+ interface SendMerchantOrderReceivedNotificationRequest {
3967
4123
  /**
3968
- * URL to redirect buyer in case of approved (successful) transaction
3969
- * @format WEB_URL
4124
+ * @minLength 1
4125
+ * @maxLength 100
3970
4126
  */
3971
- successUrl?: string | null;
4127
+ orderId?: string;
4128
+ }
4129
+ interface SendMerchantOrderReceivedNotificationResponse {
4130
+ }
4131
+ interface SendCancelRefundEmailRequest {
3972
4132
  /**
3973
- * URL to redirect buyer in case of buyer canceled the transaction
3974
- * @format WEB_URL
4133
+ * The ID of order that is canceled/refunded
4134
+ * @minLength 1
4135
+ * @maxLength 100
3975
4136
  */
3976
- cancelUrl?: string | null;
4137
+ orderId?: string;
3977
4138
  /**
3978
- * URL to redirect buyer in case of failed/rejected transaction
3979
- * @format WEB_URL
4139
+ * Personal note added to the email (optional)
4140
+ * @minLength 1
4141
+ * @maxLength 1000
3980
4142
  */
3981
- errorUrl?: string | null;
4143
+ customMessage?: string | null;
4144
+ /** Refund amount */
4145
+ refundAmount?: Price;
3982
4146
  /**
3983
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
3984
- * @format WEB_URL
4147
+ * Refund ID. (Optional)
4148
+ * @format GUID
3985
4149
  */
3986
- pendingUrl?: string | null;
3987
- }
3988
- interface DelayedCaptureSettings {
3989
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
3990
- scheduledAction?: ScheduledActionWithLiterals;
3991
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
3992
- delayDuration?: Duration;
4150
+ refundId?: string | null;
3993
4151
  }
3994
- declare enum ScheduledAction {
3995
- /** Whether payment will be auto-voided when duration passes */
3996
- VOID = "VOID",
3997
- /** Whether payment will be auto-captured when duration passes */
3998
- CAPTURE = "CAPTURE"
4152
+ interface SendCancelRefundEmailResponse {
3999
4153
  }
4000
- /** @enumType */
4001
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4002
- interface Duration {
4154
+ interface SendRefundEmailRequest {
4003
4155
  /**
4004
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4005
- * @min 1
4156
+ * The ID of order that is refunded
4157
+ * @format GUID
4006
4158
  */
4007
- count?: number;
4008
- /** Duration unit: MINUTES, HOURS and DAYS */
4009
- unit?: DurationUnitWithLiterals;
4159
+ orderId?: string;
4160
+ /**
4161
+ * Refund ID
4162
+ * @format GUID
4163
+ */
4164
+ refundId?: string;
4165
+ /**
4166
+ * Personal note added to the email (optional)
4167
+ * @minLength 1
4168
+ * @maxLength 1000
4169
+ */
4170
+ customMessage?: string | null;
4010
4171
  }
4011
- declare enum DurationUnit {
4012
- MINUTES = "MINUTES",
4013
- HOURS = "HOURS",
4014
- DAYS = "DAYS"
4172
+ interface SendRefundEmailResponse {
4015
4173
  }
4016
- /** @enumType */
4017
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4018
- interface PreparePaymentCollectionResponse {
4019
- /** Payment gateway order id which is associated with given payment */
4020
- paymentGatewayOrderId?: string;
4174
+ interface SendFulfillmentEmailRequest {
4175
+ /** @format GUID */
4176
+ orderId?: string;
4177
+ /** @format GUID */
4178
+ fulfillerId?: string;
4021
4179
  }
4022
- interface GetPaymentCollectabilityStatusRequest {
4180
+ interface SendFulfillmentEmailResponse {
4181
+ }
4182
+ interface SendMerchantOrderReceivedPushRequest {
4023
4183
  /**
4024
- * Ecom order ID.
4025
4184
  * @minLength 1
4026
4185
  * @maxLength 100
4027
4186
  */
4028
- ecomOrderId: string;
4187
+ orderId?: string;
4029
4188
  }
4030
- interface GetPaymentCollectabilityStatusResponse {
4031
- /** Payment collectability status */
4032
- status?: PaymentCollectabilityStatusWithLiterals;
4033
- /** Collectable order amount */
4034
- amount?: Price;
4189
+ interface SendMerchantOrderReceivedPushResponse {
4035
4190
  }
4036
- declare enum PaymentCollectabilityStatus {
4037
- UNKNOWN = "UNKNOWN",
4038
- COLLECTABLE = "COLLECTABLE",
4039
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4040
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4041
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4042
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4043
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4044
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4045
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4046
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4047
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4048
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4049
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4191
+ interface PreviewEmailByTypeRequest {
4192
+ emailType?: PreviewEmailTypeWithLiterals;
4193
+ }
4194
+ declare enum PreviewEmailType {
4195
+ ORDER_PLACED = "ORDER_PLACED",
4196
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4197
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4198
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4050
4199
  }
4051
4200
  /** @enumType */
4052
- 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';
4053
- interface RecordManuallyCollectedPaymentRequest {
4201
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4202
+ interface PreviewEmailByTypeResponse {
4203
+ emailPreview?: string;
4204
+ }
4205
+ interface PreviewRefundEmailRequest {
4054
4206
  /**
4055
- * Order ID.
4056
4207
  * @minLength 1
4057
4208
  * @maxLength 100
4058
4209
  */
4059
- orderId: string;
4060
- /** Amount to be recorded as approved manual payment for given order */
4061
- amount: Price;
4062
- }
4063
- /**
4064
- * User-defined payment method name.
4065
- * Allows specifying either a predefined type or a custom name.
4066
- */
4067
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4068
- /** Predefined payment method. */
4069
- predefined?: PredefinedPaymentMethodWithLiterals;
4210
+ orderId?: string;
4211
+ /** Refund amount */
4212
+ refundAmount?: Price;
4213
+ /** Refund business details */
4214
+ details?: RefundDetails;
4070
4215
  /**
4071
- * Custom payment method name provided by user.
4072
- *
4073
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4216
+ * Personal note added to the email (optional)
4074
4217
  * @minLength 1
4075
- * @maxLength 150
4218
+ * @maxLength 1000
4076
4219
  */
4077
- custom?: string | null;
4078
- }
4079
- /** @oneof */
4080
- interface UserDefinedPaymentMethodNameKindOneOf {
4081
- /** Predefined payment method. */
4082
- predefined?: PredefinedPaymentMethodWithLiterals;
4220
+ customMessage?: string | null;
4083
4221
  /**
4084
- * Custom payment method name provided by user.
4085
- *
4086
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4087
- * @minLength 1
4088
- * @maxLength 150
4222
+ * Refund ID. (Optional)
4223
+ * @format GUID
4089
4224
  */
4090
- custom?: string | null;
4091
- }
4092
- /** Predefined payment method types for offline/manual payments. */
4093
- declare enum PredefinedPaymentMethod {
4094
- /** Cash payment. */
4095
- CASH = "CASH",
4096
- /** Bank transfer. */
4097
- BANK_TRANSFER = "BANK_TRANSFER",
4098
- /** Payment by check. */
4099
- CHECK = "CHECK"
4100
- }
4101
- /** @enumType */
4102
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4103
- interface RecordManuallyCollectedPaymentResponse {
4225
+ refundId?: string | null;
4104
4226
  }
4105
- interface MarkOrderAsPaidRequest {
4227
+ /** Business model of a refund request */
4228
+ interface RefundDetails {
4106
4229
  /**
4107
- * Ecom order ID.
4108
- * @minLength 1
4109
- * @maxLength 100
4230
+ * Order line item IDs and quantities that were refunded.
4231
+ * @maxSize 300
4110
4232
  */
4111
- ecomOrderId: string;
4112
- }
4113
- interface MarkOrderAsPaidResponse {
4114
- /** Updated order. */
4115
- order?: Order;
4116
- }
4117
- interface BulkMarkOrdersAsPaidRequest {
4233
+ items?: RefundItem[];
4234
+ /** Whether the shipping fee was also refunded. */
4235
+ shippingIncluded?: boolean;
4118
4236
  /**
4119
- * IDs of orders to mark as paid.
4120
- * @minSize 1
4237
+ * Reason for the refund, provided by customer (optional).
4238
+ * @maxLength 200
4239
+ */
4240
+ reason?: string | null;
4241
+ /**
4242
+ * Line items that were refunded.
4243
+ * @maxSize 300
4244
+ */
4245
+ lineItems?: LineItemRefund[];
4246
+ /**
4247
+ * Additional fees that were refunded.
4121
4248
  * @maxSize 100
4122
- * @minLength 1
4123
- * @maxLength 100
4124
4249
  */
4125
- ecomOrderIds: string[];
4250
+ additionalFees?: AdditionalFeeRefund[];
4251
+ /** Shipping amount that was refunded. */
4252
+ shipping?: ShippingRefund;
4126
4253
  }
4127
- interface BulkMarkOrdersAsPaidResponse {
4254
+ interface RefundItem {
4128
4255
  /**
4129
- * Items updated by the bulk action.
4130
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4256
+ * Line item ID the refunded line item.
4257
+ * @format GUID
4131
4258
  */
4132
- results?: BulkOrderResult[];
4133
- /** Bulk action metadata. */
4134
- bulkActionMetadata?: BulkActionMetadata;
4135
- }
4136
- interface BulkOrderResult {
4137
- /** Item metadata. */
4138
- itemMetadata?: ItemMetadata;
4259
+ lineItemId?: string;
4139
4260
  /**
4140
- * Updated order.
4141
- *
4142
- * Returned when `returnFullEntity = true`.
4261
+ * Line item quantity refunded.
4262
+ * @min 1
4263
+ * @max 100000
4143
4264
  */
4144
- item?: Order;
4145
- }
4146
- interface ItemMetadata {
4147
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4148
- _id?: string | null;
4149
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4150
- originalIndex?: number;
4151
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4152
- success?: boolean;
4153
- /** Details about the error in case of failure. */
4154
- error?: ApplicationError;
4155
- }
4156
- interface ApplicationError {
4157
- /** Error code. */
4158
- code?: string;
4159
- /** Description of the error. */
4160
- description?: string;
4161
- /** Data related to the error. */
4162
- data?: Record<string, any> | null;
4163
- }
4164
- interface BulkActionMetadata {
4165
- /** Number of items that were successfully processed. */
4166
- totalSuccesses?: number;
4167
- /** Number of items that couldn't be processed. */
4168
- totalFailures?: number;
4169
- /** Number of failures without details because detailed failure threshold was exceeded. */
4170
- undetailedFailures?: number;
4265
+ quantity?: number;
4171
4266
  }
4172
- interface GetRefundabilityStatusRequest {
4267
+ interface LineItemRefund {
4173
4268
  /**
4174
- * Order ID.
4175
- * @minLength 1
4176
- * @maxLength 100
4269
+ * Line item ID.
4270
+ * @format GUID
4271
+ * @immutable
4177
4272
  */
4178
- ecomOrderId: string;
4273
+ lineItemId?: string;
4274
+ /**
4275
+ * Refund quantity.
4276
+ * @min 1
4277
+ * @max 100000
4278
+ * @immutable
4279
+ */
4280
+ quantity?: number;
4179
4281
  }
4180
- interface GetRefundabilityStatusResponse {
4282
+ interface AdditionalFeeRefund {
4181
4283
  /**
4182
- * Refundability details.
4183
- * @maxSize 300
4284
+ * Additional fee ID.
4285
+ * @format GUID
4286
+ * @immutable
4184
4287
  */
4185
- refundabilities?: Refundability[];
4288
+ additionalFeeId?: string;
4186
4289
  /**
4187
- * Whether the order supports refunding per item.
4188
- * @deprecated
4290
+ * Refund amount.
4291
+ * @immutable
4189
4292
  */
4190
- refundablePerItem?: boolean;
4191
- }
4192
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4193
- /** Reason why payment is not refundable. */
4194
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4195
- /** Reason why payment is only refundable manually. */
4196
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4197
- /** Payment ID. */
4198
- paymentId?: string;
4199
- /** Payment refundability status. */
4200
- refundabilityStatus?: RefundableStatusWithLiterals;
4201
- /** Link to payment provider dashboard. */
4202
- providerLink?: string | null;
4203
- }
4204
- /** @oneof */
4205
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4206
- /** Reason why payment is not refundable. */
4207
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4208
- /** Reason why payment is only refundable manually. */
4209
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4210
- }
4211
- declare enum RefundableStatus {
4212
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4213
- MANUAL = "MANUAL",
4214
- REFUNDABLE = "REFUNDABLE"
4293
+ amount?: Price;
4215
4294
  }
4216
- /** @enumType */
4217
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4218
- declare enum NonRefundableReason {
4219
- NONE = "NONE",
4220
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4221
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4222
- INTERNAL_ERROR = "INTERNAL_ERROR",
4223
- NOT_PAID = "NOT_PAID",
4224
- ACCESS_DENIED = "ACCESS_DENIED",
4225
- ZERO_PRICE = "ZERO_PRICE",
4226
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4227
- PENDING_REFUND = "PENDING_REFUND",
4228
- FORBIDDEN = "FORBIDDEN",
4229
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4230
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4231
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4295
+ interface ShippingRefund {
4296
+ /**
4297
+ * Refund amount.
4298
+ * @immutable
4299
+ */
4300
+ amount?: Price;
4232
4301
  }
4233
- /** @enumType */
4234
- 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';
4235
- declare enum ManuallyRefundableReason {
4236
- EXPIRED = "EXPIRED",
4237
- NOT_SUPPORTED = "NOT_SUPPORTED",
4238
- OFFLINE = "OFFLINE",
4239
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4302
+ interface PreviewRefundEmailResponse {
4303
+ emailPreview?: string;
4240
4304
  }
4241
- /** @enumType */
4242
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4243
- interface CreatePaymentGatewayOrderRequest {
4305
+ interface PreviewCancelEmailRequest {
4244
4306
  /**
4245
- * Ecom order ID.
4246
4307
  * @minLength 1
4247
4308
  * @maxLength 100
4248
4309
  */
4249
- ecomOrderId: string;
4250
- /** Information about the user who initiated the payment. */
4251
- chargedBy?: ChargedBy;
4252
- }
4253
- interface ChargedBy {
4254
- /**
4255
- * ID - id of the user who initiated the payment
4256
- * @format GUID
4257
- */
4258
- _id?: string;
4310
+ orderId?: string;
4259
4311
  /**
4260
- * Full name - name of the user who initiated the payment
4312
+ * Personal note added to the email (optional)
4261
4313
  * @minLength 1
4262
- * @maxLength 200
4314
+ * @maxLength 1000
4263
4315
  */
4264
- fullName?: string | null;
4316
+ customMessage?: string | null;
4265
4317
  }
4266
- interface CreatePaymentGatewayOrderResponse {
4267
- /** ID of the order created in the payment gateway */
4268
- paymentGatewayOrderId?: string;
4318
+ interface PreviewCancelEmailResponse {
4319
+ emailPreview?: string;
4269
4320
  }
4270
- interface ChargeMembershipsRequest {
4321
+ interface PreviewCancelRefundEmailRequest {
4271
4322
  /**
4272
- * Order ID.
4273
4323
  * @minLength 1
4274
4324
  * @maxLength 100
4275
4325
  */
4276
- ecomOrderId: string;
4277
- /**
4278
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4279
- * but a user which is using the membership on behalf of the a member
4280
- * @format GUID
4281
- */
4282
- memberId: string;
4283
- /**
4284
- * List of items to be paid by memberships
4285
- * @minSize 1
4286
- * @maxSize 300
4287
- */
4288
- membershipCharges?: MembershipChargeItem[];
4289
- }
4290
- interface MembershipChargeItem {
4326
+ orderId?: string;
4291
4327
  /**
4292
- * The id of used membership
4328
+ * Personal note added to the email (optional)
4293
4329
  * @minLength 1
4294
- * @maxLength 100
4330
+ * @maxLength 1000
4295
4331
  */
4296
- membershipId?: string;
4332
+ customMessage?: string | null;
4333
+ /** Refund amount */
4334
+ refundAmount?: Price;
4297
4335
  /**
4298
- * ID of the application providing this payment option
4336
+ * Refund ID. (Optional)
4299
4337
  * @format GUID
4300
4338
  */
4301
- appId?: string;
4302
- /** The name of used membership */
4303
- membershipName?: MembershipName;
4304
- /** Additional data about this membership */
4305
- membershipAdditionalData?: Record<string, any> | null;
4306
- /** Catalog and item reference info. */
4307
- catalogReference?: CatalogReference;
4308
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4309
- serviceProperties?: ServiceProperties;
4310
- /**
4311
- * Usually would be the same as catalogReference.catalogItemId
4312
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4313
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4314
- * @minLength 1
4315
- * @maxLength 36
4316
- */
4317
- rootCatalogItemId?: string | null;
4318
- /**
4319
- * line item id of Checkout/Order line item
4320
- * @minLength 1
4321
- * @maxLength 100
4322
- */
4323
- lineItemId?: string;
4339
+ refundId?: string | null;
4324
4340
  }
4325
- interface MembershipName {
4326
- /**
4327
- * Membership name in the site's original language.
4328
- * @maxLength 100
4329
- */
4330
- original?: string;
4331
- /**
4332
- * Membership name translated into the buyer's language.
4333
- *
4334
- * Default: The value of `original`
4335
- * @maxLength 100
4336
- */
4337
- translated?: string | null;
4341
+ interface PreviewCancelRefundEmailResponse {
4342
+ emailPreview?: string;
4338
4343
  }
4339
- interface ChargeMembershipsResponse {
4344
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4340
4345
  }
4341
- interface TriggerRefundRequest {
4346
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4347
+ emailPreview?: string;
4348
+ }
4349
+ interface PreviewBuyerConfirmationEmailRequest {
4350
+ }
4351
+ interface PreviewBuyerConfirmationEmailResponse {
4352
+ emailPreview?: string;
4353
+ }
4354
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4355
+ }
4356
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4357
+ emailPreview?: string;
4358
+ }
4359
+ interface PreviewShippingConfirmationEmailRequest {
4360
+ }
4361
+ interface PreviewShippingConfirmationEmailResponse {
4362
+ emailPreview?: string;
4363
+ }
4364
+ interface PreviewResendDownloadLinksEmailRequest {
4365
+ }
4366
+ interface PreviewResendDownloadLinksEmailResponse {
4367
+ emailPreview?: string;
4368
+ }
4369
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4370
+ /** Emitted on a meta site creation. */
4371
+ siteCreated?: SiteCreated;
4372
+ /** Emitted on a meta site transfer completion. */
4373
+ siteTransferred?: SiteTransferred;
4374
+ /** Emitted on a meta site deletion. */
4375
+ siteDeleted?: SiteDeleted;
4376
+ /** Emitted on a meta site restoration. */
4377
+ siteUndeleted?: SiteUndeleted;
4378
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4379
+ sitePublished?: SitePublished;
4380
+ /** Emitted on a meta site unpublish. */
4381
+ siteUnpublished?: SiteUnpublished;
4382
+ /** Emitted when meta site is marked as template. */
4383
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4384
+ /** Emitted when meta site is marked as a WixSite. */
4385
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4386
+ /** Emitted when an application is provisioned (installed). */
4387
+ serviceProvisioned?: ServiceProvisioned;
4388
+ /** Emitted when an application is removed (uninstalled). */
4389
+ serviceRemoved?: ServiceRemoved;
4390
+ /** Emitted when meta site name (URL slug) is changed. */
4391
+ siteRenamedPayload?: SiteRenamed;
4392
+ /** Emitted when meta site was permanently deleted. */
4393
+ hardDeleted?: SiteHardDeleted;
4394
+ /** Emitted on a namespace change. */
4395
+ namespaceChanged?: NamespaceChanged;
4396
+ /** Emitted when Studio is attached. */
4397
+ studioAssigned?: StudioAssigned;
4398
+ /** Emitted when Studio is detached. */
4399
+ studioUnassigned?: StudioUnassigned;
4342
4400
  /**
4343
- * The order this refund related to
4344
- * @minLength 1
4345
- * @maxLength 100
4401
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4402
+ * the actual URL.
4403
+ *
4404
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4405
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4346
4406
  */
4347
- ecomOrderId: string;
4407
+ urlChanged?: SiteUrlChanged;
4408
+ /** Site is marked as PurgedExternally */
4409
+ sitePurgedExternally?: SitePurgedExternally;
4410
+ /** Emitted when Odeditor is attached. */
4411
+ odeditorAssigned?: OdeditorAssigned;
4412
+ /** Emitted when Odeditor is detached. */
4413
+ odeditorUnassigned?: OdeditorUnassigned;
4414
+ /** Emitted when Picasso is attached. */
4415
+ picassoAssigned?: PicassoAssigned;
4416
+ /** Emitted when Picasso is detached. */
4417
+ picassoUnassigned?: PicassoUnassigned;
4418
+ /** Emitted when Wixel is attached. */
4419
+ wixelAssigned?: WixelAssigned;
4420
+ /** Emitted when Wixel is detached. */
4421
+ wixelUnassigned?: WixelUnassigned;
4422
+ /** Emitted when StudioTwo is attached. */
4423
+ studioTwoAssigned?: StudioTwoAssigned;
4424
+ /** Emitted when StudioTwo is detached. */
4425
+ studioTwoUnassigned?: StudioTwoUnassigned;
4426
+ /** Emitted when media from user domain is enabled. */
4427
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4428
+ /** Emitted when media from user domain is disabled. */
4429
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4430
+ /** Emitted when Editorless is attached. */
4431
+ editorlessAssigned?: EditorlessAssigned;
4432
+ /** Emitted when Editorless is detached. */
4433
+ editorlessUnassigned?: EditorlessUnassigned;
4348
4434
  /**
4349
- * Refund operations information
4350
- * @minSize 1
4351
- * @maxSize 1
4435
+ * A meta site id.
4436
+ * @format GUID
4352
4437
  */
4353
- payments: PaymentRefund[];
4354
- /** Business model of a refund */
4355
- details?: RefundDetails;
4356
- /** Side effect details related to refund */
4357
- sideEffects?: RefundSideEffects;
4358
- }
4359
- interface PaymentRefund {
4438
+ metaSiteId?: string;
4439
+ /** A meta site version. Monotonically increasing. */
4440
+ version?: string;
4441
+ /** A timestamp of the event. */
4442
+ timestamp?: string;
4360
4443
  /**
4361
- * Specific payment within the order to refund
4362
- * @format GUID
4444
+ * TODO(meta-site): Change validation once validations are disabled for consumers
4445
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4446
+ * @maxSize 4000
4363
4447
  */
4364
- paymentId?: string;
4365
- /** Refund amount. Not relevant for membership and gift card refunds. */
4366
- amount?: Price;
4448
+ assets?: Asset[];
4449
+ }
4450
+ /** @oneof */
4451
+ interface MetaSiteSpecialEventPayloadOneOf {
4452
+ /** Emitted on a meta site creation. */
4453
+ siteCreated?: SiteCreated;
4454
+ /** Emitted on a meta site transfer completion. */
4455
+ siteTransferred?: SiteTransferred;
4456
+ /** Emitted on a meta site deletion. */
4457
+ siteDeleted?: SiteDeleted;
4458
+ /** Emitted on a meta site restoration. */
4459
+ siteUndeleted?: SiteUndeleted;
4460
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4461
+ sitePublished?: SitePublished;
4462
+ /** Emitted on a meta site unpublish. */
4463
+ siteUnpublished?: SiteUnpublished;
4464
+ /** Emitted when meta site is marked as template. */
4465
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4466
+ /** Emitted when meta site is marked as a WixSite. */
4467
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4468
+ /** Emitted when an application is provisioned (installed). */
4469
+ serviceProvisioned?: ServiceProvisioned;
4470
+ /** Emitted when an application is removed (uninstalled). */
4471
+ serviceRemoved?: ServiceRemoved;
4472
+ /** Emitted when meta site name (URL slug) is changed. */
4473
+ siteRenamedPayload?: SiteRenamed;
4474
+ /** Emitted when meta site was permanently deleted. */
4475
+ hardDeleted?: SiteHardDeleted;
4476
+ /** Emitted on a namespace change. */
4477
+ namespaceChanged?: NamespaceChanged;
4478
+ /** Emitted when Studio is attached. */
4479
+ studioAssigned?: StudioAssigned;
4480
+ /** Emitted when Studio is detached. */
4481
+ studioUnassigned?: StudioUnassigned;
4367
4482
  /**
4368
- * Whether refund is made externally and manually (on the payment provider's side)
4369
- * 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.
4370
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4483
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4484
+ * the actual URL.
4485
+ *
4486
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4487
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4371
4488
  */
4372
- externalRefund?: boolean;
4489
+ urlChanged?: SiteUrlChanged;
4490
+ /** Site is marked as PurgedExternally */
4491
+ sitePurgedExternally?: SitePurgedExternally;
4492
+ /** Emitted when Odeditor is attached. */
4493
+ odeditorAssigned?: OdeditorAssigned;
4494
+ /** Emitted when Odeditor is detached. */
4495
+ odeditorUnassigned?: OdeditorUnassigned;
4496
+ /** Emitted when Picasso is attached. */
4497
+ picassoAssigned?: PicassoAssigned;
4498
+ /** Emitted when Picasso is detached. */
4499
+ picassoUnassigned?: PicassoUnassigned;
4500
+ /** Emitted when Wixel is attached. */
4501
+ wixelAssigned?: WixelAssigned;
4502
+ /** Emitted when Wixel is detached. */
4503
+ wixelUnassigned?: WixelUnassigned;
4504
+ /** Emitted when StudioTwo is attached. */
4505
+ studioTwoAssigned?: StudioTwoAssigned;
4506
+ /** Emitted when StudioTwo is detached. */
4507
+ studioTwoUnassigned?: StudioTwoUnassigned;
4508
+ /** Emitted when media from user domain is enabled. */
4509
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
4510
+ /** Emitted when media from user domain is disabled. */
4511
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
4512
+ /** Emitted when Editorless is attached. */
4513
+ editorlessAssigned?: EditorlessAssigned;
4514
+ /** Emitted when Editorless is detached. */
4515
+ editorlessUnassigned?: EditorlessUnassigned;
4373
4516
  }
4374
- /** Business model of a refund request */
4375
- interface RefundDetails {
4517
+ interface Asset {
4376
4518
  /**
4377
- * Order line item IDs and quantities that were refunded.
4378
- * @maxSize 300
4519
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4520
+ * @maxLength 36
4379
4521
  */
4380
- items?: RefundItem[];
4381
- /** Whether the shipping fee was also refunded. */
4382
- shippingIncluded?: boolean;
4522
+ appDefId?: string;
4383
4523
  /**
4384
- * Reason for the refund, provided by customer (optional).
4524
+ * An instance id. For legacy reasons may be UUID or a string.
4385
4525
  * @maxLength 200
4386
4526
  */
4387
- reason?: string | null;
4527
+ instanceId?: string;
4528
+ /** An application state. */
4529
+ state?: StateWithLiterals;
4530
+ }
4531
+ declare enum State {
4532
+ UNKNOWN = "UNKNOWN",
4533
+ ENABLED = "ENABLED",
4534
+ DISABLED = "DISABLED",
4535
+ PENDING = "PENDING",
4536
+ DEMO = "DEMO"
4537
+ }
4538
+ /** @enumType */
4539
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4540
+ interface SiteCreated {
4388
4541
  /**
4389
- * Line items that were refunded.
4390
- * @maxSize 300
4542
+ * A template identifier (empty if not created from a template).
4543
+ * @maxLength 36
4391
4544
  */
4392
- lineItems?: LineItemRefund[];
4545
+ originTemplateId?: string;
4393
4546
  /**
4394
- * Additional fees that were refunded.
4395
- * @maxSize 100
4547
+ * An account id of the owner.
4548
+ * @format GUID
4396
4549
  */
4397
- additionalFees?: AdditionalFeeRefund[];
4398
- /** Shipping amount that was refunded. */
4399
- shipping?: ShippingRefund;
4400
- }
4401
- interface RefundItem {
4550
+ ownerId?: string;
4551
+ /** A context in which meta site was created. */
4552
+ context?: SiteCreatedContextWithLiterals;
4402
4553
  /**
4403
- * Line item ID the refunded line item.
4554
+ * A meta site id from which this site was created.
4555
+ *
4556
+ * In case of a creation from a template it's a template id.
4557
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4404
4558
  * @format GUID
4405
4559
  */
4406
- lineItemId?: string;
4560
+ originMetaSiteId?: string | null;
4407
4561
  /**
4408
- * Line item quantity refunded.
4409
- * @min 1
4410
- * @max 100000
4562
+ * A meta site name (URL slug).
4563
+ * @maxLength 20
4411
4564
  */
4412
- quantity?: number;
4565
+ siteName?: string;
4566
+ /** A namespace. */
4567
+ namespace?: NamespaceWithLiterals;
4413
4568
  }
4414
- interface LineItemRefund {
4415
- /**
4416
- * Line item ID.
4417
- * @format GUID
4418
- * @immutable
4419
- */
4420
- lineItemId?: string;
4569
+ declare enum SiteCreatedContext {
4570
+ /** A valid option, we don't expose all reasons why site might be created. */
4571
+ OTHER = "OTHER",
4572
+ /** A meta site was created from template. */
4573
+ FROM_TEMPLATE = "FROM_TEMPLATE",
4574
+ /** A meta site was created by copying of the transfferred meta site. */
4575
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4576
+ /** A copy of existing meta site. */
4577
+ DUPLICATE = "DUPLICATE",
4578
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4579
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4580
+ /** deprecated A meta site was created for Flash editor. */
4581
+ FLASH = "FLASH"
4582
+ }
4583
+ /** @enumType */
4584
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4585
+ declare enum Namespace {
4586
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4587
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4588
+ WIX = "WIX",
4589
+ /** 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. */
4590
+ SHOUT_OUT = "SHOUT_OUT",
4591
+ /** 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. */
4592
+ ALBUMS = "ALBUMS",
4593
+ /** 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. */
4594
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4595
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4596
+ HOTELS = "HOTELS",
4597
+ /** 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. */
4598
+ CLUBS = "CLUBS",
4599
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4600
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4421
4601
  /**
4422
- * Refund quantity.
4423
- * @min 1
4424
- * @max 100000
4425
- * @immutable
4602
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4603
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4426
4604
  */
4427
- quantity?: number;
4428
- }
4429
- interface AdditionalFeeRefund {
4605
+ DEV_SITE = "DEV_SITE",
4606
+ /** 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. */
4607
+ LOGOS = "LOGOS",
4608
+ /** 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. */
4609
+ VIDEO_MAKER = "VIDEO_MAKER",
4610
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4611
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4612
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4613
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4430
4614
  /**
4431
- * Additional fee ID.
4432
- * @format GUID
4433
- * @immutable
4615
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4616
+ *
4617
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
4434
4618
  */
4435
- additionalFeeId?: string;
4619
+ HTML_DRAFT = "HTML_DRAFT",
4436
4620
  /**
4437
- * Refund amount.
4438
- * @immutable
4621
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4622
+ * Will be accessible from Site List and will not have a website app.
4623
+ * Once the user attaches a site, the site will become a regular wixsite.
4439
4624
  */
4440
- amount?: Price;
4441
- }
4442
- interface ShippingRefund {
4625
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
4626
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4627
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
4628
+ /** It is to be used in the Business First efforts. */
4629
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
4630
+ /** Bookings business flow with no site. */
4631
+ ANYWHERE = "ANYWHERE",
4632
+ /** Namespace for Headless Backoffice with no editor */
4633
+ HEADLESS = "HEADLESS",
4443
4634
  /**
4444
- * Refund amount.
4445
- * @immutable
4635
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4636
+ * The site will be used for account level CSM feature for enterprise
4446
4637
  */
4447
- amount?: Price;
4448
- }
4449
- interface RefundSideEffects {
4450
- /** Inventory restock details as part of this refund. */
4451
- restockInfo?: RestockInfo;
4452
- /** Whether to send a refund confirmation email to the customer. */
4453
- sendOrderRefundedEmail?: boolean;
4638
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4639
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4640
+ RISE = "RISE",
4454
4641
  /**
4455
- * Custom message added to the refund confirmation email.
4456
- * @minLength 1
4457
- * @maxLength 1000
4642
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4643
+ * There's a blank site behind the scene but it's blank).
4644
+ * The Mobile company will be the owner of this namespace.
4458
4645
  */
4459
- customMessage?: string | null;
4460
- }
4461
- interface RestockInfo {
4462
- /** Restock type. */
4463
- type?: RestockTypeWithLiterals;
4646
+ BRANDED_FIRST = "BRANDED_FIRST",
4647
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4648
+ NOWNIA = "NOWNIA",
4464
4649
  /**
4465
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4466
- * @maxSize 300
4650
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
4651
+ * The Partners company owns this namespace.
4467
4652
  */
4468
- items?: RestockItem[];
4469
- }
4470
- declare enum RestockType {
4471
- NO_ITEMS = "NO_ITEMS",
4472
- ALL_ITEMS = "ALL_ITEMS",
4473
- SOME_ITEMS = "SOME_ITEMS"
4474
- }
4475
- /** @enumType */
4476
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4477
- interface RestockItem {
4653
+ UGC_TEMPLATE = "UGC_TEMPLATE",
4654
+ /** Codux Headless Sites */
4655
+ CODUX = "CODUX",
4656
+ /** Bobb - AI Design Creator. */
4657
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4478
4658
  /**
4479
- * ID of the line item being restocked.
4480
- * @format GUID
4659
+ * Shared Blog Site is a unique single site across Enterprise account,
4660
+ * This site will hold all Blog posts related to the Marketing product.
4481
4661
  */
4482
- lineItemId?: string;
4662
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4663
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4664
+ STANDALONE_FORMS = "STANDALONE_FORMS",
4665
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4666
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
4667
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4668
+ MIMIR = "MIMIR",
4669
+ /** Wix Twins platform. */
4670
+ TWINS = "TWINS",
4671
+ /** Wix Nano. */
4672
+ NANO = "NANO",
4673
+ /** Base44 headless sites. */
4674
+ BASE44 = "BASE44",
4675
+ /** Wix Channels Sites */
4676
+ CHANNELS = "CHANNELS",
4677
+ /** Nautilus platform. */
4678
+ NAUTILUS = "NAUTILUS",
4483
4679
  /**
4484
- * Line item quantity being restocked.
4485
- * @min 1
4486
- * @max 100000
4680
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4681
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4487
4682
  */
4488
- quantity?: number;
4489
- }
4490
- interface TriggerRefundResponse {
4491
- /** All order's transactions after the refunds were added */
4492
- orderTransactions?: OrderTransactions;
4493
- /** Created refund ID */
4494
- refundId?: string | null;
4495
- /** Payment ID's that the refund execution had failed for */
4496
- failedPaymentIds?: ItemMetadata[];
4497
- }
4498
- /**
4499
- * A record of all payments and refunds associated with an order.
4500
- *
4501
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4502
- */
4503
- interface OrderTransactions {
4683
+ SYMPHONY = "SYMPHONY",
4684
+ /** Nautilus platform app. */
4685
+ NAUTILUS_APPS = "NAUTILUS_APPS",
4504
4686
  /**
4505
- * Order ID.
4506
- * @format GUID
4687
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
4688
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
4507
4689
  */
4508
- orderId?: string;
4690
+ VIBU = "VIBU",
4509
4691
  /**
4510
- * Record of payments made to the merchant.
4511
- * @maxSize 100
4692
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
4693
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
4694
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
4695
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
4512
4696
  */
4513
- payments?: Payment[];
4697
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4514
4698
  /**
4515
- * Record of refunds made to the buyer.
4516
- * @maxSize 300
4699
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
4700
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
4517
4701
  */
4518
- refunds?: Refund[];
4702
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
4519
4703
  }
4520
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4521
- /** Regular payment details. */
4522
- regularPaymentDetails?: RegularPaymentDetails;
4523
- /** Gift card payment details. */
4524
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4525
- /** Membership payment details. */
4526
- membershipPaymentDetails?: MembershipPaymentDetails;
4704
+ /** @enumType */
4705
+ 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';
4706
+ /** Site transferred to another user. */
4707
+ interface SiteTransferred {
4527
4708
  /**
4528
- * Payment ID.
4709
+ * A previous owner id (user that transfers meta site).
4529
4710
  * @format GUID
4530
- * @readonly
4531
- */
4532
- _id?: string | null;
4533
- /** 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. */
4534
- _createdDate?: Date | null;
4535
- /**
4536
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4537
- * @readonly
4538
- */
4539
- _updatedDate?: Date | null;
4540
- /** Payment amount. */
4541
- amount?: Price;
4542
- /**
4543
- * Whether refunds for this payment are disabled.
4544
- * + `true`: This payment is not refundable.
4545
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4546
4711
  */
4547
- refundDisabled?: boolean;
4712
+ oldOwnerId?: string;
4548
4713
  /**
4549
- * Whether receipt generation is allowed for this payment.
4550
- * + `true`: This payment supports receipt generation.
4551
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4552
- * @readonly
4714
+ * A new owner id (user that accepts meta site).
4715
+ * @format GUID
4553
4716
  */
4554
- supportReceiptGeneration?: boolean;
4555
- /** Details about cash rounding applied to this payment, when relevant. */
4556
- cashRounding?: CashRoundingDetails;
4717
+ newOwnerId?: string;
4718
+ }
4719
+ /** Soft deletion of the meta site. Could be restored. */
4720
+ interface SiteDeleted {
4721
+ /** A deletion context. */
4722
+ deleteContext?: DeleteContext;
4723
+ }
4724
+ interface DeleteContext {
4725
+ /** When the meta site was deleted. */
4726
+ dateDeleted?: Date | null;
4727
+ /** A status. */
4728
+ deleteStatus?: DeleteStatusWithLiterals;
4557
4729
  /**
4558
- * Overall payment status.
4559
- *
4560
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
4730
+ * A reason (flow).
4731
+ * @maxLength 255
4561
4732
  */
4562
- status?: PaymentStatusWithLiterals;
4733
+ deleteOrigin?: string;
4563
4734
  /**
4564
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4565
- * @format GUID
4735
+ * A service that deleted it.
4736
+ * @maxLength 255
4566
4737
  */
4567
- chargeCorrelationId?: string | null;
4738
+ initiatorId?: string | null;
4568
4739
  }
4569
- /** @oneof */
4570
- interface PaymentPaymentDetailsOneOf {
4571
- /** Regular payment details. */
4572
- regularPaymentDetails?: RegularPaymentDetails;
4573
- /** Gift card payment details. */
4574
- giftcardPaymentDetails?: GiftCardPaymentDetails;
4575
- /** Membership payment details. */
4576
- membershipPaymentDetails?: MembershipPaymentDetails;
4740
+ declare enum DeleteStatus {
4741
+ UNKNOWN = "UNKNOWN",
4742
+ TRASH = "TRASH",
4743
+ DELETED = "DELETED",
4744
+ PENDING_PURGE = "PENDING_PURGE",
4745
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4577
4746
  }
4578
- /** @oneof */
4579
- interface PaymentReceiptInfoOneOf {
4747
+ /** @enumType */
4748
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4749
+ /** Restoration of the meta site. */
4750
+ interface SiteUndeleted {
4580
4751
  }
4581
- /** @oneof */
4582
- interface PaymentStatusDetailsOneOf {
4752
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
4753
+ interface SitePublished {
4583
4754
  }
4584
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4585
- /** Credit card details. */
4586
- creditCardDetails?: CreditCardPaymentMethodDetails;
4755
+ interface SiteUnpublished {
4587
4756
  /**
4588
- * Wix Payments order ID.
4589
- * @maxLength 100
4757
+ * A list of URLs previously associated with the meta site.
4758
+ * @maxLength 4000
4759
+ * @maxSize 10000
4590
4760
  */
4591
- paymentOrderId?: string | null;
4761
+ urls?: string[];
4762
+ }
4763
+ interface SiteMarkedAsTemplate {
4764
+ }
4765
+ interface SiteMarkedAsWixSite {
4766
+ }
4767
+ /**
4768
+ * Represents a service provisioned a site.
4769
+ *
4770
+ * Note on `origin_instance_id`:
4771
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4772
+ * This is because of the following scenario:
4773
+ *
4774
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
4775
+ * such as a product catalog. When you create a site from this template, you inherit this
4776
+ * default product catalog. However, if the template's product catalog is modified,
4777
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
4778
+ * your site remains consistent with what you initially received and does not include any
4779
+ * changes made to the original template afterward.
4780
+ * To ensure this, the TPA on the template gets a new instance_id.
4781
+ */
4782
+ interface ServiceProvisioned {
4592
4783
  /**
4593
- * Payment gateway's transaction ID.
4594
- * This field is only returned when the value of `offline_payment` is `false`.
4595
- * @maxLength 100
4784
+ * Either UUID or EmbeddedServiceType.
4785
+ * @maxLength 36
4596
4786
  */
4597
- gatewayTransactionId?: string | null;
4787
+ appDefId?: string;
4598
4788
  /**
4599
- * Payment method.
4600
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4601
- * Non-exhaustive list of supported values:
4602
- * + `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`
4603
- * @maxLength 150
4604
- * @deprecated Payment method.
4605
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4606
- * Non-exhaustive list of supported values:
4607
- * + `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`
4608
- * @replacedBy payment_method_name
4609
- * @targetRemovalDate 2026-07-01
4789
+ * Not only UUID. Something here could be something weird.
4790
+ * @maxLength 36
4610
4791
  */
4611
- paymentMethod?: string | null;
4792
+ instanceId?: string;
4612
4793
  /**
4613
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4614
- * @maxLength 100
4794
+ * An instance id from which this instance is originated.
4795
+ * @maxLength 36
4615
4796
  */
4616
- providerTransactionId?: string | null;
4617
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4618
- offlinePayment?: boolean;
4797
+ originInstanceId?: string;
4619
4798
  /**
4620
- * Payment status.
4621
- * @deprecated Payment status.
4622
- * @replacedBy payment.status
4623
- * @targetRemovalDate 2026-11-01
4799
+ * A version.
4800
+ * @maxLength 500
4624
4801
  */
4625
- status?: TransactionStatusWithLiterals;
4626
- /** Whether there is a payment agreement that allows for future charges. */
4627
- savedPaymentMethod?: boolean;
4628
- /** Authorization details. */
4629
- authorizationDetails?: AuthorizationDetails;
4802
+ version?: string | null;
4630
4803
  /**
4631
- * Record of chargebacks made by the buyer.
4632
- * @maxSize 6
4804
+ * The origin meta site id
4805
+ * @format GUID
4633
4806
  */
4634
- chargebacks?: Chargeback[];
4635
- /** Platform fee amount associated with this payment. */
4636
- platformFee?: Price;
4807
+ originMetaSiteId?: string | null;
4808
+ }
4809
+ interface ServiceRemoved {
4637
4810
  /**
4638
- * Payment method with buyer and optional owner translations.
4639
- * Non-exhaustive list of supported values:
4640
- * + `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`
4811
+ * Either UUID or EmbeddedServiceType.
4812
+ * @maxLength 36
4641
4813
  */
4642
- paymentMethodName?: PaymentMethodName;
4643
- }
4644
- /** @oneof */
4645
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4646
- /** Credit card details. */
4647
- creditCardDetails?: CreditCardPaymentMethodDetails;
4648
- }
4649
- declare enum TransactionStatus {
4650
- UNDEFINED = "UNDEFINED",
4651
- APPROVED = "APPROVED",
4652
- PENDING = "PENDING",
4653
- PENDING_MERCHANT = "PENDING_MERCHANT",
4654
- CANCELED = "CANCELED",
4655
- DECLINED = "DECLINED",
4656
- REFUNDED = "REFUNDED",
4657
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4658
- AUTHORIZED = "AUTHORIZED",
4659
- VOIDED = "VOIDED"
4660
- }
4661
- /** @enumType */
4662
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4663
- interface CreditCardPaymentMethodDetails {
4814
+ appDefId?: string;
4664
4815
  /**
4665
- * The last 4 digits of the card number.
4666
- * @maxLength 4
4816
+ * Not only UUID. Something here could be something weird.
4817
+ * @maxLength 36
4667
4818
  */
4668
- lastFourDigits?: string | null;
4819
+ instanceId?: string;
4669
4820
  /**
4670
- * Card issuer's brand.
4671
- * @maxLength 100
4821
+ * A version.
4822
+ * @maxLength 500
4672
4823
  */
4673
- brand?: string | null;
4824
+ version?: string | null;
4674
4825
  }
4675
- interface AuthorizationDetails {
4826
+ /** Rename of the site. Meaning, free public url has been changed as well. */
4827
+ interface SiteRenamed {
4676
4828
  /**
4677
- * Whether the authorized payment is of a delayed capture.
4678
- * @readonly
4829
+ * A new meta site name (URL slug).
4830
+ * @maxLength 20
4679
4831
  */
4680
- delayedCapture?: boolean;
4681
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4682
- authorizedDate?: Date | null;
4832
+ newSiteName?: string;
4683
4833
  /**
4684
- * List of captures associated with payment
4685
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4686
- * @maxSize 1
4834
+ * A previous meta site name (URL slug).
4835
+ * @maxLength 255
4687
4836
  */
4688
- captures?: AuthorizationCapture[];
4689
- /** Void associated with payment */
4690
- void?: AuthorizationVoid;
4691
- /** Scheduled action for this transaction */
4692
- scheduledAction?: V1ScheduledAction;
4837
+ oldSiteName?: string;
4693
4838
  }
4694
- interface AuthorizationCapture {
4695
- /**
4696
- * Capture ID.
4697
- * @format GUID
4698
- * @readonly
4699
- */
4700
- _id?: string | null;
4701
- /** Status of this capture action */
4702
- status?: AuthorizationCaptureStatusWithLiterals;
4839
+ /**
4840
+ * Hard deletion of the meta site.
4841
+ *
4842
+ * Could not be restored. Therefore it's desirable to cleanup data.
4843
+ */
4844
+ interface SiteHardDeleted {
4845
+ /** A deletion context. */
4846
+ deleteContext?: DeleteContext;
4847
+ }
4848
+ interface NamespaceChanged {
4849
+ /** A previous namespace. */
4850
+ oldNamespace?: NamespaceWithLiterals;
4851
+ /** A new namespace. */
4852
+ newNamespace?: NamespaceWithLiterals;
4853
+ }
4854
+ /** Assigned Studio editor */
4855
+ interface StudioAssigned {
4856
+ }
4857
+ /** Unassigned Studio editor */
4858
+ interface StudioUnassigned {
4859
+ }
4860
+ /**
4861
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4862
+ *
4863
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4864
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
4865
+ *
4866
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4867
+ */
4868
+ interface SiteUrlChanged {
4869
+ }
4870
+ /**
4871
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4872
+ * Consumed by other teams to remove relevant data.
4873
+ */
4874
+ interface SitePurgedExternally {
4703
4875
  /**
4704
- * Amount of this capture
4705
- * @immutable
4876
+ * @maxLength 2048
4877
+ * @maxSize 100
4878
+ * @deprecated
4879
+ * @targetRemovalDate 2025-04-15
4706
4880
  */
4707
- amount?: Price;
4708
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4709
- _createdDate?: Date | null;
4710
- /** In case of status is FAILED may contain failure details */
4711
- failureDetails?: AuthorizationActionFailureDetails;
4881
+ appDefId?: string[];
4712
4882
  }
4713
- declare enum AuthorizationCaptureStatus {
4714
- /** Capture operation still in progress. */
4715
- PENDING = "PENDING",
4716
- /** Capture operation succeeded. */
4717
- SUCCEEDED = "SUCCEEDED",
4718
- /** Capture operation failed. */
4719
- FAILED = "FAILED"
4883
+ /** Assigned Odeditor */
4884
+ interface OdeditorAssigned {
4720
4885
  }
4721
- /** @enumType */
4722
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4723
- interface AuthorizationActionFailureDetails {
4724
- /** @maxLength 100 */
4725
- failureCode?: string;
4886
+ /** Unassigned Odeditor */
4887
+ interface OdeditorUnassigned {
4726
4888
  }
4727
- interface AuthorizationVoid {
4728
- /** Status of this void action */
4729
- status?: AuthorizationVoidStatusWithLiterals;
4730
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4731
- voidedDate?: Date | null;
4732
- /** In case of status is FAILED may contain failure details */
4733
- failureDetails?: AuthorizationActionFailureDetails;
4734
- /** Reason of void action */
4735
- reason?: ReasonWithLiterals;
4889
+ /** Assigned Picasso editor */
4890
+ interface PicassoAssigned {
4736
4891
  }
4737
- declare enum AuthorizationVoidStatus {
4738
- /** Void operation still in progress. */
4739
- PENDING = "PENDING",
4740
- /** Void operation succeeded. */
4741
- SUCCEEDED = "SUCCEEDED",
4742
- /** Void operation failed. */
4743
- FAILED = "FAILED"
4892
+ /** Unassigned Picasso */
4893
+ interface PicassoUnassigned {
4894
+ }
4895
+ /** Assigned Wixel */
4896
+ interface WixelAssigned {
4897
+ }
4898
+ /** Unassigned Wixel */
4899
+ interface WixelUnassigned {
4900
+ }
4901
+ /** Assigned StudioTwo */
4902
+ interface StudioTwoAssigned {
4903
+ }
4904
+ /** Unassigned StudioTwo */
4905
+ interface StudioTwoUnassigned {
4906
+ }
4907
+ /** Media from user domain is enabled. */
4908
+ interface UserDomainMediaEnabled {
4909
+ }
4910
+ /** Media from user domain is disabled. */
4911
+ interface UserDomainMediaDisabled {
4912
+ }
4913
+ /** Assigned Editorless */
4914
+ interface EditorlessAssigned {
4915
+ }
4916
+ /** Unassigned Editorless */
4917
+ interface EditorlessUnassigned {
4918
+ }
4919
+ interface HasCustomEmailConfigurationsRequest {
4920
+ }
4921
+ interface HasCustomEmailConfigurationsResponse {
4922
+ hasCustomConfigurations?: boolean;
4923
+ }
4924
+ interface AddToAutomationMigrationPopulationRequest {
4925
+ /** When true, sends custom email configurations to automation system via email */
4926
+ sendCustomEmailConfigs?: boolean;
4927
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4928
+ origin?: OriginWithLiterals;
4929
+ }
4930
+ declare enum Origin {
4931
+ OPT_IN = "OPT_IN",
4932
+ MIGRATION = "MIGRATION"
4744
4933
  }
4745
4934
  /** @enumType */
4746
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4747
- /** Reason the authorization was voided. */
4748
- declare enum Reason {
4749
- /** Authorization was voided by user. */
4750
- MANUAL = "MANUAL",
4751
- /** Authorization passed execution date. */
4752
- SCHEDULED = "SCHEDULED"
4935
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4936
+ interface AddToAutomationMigrationPopulationResponse {
4937
+ success?: boolean;
4753
4938
  }
4754
- /** @enumType */
4755
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4756
- interface V1ScheduledAction {
4757
- /** Type of the action. */
4758
- actionType?: ActionTypeWithLiterals;
4759
- /** The date and time of the action. */
4760
- executionDate?: Date | null;
4939
+ interface IsInAutomationMigrationPopulationRequest {
4761
4940
  }
4762
- declare enum ActionType {
4763
- VOID = "VOID",
4764
- CAPTURE = "CAPTURE"
4941
+ interface IsInAutomationMigrationPopulationResponse {
4942
+ inPopulation?: boolean;
4765
4943
  }
4766
- /** @enumType */
4767
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4768
- interface Chargeback {
4944
+ interface PreparePaymentCollectionRequest {
4769
4945
  /**
4770
- * Chargeback ID.
4771
- * @format GUID
4772
- * @readonly
4773
- * @immutable
4946
+ * Ecom order ID.
4947
+ * @minLength 1
4948
+ * @maxLength 100
4774
4949
  */
4775
- _id?: string;
4950
+ ecomOrderId: string;
4951
+ /** Amount to collect */
4952
+ amount: Price;
4776
4953
  /**
4777
- * 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.
4778
- * @readonly
4779
- * @immutable
4954
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4955
+ * Existing payment gateway order will be updated with a new amount.
4956
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
4780
4957
  */
4781
- _createdDate?: Date | null;
4958
+ paymentGatewayOrderId?: string | null;
4782
4959
  /**
4783
- * 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.
4784
- * @readonly
4960
+ * Whether to delay capture of the payment.
4961
+ * Default: false
4962
+ * @deprecated Whether to delay capture of the payment.
4963
+ * Default: false
4964
+ * @replacedBy delayed_capture_settings.scheduled_action
4965
+ * @targetRemovalDate 2024-09-30
4785
4966
  */
4786
- _updatedDate?: Date | null;
4967
+ delayedCapture?: boolean;
4968
+ /** Delayed capture payment settings */
4969
+ delayedCaptureSettings?: DelayedCaptureSettings;
4970
+ }
4971
+ interface RedirectUrls {
4787
4972
  /**
4788
- * Amount.
4789
- * @readonly
4790
- * @immutable
4973
+ * URL to redirect buyer in case of approved (successful) transaction
4974
+ * @format WEB_URL
4791
4975
  */
4792
- amount?: Price;
4976
+ successUrl?: string | null;
4793
4977
  /**
4794
- * Reversal amount. Present only when status is REVERSED.
4795
- * @readonly
4978
+ * URL to redirect buyer in case of buyer canceled the transaction
4979
+ * @format WEB_URL
4796
4980
  */
4797
- reversalAmount?: Price;
4981
+ cancelUrl?: string | null;
4798
4982
  /**
4799
- * Status.
4800
- *
4801
- * Default: `"APPROVED"`.
4983
+ * URL to redirect buyer in case of failed/rejected transaction
4984
+ * @format WEB_URL
4802
4985
  */
4803
- status?: ChargebackStatusWithLiterals;
4986
+ errorUrl?: string | null;
4804
4987
  /**
4805
- * External chargeback ID.
4806
- * @format GUID
4807
- * @readonly
4808
- * @immutable
4988
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4989
+ * @format WEB_URL
4809
4990
  */
4810
- externalId?: string | null;
4991
+ pendingUrl?: string | null;
4811
4992
  }
4812
- declare enum ChargebackStatus {
4813
- /** Chargeback was approved. */
4814
- APPROVED = "APPROVED",
4815
- /** Chargeback was reversed. */
4816
- REVERSED = "REVERSED"
4993
+ interface DelayedCaptureSettings {
4994
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4995
+ scheduledAction?: ScheduledActionWithLiterals;
4996
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4997
+ delayDuration?: Duration;
4998
+ }
4999
+ declare enum ScheduledAction {
5000
+ /** Whether payment will be auto-voided when duration passes */
5001
+ VOID = "VOID",
5002
+ /** Whether payment will be auto-captured when duration passes */
5003
+ CAPTURE = "CAPTURE"
4817
5004
  }
4818
5005
  /** @enumType */
4819
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4820
- interface PaymentMethodName {
4821
- /**
4822
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
4823
- * @maxLength 150
4824
- */
4825
- buyerLanguageName?: string | null;
4826
- /**
4827
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
4828
- *
4829
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
4830
- * @maxLength 150
4831
- */
4832
- siteLanguageName?: string | null;
5006
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5007
+ interface Duration {
4833
5008
  /**
4834
- * User-provided payment method name.
4835
- *
4836
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5009
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5010
+ * @min 1
4837
5011
  */
4838
- userDefinedName?: UserDefinedPaymentMethodName;
5012
+ count?: number;
5013
+ /** Duration unit: MINUTES, HOURS and DAYS */
5014
+ unit?: DurationUnitWithLiterals;
4839
5015
  }
4840
- interface GiftCardPaymentDetails {
4841
- /**
4842
- * Gift card payment ID.
4843
- * @maxLength 100
4844
- */
4845
- giftCardPaymentId?: string;
4846
- /**
4847
- * ID of the app that created the gift card.
4848
- * @format GUID
4849
- */
4850
- appId?: string;
4851
- /**
4852
- * Whether the gift card is voided.
4853
- * @readonly
4854
- * @deprecated Whether the gift card is voided.
4855
- * @replacedBy payment.status
4856
- * @targetRemovalDate 2026-11-01
4857
- */
4858
- voided?: boolean;
4859
- /**
4860
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
4861
- * @maxLength 30
4862
- * @immutable
4863
- */
4864
- obfuscatedCode?: string | null;
5016
+ declare enum DurationUnit {
5017
+ MINUTES = "MINUTES",
5018
+ HOURS = "HOURS",
5019
+ DAYS = "DAYS"
4865
5020
  }
4866
- interface MembershipPaymentDetails {
4867
- /**
4868
- * Membership ID.
4869
- * @maxLength 200
4870
- */
4871
- membershipId?: string;
5021
+ /** @enumType */
5022
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5023
+ interface PreparePaymentCollectionResponse {
5024
+ /** Payment gateway order id which is associated with given payment */
5025
+ paymentGatewayOrderId?: string;
5026
+ }
5027
+ interface GetPaymentCollectabilityStatusRequest {
4872
5028
  /**
4873
- * ID of the line item this membership applies to.
5029
+ * Ecom order ID.
4874
5030
  * @minLength 1
4875
5031
  * @maxLength 100
4876
5032
  */
4877
- lineItemId?: string;
4878
- /**
4879
- * Payment status.
4880
- * @deprecated Payment status.
4881
- * @replacedBy payment.status
4882
- * @targetRemovalDate 2026-11-01
4883
- */
4884
- status?: MembershipPaymentStatusWithLiterals;
4885
- /** Membership name. */
4886
- name?: MembershipName;
5033
+ ecomOrderId: string;
5034
+ }
5035
+ interface GetPaymentCollectabilityStatusResponse {
5036
+ /** Payment collectability status */
5037
+ status?: PaymentCollectabilityStatusWithLiterals;
5038
+ /** Collectable order amount */
5039
+ amount?: Price;
5040
+ }
5041
+ declare enum PaymentCollectabilityStatus {
5042
+ UNKNOWN = "UNKNOWN",
5043
+ COLLECTABLE = "COLLECTABLE",
5044
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5045
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5046
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5047
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5048
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5049
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5050
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5051
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5052
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5053
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5054
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5055
+ }
5056
+ /** @enumType */
5057
+ 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';
5058
+ interface RecordManuallyCollectedPaymentRequest {
4887
5059
  /**
4888
- * The transaction ID in the membership system. Can be used to void the transaction.
5060
+ * Order ID.
4889
5061
  * @minLength 1
4890
5062
  * @maxLength 100
4891
5063
  */
4892
- externalTransactionId?: string | null;
5064
+ orderId: string;
5065
+ /** Amount to be recorded as approved manual payment for given order */
5066
+ amount: Price;
5067
+ }
5068
+ /**
5069
+ * User-defined payment method name.
5070
+ * Allows specifying either a predefined type or a custom name.
5071
+ */
5072
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5073
+ /** Predefined payment method. */
5074
+ predefined?: PredefinedPaymentMethodWithLiterals;
4893
5075
  /**
4894
- * Whether the membership is voided.
4895
- * @readonly
4896
- * @deprecated Whether the membership is voided.
4897
- * @replacedBy payment.status
4898
- * @targetRemovalDate 2026-11-01
5076
+ * Custom payment method name provided by user.
5077
+ *
5078
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5079
+ * @minLength 1
5080
+ * @maxLength 150
4899
5081
  */
4900
- voided?: boolean;
5082
+ custom?: string | null;
5083
+ }
5084
+ /** @oneof */
5085
+ interface UserDefinedPaymentMethodNameKindOneOf {
5086
+ /** Predefined payment method. */
5087
+ predefined?: PredefinedPaymentMethodWithLiterals;
4901
5088
  /**
4902
- * ID of the application providing this payment option.
4903
- * @format GUID
5089
+ * Custom payment method name provided by user.
5090
+ *
5091
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5092
+ * @minLength 1
5093
+ * @maxLength 150
4904
5094
  */
4905
- providerAppId?: string;
4906
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
4907
- futureMembership?: FutureMembershipDetails;
5095
+ custom?: string | null;
4908
5096
  }
4909
- declare enum MembershipPaymentStatus {
4910
- /** Payment was charged. */
4911
- CHARGED = "CHARGED",
4912
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
4913
- CHARGE_FAILED = "CHARGE_FAILED",
4914
- /** Payment is pending. */
4915
- CHARGE_PENDING = "CHARGE_PENDING",
4916
- /** Payment was voided. */
4917
- VOIDED = "VOIDED"
5097
+ /** Predefined payment method types for offline/manual payments. */
5098
+ declare enum PredefinedPaymentMethod {
5099
+ /** Cash payment. */
5100
+ CASH = "CASH",
5101
+ /** Bank transfer. */
5102
+ BANK_TRANSFER = "BANK_TRANSFER",
5103
+ /** Payment by check. */
5104
+ CHECK = "CHECK"
4918
5105
  }
4919
5106
  /** @enumType */
4920
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
4921
- interface FutureMembershipDetails {
4922
- /**
4923
- * ID of the plan line item in the order from which the membership will be created.
4924
- * @format GUID
4925
- */
4926
- lineItemId?: string;
4927
- /**
4928
- * ID of the benefit the future membership will grant.
4929
- * @maxLength 200
4930
- */
4931
- benefitId?: string;
5107
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5108
+ interface RecordManuallyCollectedPaymentResponse {
4932
5109
  }
4933
- interface WixReceiptInfo {
5110
+ interface MarkOrderAsPaidRequest {
4934
5111
  /**
4935
- * Receipt ID
4936
- * @format GUID
5112
+ * Ecom order ID.
5113
+ * @minLength 1
5114
+ * @maxLength 100
4937
5115
  */
4938
- receiptId?: string;
5116
+ ecomOrderId: string;
5117
+ }
5118
+ interface MarkOrderAsPaidResponse {
5119
+ /** Updated order. */
5120
+ order?: Order;
5121
+ }
5122
+ interface BulkMarkOrdersAsPaidRequest {
4939
5123
  /**
4940
- * Display number of receipt
5124
+ * IDs of orders to mark as paid.
5125
+ * @minSize 1
5126
+ * @maxSize 100
4941
5127
  * @minLength 1
4942
- * @maxLength 40
5128
+ * @maxLength 100
4943
5129
  */
4944
- displayNumber?: string | null;
5130
+ ecomOrderIds: string[];
4945
5131
  }
4946
- interface ExternalReceiptInfo {
5132
+ interface BulkMarkOrdersAsPaidResponse {
4947
5133
  /**
4948
- * External receipt ID
4949
- * @maxLength 100
5134
+ * Items updated by the bulk action.
5135
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4950
5136
  */
4951
- receiptId?: string | null;
5137
+ results?: BulkOrderResult[];
5138
+ /** Bulk action metadata. */
5139
+ bulkActionMetadata?: BulkActionMetadata;
5140
+ }
5141
+ interface BulkOrderResult {
5142
+ /** Item metadata. */
5143
+ itemMetadata?: ItemMetadata;
4952
5144
  /**
4953
- * ID of the app providing the receipt
4954
- * @format GUID
5145
+ * Updated order.
5146
+ *
5147
+ * Returned when `returnFullEntity = true`.
4955
5148
  */
4956
- appId?: string | null;
5149
+ item?: Order;
5150
+ }
5151
+ interface ItemMetadata {
5152
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5153
+ _id?: string | null;
5154
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5155
+ originalIndex?: number;
5156
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5157
+ success?: boolean;
5158
+ /** Details about the error in case of failure. */
5159
+ error?: ApplicationError;
5160
+ }
5161
+ interface ApplicationError {
5162
+ /** Error code. */
5163
+ code?: string;
5164
+ /** Description of the error. */
5165
+ description?: string;
5166
+ /** Data related to the error. */
5167
+ data?: Record<string, any> | null;
5168
+ }
5169
+ interface BulkActionMetadata {
5170
+ /** Number of items that were successfully processed. */
5171
+ totalSuccesses?: number;
5172
+ /** Number of items that couldn't be processed. */
5173
+ totalFailures?: number;
5174
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5175
+ undetailedFailures?: number;
5176
+ }
5177
+ interface GetRefundabilityStatusRequest {
4957
5178
  /**
4958
- * Display number of receipt
5179
+ * Order ID.
4959
5180
  * @minLength 1
4960
- * @maxLength 40
5181
+ * @maxLength 100
4961
5182
  */
4962
- displayNumber?: string | null;
5183
+ ecomOrderId: string;
4963
5184
  }
4964
- interface CashRoundingDetails {
5185
+ interface GetRefundabilityStatusResponse {
4965
5186
  /**
4966
- * Payment amount before cash rounding was applied.
4967
- * When provided, balance and status calculations use this value instead of `amount`
4968
- * to prevent false overpayment or underpayment due to rounding.
5187
+ * Refundability details.
5188
+ * @maxSize 300
4969
5189
  */
4970
- unroundedAmount?: Price;
5190
+ refundabilities?: Refundability[];
4971
5191
  /**
4972
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
4973
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
4974
- * @readonly
5192
+ * Whether the order supports refunding per item.
5193
+ * @deprecated
4975
5194
  */
4976
- roundingAdjustment?: CashRounding;
5195
+ refundablePerItem?: boolean;
4977
5196
  }
4978
- declare enum PaymentStatus {
4979
- /** Payment was charged successfully. */
4980
- APPROVED = "APPROVED",
4981
- /** Payment is being processed and hasn't been confirmed yet. */
4982
- PENDING = "PENDING",
4983
- /** 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. */
4984
- PENDING_MERCHANT = "PENDING_MERCHANT",
4985
- /** Payment was canceled before it was charged. */
4986
- CANCELED = "CANCELED",
4987
- /** Payment was declined by the payment provider. */
4988
- DECLINED = "DECLINED",
4989
- /** Payment was fully refunded. */
4990
- REFUNDED = "REFUNDED",
4991
- /** Part of the payment amount was refunded. */
4992
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4993
- /** 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. */
4994
- AUTHORIZED = "AUTHORIZED",
4995
- /**
4996
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
4997
- *
4998
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
4999
- */
5000
- VOIDED = "VOIDED"
5197
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5198
+ /** Reason why payment is not refundable. */
5199
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5200
+ /** Reason why payment is only refundable manually. */
5201
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5202
+ /** Payment ID. */
5203
+ paymentId?: string;
5204
+ /** Payment refundability status. */
5205
+ refundabilityStatus?: RefundableStatusWithLiterals;
5206
+ /** Link to payment provider dashboard. */
5207
+ providerLink?: string | null;
5001
5208
  }
5002
- /** @enumType */
5003
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5004
- interface CanceledStatusDetails {
5005
- reason?: CanceledReasonWithLiterals;
5209
+ /** @oneof */
5210
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5211
+ /** Reason why payment is not refundable. */
5212
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5213
+ /** Reason why payment is only refundable manually. */
5214
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5006
5215
  }
5007
- declare enum CanceledReason {
5008
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5009
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5010
- /** Payment was not completed by user and expired. */
5011
- EXPIRED = "EXPIRED"
5216
+ declare enum RefundableStatus {
5217
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5218
+ MANUAL = "MANUAL",
5219
+ REFUNDABLE = "REFUNDABLE"
5012
5220
  }
5013
5221
  /** @enumType */
5014
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5015
- interface DeclinedStatusDetails {
5016
- reason?: DeclinedReasonWithLiterals;
5017
- }
5018
- declare enum DeclinedReason {
5019
- /** Corresponding charge failed. */
5020
- CHARGE_FAILED = "CHARGE_FAILED",
5021
- /** Payment details expired. */
5022
- EXPIRED = "EXPIRED",
5023
- /** Insufficient funds. */
5024
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5025
- /** Gift card was disabled before charge was attempted. */
5026
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5222
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5223
+ declare enum NonRefundableReason {
5224
+ NONE = "NONE",
5225
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5226
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5227
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5228
+ NOT_PAID = "NOT_PAID",
5229
+ ACCESS_DENIED = "ACCESS_DENIED",
5230
+ ZERO_PRICE = "ZERO_PRICE",
5231
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5232
+ PENDING_REFUND = "PENDING_REFUND",
5233
+ FORBIDDEN = "FORBIDDEN",
5234
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5235
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5236
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5027
5237
  }
5028
5238
  /** @enumType */
5029
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5030
- interface VoidedStatusDetails {
5031
- reason?: VoidedReasonWithLiterals;
5032
- }
5033
- declare enum VoidedReason {
5034
- /** Payment was voided by merchant request. */
5035
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5036
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5037
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5239
+ 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';
5240
+ declare enum ManuallyRefundableReason {
5241
+ EXPIRED = "EXPIRED",
5242
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5243
+ OFFLINE = "OFFLINE",
5244
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5038
5245
  }
5039
5246
  /** @enumType */
5040
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5041
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5042
- }
5043
- /** @oneof */
5044
- interface PaymentStatusDetailsStatusDetailsOneOf {
5247
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5248
+ interface CreatePaymentGatewayOrderRequest {
5249
+ /**
5250
+ * Ecom order ID.
5251
+ * @minLength 1
5252
+ * @maxLength 100
5253
+ */
5254
+ ecomOrderId: string;
5255
+ /** Information about the user who initiated the payment. */
5256
+ chargedBy?: ChargedBy;
5045
5257
  }
5046
- interface Refund {
5258
+ interface ChargedBy {
5047
5259
  /**
5048
- * Refund ID.
5260
+ * ID - id of the user who initiated the payment
5049
5261
  * @format GUID
5050
- * @readonly
5051
5262
  */
5052
5263
  _id?: string;
5053
5264
  /**
5054
- * List of transactions.
5055
- * @maxSize 50
5265
+ * Full name - name of the user who initiated the payment
5266
+ * @minLength 1
5267
+ * @maxLength 200
5056
5268
  */
5057
- transactions?: RefundTransaction[];
5058
- /** Refund business details. */
5059
- details?: RefundDetails;
5269
+ fullName?: string | null;
5270
+ }
5271
+ interface CreatePaymentGatewayOrderResponse {
5272
+ /** ID of the order created in the payment gateway */
5273
+ paymentGatewayOrderId?: string;
5274
+ }
5275
+ interface ChargeMembershipsRequest {
5060
5276
  /**
5061
- * 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.
5062
- * @readonly
5063
- * @immutable
5277
+ * Order ID.
5278
+ * @minLength 1
5279
+ * @maxLength 100
5280
+ */
5281
+ ecomOrderId: string;
5282
+ /**
5283
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5284
+ * but a user which is using the membership on behalf of the a member
5285
+ * @format GUID
5286
+ */
5287
+ memberId: string;
5288
+ /**
5289
+ * List of items to be paid by memberships
5290
+ * @minSize 1
5291
+ * @maxSize 300
5064
5292
  */
5065
- _createdDate?: Date | null;
5293
+ membershipCharges?: MembershipChargeItem[];
5294
+ }
5295
+ interface MembershipChargeItem {
5066
5296
  /**
5067
- * Aggregated refund summary.
5068
- * @readonly
5297
+ * The id of used membership
5298
+ * @minLength 1
5299
+ * @maxLength 100
5069
5300
  */
5070
- summary?: AggregatedRefundSummary;
5301
+ membershipId?: string;
5071
5302
  /**
5072
- * ID of the app that initiated this refund.
5303
+ * ID of the application providing this payment option
5073
5304
  * @format GUID
5074
- * @readonly
5075
- * @immutable
5076
5305
  */
5077
- requestingServiceAppId?: string | null;
5078
- }
5079
- interface RefundTransaction {
5306
+ appId?: string;
5307
+ /** The name of used membership */
5308
+ membershipName?: MembershipName;
5309
+ /** Additional data about this membership */
5310
+ membershipAdditionalData?: Record<string, any> | null;
5311
+ /** Catalog and item reference info. */
5312
+ catalogReference?: CatalogReference;
5313
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5314
+ serviceProperties?: ServiceProperties;
5080
5315
  /**
5081
- * ID of the payment associated with this refund.
5082
- * @format GUID
5083
- * @immutable
5316
+ * Usually would be the same as catalogReference.catalogItemId
5317
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5318
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5319
+ * @minLength 1
5320
+ * @maxLength 36
5084
5321
  */
5085
- paymentId?: string;
5322
+ rootCatalogItemId?: string | null;
5086
5323
  /**
5087
- * Refund amount.
5088
- * @immutable
5324
+ * line item id of Checkout/Order line item
5325
+ * @minLength 1
5326
+ * @maxLength 100
5089
5327
  */
5090
- amount?: Price;
5091
- /** Refund status. */
5092
- refundStatus?: RefundStatusWithLiterals;
5093
- /** Optional details of current refund status. */
5094
- refundStatusInfo?: RefundStatusInfo;
5328
+ lineItemId?: string;
5329
+ }
5330
+ interface MembershipName {
5095
5331
  /**
5096
- * Payment gateway's refund ID.
5097
- * This field is only returned when the value of `external_refund` is `false`.
5098
- * @format GUID
5332
+ * Membership name in the site's original language.
5333
+ * @maxLength 100
5099
5334
  */
5100
- gatewayRefundId?: string | null;
5101
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5102
- providerRefundId?: string | null;
5335
+ original?: string;
5103
5336
  /**
5104
- * Whether refund was made externally and manually on the payment provider's side.
5105
- * @immutable
5337
+ * Membership name translated into the buyer's language.
5338
+ *
5339
+ * Default: The value of `original`
5340
+ * @maxLength 100
5106
5341
  */
5107
- externalRefund?: boolean;
5342
+ translated?: string | null;
5108
5343
  }
5109
- /** Refund transaction status. */
5110
- declare enum RefundStatus {
5111
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5112
- PENDING = "PENDING",
5113
- /** Refund transaction succeeded. */
5114
- SUCCEEDED = "SUCCEEDED",
5115
- /** Refund transaction failed. */
5116
- FAILED = "FAILED",
5117
- /** Refund request acknowledged, and will be executed soon. */
5118
- SCHEDULED = "SCHEDULED",
5119
- /** Refund was initiated on payment provider side. */
5120
- STARTED = "STARTED"
5344
+ interface ChargeMembershipsResponse {
5121
5345
  }
5122
- /** @enumType */
5123
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5124
- interface RefundStatusInfo {
5346
+ interface TriggerRefundRequest {
5125
5347
  /**
5126
- * Reason code for the refund's current status.
5127
- *
5128
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5348
+ * The order this refund related to
5129
5349
  * @minLength 1
5130
- * @maxLength 10
5350
+ * @maxLength 100
5131
5351
  */
5132
- paymentGatewayReasonCode?: string | null;
5352
+ ecomOrderId: string;
5133
5353
  /**
5134
- * Free text explanation of current refund status.
5135
- * @minLength 1
5136
- * @maxLength 1000
5354
+ * Refund operations information
5355
+ * @minSize 1
5356
+ * @maxSize 1
5137
5357
  */
5138
- description?: string | null;
5139
- }
5140
- interface AggregatedRefundSummary {
5141
- /** Total amount requested for refund. */
5142
- requestedRefund?: Price;
5143
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5144
- pendingRefund?: Price;
5145
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5146
- refunded?: Price;
5147
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5148
- failedRefundAmount?: Price;
5149
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5150
- pending?: boolean;
5151
- /** Breakdown of refunded items. Available only after refund is complete. */
5152
- breakdown?: RefundItemsBreakdown;
5358
+ payments: PaymentRefund[];
5359
+ /** Business model of a refund */
5360
+ details?: RefundDetails;
5361
+ /** Side effect details related to refund */
5362
+ sideEffects?: RefundSideEffects;
5153
5363
  }
5154
- interface RefundItemsBreakdown {
5364
+ interface PaymentRefund {
5155
5365
  /**
5156
- * Refunded line items and the amount refunded for each.
5157
- * @maxSize 300
5366
+ * Specific payment within the order to refund
5367
+ * @format GUID
5158
5368
  */
5159
- lineItems?: LineItemRefundSummary[];
5160
- }
5161
- interface LineItemRefundSummary {
5369
+ paymentId?: string;
5370
+ /** Refund amount. Not relevant for membership and gift card refunds. */
5371
+ amount?: Price;
5162
5372
  /**
5163
- * ID of the refunded line item.
5164
- * @format GUID
5373
+ * Whether refund is made externally and manually (on the payment provider's side)
5374
+ * 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.
5375
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5165
5376
  */
5166
- lineItemId?: string;
5167
- /** Total refunded amount for the line item. */
5168
- totalRefundedAmount?: Price;
5377
+ externalRefund?: boolean;
5169
5378
  }
5170
- interface CalculateRefundRequest {
5379
+ interface RefundSideEffects {
5380
+ /** Inventory restock details as part of this refund. */
5381
+ restockInfo?: RestockInfo;
5382
+ /** Whether to send a refund confirmation email to the customer. */
5383
+ sendOrderRefundedEmail?: boolean;
5171
5384
  /**
5172
- * Order ID
5385
+ * Custom message added to the refund confirmation email.
5173
5386
  * @minLength 1
5174
- * @maxLength 100
5387
+ * @maxLength 1000
5175
5388
  */
5176
- ecomOrderId?: string;
5389
+ customMessage?: string | null;
5390
+ }
5391
+ interface RestockInfo {
5392
+ /** Restock type. */
5393
+ type?: RestockTypeWithLiterals;
5177
5394
  /**
5178
- * Refunded line items and quantity
5395
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5179
5396
  * @maxSize 300
5180
5397
  */
5181
- refundItems?: CalculateRefundItemRequest[];
5182
- /** Should include shipping in refund calculation */
5183
- refundShipping?: boolean;
5398
+ items?: RestockItem[];
5184
5399
  }
5185
- interface CalculateRefundItemRequest {
5400
+ declare enum RestockType {
5401
+ NO_ITEMS = "NO_ITEMS",
5402
+ ALL_ITEMS = "ALL_ITEMS",
5403
+ SOME_ITEMS = "SOME_ITEMS"
5404
+ }
5405
+ /** @enumType */
5406
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5407
+ interface RestockItem {
5186
5408
  /**
5187
- * ID of the line item being refunded
5409
+ * ID of the line item being restocked.
5188
5410
  * @format GUID
5189
5411
  */
5190
- _id?: string;
5412
+ lineItemId?: string;
5191
5413
  /**
5192
- * How much of that line item is being refunded
5414
+ * Line item quantity being restocked.
5193
5415
  * @min 1
5194
5416
  * @max 100000
5195
5417
  */
5196
5418
  quantity?: number;
5197
5419
  }
5198
- interface CalculateRefundResponse {
5199
- /** Total refundable amount */
5200
- total?: Price;
5201
- /** Tax cost of the order */
5202
- tax?: Price;
5203
- /** Discount given for this order */
5204
- discount?: Price;
5205
- /** Total cost of the order (without tax) */
5206
- subtotal?: Price;
5207
- /** Total shipping cost for order */
5208
- shipping?: Price;
5209
- /** Previous refund given on that order */
5210
- previouslyRefundedAmount?: Price;
5211
- /**
5212
- * The refundable items of that order
5213
- * @maxSize 300
5214
- */
5215
- items?: CalculateRefundItemResponse[];
5420
+ interface TriggerRefundResponse {
5421
+ /** All order's transactions after the refunds were added */
5422
+ orderTransactions?: OrderTransactions;
5423
+ /** Created refund ID */
5424
+ refundId?: string | null;
5425
+ /** Payment ID's that the refund execution had failed for */
5426
+ failedPaymentIds?: ItemMetadata[];
5216
5427
  }
5217
- interface CalculateRefundItemResponse {
5428
+ /**
5429
+ * A record of all payments and refunds associated with an order.
5430
+ *
5431
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5432
+ */
5433
+ interface OrderTransactions {
5218
5434
  /**
5219
- * Line item ID
5435
+ * Order ID.
5220
5436
  * @format GUID
5221
5437
  */
5222
- _id?: string;
5223
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5224
- price?: Price;
5225
- }
5226
- interface VoidAuthorizedPaymentsRequest {
5438
+ orderId?: string;
5227
5439
  /**
5228
- * Wix eCommerce order ID
5229
- * @minLength 1
5230
- * @maxLength 100
5440
+ * Record of payments made to the merchant.
5441
+ * @maxSize 100
5231
5442
  */
5232
- ecomOrderId: string;
5443
+ payments?: Payment[];
5233
5444
  /**
5234
- * Payment IDs
5235
- * @minSize 1
5236
- * @maxSize 100
5237
- * @format GUID
5445
+ * Record of refunds made to the buyer.
5446
+ * @maxSize 300
5238
5447
  */
5239
- paymentIds: string[];
5240
- }
5241
- interface VoidAuthorizedPaymentsResponse {
5242
- /** All order's transactions after the void was triggered */
5243
- orderTransactions?: OrderTransactions;
5448
+ refunds?: Refund[];
5244
5449
  }
5245
- interface CaptureAuthorizedPaymentsRequest {
5450
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5451
+ /** Regular payment details. */
5452
+ regularPaymentDetails?: RegularPaymentDetails;
5453
+ /** Gift card payment details. */
5454
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5455
+ /** Membership payment details. */
5456
+ membershipPaymentDetails?: MembershipPaymentDetails;
5246
5457
  /**
5247
- * Wix eCommerce order ID
5248
- * @minLength 1
5249
- * @maxLength 100
5458
+ * Payment ID.
5459
+ * @format GUID
5460
+ * @readonly
5461
+ */
5462
+ _id?: string | null;
5463
+ /** 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. */
5464
+ _createdDate?: Date | null;
5465
+ /**
5466
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5467
+ * @readonly
5250
5468
  */
5251
- ecomOrderId: string;
5469
+ _updatedDate?: Date | null;
5470
+ /** Payment amount. */
5471
+ amount?: Price;
5252
5472
  /**
5253
- * Capture payments information
5254
- * @minSize 1
5255
- * @maxSize 100
5473
+ * Whether refunds for this payment are disabled.
5474
+ * + `true`: This payment is not refundable.
5475
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5256
5476
  */
5257
- payments: PaymentCapture[];
5258
- }
5259
- interface PaymentCapture {
5477
+ refundDisabled?: boolean;
5260
5478
  /**
5261
- * Payment ID
5262
- * @format GUID
5479
+ * Whether receipt generation is allowed for this payment.
5480
+ * + `true`: This payment supports receipt generation.
5481
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5482
+ * @readonly
5263
5483
  */
5264
- paymentId?: string | null;
5484
+ supportReceiptGeneration?: boolean;
5485
+ /** Details about cash rounding applied to this payment, when relevant. */
5486
+ cashRounding?: CashRoundingDetails;
5265
5487
  /**
5266
- * Capture amount.
5267
- * If not provided - full authorized amount will be captured.
5488
+ * Overall payment status.
5489
+ *
5490
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5268
5491
  */
5269
- amount?: Price;
5270
- }
5271
- interface CaptureAuthorizedPaymentsResponse {
5272
- /** All order's transactions after the capture was triggered */
5273
- orderTransactions?: OrderTransactions;
5274
- }
5275
- interface ChargeSavedPaymentMethodRequest {
5492
+ status?: PaymentStatusWithLiterals;
5276
5493
  /**
5277
- * Ecom Order ID.
5278
- * @minLength 1
5279
- * @maxLength 100
5494
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5495
+ * @format GUID
5280
5496
  */
5281
- ecomOrderId?: string;
5282
- /** Amount to be charged */
5283
- amount?: Price;
5497
+ chargeCorrelationId?: string | null;
5284
5498
  }
5285
- interface ChargeSavedPaymentMethodResponse {
5286
- /** Payment gateway's order ID (e.g Wix Payments) */
5287
- paymentGatewayOrderId?: string;
5499
+ /** @oneof */
5500
+ interface PaymentPaymentDetailsOneOf {
5501
+ /** Regular payment details. */
5502
+ regularPaymentDetails?: RegularPaymentDetails;
5503
+ /** Gift card payment details. */
5504
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
5505
+ /** Membership payment details. */
5506
+ membershipPaymentDetails?: MembershipPaymentDetails;
5288
5507
  }
5289
- interface SendBuyerConfirmationEmailRequest {
5290
- /** @format GUID */
5291
- orderId?: string;
5508
+ /** @oneof */
5509
+ interface PaymentReceiptInfoOneOf {
5292
5510
  }
5293
- interface SendBuyerConfirmationEmailResponse {
5511
+ /** @oneof */
5512
+ interface PaymentStatusDetailsOneOf {
5294
5513
  }
5295
- interface SendBuyerPaymentsReceivedEmailRequest {
5514
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5515
+ /** Credit card details. */
5516
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5296
5517
  /**
5297
- * @minLength 1
5518
+ * Wix Payments order ID.
5298
5519
  * @maxLength 100
5299
5520
  */
5300
- orderId?: string;
5301
- }
5302
- interface SendBuyerPaymentsReceivedEmailResponse {
5303
- }
5304
- interface SendBuyerPickupConfirmationEmailRequest {
5521
+ paymentOrderId?: string | null;
5305
5522
  /**
5306
- * @minLength 1
5523
+ * Payment gateway's transaction ID.
5524
+ * This field is only returned when the value of `offline_payment` is `false`.
5307
5525
  * @maxLength 100
5308
5526
  */
5309
- orderId?: string;
5310
- }
5311
- interface SendBuyerPickupConfirmationEmailResponse {
5312
- }
5313
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
5527
+ gatewayTransactionId?: string | null;
5314
5528
  /**
5315
- * IDs of orders to send pickup emails for.
5316
- * @minSize 1
5317
- * @maxSize 300
5529
+ * Payment method.
5530
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5531
+ * Non-exhaustive list of supported values:
5532
+ * + `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`
5533
+ * @maxLength 150
5534
+ * @deprecated Payment method.
5535
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5536
+ * Non-exhaustive list of supported values:
5537
+ * + `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`
5538
+ * @replacedBy payment_method_name
5539
+ * @targetRemovalDate 2026-07-01
5318
5540
  */
5319
- orderIds?: string[];
5320
- }
5321
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
5322
- }
5323
- interface SendBuyerShippingConfirmationEmailRequest {
5541
+ paymentMethod?: string | null;
5324
5542
  /**
5325
- * @minLength 1
5543
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5326
5544
  * @maxLength 100
5327
5545
  */
5328
- orderId?: string;
5329
- }
5330
- interface SendBuyerShippingConfirmationEmailResponse {
5331
- }
5332
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
5546
+ providerTransactionId?: string | null;
5547
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5548
+ offlinePayment?: boolean;
5333
5549
  /**
5334
- * IDs of orders to send pickup emails for.
5335
- * @minSize 1
5336
- * @maxSize 300
5550
+ * Payment status.
5551
+ * @deprecated Payment status.
5552
+ * @replacedBy payment.status
5553
+ * @targetRemovalDate 2026-11-01
5337
5554
  */
5338
- orderIds?: string[];
5555
+ status?: TransactionStatusWithLiterals;
5556
+ /** Whether there is a payment agreement that allows for future charges. */
5557
+ savedPaymentMethod?: boolean;
5558
+ /** Authorization details. */
5559
+ authorizationDetails?: AuthorizationDetails;
5560
+ /**
5561
+ * Record of chargebacks made by the buyer.
5562
+ * @maxSize 6
5563
+ */
5564
+ chargebacks?: Chargeback[];
5565
+ /** Platform fee amount associated with this payment. */
5566
+ platformFee?: Price;
5567
+ /**
5568
+ * Payment method with buyer and optional owner translations.
5569
+ * Non-exhaustive list of supported values:
5570
+ * + `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`
5571
+ */
5572
+ paymentMethodName?: PaymentMethodName;
5339
5573
  }
5340
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
5574
+ /** @oneof */
5575
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5576
+ /** Credit card details. */
5577
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5341
5578
  }
5342
- interface SendMerchantOrderReceivedNotificationRequest {
5579
+ declare enum TransactionStatus {
5580
+ UNDEFINED = "UNDEFINED",
5581
+ APPROVED = "APPROVED",
5582
+ PENDING = "PENDING",
5583
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5584
+ CANCELED = "CANCELED",
5585
+ DECLINED = "DECLINED",
5586
+ REFUNDED = "REFUNDED",
5587
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5588
+ AUTHORIZED = "AUTHORIZED",
5589
+ VOIDED = "VOIDED"
5590
+ }
5591
+ /** @enumType */
5592
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5593
+ interface CreditCardPaymentMethodDetails {
5343
5594
  /**
5344
- * @minLength 1
5595
+ * The last 4 digits of the card number.
5596
+ * @maxLength 4
5597
+ */
5598
+ lastFourDigits?: string | null;
5599
+ /**
5600
+ * Card issuer's brand.
5345
5601
  * @maxLength 100
5346
5602
  */
5347
- orderId?: string;
5348
- }
5349
- interface SendMerchantOrderReceivedNotificationResponse {
5603
+ brand?: string | null;
5350
5604
  }
5351
- interface SendCancelRefundEmailRequest {
5605
+ interface AuthorizationDetails {
5352
5606
  /**
5353
- * The ID of order that is canceled/refunded
5354
- * @minLength 1
5355
- * @maxLength 100
5607
+ * Whether the authorized payment is of a delayed capture.
5608
+ * @readonly
5356
5609
  */
5357
- orderId?: string;
5610
+ delayedCapture?: boolean;
5611
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5612
+ authorizedDate?: Date | null;
5358
5613
  /**
5359
- * Personal note added to the email (optional)
5360
- * @minLength 1
5361
- * @maxLength 1000
5614
+ * List of captures associated with payment
5615
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5616
+ * @maxSize 1
5362
5617
  */
5363
- customMessage?: string | null;
5364
- /** Refund amount */
5365
- refundAmount?: Price;
5618
+ captures?: AuthorizationCapture[];
5619
+ /** Void associated with payment */
5620
+ void?: AuthorizationVoid;
5621
+ /** Scheduled action for this transaction */
5622
+ scheduledAction?: V1ScheduledAction;
5623
+ }
5624
+ interface AuthorizationCapture {
5366
5625
  /**
5367
- * Refund ID. (Optional)
5626
+ * Capture ID.
5368
5627
  * @format GUID
5628
+ * @readonly
5369
5629
  */
5370
- refundId?: string | null;
5630
+ _id?: string | null;
5631
+ /** Status of this capture action */
5632
+ status?: AuthorizationCaptureStatusWithLiterals;
5633
+ /**
5634
+ * Amount of this capture
5635
+ * @immutable
5636
+ */
5637
+ amount?: Price;
5638
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5639
+ _createdDate?: Date | null;
5640
+ /** In case of status is FAILED may contain failure details */
5641
+ failureDetails?: AuthorizationActionFailureDetails;
5642
+ }
5643
+ declare enum AuthorizationCaptureStatus {
5644
+ /** Capture operation still in progress. */
5645
+ PENDING = "PENDING",
5646
+ /** Capture operation succeeded. */
5647
+ SUCCEEDED = "SUCCEEDED",
5648
+ /** Capture operation failed. */
5649
+ FAILED = "FAILED"
5650
+ }
5651
+ /** @enumType */
5652
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5653
+ interface AuthorizationActionFailureDetails {
5654
+ /** @maxLength 100 */
5655
+ failureCode?: string;
5656
+ }
5657
+ interface AuthorizationVoid {
5658
+ /** Status of this void action */
5659
+ status?: AuthorizationVoidStatusWithLiterals;
5660
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5661
+ voidedDate?: Date | null;
5662
+ /** In case of status is FAILED may contain failure details */
5663
+ failureDetails?: AuthorizationActionFailureDetails;
5664
+ /** Reason of void action */
5665
+ reason?: ReasonWithLiterals;
5666
+ }
5667
+ declare enum AuthorizationVoidStatus {
5668
+ /** Void operation still in progress. */
5669
+ PENDING = "PENDING",
5670
+ /** Void operation succeeded. */
5671
+ SUCCEEDED = "SUCCEEDED",
5672
+ /** Void operation failed. */
5673
+ FAILED = "FAILED"
5674
+ }
5675
+ /** @enumType */
5676
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5677
+ /** Reason the authorization was voided. */
5678
+ declare enum Reason {
5679
+ /** Authorization was voided by user. */
5680
+ MANUAL = "MANUAL",
5681
+ /** Authorization passed execution date. */
5682
+ SCHEDULED = "SCHEDULED"
5371
5683
  }
5372
- interface SendCancelRefundEmailResponse {
5684
+ /** @enumType */
5685
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5686
+ interface V1ScheduledAction {
5687
+ /** Type of the action. */
5688
+ actionType?: ActionTypeWithLiterals;
5689
+ /** The date and time of the action. */
5690
+ executionDate?: Date | null;
5373
5691
  }
5374
- interface SendRefundEmailRequest {
5692
+ declare enum ActionType {
5693
+ VOID = "VOID",
5694
+ CAPTURE = "CAPTURE"
5695
+ }
5696
+ /** @enumType */
5697
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5698
+ interface Chargeback {
5375
5699
  /**
5376
- * The ID of order that is refunded
5700
+ * Chargeback ID.
5377
5701
  * @format GUID
5702
+ * @readonly
5703
+ * @immutable
5378
5704
  */
5379
- orderId?: string;
5705
+ _id?: string;
5380
5706
  /**
5381
- * Refund ID
5382
- * @format GUID
5707
+ * 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.
5708
+ * @readonly
5709
+ * @immutable
5383
5710
  */
5384
- refundId?: string;
5711
+ _createdDate?: Date | null;
5385
5712
  /**
5386
- * Personal note added to the email (optional)
5387
- * @minLength 1
5388
- * @maxLength 1000
5713
+ * 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.
5714
+ * @readonly
5389
5715
  */
5390
- customMessage?: string | null;
5391
- }
5392
- interface SendRefundEmailResponse {
5393
- }
5394
- interface SendFulfillmentEmailRequest {
5395
- /** @format GUID */
5396
- orderId?: string;
5397
- /** @format GUID */
5398
- fulfillerId?: string;
5399
- }
5400
- interface SendFulfillmentEmailResponse {
5401
- }
5402
- interface SendMerchantOrderReceivedPushRequest {
5716
+ _updatedDate?: Date | null;
5403
5717
  /**
5404
- * @minLength 1
5405
- * @maxLength 100
5718
+ * Amount.
5719
+ * @readonly
5720
+ * @immutable
5406
5721
  */
5407
- orderId?: string;
5408
- }
5409
- interface SendMerchantOrderReceivedPushResponse {
5410
- }
5411
- interface PreviewEmailByTypeRequest {
5412
- emailType?: PreviewEmailTypeWithLiterals;
5413
- }
5414
- declare enum PreviewEmailType {
5415
- ORDER_PLACED = "ORDER_PLACED",
5416
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5417
- ORDER_SHIPPED = "ORDER_SHIPPED",
5418
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5419
- }
5420
- /** @enumType */
5421
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5422
- interface PreviewEmailByTypeResponse {
5423
- emailPreview?: string;
5424
- }
5425
- interface PreviewRefundEmailRequest {
5722
+ amount?: Price;
5426
5723
  /**
5427
- * @minLength 1
5428
- * @maxLength 100
5724
+ * Reversal amount. Present only when status is REVERSED.
5725
+ * @readonly
5429
5726
  */
5430
- orderId?: string;
5431
- /** Refund amount */
5432
- refundAmount?: Price;
5433
- /** Refund business details */
5434
- details?: RefundDetails;
5727
+ reversalAmount?: Price;
5435
5728
  /**
5436
- * Personal note added to the email (optional)
5437
- * @minLength 1
5438
- * @maxLength 1000
5729
+ * Status.
5730
+ *
5731
+ * Default: `"APPROVED"`.
5439
5732
  */
5440
- customMessage?: string | null;
5733
+ status?: ChargebackStatusWithLiterals;
5441
5734
  /**
5442
- * Refund ID. (Optional)
5735
+ * External chargeback ID.
5443
5736
  * @format GUID
5737
+ * @readonly
5738
+ * @immutable
5444
5739
  */
5445
- refundId?: string | null;
5740
+ externalId?: string | null;
5446
5741
  }
5447
- interface PreviewRefundEmailResponse {
5448
- emailPreview?: string;
5742
+ declare enum ChargebackStatus {
5743
+ /** Chargeback was approved. */
5744
+ APPROVED = "APPROVED",
5745
+ /** Chargeback was reversed. */
5746
+ REVERSED = "REVERSED"
5449
5747
  }
5450
- interface PreviewCancelEmailRequest {
5748
+ /** @enumType */
5749
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5750
+ interface PaymentMethodName {
5451
5751
  /**
5452
- * @minLength 1
5453
- * @maxLength 100
5752
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5753
+ * @maxLength 150
5454
5754
  */
5455
- orderId?: string;
5755
+ buyerLanguageName?: string | null;
5456
5756
  /**
5457
- * Personal note added to the email (optional)
5458
- * @minLength 1
5459
- * @maxLength 1000
5757
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5758
+ *
5759
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5760
+ * @maxLength 150
5460
5761
  */
5461
- customMessage?: string | null;
5462
- }
5463
- interface PreviewCancelEmailResponse {
5464
- emailPreview?: string;
5465
- }
5466
- interface PreviewCancelRefundEmailRequest {
5762
+ siteLanguageName?: string | null;
5467
5763
  /**
5468
- * @minLength 1
5469
- * @maxLength 100
5764
+ * User-provided payment method name.
5765
+ *
5766
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5470
5767
  */
5471
- orderId?: string;
5768
+ userDefinedName?: UserDefinedPaymentMethodName;
5769
+ }
5770
+ interface GiftCardPaymentDetails {
5472
5771
  /**
5473
- * Personal note added to the email (optional)
5474
- * @minLength 1
5475
- * @maxLength 1000
5772
+ * Gift card payment ID.
5773
+ * @maxLength 100
5476
5774
  */
5477
- customMessage?: string | null;
5478
- /** Refund amount */
5479
- refundAmount?: Price;
5775
+ giftCardPaymentId?: string;
5480
5776
  /**
5481
- * Refund ID. (Optional)
5777
+ * ID of the app that created the gift card.
5482
5778
  * @format GUID
5483
5779
  */
5484
- refundId?: string | null;
5485
- }
5486
- interface PreviewCancelRefundEmailResponse {
5487
- emailPreview?: string;
5488
- }
5489
- interface PreviewBuyerPaymentsReceivedEmailRequest {
5490
- }
5491
- interface PreviewBuyerPaymentsReceivedEmailResponse {
5492
- emailPreview?: string;
5493
- }
5494
- interface PreviewBuyerConfirmationEmailRequest {
5495
- }
5496
- interface PreviewBuyerConfirmationEmailResponse {
5497
- emailPreview?: string;
5498
- }
5499
- interface PreviewBuyerPickupConfirmationEmailRequest {
5500
- }
5501
- interface PreviewBuyerPickupConfirmationEmailResponse {
5502
- emailPreview?: string;
5503
- }
5504
- interface PreviewShippingConfirmationEmailRequest {
5505
- }
5506
- interface PreviewShippingConfirmationEmailResponse {
5507
- emailPreview?: string;
5508
- }
5509
- interface PreviewResendDownloadLinksEmailRequest {
5510
- }
5511
- interface PreviewResendDownloadLinksEmailResponse {
5512
- emailPreview?: string;
5513
- }
5514
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5515
- /** Emitted on a meta site creation. */
5516
- siteCreated?: SiteCreated;
5517
- /** Emitted on a meta site transfer completion. */
5518
- siteTransferred?: SiteTransferred;
5519
- /** Emitted on a meta site deletion. */
5520
- siteDeleted?: SiteDeleted;
5521
- /** Emitted on a meta site restoration. */
5522
- siteUndeleted?: SiteUndeleted;
5523
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5524
- sitePublished?: SitePublished;
5525
- /** Emitted on a meta site unpublish. */
5526
- siteUnpublished?: SiteUnpublished;
5527
- /** Emitted when meta site is marked as template. */
5528
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5529
- /** Emitted when meta site is marked as a WixSite. */
5530
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5531
- /** Emitted when an application is provisioned (installed). */
5532
- serviceProvisioned?: ServiceProvisioned;
5533
- /** Emitted when an application is removed (uninstalled). */
5534
- serviceRemoved?: ServiceRemoved;
5535
- /** Emitted when meta site name (URL slug) is changed. */
5536
- siteRenamedPayload?: SiteRenamed;
5537
- /** Emitted when meta site was permanently deleted. */
5538
- hardDeleted?: SiteHardDeleted;
5539
- /** Emitted on a namespace change. */
5540
- namespaceChanged?: NamespaceChanged;
5541
- /** Emitted when Studio is attached. */
5542
- studioAssigned?: StudioAssigned;
5543
- /** Emitted when Studio is detached. */
5544
- studioUnassigned?: StudioUnassigned;
5545
- /**
5546
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5547
- * the actual URL.
5548
- *
5549
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5550
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5551
- */
5552
- urlChanged?: SiteUrlChanged;
5553
- /** Site is marked as PurgedExternally */
5554
- sitePurgedExternally?: SitePurgedExternally;
5555
- /** Emitted when Odeditor is attached. */
5556
- odeditorAssigned?: OdeditorAssigned;
5557
- /** Emitted when Odeditor is detached. */
5558
- odeditorUnassigned?: OdeditorUnassigned;
5559
- /** Emitted when Picasso is attached. */
5560
- picassoAssigned?: PicassoAssigned;
5561
- /** Emitted when Picasso is detached. */
5562
- picassoUnassigned?: PicassoUnassigned;
5563
- /** Emitted when Wixel is attached. */
5564
- wixelAssigned?: WixelAssigned;
5565
- /** Emitted when Wixel is detached. */
5566
- wixelUnassigned?: WixelUnassigned;
5567
- /** Emitted when StudioTwo is attached. */
5568
- studioTwoAssigned?: StudioTwoAssigned;
5569
- /** Emitted when StudioTwo is detached. */
5570
- studioTwoUnassigned?: StudioTwoUnassigned;
5571
- /** Emitted when media from user domain is enabled. */
5572
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5573
- /** Emitted when media from user domain is disabled. */
5574
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5575
- /** Emitted when Editorless is attached. */
5576
- editorlessAssigned?: EditorlessAssigned;
5577
- /** Emitted when Editorless is detached. */
5578
- editorlessUnassigned?: EditorlessUnassigned;
5780
+ appId?: string;
5579
5781
  /**
5580
- * A meta site id.
5581
- * @format GUID
5782
+ * Whether the gift card is voided.
5783
+ * @readonly
5784
+ * @deprecated Whether the gift card is voided.
5785
+ * @replacedBy payment.status
5786
+ * @targetRemovalDate 2026-11-01
5582
5787
  */
5583
- metaSiteId?: string;
5584
- /** A meta site version. Monotonically increasing. */
5585
- version?: string;
5586
- /** A timestamp of the event. */
5587
- timestamp?: string;
5788
+ voided?: boolean;
5588
5789
  /**
5589
- * TODO(meta-site): Change validation once validations are disabled for consumers
5590
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5591
- * @maxSize 4000
5790
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5791
+ * @maxLength 30
5792
+ * @immutable
5592
5793
  */
5593
- assets?: Asset[];
5794
+ obfuscatedCode?: string | null;
5594
5795
  }
5595
- /** @oneof */
5596
- interface MetaSiteSpecialEventPayloadOneOf {
5597
- /** Emitted on a meta site creation. */
5598
- siteCreated?: SiteCreated;
5599
- /** Emitted on a meta site transfer completion. */
5600
- siteTransferred?: SiteTransferred;
5601
- /** Emitted on a meta site deletion. */
5602
- siteDeleted?: SiteDeleted;
5603
- /** Emitted on a meta site restoration. */
5604
- siteUndeleted?: SiteUndeleted;
5605
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5606
- sitePublished?: SitePublished;
5607
- /** Emitted on a meta site unpublish. */
5608
- siteUnpublished?: SiteUnpublished;
5609
- /** Emitted when meta site is marked as template. */
5610
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5611
- /** Emitted when meta site is marked as a WixSite. */
5612
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5613
- /** Emitted when an application is provisioned (installed). */
5614
- serviceProvisioned?: ServiceProvisioned;
5615
- /** Emitted when an application is removed (uninstalled). */
5616
- serviceRemoved?: ServiceRemoved;
5617
- /** Emitted when meta site name (URL slug) is changed. */
5618
- siteRenamedPayload?: SiteRenamed;
5619
- /** Emitted when meta site was permanently deleted. */
5620
- hardDeleted?: SiteHardDeleted;
5621
- /** Emitted on a namespace change. */
5622
- namespaceChanged?: NamespaceChanged;
5623
- /** Emitted when Studio is attached. */
5624
- studioAssigned?: StudioAssigned;
5625
- /** Emitted when Studio is detached. */
5626
- studioUnassigned?: StudioUnassigned;
5796
+ interface MembershipPaymentDetails {
5627
5797
  /**
5628
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5629
- * the actual URL.
5630
- *
5631
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5632
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5798
+ * Membership ID.
5799
+ * @maxLength 200
5633
5800
  */
5634
- urlChanged?: SiteUrlChanged;
5635
- /** Site is marked as PurgedExternally */
5636
- sitePurgedExternally?: SitePurgedExternally;
5637
- /** Emitted when Odeditor is attached. */
5638
- odeditorAssigned?: OdeditorAssigned;
5639
- /** Emitted when Odeditor is detached. */
5640
- odeditorUnassigned?: OdeditorUnassigned;
5641
- /** Emitted when Picasso is attached. */
5642
- picassoAssigned?: PicassoAssigned;
5643
- /** Emitted when Picasso is detached. */
5644
- picassoUnassigned?: PicassoUnassigned;
5645
- /** Emitted when Wixel is attached. */
5646
- wixelAssigned?: WixelAssigned;
5647
- /** Emitted when Wixel is detached. */
5648
- wixelUnassigned?: WixelUnassigned;
5649
- /** Emitted when StudioTwo is attached. */
5650
- studioTwoAssigned?: StudioTwoAssigned;
5651
- /** Emitted when StudioTwo is detached. */
5652
- studioTwoUnassigned?: StudioTwoUnassigned;
5653
- /** Emitted when media from user domain is enabled. */
5654
- userDomainMediaEnabled?: UserDomainMediaEnabled;
5655
- /** Emitted when media from user domain is disabled. */
5656
- userDomainMediaDisabled?: UserDomainMediaDisabled;
5657
- /** Emitted when Editorless is attached. */
5658
- editorlessAssigned?: EditorlessAssigned;
5659
- /** Emitted when Editorless is detached. */
5660
- editorlessUnassigned?: EditorlessUnassigned;
5661
- }
5662
- interface Asset {
5801
+ membershipId?: string;
5663
5802
  /**
5664
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5665
- * @maxLength 36
5803
+ * ID of the line item this membership applies to.
5804
+ * @minLength 1
5805
+ * @maxLength 100
5666
5806
  */
5667
- appDefId?: string;
5807
+ lineItemId?: string;
5668
5808
  /**
5669
- * An instance id. For legacy reasons may be UUID or a string.
5670
- * @maxLength 200
5809
+ * Payment status.
5810
+ * @deprecated Payment status.
5811
+ * @replacedBy payment.status
5812
+ * @targetRemovalDate 2026-11-01
5671
5813
  */
5672
- instanceId?: string;
5673
- /** An application state. */
5674
- state?: StateWithLiterals;
5814
+ status?: MembershipPaymentStatusWithLiterals;
5815
+ /** Membership name. */
5816
+ name?: MembershipName;
5817
+ /**
5818
+ * The transaction ID in the membership system. Can be used to void the transaction.
5819
+ * @minLength 1
5820
+ * @maxLength 100
5821
+ */
5822
+ externalTransactionId?: string | null;
5823
+ /**
5824
+ * Whether the membership is voided.
5825
+ * @readonly
5826
+ * @deprecated Whether the membership is voided.
5827
+ * @replacedBy payment.status
5828
+ * @targetRemovalDate 2026-11-01
5829
+ */
5830
+ voided?: boolean;
5831
+ /**
5832
+ * ID of the application providing this payment option.
5833
+ * @format GUID
5834
+ */
5835
+ providerAppId?: string;
5836
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5837
+ futureMembership?: FutureMembershipDetails;
5675
5838
  }
5676
- declare enum State {
5677
- UNKNOWN = "UNKNOWN",
5678
- ENABLED = "ENABLED",
5679
- DISABLED = "DISABLED",
5680
- PENDING = "PENDING",
5681
- DEMO = "DEMO"
5839
+ declare enum MembershipPaymentStatus {
5840
+ /** Payment was charged. */
5841
+ CHARGED = "CHARGED",
5842
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5843
+ CHARGE_FAILED = "CHARGE_FAILED",
5844
+ /** Payment is pending. */
5845
+ CHARGE_PENDING = "CHARGE_PENDING",
5846
+ /** Payment was voided. */
5847
+ VOIDED = "VOIDED"
5682
5848
  }
5683
5849
  /** @enumType */
5684
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5685
- interface SiteCreated {
5850
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5851
+ interface FutureMembershipDetails {
5686
5852
  /**
5687
- * A template identifier (empty if not created from a template).
5688
- * @maxLength 36
5853
+ * ID of the plan line item in the order from which the membership will be created.
5854
+ * @format GUID
5689
5855
  */
5690
- originTemplateId?: string;
5856
+ lineItemId?: string;
5691
5857
  /**
5692
- * An account id of the owner.
5693
- * @format GUID
5858
+ * ID of the benefit the future membership will grant.
5859
+ * @maxLength 200
5694
5860
  */
5695
- ownerId?: string;
5696
- /** A context in which meta site was created. */
5697
- context?: SiteCreatedContextWithLiterals;
5861
+ benefitId?: string;
5862
+ }
5863
+ interface WixReceiptInfo {
5698
5864
  /**
5699
- * A meta site id from which this site was created.
5700
- *
5701
- * In case of a creation from a template it's a template id.
5702
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5865
+ * Receipt ID
5703
5866
  * @format GUID
5704
5867
  */
5705
- originMetaSiteId?: string | null;
5868
+ receiptId?: string;
5706
5869
  /**
5707
- * A meta site name (URL slug).
5708
- * @maxLength 20
5870
+ * Display number of receipt
5871
+ * @minLength 1
5872
+ * @maxLength 40
5709
5873
  */
5710
- siteName?: string;
5711
- /** A namespace. */
5712
- namespace?: NamespaceWithLiterals;
5713
- }
5714
- declare enum SiteCreatedContext {
5715
- /** A valid option, we don't expose all reasons why site might be created. */
5716
- OTHER = "OTHER",
5717
- /** A meta site was created from template. */
5718
- FROM_TEMPLATE = "FROM_TEMPLATE",
5719
- /** A meta site was created by copying of the transfferred meta site. */
5720
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5721
- /** A copy of existing meta site. */
5722
- DUPLICATE = "DUPLICATE",
5723
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5724
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5725
- /** deprecated A meta site was created for Flash editor. */
5726
- FLASH = "FLASH"
5874
+ displayNumber?: string | null;
5727
5875
  }
5728
- /** @enumType */
5729
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5730
- declare enum Namespace {
5731
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5732
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5733
- WIX = "WIX",
5734
- /** 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. */
5735
- SHOUT_OUT = "SHOUT_OUT",
5736
- /** 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. */
5737
- ALBUMS = "ALBUMS",
5738
- /** 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. */
5739
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5740
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5741
- HOTELS = "HOTELS",
5742
- /** 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. */
5743
- CLUBS = "CLUBS",
5744
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5745
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5876
+ interface ExternalReceiptInfo {
5746
5877
  /**
5747
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5748
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5878
+ * External receipt ID
5879
+ * @maxLength 100
5749
5880
  */
5750
- DEV_SITE = "DEV_SITE",
5751
- /** 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. */
5752
- LOGOS = "LOGOS",
5753
- /** 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. */
5754
- VIDEO_MAKER = "VIDEO_MAKER",
5755
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5756
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5757
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5758
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5881
+ receiptId?: string | null;
5759
5882
  /**
5760
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5761
- *
5762
- * Meta site with this namespace will *not* be shown in a user's site list by default.
5883
+ * ID of the app providing the receipt
5884
+ * @format GUID
5763
5885
  */
5764
- HTML_DRAFT = "HTML_DRAFT",
5886
+ appId?: string | null;
5765
5887
  /**
5766
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5767
- * Will be accessible from Site List and will not have a website app.
5768
- * Once the user attaches a site, the site will become a regular wixsite.
5888
+ * Display number of receipt
5889
+ * @minLength 1
5890
+ * @maxLength 40
5769
5891
  */
5770
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
5771
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5772
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
5773
- /** It is to be used in the Business First efforts. */
5774
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
5775
- /** Bookings business flow with no site. */
5776
- ANYWHERE = "ANYWHERE",
5777
- /** Namespace for Headless Backoffice with no editor */
5778
- HEADLESS = "HEADLESS",
5892
+ displayNumber?: string | null;
5893
+ }
5894
+ interface CashRoundingDetails {
5779
5895
  /**
5780
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5781
- * The site will be used for account level CSM feature for enterprise
5896
+ * Payment amount before cash rounding was applied.
5897
+ * When provided, balance and status calculations use this value instead of `amount`
5898
+ * to prevent false overpayment or underpayment due to rounding.
5782
5899
  */
5783
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5784
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5785
- RISE = "RISE",
5900
+ unroundedAmount?: Price;
5786
5901
  /**
5787
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5788
- * There's a blank site behind the scene but it's blank).
5789
- * The Mobile company will be the owner of this namespace.
5902
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5903
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5904
+ * @readonly
5790
5905
  */
5791
- BRANDED_FIRST = "BRANDED_FIRST",
5792
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5793
- NOWNIA = "NOWNIA",
5906
+ roundingAdjustment?: CashRounding;
5907
+ }
5908
+ declare enum PaymentStatus {
5909
+ /** Payment was charged successfully. */
5910
+ APPROVED = "APPROVED",
5911
+ /** Payment is being processed and hasn't been confirmed yet. */
5912
+ PENDING = "PENDING",
5913
+ /** 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. */
5914
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5915
+ /** Payment was canceled before it was charged. */
5916
+ CANCELED = "CANCELED",
5917
+ /** Payment was declined by the payment provider. */
5918
+ DECLINED = "DECLINED",
5919
+ /** Payment was fully refunded. */
5920
+ REFUNDED = "REFUNDED",
5921
+ /** Part of the payment amount was refunded. */
5922
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5923
+ /** 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. */
5924
+ AUTHORIZED = "AUTHORIZED",
5794
5925
  /**
5795
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
5796
- * The Partners company owns this namespace.
5926
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5927
+ *
5928
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5797
5929
  */
5798
- UGC_TEMPLATE = "UGC_TEMPLATE",
5799
- /** Codux Headless Sites */
5800
- CODUX = "CODUX",
5801
- /** Bobb - AI Design Creator. */
5802
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5930
+ VOIDED = "VOIDED"
5931
+ }
5932
+ /** @enumType */
5933
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5934
+ interface CanceledStatusDetails {
5935
+ reason?: CanceledReasonWithLiterals;
5936
+ }
5937
+ declare enum CanceledReason {
5938
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5939
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5940
+ /** Payment was not completed by user and expired. */
5941
+ EXPIRED = "EXPIRED"
5942
+ }
5943
+ /** @enumType */
5944
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5945
+ interface DeclinedStatusDetails {
5946
+ reason?: DeclinedReasonWithLiterals;
5947
+ }
5948
+ declare enum DeclinedReason {
5949
+ /** Corresponding charge failed. */
5950
+ CHARGE_FAILED = "CHARGE_FAILED",
5951
+ /** Payment details expired. */
5952
+ EXPIRED = "EXPIRED",
5953
+ /** Insufficient funds. */
5954
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5955
+ /** Gift card was disabled before charge was attempted. */
5956
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5957
+ }
5958
+ /** @enumType */
5959
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5960
+ interface VoidedStatusDetails {
5961
+ reason?: VoidedReasonWithLiterals;
5962
+ }
5963
+ declare enum VoidedReason {
5964
+ /** Payment was voided by merchant request. */
5965
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5966
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5967
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5968
+ }
5969
+ /** @enumType */
5970
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5971
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5972
+ }
5973
+ /** @oneof */
5974
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5975
+ }
5976
+ interface Refund {
5803
5977
  /**
5804
- * Shared Blog Site is a unique single site across Enterprise account,
5805
- * This site will hold all Blog posts related to the Marketing product.
5978
+ * Refund ID.
5979
+ * @format GUID
5980
+ * @readonly
5806
5981
  */
5807
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5808
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5809
- STANDALONE_FORMS = "STANDALONE_FORMS",
5810
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5811
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
5812
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5813
- MIMIR = "MIMIR",
5814
- /** Wix Twins platform. */
5815
- TWINS = "TWINS",
5816
- /** Wix Nano. */
5817
- NANO = "NANO",
5818
- /** Base44 headless sites. */
5819
- BASE44 = "BASE44",
5820
- /** Wix Channels Sites */
5821
- CHANNELS = "CHANNELS",
5822
- /** Nautilus platform. */
5823
- NAUTILUS = "NAUTILUS",
5982
+ _id?: string;
5824
5983
  /**
5825
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5826
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5984
+ * List of transactions.
5985
+ * @maxSize 50
5827
5986
  */
5828
- SYMPHONY = "SYMPHONY",
5829
- /** Nautilus platform app. */
5830
- NAUTILUS_APPS = "NAUTILUS_APPS",
5987
+ transactions?: RefundTransaction[];
5988
+ /** Refund business details. */
5989
+ details?: RefundDetails;
5831
5990
  /**
5832
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5833
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5991
+ * 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.
5992
+ * @readonly
5993
+ * @immutable
5834
5994
  */
5835
- VIBU = "VIBU",
5995
+ _createdDate?: Date | null;
5836
5996
  /**
5837
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5838
- * (an Enterprise account may have several), holding that BrandKit's brand definition
5839
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5840
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
5997
+ * Aggregated refund summary.
5998
+ * @readonly
5841
5999
  */
5842
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6000
+ summary?: AggregatedRefundSummary;
5843
6001
  /**
5844
- * Dev-center development sites (com.wixpress.devcenter.dsm).
5845
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6002
+ * ID of the app that initiated this refund.
6003
+ * @format GUID
6004
+ * @readonly
6005
+ * @immutable
5846
6006
  */
5847
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6007
+ requestingServiceAppId?: string | null;
5848
6008
  }
5849
- /** @enumType */
5850
- 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';
5851
- /** Site transferred to another user. */
5852
- interface SiteTransferred {
6009
+ interface RefundTransaction {
5853
6010
  /**
5854
- * A previous owner id (user that transfers meta site).
6011
+ * ID of the payment associated with this refund.
5855
6012
  * @format GUID
6013
+ * @immutable
5856
6014
  */
5857
- oldOwnerId?: string;
6015
+ paymentId?: string;
5858
6016
  /**
5859
- * A new owner id (user that accepts meta site).
5860
- * @format GUID
6017
+ * Refund amount.
6018
+ * @immutable
5861
6019
  */
5862
- newOwnerId?: string;
5863
- }
5864
- /** Soft deletion of the meta site. Could be restored. */
5865
- interface SiteDeleted {
5866
- /** A deletion context. */
5867
- deleteContext?: DeleteContext;
5868
- }
5869
- interface DeleteContext {
5870
- /** When the meta site was deleted. */
5871
- dateDeleted?: Date | null;
5872
- /** A status. */
5873
- deleteStatus?: DeleteStatusWithLiterals;
6020
+ amount?: Price;
6021
+ /** Refund status. */
6022
+ refundStatus?: RefundStatusWithLiterals;
6023
+ /** Optional details of current refund status. */
6024
+ refundStatusInfo?: RefundStatusInfo;
5874
6025
  /**
5875
- * A reason (flow).
5876
- * @maxLength 255
6026
+ * Payment gateway's refund ID.
6027
+ * This field is only returned when the value of `external_refund` is `false`.
6028
+ * @format GUID
5877
6029
  */
5878
- deleteOrigin?: string;
6030
+ gatewayRefundId?: string | null;
6031
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6032
+ providerRefundId?: string | null;
5879
6033
  /**
5880
- * A service that deleted it.
5881
- * @maxLength 255
6034
+ * Whether refund was made externally and manually on the payment provider's side.
6035
+ * @immutable
5882
6036
  */
5883
- initiatorId?: string | null;
6037
+ externalRefund?: boolean;
5884
6038
  }
5885
- declare enum DeleteStatus {
5886
- UNKNOWN = "UNKNOWN",
5887
- TRASH = "TRASH",
5888
- DELETED = "DELETED",
5889
- PENDING_PURGE = "PENDING_PURGE",
5890
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6039
+ /** Refund transaction status. */
6040
+ declare enum RefundStatus {
6041
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6042
+ PENDING = "PENDING",
6043
+ /** Refund transaction succeeded. */
6044
+ SUCCEEDED = "SUCCEEDED",
6045
+ /** Refund transaction failed. */
6046
+ FAILED = "FAILED",
6047
+ /** Refund request acknowledged, and will be executed soon. */
6048
+ SCHEDULED = "SCHEDULED",
6049
+ /** Refund was initiated on payment provider side. */
6050
+ STARTED = "STARTED"
5891
6051
  }
5892
6052
  /** @enumType */
5893
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5894
- /** Restoration of the meta site. */
5895
- interface SiteUndeleted {
5896
- }
5897
- /** First publish of a meta site. Or subsequent publish after unpublish. */
5898
- interface SitePublished {
5899
- }
5900
- interface SiteUnpublished {
6053
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6054
+ interface RefundStatusInfo {
5901
6055
  /**
5902
- * A list of URLs previously associated with the meta site.
5903
- * @maxLength 4000
5904
- * @maxSize 10000
6056
+ * Reason code for the refund's current status.
6057
+ *
6058
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6059
+ * @minLength 1
6060
+ * @maxLength 10
5905
6061
  */
5906
- urls?: string[];
5907
- }
5908
- interface SiteMarkedAsTemplate {
5909
- }
5910
- interface SiteMarkedAsWixSite {
6062
+ paymentGatewayReasonCode?: string | null;
6063
+ /**
6064
+ * Free text explanation of current refund status.
6065
+ * @minLength 1
6066
+ * @maxLength 1000
6067
+ */
6068
+ description?: string | null;
5911
6069
  }
5912
- /**
5913
- * Represents a service provisioned a site.
5914
- *
5915
- * Note on `origin_instance_id`:
5916
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5917
- * This is because of the following scenario:
5918
- *
5919
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
5920
- * such as a product catalog. When you create a site from this template, you inherit this
5921
- * default product catalog. However, if the template's product catalog is modified,
5922
- * your site will retain the catalog as it was at the time of site creation. This ensures that
5923
- * your site remains consistent with what you initially received and does not include any
5924
- * changes made to the original template afterward.
5925
- * To ensure this, the TPA on the template gets a new instance_id.
5926
- */
5927
- interface ServiceProvisioned {
6070
+ interface AggregatedRefundSummary {
6071
+ /** Total amount requested for refund. */
6072
+ requestedRefund?: Price;
6073
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6074
+ pendingRefund?: Price;
6075
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6076
+ refunded?: Price;
6077
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6078
+ failedRefundAmount?: Price;
6079
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6080
+ pending?: boolean;
6081
+ /** Breakdown of refunded items. Available only after refund is complete. */
6082
+ breakdown?: RefundItemsBreakdown;
6083
+ }
6084
+ interface RefundItemsBreakdown {
5928
6085
  /**
5929
- * Either UUID or EmbeddedServiceType.
5930
- * @maxLength 36
6086
+ * Refunded line items and the amount refunded for each.
6087
+ * @maxSize 300
5931
6088
  */
5932
- appDefId?: string;
6089
+ lineItems?: LineItemRefundSummary[];
6090
+ }
6091
+ interface LineItemRefundSummary {
5933
6092
  /**
5934
- * Not only UUID. Something here could be something weird.
5935
- * @maxLength 36
6093
+ * ID of the refunded line item.
6094
+ * @format GUID
5936
6095
  */
5937
- instanceId?: string;
6096
+ lineItemId?: string;
6097
+ /** Total refunded amount for the line item. */
6098
+ totalRefundedAmount?: Price;
6099
+ }
6100
+ interface CalculateRefundRequest {
5938
6101
  /**
5939
- * An instance id from which this instance is originated.
5940
- * @maxLength 36
6102
+ * Order ID
6103
+ * @minLength 1
6104
+ * @maxLength 100
5941
6105
  */
5942
- originInstanceId?: string;
6106
+ ecomOrderId?: string;
5943
6107
  /**
5944
- * A version.
5945
- * @maxLength 500
6108
+ * Refunded line items and quantity
6109
+ * @maxSize 300
5946
6110
  */
5947
- version?: string | null;
6111
+ refundItems?: CalculateRefundItemRequest[];
6112
+ /** Should include shipping in refund calculation */
6113
+ refundShipping?: boolean;
6114
+ }
6115
+ interface CalculateRefundItemRequest {
5948
6116
  /**
5949
- * The origin meta site id
6117
+ * ID of the line item being refunded
5950
6118
  * @format GUID
5951
6119
  */
5952
- originMetaSiteId?: string | null;
5953
- }
5954
- interface ServiceRemoved {
6120
+ _id?: string;
5955
6121
  /**
5956
- * Either UUID or EmbeddedServiceType.
5957
- * @maxLength 36
6122
+ * How much of that line item is being refunded
6123
+ * @min 1
6124
+ * @max 100000
5958
6125
  */
5959
- appDefId?: string;
6126
+ quantity?: number;
6127
+ }
6128
+ interface CalculateRefundResponse {
6129
+ /** Total refundable amount */
6130
+ total?: Price;
6131
+ /** Tax cost of the order */
6132
+ tax?: Price;
6133
+ /** Discount given for this order */
6134
+ discount?: Price;
6135
+ /** Total cost of the order (without tax) */
6136
+ subtotal?: Price;
6137
+ /** Total shipping cost for order */
6138
+ shipping?: Price;
6139
+ /** Previous refund given on that order */
6140
+ previouslyRefundedAmount?: Price;
5960
6141
  /**
5961
- * Not only UUID. Something here could be something weird.
5962
- * @maxLength 36
6142
+ * The refundable items of that order
6143
+ * @maxSize 300
5963
6144
  */
5964
- instanceId?: string;
6145
+ items?: CalculateRefundItemResponse[];
6146
+ }
6147
+ interface CalculateRefundItemResponse {
5965
6148
  /**
5966
- * A version.
5967
- * @maxLength 500
6149
+ * Line item ID
6150
+ * @format GUID
5968
6151
  */
5969
- version?: string | null;
6152
+ _id?: string;
6153
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6154
+ price?: Price;
5970
6155
  }
5971
- /** Rename of the site. Meaning, free public url has been changed as well. */
5972
- interface SiteRenamed {
6156
+ interface VoidAuthorizedPaymentsRequest {
5973
6157
  /**
5974
- * A new meta site name (URL slug).
5975
- * @maxLength 20
6158
+ * Wix eCommerce order ID
6159
+ * @minLength 1
6160
+ * @maxLength 100
5976
6161
  */
5977
- newSiteName?: string;
6162
+ ecomOrderId: string;
5978
6163
  /**
5979
- * A previous meta site name (URL slug).
5980
- * @maxLength 255
6164
+ * Payment IDs
6165
+ * @minSize 1
6166
+ * @maxSize 100
6167
+ * @format GUID
5981
6168
  */
5982
- oldSiteName?: string;
5983
- }
5984
- /**
5985
- * Hard deletion of the meta site.
5986
- *
5987
- * Could not be restored. Therefore it's desirable to cleanup data.
5988
- */
5989
- interface SiteHardDeleted {
5990
- /** A deletion context. */
5991
- deleteContext?: DeleteContext;
5992
- }
5993
- interface NamespaceChanged {
5994
- /** A previous namespace. */
5995
- oldNamespace?: NamespaceWithLiterals;
5996
- /** A new namespace. */
5997
- newNamespace?: NamespaceWithLiterals;
5998
- }
5999
- /** Assigned Studio editor */
6000
- interface StudioAssigned {
6001
- }
6002
- /** Unassigned Studio editor */
6003
- interface StudioUnassigned {
6169
+ paymentIds: string[];
6004
6170
  }
6005
- /**
6006
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6007
- *
6008
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6009
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6010
- *
6011
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6012
- */
6013
- interface SiteUrlChanged {
6171
+ interface VoidAuthorizedPaymentsResponse {
6172
+ /** All order's transactions after the void was triggered */
6173
+ orderTransactions?: OrderTransactions;
6014
6174
  }
6015
- /**
6016
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6017
- * Consumed by other teams to remove relevant data.
6018
- */
6019
- interface SitePurgedExternally {
6175
+ interface CaptureAuthorizedPaymentsRequest {
6020
6176
  /**
6021
- * @maxLength 2048
6177
+ * Wix eCommerce order ID
6178
+ * @minLength 1
6179
+ * @maxLength 100
6180
+ */
6181
+ ecomOrderId: string;
6182
+ /**
6183
+ * Capture payments information
6184
+ * @minSize 1
6022
6185
  * @maxSize 100
6023
- * @deprecated
6024
- * @targetRemovalDate 2025-04-15
6025
6186
  */
6026
- appDefId?: string[];
6027
- }
6028
- /** Assigned Odeditor */
6029
- interface OdeditorAssigned {
6030
- }
6031
- /** Unassigned Odeditor */
6032
- interface OdeditorUnassigned {
6033
- }
6034
- /** Assigned Picasso editor */
6035
- interface PicassoAssigned {
6036
- }
6037
- /** Unassigned Picasso */
6038
- interface PicassoUnassigned {
6039
- }
6040
- /** Assigned Wixel */
6041
- interface WixelAssigned {
6042
- }
6043
- /** Unassigned Wixel */
6044
- interface WixelUnassigned {
6045
- }
6046
- /** Assigned StudioTwo */
6047
- interface StudioTwoAssigned {
6048
- }
6049
- /** Unassigned StudioTwo */
6050
- interface StudioTwoUnassigned {
6051
- }
6052
- /** Media from user domain is enabled. */
6053
- interface UserDomainMediaEnabled {
6054
- }
6055
- /** Media from user domain is disabled. */
6056
- interface UserDomainMediaDisabled {
6057
- }
6058
- /** Assigned Editorless */
6059
- interface EditorlessAssigned {
6060
- }
6061
- /** Unassigned Editorless */
6062
- interface EditorlessUnassigned {
6187
+ payments: PaymentCapture[];
6063
6188
  }
6064
- interface HasCustomEmailConfigurationsRequest {
6189
+ interface PaymentCapture {
6190
+ /**
6191
+ * Payment ID
6192
+ * @format GUID
6193
+ */
6194
+ paymentId?: string | null;
6195
+ /**
6196
+ * Capture amount.
6197
+ * If not provided - full authorized amount will be captured.
6198
+ */
6199
+ amount?: Price;
6065
6200
  }
6066
- interface HasCustomEmailConfigurationsResponse {
6067
- hasCustomConfigurations?: boolean;
6201
+ interface CaptureAuthorizedPaymentsResponse {
6202
+ /** All order's transactions after the capture was triggered */
6203
+ orderTransactions?: OrderTransactions;
6068
6204
  }
6069
- interface AddToAutomationMigrationPopulationRequest {
6070
- /** When true, sends custom email configurations to automation system via email */
6071
- sendCustomEmailConfigs?: boolean;
6072
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6073
- origin?: OriginWithLiterals;
6205
+ interface ChargeSavedPaymentMethodRequest {
6206
+ /**
6207
+ * Ecom Order ID.
6208
+ * @minLength 1
6209
+ * @maxLength 100
6210
+ */
6211
+ ecomOrderId?: string;
6212
+ /** Amount to be charged */
6213
+ amount?: Price;
6074
6214
  }
6075
- declare enum Origin {
6076
- OPT_IN = "OPT_IN",
6077
- MIGRATION = "MIGRATION"
6215
+ interface ChargeSavedPaymentMethodResponse {
6216
+ /** Payment gateway's order ID (e.g Wix Payments) */
6217
+ paymentGatewayOrderId?: string;
6078
6218
  }
6079
- /** @enumType */
6080
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6081
- interface AddToAutomationMigrationPopulationResponse {
6082
- success?: boolean;
6219
+ interface V1TriggerReindexRequest {
6220
+ /** @format GUID */
6221
+ metasiteId?: string;
6222
+ /**
6223
+ * @minLength 1
6224
+ * @maxLength 100
6225
+ * @maxSize 100
6226
+ */
6227
+ orderIds?: string[];
6083
6228
  }
6084
- interface IsInAutomationMigrationPopulationRequest {
6229
+ interface V1TriggerReindexResponse {
6085
6230
  }
6086
- interface IsInAutomationMigrationPopulationResponse {
6087
- inPopulation?: boolean;
6231
+ interface V1TriggerReindexOrderRequest {
6232
+ /** @format GUID */
6233
+ metasiteId?: string;
6234
+ /**
6235
+ * @minLength 1
6236
+ * @maxLength 100
6237
+ */
6238
+ orderId?: string;
6088
6239
  }
6089
6240
  interface DiffmatokyPayload {
6090
6241
  left?: string;
@@ -9320,4 +9471,4 @@ interface BulkUpdateOrderTagsOptions {
9320
9471
  unassignTags?: TagsTags;
9321
9472
  }
9322
9473
 
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, CanceledReason as aA, DeclinedReason as aB, VoidedReason as aC, RefundStatus as aD, PreviewEmailType as aE, State as aF, SiteCreatedContext as aG, Namespace as aH, DeleteStatus as aI, Origin 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, ScheduledAction as ak, DurationUnit as al, PaymentCollectabilityStatus as am, PredefinedPaymentMethod as an, RefundableStatus as ao, NonRefundableReason as ap, ManuallyRefundableReason as aq, RestockType as ar, TransactionStatus as as, AuthorizationCaptureStatus as at, AuthorizationVoidStatus as au, Reason as av, ActionType as aw, ChargebackStatus as ax, MembershipPaymentStatus as ay, PaymentStatus 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 V1TriggerReindexRequest 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 DeclinedStatusDetails as e$, type V1TriggerReindexResponse as e0, type V1TriggerReindexOrderRequest as e1, type PreparePaymentCollectionRequest as e2, type RedirectUrls as e3, type DelayedCaptureSettings as e4, type Duration as e5, type GetPaymentCollectabilityStatusRequest as e6, type RecordManuallyCollectedPaymentRequest as e7, type UserDefinedPaymentMethodName as e8, type UserDefinedPaymentMethodNameKindOneOf as e9, type ShippingRefund as eA, type RefundSideEffects as eB, type RestockInfo as eC, type RestockItem as eD, type TriggerRefundResponse as eE, type OrderTransactions as eF, type Payment as eG, type PaymentPaymentDetailsOneOf as eH, type PaymentReceiptInfoOneOf as eI, type PaymentStatusDetailsOneOf as eJ, type RegularPaymentDetails as eK, type RegularPaymentDetailsPaymentMethodDetailsOneOf as eL, type CreditCardPaymentMethodDetails as eM, type AuthorizationDetails as eN, type AuthorizationCapture as eO, type AuthorizationActionFailureDetails as eP, type AuthorizationVoid as eQ, type V1ScheduledAction as eR, type Chargeback as eS, type PaymentMethodName as eT, type GiftCardPaymentDetails as eU, type MembershipPaymentDetails as eV, type FutureMembershipDetails as eW, type WixReceiptInfo as eX, type ExternalReceiptInfo as eY, type CashRoundingDetails as eZ, type CanceledStatusDetails as e_, type RecordManuallyCollectedPaymentResponse as ea, type MarkOrderAsPaidRequest as eb, type MarkOrderAsPaidResponse as ec, type BulkMarkOrdersAsPaidRequest as ed, type BulkMarkOrdersAsPaidResponse as ee, type BulkOrderResult as ef, type ItemMetadata as eg, type ApplicationError as eh, type BulkActionMetadata as ei, type GetRefundabilityStatusRequest as ej, type GetRefundabilityStatusResponse as ek, type Refundability as el, type RefundabilityAdditionalRefundabilityInfoOneOf as em, type CreatePaymentGatewayOrderRequest as en, type ChargedBy as eo, type CreatePaymentGatewayOrderResponse as ep, type ChargeMembershipsRequest as eq, type MembershipChargeItem as er, type MembershipName as es, type ChargeMembershipsResponse as et, type TriggerRefundRequest as eu, type PaymentRefund as ev, type RefundDetails as ew, type RefundItem as ex, type LineItemRefund as ey, type AdditionalFeeRefund as ez, type PreparePaymentCollectionApplicationErrors as f, type DeleteContext as f$, type VoidedStatusDetails as f0, type PaymentStatusDetails as f1, type PaymentStatusDetailsStatusDetailsOneOf as f2, type Refund as f3, type RefundTransaction as f4, type RefundStatusInfo as f5, type AggregatedRefundSummary as f6, type RefundItemsBreakdown as f7, type LineItemRefundSummary as f8, type CalculateRefundRequest as f9, type SendFulfillmentEmailResponse as fA, type SendMerchantOrderReceivedPushRequest as fB, type SendMerchantOrderReceivedPushResponse as fC, type PreviewEmailByTypeRequest as fD, type PreviewEmailByTypeResponse as fE, type PreviewRefundEmailRequest as fF, type PreviewRefundEmailResponse as fG, type PreviewCancelEmailRequest as fH, type PreviewCancelEmailResponse as fI, type PreviewCancelRefundEmailRequest as fJ, type PreviewCancelRefundEmailResponse as fK, type PreviewBuyerPaymentsReceivedEmailRequest as fL, type PreviewBuyerPaymentsReceivedEmailResponse as fM, type PreviewBuyerConfirmationEmailRequest as fN, type PreviewBuyerConfirmationEmailResponse as fO, type PreviewBuyerPickupConfirmationEmailRequest as fP, type PreviewBuyerPickupConfirmationEmailResponse as fQ, type PreviewShippingConfirmationEmailRequest as fR, type PreviewShippingConfirmationEmailResponse as fS, type PreviewResendDownloadLinksEmailRequest as fT, type PreviewResendDownloadLinksEmailResponse as fU, type MetaSiteSpecialEvent as fV, type MetaSiteSpecialEventPayloadOneOf as fW, type Asset as fX, type SiteCreated as fY, type SiteTransferred as fZ, type SiteDeleted as f_, type CalculateRefundItemRequest as fa, type CalculateRefundResponse as fb, type CalculateRefundItemResponse as fc, type VoidAuthorizedPaymentsRequest as fd, type CaptureAuthorizedPaymentsRequest as fe, type ChargeSavedPaymentMethodRequest as ff, type ChargeSavedPaymentMethodResponse as fg, type SendBuyerConfirmationEmailRequest as fh, type SendBuyerConfirmationEmailResponse as fi, type SendBuyerPaymentsReceivedEmailRequest as fj, type SendBuyerPaymentsReceivedEmailResponse as fk, type SendBuyerPickupConfirmationEmailRequest as fl, type SendBuyerPickupConfirmationEmailResponse as fm, type BulkSendBuyerPickupConfirmationEmailsRequest as fn, type BulkSendBuyerPickupConfirmationEmailsResponse as fo, type SendBuyerShippingConfirmationEmailRequest as fp, type SendBuyerShippingConfirmationEmailResponse as fq, type BulkSendBuyerShippingConfirmationEmailsRequest as fr, type BulkSendBuyerShippingConfirmationEmailsResponse as fs, type SendMerchantOrderReceivedNotificationRequest as ft, type SendMerchantOrderReceivedNotificationResponse as fu, type SendCancelRefundEmailRequest as fv, type SendCancelRefundEmailResponse as fw, type SendRefundEmailRequest as fx, type SendRefundEmailResponse as fy, type SendFulfillmentEmailRequest as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type DraftOrderDiffsBillingUpdateInfoOneOf as g$, type SiteUndeleted as g0, type SitePublished as g1, type SiteUnpublished as g2, type SiteMarkedAsTemplate as g3, type SiteMarkedAsWixSite as g4, type ServiceProvisioned as g5, type ServiceRemoved as g6, type SiteRenamed as g7, type SiteHardDeleted as g8, type NamespaceChanged as g9, type InternalQueryOrdersRequest as gA, type PlatformQuery as gB, type PlatformQueryPagingMethodOneOf as gC, type Sorting as gD, type PlatformPaging as gE, type CursorPaging as gF, type InternalQueryOrdersResponse as gG, type PlatformPagingMetadata as gH, type Cursors as gI, type QueryOrderRequest as gJ, type QueryOrderResponse as gK, type SearchOrdersRequest as gL, type CursorSearch as gM, type CursorSearchPagingMethodOneOf as gN, type CursorPagingMetadata as gO, type CreateOrderRequest as gP, type OrderCreationSettings as gQ, type OrderCreationSettingsEditableByOneOf as gR, type OrderCreateNotifications as gS, type CreateOrderResponse as gT, type UpdateOrderRequest as gU, type UpdateOrderResponse as gV, type BulkUpdateOrdersRequest as gW, type CommitDeltasRequest as gX, type DraftOrderDiffs as gY, type DraftOrderDiffsShippingUpdateInfoOneOf as gZ, type DraftOrderDiffsBuyerUpdateInfoOneOf as g_, type StudioAssigned as ga, type StudioUnassigned as gb, type SiteUrlChanged as gc, type SitePurgedExternally as gd, type OdeditorAssigned as ge, type OdeditorUnassigned as gf, type PicassoAssigned as gg, type PicassoUnassigned as gh, type WixelAssigned as gi, type WixelUnassigned as gj, type StudioTwoAssigned as gk, type StudioTwoUnassigned as gl, type UserDomainMediaEnabled as gm, type UserDomainMediaDisabled as gn, type EditorlessAssigned as go, type EditorlessUnassigned as gp, type HasCustomEmailConfigurationsRequest as gq, type HasCustomEmailConfigurationsResponse as gr, type AddToAutomationMigrationPopulationRequest as gs, type AddToAutomationMigrationPopulationResponse as gt, type IsInAutomationMigrationPopulationRequest as gu, type IsInAutomationMigrationPopulationResponse as gv, type DiffmatokyPayload as gw, type ErrorInformation as gx, type GetOrderRequest as gy, type GetOrderResponse as gz, type 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 ScheduledActionWithLiterals as k2, type DurationUnitWithLiterals as k3, type PaymentCollectabilityStatusWithLiterals as k4, type PredefinedPaymentMethodWithLiterals as k5, type RefundableStatusWithLiterals as k6, type NonRefundableReasonWithLiterals as k7, type ManuallyRefundableReasonWithLiterals as k8, type RestockTypeWithLiterals 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 TransactionStatusWithLiterals as ka, type AuthorizationCaptureStatusWithLiterals as kb, type AuthorizationVoidStatusWithLiterals as kc, type ReasonWithLiterals as kd, type ActionTypeWithLiterals as ke, type ChargebackStatusWithLiterals as kf, type MembershipPaymentStatusWithLiterals as kg, type PaymentStatusWithLiterals as kh, type CanceledReasonWithLiterals as ki, type DeclinedReasonWithLiterals as kj, type VoidedReasonWithLiterals as kk, type RefundStatusWithLiterals as kl, type PreviewEmailTypeWithLiterals as km, type StateWithLiterals as kn, type SiteCreatedContextWithLiterals as ko, type NamespaceWithLiterals as kp, type DeleteStatusWithLiterals as kq, type OriginWithLiterals 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 };
9474
+ 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, ManuallyRefundableReason as aA, RestockType as aB, TransactionStatus as aC, AuthorizationCaptureStatus as aD, AuthorizationVoidStatus as aE, Reason as aF, ActionType as aG, ChargebackStatus as aH, MembershipPaymentStatus as aI, PaymentStatus as aJ, CanceledReason as aK, DeclinedReason as aL, VoidedReason as aM, RefundStatus 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, PreviewEmailType as ao, State as ap, SiteCreatedContext as aq, Namespace as ar, DeleteStatus as as, Origin as at, ScheduledAction as au, DurationUnit as av, PaymentCollectabilityStatus as aw, PredefinedPaymentMethod as ax, RefundableStatus as ay, NonRefundableReason 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 SiteMarkedAsWixSite 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 SendBuyerConfirmationEmailRequest as e7, type SendBuyerConfirmationEmailResponse as e8, type SendBuyerPaymentsReceivedEmailRequest as e9, type ShippingRefund as eA, type PreviewRefundEmailResponse as eB, type PreviewCancelEmailRequest as eC, type PreviewCancelEmailResponse as eD, type PreviewCancelRefundEmailRequest as eE, type PreviewCancelRefundEmailResponse as eF, type PreviewBuyerPaymentsReceivedEmailRequest as eG, type PreviewBuyerPaymentsReceivedEmailResponse as eH, type PreviewBuyerConfirmationEmailRequest as eI, type PreviewBuyerConfirmationEmailResponse as eJ, type PreviewBuyerPickupConfirmationEmailRequest as eK, type PreviewBuyerPickupConfirmationEmailResponse as eL, type PreviewShippingConfirmationEmailRequest as eM, type PreviewShippingConfirmationEmailResponse as eN, type PreviewResendDownloadLinksEmailRequest as eO, type PreviewResendDownloadLinksEmailResponse as eP, type MetaSiteSpecialEvent as eQ, type MetaSiteSpecialEventPayloadOneOf as eR, type Asset as eS, type SiteCreated as eT, type SiteTransferred as eU, type SiteDeleted as eV, type DeleteContext as eW, type SiteUndeleted as eX, type SitePublished as eY, type SiteUnpublished as eZ, type SiteMarkedAsTemplate as e_, type SendBuyerPaymentsReceivedEmailResponse as ea, type SendBuyerPickupConfirmationEmailRequest as eb, type SendBuyerPickupConfirmationEmailResponse as ec, type BulkSendBuyerPickupConfirmationEmailsRequest as ed, type BulkSendBuyerPickupConfirmationEmailsResponse as ee, type SendBuyerShippingConfirmationEmailRequest as ef, type SendBuyerShippingConfirmationEmailResponse as eg, type BulkSendBuyerShippingConfirmationEmailsRequest as eh, type BulkSendBuyerShippingConfirmationEmailsResponse as ei, type SendMerchantOrderReceivedNotificationRequest as ej, type SendMerchantOrderReceivedNotificationResponse as ek, type SendCancelRefundEmailRequest as el, type SendCancelRefundEmailResponse as em, type SendRefundEmailRequest as en, type SendRefundEmailResponse as eo, type SendFulfillmentEmailRequest as ep, type SendFulfillmentEmailResponse as eq, type SendMerchantOrderReceivedPushRequest as er, type SendMerchantOrderReceivedPushResponse as es, type PreviewEmailByTypeRequest as et, type PreviewEmailByTypeResponse as eu, type PreviewRefundEmailRequest as ev, type RefundDetails as ew, type RefundItem as ex, type LineItemRefund as ey, type AdditionalFeeRefund as ez, type PreparePaymentCollectionApplicationErrors as f, type PaymentPaymentDetailsOneOf as f$, type ServiceProvisioned as f0, type ServiceRemoved as f1, type SiteRenamed as f2, type SiteHardDeleted as f3, type NamespaceChanged as f4, type StudioAssigned as f5, type StudioUnassigned as f6, type SiteUrlChanged as f7, type SitePurgedExternally as f8, type OdeditorAssigned as f9, type MarkOrderAsPaidRequest as fA, type MarkOrderAsPaidResponse as fB, type BulkMarkOrdersAsPaidRequest as fC, type BulkMarkOrdersAsPaidResponse as fD, type BulkOrderResult as fE, type ItemMetadata as fF, type ApplicationError as fG, type BulkActionMetadata as fH, type GetRefundabilityStatusRequest as fI, type GetRefundabilityStatusResponse as fJ, type Refundability as fK, type RefundabilityAdditionalRefundabilityInfoOneOf as fL, type CreatePaymentGatewayOrderRequest as fM, type ChargedBy as fN, type CreatePaymentGatewayOrderResponse as fO, type ChargeMembershipsRequest as fP, type MembershipChargeItem as fQ, type MembershipName as fR, type ChargeMembershipsResponse as fS, type TriggerRefundRequest as fT, type PaymentRefund as fU, type RefundSideEffects as fV, type RestockInfo as fW, type RestockItem as fX, type TriggerRefundResponse as fY, type OrderTransactions as fZ, type Payment as f_, type OdeditorUnassigned as fa, type PicassoAssigned as fb, type PicassoUnassigned as fc, type WixelAssigned as fd, type WixelUnassigned as fe, type StudioTwoAssigned as ff, type StudioTwoUnassigned as fg, type UserDomainMediaEnabled as fh, type UserDomainMediaDisabled as fi, type EditorlessAssigned as fj, type EditorlessUnassigned as fk, type HasCustomEmailConfigurationsRequest as fl, type HasCustomEmailConfigurationsResponse as fm, type AddToAutomationMigrationPopulationRequest as fn, type AddToAutomationMigrationPopulationResponse as fo, type IsInAutomationMigrationPopulationRequest as fp, type IsInAutomationMigrationPopulationResponse as fq, type PreparePaymentCollectionRequest as fr, type RedirectUrls as fs, type DelayedCaptureSettings as ft, type Duration as fu, type GetPaymentCollectabilityStatusRequest as fv, type RecordManuallyCollectedPaymentRequest as fw, type UserDefinedPaymentMethodName as fx, type UserDefinedPaymentMethodNameKindOneOf as fy, type RecordManuallyCollectedPaymentResponse as fz, type VoidAuthorizedPaymentsApplicationErrors as g, type CreateOrderResponse as g$, type PaymentReceiptInfoOneOf as g0, type PaymentStatusDetailsOneOf as g1, type RegularPaymentDetails as g2, type RegularPaymentDetailsPaymentMethodDetailsOneOf as g3, type CreditCardPaymentMethodDetails as g4, type AuthorizationDetails as g5, type AuthorizationCapture as g6, type AuthorizationActionFailureDetails as g7, type AuthorizationVoid as g8, type V1ScheduledAction as g9, type ChargeSavedPaymentMethodResponse as gA, type V1TriggerReindexRequest as gB, type V1TriggerReindexResponse as gC, type V1TriggerReindexOrderRequest 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 Chargeback as ga, type PaymentMethodName as gb, type GiftCardPaymentDetails as gc, type MembershipPaymentDetails as gd, type FutureMembershipDetails as ge, type WixReceiptInfo as gf, type ExternalReceiptInfo as gg, type CashRoundingDetails as gh, type CanceledStatusDetails as gi, type DeclinedStatusDetails as gj, type VoidedStatusDetails as gk, type PaymentStatusDetails as gl, type PaymentStatusDetailsStatusDetailsOneOf as gm, type Refund as gn, type RefundTransaction as go, type RefundStatusInfo as gp, type AggregatedRefundSummary as gq, type RefundItemsBreakdown as gr, type LineItemRefundSummary as gs, type CalculateRefundRequest as gt, type CalculateRefundItemRequest as gu, type CalculateRefundResponse as gv, type CalculateRefundItemResponse as gw, type VoidAuthorizedPaymentsRequest as gx, type CaptureAuthorizedPaymentsRequest as gy, type ChargeSavedPaymentMethodRequest as gz, type 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 CanceledReasonWithLiterals as kA, type DeclinedReasonWithLiterals as kB, type VoidedReasonWithLiterals as kC, type RefundStatusWithLiterals 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 PreviewEmailTypeWithLiterals as ke, type StateWithLiterals as kf, type SiteCreatedContextWithLiterals as kg, type NamespaceWithLiterals as kh, type DeleteStatusWithLiterals as ki, type OriginWithLiterals as kj, type ScheduledActionWithLiterals as kk, type DurationUnitWithLiterals as kl, type PaymentCollectabilityStatusWithLiterals as km, type PredefinedPaymentMethodWithLiterals as kn, type RefundableStatusWithLiterals as ko, type NonRefundableReasonWithLiterals as kp, type ManuallyRefundableReasonWithLiterals as kq, type RestockTypeWithLiterals as kr, type TransactionStatusWithLiterals as ks, type AuthorizationCaptureStatusWithLiterals as kt, type AuthorizationVoidStatusWithLiterals as ku, type ReasonWithLiterals as kv, type ActionTypeWithLiterals as kw, type ChargebackStatusWithLiterals as kx, type MembershipPaymentStatusWithLiterals as ky, type PaymentStatusWithLiterals 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 };