@wix/auto_sdk_ecom_orders 1.0.316 → 1.0.318

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-DXcKuMZ8.d.ts → ecom-v1-order-orders.universal-cwJXByV0.d.ts} +1837 -1696
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +197 -86
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +154 -85
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1838 -1697
  9. package/build/cjs/meta.js +154 -85
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-DXcKuMZ8.d.mts → ecom-v1-order-orders.universal-cwJXByV0.d.mts} +1837 -1696
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +193 -86
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +150 -85
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1838 -1697
  19. package/build/es/meta.mjs +150 -85
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-BOZydR9Q.d.ts → ecom-v1-order-orders.universal-CaNCF4JV.d.ts} +1995 -1798
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +1980 -1796
  25. package/build/internal/es/{ecom-v1-order-orders.universal-BOZydR9Q.d.mts → ecom-v1-order-orders.universal-CaNCF4JV.d.mts} +1995 -1798
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +1980 -1796
  29. package/package.json +2 -2
@@ -1,4 +1,4 @@
1
- import { dY as ImportOrderRequest$1, I as ImportOrderResponse$1, dZ as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, d_ as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fj as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fn as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fo as RecordManuallyCollectedPaymentRequest$1, fr as RecordManuallyCollectedPaymentResponse$1, fs as MarkOrderAsPaidRequest$1, ft as MarkOrderAsPaidResponse$1, fu as BulkMarkOrdersAsPaidRequest$1, fv as BulkMarkOrdersAsPaidResponse$1, fA as GetRefundabilityStatusRequest$1, fB as GetRefundabilityStatusResponse$1, fE as CreatePaymentGatewayOrderRequest$1, fG as CreatePaymentGatewayOrderResponse$1, fH as ChargeMembershipsRequest$1, fK as ChargeMembershipsResponse$1, fL as TriggerRefundRequest$1, fQ as TriggerRefundResponse$1, gp as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gq as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gy as GetOrderRequest$1, gz as GetOrderResponse$1, gL as SearchOrdersRequest$1, l as SearchOrdersResponse$1, gP as CreateOrderRequest$1, gT as CreateOrderResponse$1, gU as UpdateOrderRequest$1, gV as UpdateOrderResponse$1, gW as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, hp as UpdateOrderLineItemRequest$1, hq as UpdateOrderLineItemResponse$1, hR as AddActivityRequest$1, hU as AddActivityResponse$1, hV as AddActivitiesRequest$1, r as AddActivitiesResponse$1, hW as UpdateActivityRequest$1, hX as UpdateActivityResponse$1, hY as DeleteActivityRequest$1, hZ as DeleteActivityResponse$1, i3 as CancelOrderRequest$1, t as CancelOrderResponse$1, i4 as UpdateOrderStatusRequest$1, i5 as UpdateOrderStatusResponse$1, iv as AggregateOrdersRequest$1, iw as AggregateOrdersResponse$1, iA as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-DXcKuMZ8.mjs';
1
+ import { e4 as ImportOrderRequest$1, I as ImportOrderResponse$1, e5 as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, e6 as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, ea as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ee as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, ef as RecordManuallyCollectedPaymentRequest$1, ei as RecordManuallyCollectedPaymentResponse$1, ej as MarkOrderAsPaidRequest$1, ek as MarkOrderAsPaidResponse$1, el as BulkMarkOrdersAsPaidRequest$1, em as BulkMarkOrdersAsPaidResponse$1, er as GetRefundabilityStatusRequest$1, es as GetRefundabilityStatusResponse$1, ev as CreatePaymentGatewayOrderRequest$1, ex as CreatePaymentGatewayOrderResponse$1, ey as ChargeMembershipsRequest$1, eB as ChargeMembershipsResponse$1, eC as TriggerRefundRequest$1, eM as TriggerRefundResponse$1, fl as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fm as CaptureAuthorizedPaymentsRequest$1, C as CaptureAuthorizedPaymentsResponse$1, gG as GetOrderRequest$1, gH as GetOrderResponse$1, gT as SearchOrdersRequest$1, l as SearchOrdersResponse$1, gX as CreateOrderRequest$1, g$ as CreateOrderResponse$1, h0 as UpdateOrderRequest$1, h1 as UpdateOrderResponse$1, h2 as BulkUpdateOrdersRequest$1, q as BulkUpdateOrdersResponse$1, hx as UpdateOrderLineItemRequest$1, hy as UpdateOrderLineItemResponse$1, hZ as AddActivityRequest$1, i0 as AddActivityResponse$1, i1 as AddActivitiesRequest$1, r as AddActivitiesResponse$1, i2 as UpdateActivityRequest$1, i3 as UpdateActivityResponse$1, i4 as DeleteActivityRequest$1, i5 as DeleteActivityResponse$1, ib as CancelOrderRequest$1, t as CancelOrderResponse$1, ic as UpdateOrderStatusRequest$1, id as UpdateOrderStatusResponse$1, iD as AggregateOrdersRequest$1, iE as AggregateOrdersResponse$1, iI as BulkUpdateOrderTagsRequest$1, w as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-cwJXByV0.mjs';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -1098,6 +1098,76 @@ interface ServiceProperties {
1098
1098
  */
1099
1099
  numberOfParticipants?: number | null;
1100
1100
  }
1101
+ /**
1102
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1103
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1104
+ *
1105
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1106
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1107
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1108
+ */
1109
+ interface CrossBorderPriceAdjustment {
1110
+ /**
1111
+ * ID of the tax region whose tax is built into the catalog prices.
1112
+ * @format GUID
1113
+ */
1114
+ baseTaxRegionId?: string;
1115
+ /**
1116
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1117
+ * @format GUID
1118
+ */
1119
+ destinationTaxRegionId?: string | null;
1120
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1121
+ catalogPrice?: Price;
1122
+ /** 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. */
1123
+ baseTaxAmount?: Price;
1124
+ /** Outcome of the repricing for this line. */
1125
+ status?: RepriceStatusWithLiterals;
1126
+ /** 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`. */
1127
+ baseRateSource?: BaseRateSourceWithLiterals;
1128
+ /**
1129
+ * 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.
1130
+ * @format DECIMAL_VALUE
1131
+ * @decimalValue options { gte:0, maxScale:6 }
1132
+ */
1133
+ baseRate?: string | null;
1134
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1135
+ baseRateCapturedDate?: Date | null;
1136
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1137
+ destinationTaxIncluded?: boolean | null;
1138
+ }
1139
+ /** Outcome of the repricing for one line. */
1140
+ declare enum RepriceStatus {
1141
+ /** Base tax removed and the destination's tax applied. */
1142
+ APPLIED = "APPLIED",
1143
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1144
+ KEPT = "KEPT",
1145
+ /** 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`. */
1146
+ STRIP_ONLY = "STRIP_ONLY",
1147
+ /** The destination is the base region. Nothing was removed. */
1148
+ SAME_REGION = "SAME_REGION",
1149
+ /** 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. */
1150
+ SAME_COUNTRY = "SAME_COUNTRY",
1151
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1152
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1153
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1154
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1155
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1156
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1157
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1158
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1159
+ }
1160
+ /** @enumType */
1161
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1162
+ /** Where the base region's rate came from. */
1163
+ declare enum BaseRateSource {
1164
+ /** The manual tax calculator computed the base tax for this calculation. */
1165
+ MANUAL_SPI = "MANUAL_SPI",
1166
+ /** The rate captured from Avalara by the embedded-rate probe. */
1167
+ AVALARA_PROBE = "AVALARA_PROBE"
1168
+ }
1169
+ /** @enumType */
1170
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1101
1171
  /** Buyer information. */
1102
1172
  interface BuyerInfo extends BuyerInfoIdOneOf {
1103
1173
  /**
@@ -1221,6 +1291,25 @@ interface CurrencyConversionDetails {
1221
1291
  */
1222
1292
  conversionRate?: string | null;
1223
1293
  }
1294
+ /** 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`. */
1295
+ interface CrossBorderRepricing {
1296
+ /**
1297
+ * 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.
1298
+ *
1299
+ * Default: `false`
1300
+ */
1301
+ enabled?: boolean;
1302
+ /**
1303
+ * ID of the tax region whose tax is built into the catalog prices, as used for this order.
1304
+ * @format GUID
1305
+ */
1306
+ baseTaxRegionId?: string | null;
1307
+ /**
1308
+ * ID of the base region's tax calculator when the order was placed.
1309
+ * @format GUID
1310
+ */
1311
+ baseCalculatorId?: string | null;
1312
+ }
1224
1313
  interface PriceSummary {
1225
1314
  /** Subtotal of all line items, before discounts and before tax. */
1226
1315
  subtotal?: Price;
@@ -1583,6 +1672,56 @@ interface OrderTaxBreakdown {
1583
1672
  /** The sum of all the tax from line items that calculated by the tax identifiers. */
1584
1673
  aggregatedTaxAmount?: Price;
1585
1674
  }
1675
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1676
+ interface CrossBorderCalculation {
1677
+ /** Whether the calculation repriced the lines for the destination's tax. */
1678
+ applied?: boolean;
1679
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1680
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1681
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1682
+ mode?: CrossBorderRepricingModeWithLiterals;
1683
+ /**
1684
+ * Request ID of the calculation, for log correlation.
1685
+ * @maxLength 100
1686
+ */
1687
+ requestId?: string | null;
1688
+ }
1689
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1690
+ declare enum CrossBorderNotApplicableReason {
1691
+ /** The repricing feature toggle is off. */
1692
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1693
+ /** The site hasn't opted in to cross-border repricing. */
1694
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1695
+ /** The site's prices no longer include tax. */
1696
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
1697
+ /** The base tax region doesn't exist on the site. */
1698
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
1699
+ /** The base region uses the manual calculator and has no tax mapping. */
1700
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
1701
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
1702
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
1703
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
1704
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
1705
+ /** The line items were repriced. Repricing the shipping option failed. */
1706
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
1707
+ /** The line items were repriced. Repricing the additional fees failed. */
1708
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
1709
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
1710
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
1711
+ }
1712
+ /** @enumType */
1713
+ 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';
1714
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
1715
+ declare enum CrossBorderRepricingMode {
1716
+ /** Nothing is repriced. */
1717
+ DISABLED = "DISABLED",
1718
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
1719
+ STRIP_ONLY = "STRIP_ONLY",
1720
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
1721
+ FULL = "FULL"
1722
+ }
1723
+ /** @enumType */
1724
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1586
1725
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1587
1726
  /** Coupon applied by the customer. */
1588
1727
  coupon?: Coupon;
@@ -3639,6 +3778,8 @@ declare enum DeltaPaymentOptionType {
3639
3778
  type DeltaPaymentOptionTypeWithLiterals = DeltaPaymentOptionType | 'FULL_PAYMENT_OFFLINE' | 'MEMBERSHIP_OFFLINE';
3640
3779
  interface DecimalQuantityUpdate {
3641
3780
  }
3781
+ interface CrossBorderAdjustmentUpdate {
3782
+ }
3642
3783
  interface LineItemDelta extends LineItemDeltaDeltaOneOf {
3643
3784
  lineItemAdded?: boolean;
3644
3785
  changedDetails?: ItemChangedDetails;
@@ -3939,2176 +4080,2176 @@ interface BulkDeleteImportedOrdersResponse {
3939
4080
  */
3940
4081
  jobId?: string;
3941
4082
  }
3942
- interface SendBuyerConfirmationEmailRequest {
4083
+ interface V1TriggerReindexRequest {
3943
4084
  /** @format GUID */
3944
- orderId?: string;
3945
- }
3946
- interface SendBuyerConfirmationEmailResponse {
3947
- }
3948
- interface SendBuyerPaymentsReceivedEmailRequest {
4085
+ metasiteId?: string;
3949
4086
  /**
3950
4087
  * @minLength 1
3951
4088
  * @maxLength 100
4089
+ * @maxSize 100
3952
4090
  */
3953
- orderId?: string;
4091
+ orderIds?: string[];
3954
4092
  }
3955
- interface SendBuyerPaymentsReceivedEmailResponse {
4093
+ interface V1TriggerReindexResponse {
3956
4094
  }
3957
- interface SendBuyerPickupConfirmationEmailRequest {
4095
+ interface V1TriggerReindexOrderRequest {
4096
+ /** @format GUID */
4097
+ metasiteId?: string;
3958
4098
  /**
3959
4099
  * @minLength 1
3960
4100
  * @maxLength 100
3961
4101
  */
3962
4102
  orderId?: string;
3963
4103
  }
3964
- interface SendBuyerPickupConfirmationEmailResponse {
3965
- }
3966
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
3967
- /**
3968
- * IDs of orders to send pickup emails for.
3969
- * @minSize 1
3970
- * @maxSize 300
3971
- */
3972
- orderIds?: string[];
3973
- }
3974
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
3975
- }
3976
- interface SendBuyerShippingConfirmationEmailRequest {
4104
+ interface PreparePaymentCollectionRequest {
3977
4105
  /**
4106
+ * Ecom order ID.
3978
4107
  * @minLength 1
3979
4108
  * @maxLength 100
3980
4109
  */
3981
- orderId?: string;
3982
- }
3983
- interface SendBuyerShippingConfirmationEmailResponse {
3984
- }
3985
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
4110
+ ecomOrderId: string;
4111
+ /** Amount to collect */
4112
+ amount: Price;
3986
4113
  /**
3987
- * IDs of orders to send pickup emails for.
3988
- * @minSize 1
3989
- * @maxSize 300
4114
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4115
+ * Existing payment gateway order will be updated with a new amount.
4116
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
3990
4117
  */
3991
- orderIds?: string[];
3992
- }
3993
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
3994
- }
3995
- interface SendMerchantOrderReceivedNotificationRequest {
4118
+ paymentGatewayOrderId?: string | null;
3996
4119
  /**
3997
- * @minLength 1
3998
- * @maxLength 100
4120
+ * Whether to delay capture of the payment.
4121
+ * Default: false
4122
+ * @deprecated Whether to delay capture of the payment.
4123
+ * Default: false
4124
+ * @replacedBy delayed_capture_settings.scheduled_action
4125
+ * @targetRemovalDate 2024-09-30
3999
4126
  */
4000
- orderId?: string;
4001
- }
4002
- interface SendMerchantOrderReceivedNotificationResponse {
4127
+ delayedCapture?: boolean;
4128
+ /** Delayed capture payment settings */
4129
+ delayedCaptureSettings?: DelayedCaptureSettings;
4003
4130
  }
4004
- interface SendCancelRefundEmailRequest {
4005
- /**
4006
- * The ID of order that is canceled/refunded
4007
- * @minLength 1
4008
- * @maxLength 100
4009
- */
4010
- orderId?: string;
4131
+ interface RedirectUrls {
4011
4132
  /**
4012
- * Personal note added to the email (optional)
4013
- * @minLength 1
4014
- * @maxLength 1000
4133
+ * URL to redirect buyer in case of approved (successful) transaction
4134
+ * @format WEB_URL
4015
4135
  */
4016
- customMessage?: string | null;
4017
- /** Refund amount */
4018
- refundAmount?: Price;
4136
+ successUrl?: string | null;
4019
4137
  /**
4020
- * Refund ID. (Optional)
4021
- * @format GUID
4138
+ * URL to redirect buyer in case of buyer canceled the transaction
4139
+ * @format WEB_URL
4022
4140
  */
4023
- refundId?: string | null;
4024
- }
4025
- interface SendCancelRefundEmailResponse {
4026
- }
4027
- interface SendRefundEmailRequest {
4141
+ cancelUrl?: string | null;
4028
4142
  /**
4029
- * The ID of order that is refunded
4030
- * @format GUID
4143
+ * URL to redirect buyer in case of failed/rejected transaction
4144
+ * @format WEB_URL
4031
4145
  */
4032
- orderId?: string;
4146
+ errorUrl?: string | null;
4033
4147
  /**
4034
- * Refund ID
4035
- * @format GUID
4148
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
4149
+ * @format WEB_URL
4036
4150
  */
4037
- refundId?: string;
4151
+ pendingUrl?: string | null;
4152
+ }
4153
+ interface DelayedCaptureSettings {
4154
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4155
+ scheduledAction?: ScheduledActionWithLiterals;
4156
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
4157
+ delayDuration?: Duration;
4158
+ }
4159
+ declare enum ScheduledAction {
4160
+ /** Whether payment will be auto-voided when duration passes */
4161
+ VOID = "VOID",
4162
+ /** Whether payment will be auto-captured when duration passes */
4163
+ CAPTURE = "CAPTURE"
4164
+ }
4165
+ /** @enumType */
4166
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4167
+ interface Duration {
4038
4168
  /**
4039
- * Personal note added to the email (optional)
4040
- * @minLength 1
4041
- * @maxLength 1000
4169
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4170
+ * @min 1
4042
4171
  */
4043
- customMessage?: string | null;
4044
- }
4045
- interface SendRefundEmailResponse {
4172
+ count?: number;
4173
+ /** Duration unit: MINUTES, HOURS and DAYS */
4174
+ unit?: DurationUnitWithLiterals;
4046
4175
  }
4047
- interface SendFulfillmentEmailRequest {
4048
- /** @format GUID */
4049
- orderId?: string;
4050
- /** @format GUID */
4051
- fulfillerId?: string;
4176
+ declare enum DurationUnit {
4177
+ MINUTES = "MINUTES",
4178
+ HOURS = "HOURS",
4179
+ DAYS = "DAYS"
4052
4180
  }
4053
- interface SendFulfillmentEmailResponse {
4181
+ /** @enumType */
4182
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4183
+ interface PreparePaymentCollectionResponse {
4184
+ /** Payment gateway order id which is associated with given payment */
4185
+ paymentGatewayOrderId?: string;
4054
4186
  }
4055
- interface SendMerchantOrderReceivedPushRequest {
4187
+ interface GetPaymentCollectabilityStatusRequest {
4056
4188
  /**
4189
+ * Ecom order ID.
4057
4190
  * @minLength 1
4058
4191
  * @maxLength 100
4059
4192
  */
4060
- orderId?: string;
4061
- }
4062
- interface SendMerchantOrderReceivedPushResponse {
4193
+ ecomOrderId: string;
4063
4194
  }
4064
- interface PreviewEmailByTypeRequest {
4065
- emailType?: PreviewEmailTypeWithLiterals;
4195
+ interface GetPaymentCollectabilityStatusResponse {
4196
+ /** Payment collectability status */
4197
+ status?: PaymentCollectabilityStatusWithLiterals;
4198
+ /** Collectable order amount */
4199
+ amount?: Price;
4066
4200
  }
4067
- declare enum PreviewEmailType {
4068
- ORDER_PLACED = "ORDER_PLACED",
4069
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4070
- ORDER_SHIPPED = "ORDER_SHIPPED",
4071
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4201
+ declare enum PaymentCollectabilityStatus {
4202
+ UNKNOWN = "UNKNOWN",
4203
+ COLLECTABLE = "COLLECTABLE",
4204
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4205
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4206
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4207
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4208
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4209
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4210
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4211
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4212
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4213
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4214
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4072
4215
  }
4073
4216
  /** @enumType */
4074
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4075
- interface PreviewEmailByTypeResponse {
4076
- emailPreview?: string;
4077
- }
4078
- interface PreviewRefundEmailRequest {
4217
+ 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';
4218
+ interface RecordManuallyCollectedPaymentRequest {
4079
4219
  /**
4220
+ * Order ID.
4080
4221
  * @minLength 1
4081
4222
  * @maxLength 100
4082
4223
  */
4083
- orderId?: string;
4084
- /** Refund amount */
4085
- refundAmount?: Price;
4086
- /** Refund business details */
4087
- details?: RefundDetails;
4224
+ orderId: string;
4225
+ /** Amount to be recorded as approved manual payment for given order */
4226
+ amount: Price;
4227
+ }
4228
+ /**
4229
+ * User-defined payment method name.
4230
+ * Allows specifying either a predefined type or a custom name.
4231
+ */
4232
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4233
+ /** Predefined payment method. */
4234
+ predefined?: PredefinedPaymentMethodWithLiterals;
4088
4235
  /**
4089
- * Personal note added to the email (optional)
4236
+ * Custom payment method name provided by user.
4237
+ *
4238
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4090
4239
  * @minLength 1
4091
- * @maxLength 1000
4092
- */
4093
- customMessage?: string | null;
4094
- /**
4095
- * Refund ID. (Optional)
4096
- * @format GUID
4240
+ * @maxLength 150
4097
4241
  */
4098
- refundId?: string | null;
4242
+ custom?: string | null;
4099
4243
  }
4100
- /** Business model of a refund request */
4101
- interface RefundDetails {
4102
- /**
4103
- * Order line item IDs and quantities that were refunded.
4104
- * @maxSize 300
4105
- */
4106
- items?: RefundItem[];
4107
- /** Whether the shipping fee was also refunded. */
4108
- shippingIncluded?: boolean;
4244
+ /** @oneof */
4245
+ interface UserDefinedPaymentMethodNameKindOneOf {
4246
+ /** Predefined payment method. */
4247
+ predefined?: PredefinedPaymentMethodWithLiterals;
4109
4248
  /**
4110
- * Reason for the refund, provided by customer (optional).
4111
- * @maxLength 200
4249
+ * Custom payment method name provided by user.
4250
+ *
4251
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4252
+ * @minLength 1
4253
+ * @maxLength 150
4112
4254
  */
4113
- reason?: string | null;
4255
+ custom?: string | null;
4256
+ }
4257
+ /** Predefined payment method types for offline/manual payments. */
4258
+ declare enum PredefinedPaymentMethod {
4259
+ /** Cash payment. */
4260
+ CASH = "CASH",
4261
+ /** Bank transfer. */
4262
+ BANK_TRANSFER = "BANK_TRANSFER",
4263
+ /** Payment by check. */
4264
+ CHECK = "CHECK"
4265
+ }
4266
+ /** @enumType */
4267
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4268
+ interface RecordManuallyCollectedPaymentResponse {
4269
+ }
4270
+ interface MarkOrderAsPaidRequest {
4114
4271
  /**
4115
- * Line items that were refunded.
4116
- * @maxSize 300
4272
+ * Ecom order ID.
4273
+ * @minLength 1
4274
+ * @maxLength 100
4117
4275
  */
4118
- lineItems?: LineItemRefund[];
4276
+ ecomOrderId: string;
4277
+ }
4278
+ interface MarkOrderAsPaidResponse {
4279
+ /** Updated order. */
4280
+ order?: Order;
4281
+ }
4282
+ interface BulkMarkOrdersAsPaidRequest {
4119
4283
  /**
4120
- * Additional fees that were refunded.
4284
+ * IDs of orders to mark as paid.
4285
+ * @minSize 1
4121
4286
  * @maxSize 100
4287
+ * @minLength 1
4288
+ * @maxLength 100
4122
4289
  */
4123
- additionalFees?: AdditionalFeeRefund[];
4124
- /** Shipping amount that was refunded. */
4125
- shipping?: ShippingRefund;
4290
+ ecomOrderIds: string[];
4126
4291
  }
4127
- interface RefundItem {
4128
- /**
4129
- * Line item ID the refunded line item.
4130
- * @format GUID
4131
- */
4132
- lineItemId?: string;
4292
+ interface BulkMarkOrdersAsPaidResponse {
4133
4293
  /**
4134
- * Line item quantity refunded.
4135
- * @min 1
4136
- * @max 100000
4294
+ * Items updated by the bulk action.
4295
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4137
4296
  */
4138
- quantity?: number;
4297
+ results?: BulkOrderResult[];
4298
+ /** Bulk action metadata. */
4299
+ bulkActionMetadata?: BulkActionMetadata;
4139
4300
  }
4140
- interface LineItemRefund {
4301
+ interface BulkOrderResult {
4302
+ /** Item metadata. */
4303
+ itemMetadata?: ItemMetadata;
4141
4304
  /**
4142
- * Line item ID.
4143
- * @format GUID
4144
- * @immutable
4305
+ * Updated order.
4306
+ *
4307
+ * Returned when `returnFullEntity = true`.
4145
4308
  */
4146
- lineItemId?: string;
4309
+ item?: Order;
4310
+ }
4311
+ interface ItemMetadata {
4312
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4313
+ id?: string | null;
4314
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
4315
+ originalIndex?: number;
4316
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4317
+ success?: boolean;
4318
+ /** Details about the error in case of failure. */
4319
+ error?: ApplicationError;
4320
+ }
4321
+ interface ApplicationError {
4322
+ /** Error code. */
4323
+ code?: string;
4324
+ /** Description of the error. */
4325
+ description?: string;
4326
+ /** Data related to the error. */
4327
+ data?: Record<string, any> | null;
4328
+ }
4329
+ interface BulkActionMetadata {
4330
+ /** Number of items that were successfully processed. */
4331
+ totalSuccesses?: number;
4332
+ /** Number of items that couldn't be processed. */
4333
+ totalFailures?: number;
4334
+ /** Number of failures without details because detailed failure threshold was exceeded. */
4335
+ undetailedFailures?: number;
4336
+ }
4337
+ interface GetRefundabilityStatusRequest {
4147
4338
  /**
4148
- * Refund quantity.
4149
- * @min 1
4150
- * @max 100000
4151
- * @immutable
4339
+ * Order ID.
4340
+ * @minLength 1
4341
+ * @maxLength 100
4152
4342
  */
4153
- quantity?: number;
4343
+ ecomOrderId: string;
4154
4344
  }
4155
- interface AdditionalFeeRefund {
4345
+ interface GetRefundabilityStatusResponse {
4156
4346
  /**
4157
- * Additional fee ID.
4158
- * @format GUID
4159
- * @immutable
4347
+ * Refundability details.
4348
+ * @maxSize 300
4160
4349
  */
4161
- additionalFeeId?: string;
4350
+ refundabilities?: Refundability[];
4162
4351
  /**
4163
- * Refund amount.
4164
- * @immutable
4352
+ * Whether the order supports refunding per item.
4353
+ * @deprecated
4165
4354
  */
4166
- amount?: Price;
4355
+ refundablePerItem?: boolean;
4167
4356
  }
4168
- interface ShippingRefund {
4169
- /**
4170
- * Refund amount.
4171
- * @immutable
4172
- */
4173
- amount?: Price;
4357
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4358
+ /** Reason why payment is not refundable. */
4359
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4360
+ /** Reason why payment is only refundable manually. */
4361
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4362
+ /** Payment ID. */
4363
+ paymentId?: string;
4364
+ /** Payment refundability status. */
4365
+ refundabilityStatus?: RefundableStatusWithLiterals;
4366
+ /** Link to payment provider dashboard. */
4367
+ providerLink?: string | null;
4174
4368
  }
4175
- interface PreviewRefundEmailResponse {
4176
- emailPreview?: string;
4369
+ /** @oneof */
4370
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
4371
+ /** Reason why payment is not refundable. */
4372
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
4373
+ /** Reason why payment is only refundable manually. */
4374
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4177
4375
  }
4178
- interface PreviewCancelEmailRequest {
4376
+ declare enum RefundableStatus {
4377
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
4378
+ MANUAL = "MANUAL",
4379
+ REFUNDABLE = "REFUNDABLE"
4380
+ }
4381
+ /** @enumType */
4382
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4383
+ declare enum NonRefundableReason {
4384
+ NONE = "NONE",
4385
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
4386
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4387
+ INTERNAL_ERROR = "INTERNAL_ERROR",
4388
+ NOT_PAID = "NOT_PAID",
4389
+ ACCESS_DENIED = "ACCESS_DENIED",
4390
+ ZERO_PRICE = "ZERO_PRICE",
4391
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4392
+ PENDING_REFUND = "PENDING_REFUND",
4393
+ FORBIDDEN = "FORBIDDEN",
4394
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4395
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
4396
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4397
+ }
4398
+ /** @enumType */
4399
+ 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';
4400
+ declare enum ManuallyRefundableReason {
4401
+ EXPIRED = "EXPIRED",
4402
+ NOT_SUPPORTED = "NOT_SUPPORTED",
4403
+ OFFLINE = "OFFLINE",
4404
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4405
+ }
4406
+ /** @enumType */
4407
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4408
+ interface CreatePaymentGatewayOrderRequest {
4179
4409
  /**
4410
+ * Ecom order ID.
4180
4411
  * @minLength 1
4181
4412
  * @maxLength 100
4182
4413
  */
4183
- orderId?: string;
4414
+ ecomOrderId: string;
4415
+ /** Information about the user who initiated the payment. */
4416
+ chargedBy?: ChargedBy;
4417
+ }
4418
+ interface ChargedBy {
4184
4419
  /**
4185
- * Personal note added to the email (optional)
4420
+ * ID - id of the user who initiated the payment
4421
+ * @format GUID
4422
+ */
4423
+ id?: string;
4424
+ /**
4425
+ * Full name - name of the user who initiated the payment
4186
4426
  * @minLength 1
4187
- * @maxLength 1000
4427
+ * @maxLength 200
4188
4428
  */
4189
- customMessage?: string | null;
4429
+ fullName?: string | null;
4190
4430
  }
4191
- interface PreviewCancelEmailResponse {
4192
- emailPreview?: string;
4431
+ interface CreatePaymentGatewayOrderResponse {
4432
+ /** ID of the order created in the payment gateway */
4433
+ paymentGatewayOrderId?: string;
4193
4434
  }
4194
- interface PreviewCancelRefundEmailRequest {
4435
+ interface ChargeMembershipsRequest {
4195
4436
  /**
4437
+ * Order ID.
4196
4438
  * @minLength 1
4197
4439
  * @maxLength 100
4198
4440
  */
4199
- orderId?: string;
4441
+ ecomOrderId: string;
4200
4442
  /**
4201
- * Personal note added to the email (optional)
4443
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4444
+ * but a user which is using the membership on behalf of the a member
4445
+ * @format GUID
4446
+ */
4447
+ memberId: string;
4448
+ /**
4449
+ * List of items to be paid by memberships
4450
+ * @minSize 1
4451
+ * @maxSize 300
4452
+ */
4453
+ membershipCharges?: MembershipChargeItem[];
4454
+ }
4455
+ interface MembershipChargeItem {
4456
+ /**
4457
+ * The id of used membership
4202
4458
  * @minLength 1
4203
- * @maxLength 1000
4459
+ * @maxLength 100
4204
4460
  */
4205
- customMessage?: string | null;
4206
- /** Refund amount */
4207
- refundAmount?: Price;
4461
+ membershipId?: string;
4208
4462
  /**
4209
- * Refund ID. (Optional)
4463
+ * ID of the application providing this payment option
4210
4464
  * @format GUID
4211
4465
  */
4212
- refundId?: string | null;
4213
- }
4214
- interface PreviewCancelRefundEmailResponse {
4215
- emailPreview?: string;
4216
- }
4217
- interface PreviewBuyerPaymentsReceivedEmailRequest {
4218
- }
4219
- interface PreviewBuyerPaymentsReceivedEmailResponse {
4220
- emailPreview?: string;
4221
- }
4222
- interface PreviewBuyerConfirmationEmailRequest {
4223
- }
4224
- interface PreviewBuyerConfirmationEmailResponse {
4225
- emailPreview?: string;
4226
- }
4227
- interface PreviewBuyerPickupConfirmationEmailRequest {
4228
- }
4229
- interface PreviewBuyerPickupConfirmationEmailResponse {
4230
- emailPreview?: string;
4231
- }
4232
- interface PreviewShippingConfirmationEmailRequest {
4233
- }
4234
- interface PreviewShippingConfirmationEmailResponse {
4235
- emailPreview?: string;
4236
- }
4237
- interface PreviewResendDownloadLinksEmailRequest {
4238
- }
4239
- interface PreviewResendDownloadLinksEmailResponse {
4240
- emailPreview?: string;
4466
+ appId?: string;
4467
+ /** The name of used membership */
4468
+ membershipName?: MembershipName;
4469
+ /** Additional data about this membership */
4470
+ membershipAdditionalData?: Record<string, any> | null;
4471
+ /** Catalog and item reference info. */
4472
+ catalogReference?: CatalogReference;
4473
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
4474
+ serviceProperties?: ServiceProperties;
4475
+ /**
4476
+ * Usually would be the same as catalogReference.catalogItemId
4477
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
4478
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4479
+ * @minLength 1
4480
+ * @maxLength 36
4481
+ */
4482
+ rootCatalogItemId?: string | null;
4483
+ /**
4484
+ * line item id of Checkout/Order line item
4485
+ * @minLength 1
4486
+ * @maxLength 100
4487
+ */
4488
+ lineItemId?: string;
4241
4489
  }
4242
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4243
- /** Emitted on a meta site creation. */
4244
- siteCreated?: SiteCreated;
4245
- /** Emitted on a meta site transfer completion. */
4246
- siteTransferred?: SiteTransferred;
4247
- /** Emitted on a meta site deletion. */
4248
- siteDeleted?: SiteDeleted;
4249
- /** Emitted on a meta site restoration. */
4250
- siteUndeleted?: SiteUndeleted;
4251
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4252
- sitePublished?: SitePublished;
4253
- /** Emitted on a meta site unpublish. */
4254
- siteUnpublished?: SiteUnpublished;
4255
- /** Emitted when meta site is marked as template. */
4256
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4257
- /** Emitted when meta site is marked as a WixSite. */
4258
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4259
- /** Emitted when an application is provisioned (installed). */
4260
- serviceProvisioned?: ServiceProvisioned;
4261
- /** Emitted when an application is removed (uninstalled). */
4262
- serviceRemoved?: ServiceRemoved;
4263
- /** Emitted when meta site name (URL slug) is changed. */
4264
- siteRenamedPayload?: SiteRenamed;
4265
- /** Emitted when meta site was permanently deleted. */
4266
- hardDeleted?: SiteHardDeleted;
4267
- /** Emitted on a namespace change. */
4268
- namespaceChanged?: NamespaceChanged;
4269
- /** Emitted when Studio is attached. */
4270
- studioAssigned?: StudioAssigned;
4271
- /** Emitted when Studio is detached. */
4272
- studioUnassigned?: StudioUnassigned;
4490
+ interface MembershipName {
4273
4491
  /**
4274
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4275
- * the actual URL.
4492
+ * Membership name in the site's original language.
4493
+ * @maxLength 100
4494
+ */
4495
+ original?: string;
4496
+ /**
4497
+ * Membership name translated into the buyer's language.
4276
4498
  *
4277
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4278
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4499
+ * Default: The value of `original`
4500
+ * @maxLength 100
4279
4501
  */
4280
- urlChanged?: SiteUrlChanged;
4281
- /** Site is marked as PurgedExternally */
4282
- sitePurgedExternally?: SitePurgedExternally;
4283
- /** Emitted when Odeditor is attached. */
4284
- odeditorAssigned?: OdeditorAssigned;
4285
- /** Emitted when Odeditor is detached. */
4286
- odeditorUnassigned?: OdeditorUnassigned;
4287
- /** Emitted when Picasso is attached. */
4288
- picassoAssigned?: PicassoAssigned;
4289
- /** Emitted when Picasso is detached. */
4290
- picassoUnassigned?: PicassoUnassigned;
4291
- /** Emitted when Wixel is attached. */
4292
- wixelAssigned?: WixelAssigned;
4293
- /** Emitted when Wixel is detached. */
4294
- wixelUnassigned?: WixelUnassigned;
4295
- /** Emitted when StudioTwo is attached. */
4296
- studioTwoAssigned?: StudioTwoAssigned;
4297
- /** Emitted when StudioTwo is detached. */
4298
- studioTwoUnassigned?: StudioTwoUnassigned;
4299
- /** Emitted when media from user domain is enabled. */
4300
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4301
- /** Emitted when media from user domain is disabled. */
4302
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4303
- /** Emitted when Editorless is attached. */
4304
- editorlessAssigned?: EditorlessAssigned;
4305
- /** Emitted when Editorless is detached. */
4306
- editorlessUnassigned?: EditorlessUnassigned;
4502
+ translated?: string | null;
4503
+ }
4504
+ interface ChargeMembershipsResponse {
4505
+ }
4506
+ interface TriggerRefundRequest {
4307
4507
  /**
4308
- * A meta site id.
4309
- * @format GUID
4508
+ * The order this refund related to
4509
+ * @minLength 1
4510
+ * @maxLength 100
4310
4511
  */
4311
- metaSiteId?: string;
4312
- /** A meta site version. Monotonically increasing. */
4313
- version?: string;
4314
- /** A timestamp of the event. */
4315
- timestamp?: string;
4512
+ ecomOrderId: string;
4316
4513
  /**
4317
- * TODO(meta-site): Change validation once validations are disabled for consumers
4318
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
4319
- * @maxSize 4000
4514
+ * Refund operations information
4515
+ * @minSize 1
4516
+ * @maxSize 1
4320
4517
  */
4321
- assets?: Asset[];
4518
+ payments: PaymentRefund[];
4519
+ /** Business model of a refund */
4520
+ details?: RefundDetails;
4521
+ /** Side effect details related to refund */
4522
+ sideEffects?: RefundSideEffects;
4322
4523
  }
4323
- /** @oneof */
4324
- interface MetaSiteSpecialEventPayloadOneOf {
4325
- /** Emitted on a meta site creation. */
4326
- siteCreated?: SiteCreated;
4327
- /** Emitted on a meta site transfer completion. */
4328
- siteTransferred?: SiteTransferred;
4329
- /** Emitted on a meta site deletion. */
4330
- siteDeleted?: SiteDeleted;
4331
- /** Emitted on a meta site restoration. */
4332
- siteUndeleted?: SiteUndeleted;
4333
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
4334
- sitePublished?: SitePublished;
4335
- /** Emitted on a meta site unpublish. */
4336
- siteUnpublished?: SiteUnpublished;
4337
- /** Emitted when meta site is marked as template. */
4338
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
4339
- /** Emitted when meta site is marked as a WixSite. */
4340
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
4341
- /** Emitted when an application is provisioned (installed). */
4342
- serviceProvisioned?: ServiceProvisioned;
4343
- /** Emitted when an application is removed (uninstalled). */
4344
- serviceRemoved?: ServiceRemoved;
4345
- /** Emitted when meta site name (URL slug) is changed. */
4346
- siteRenamedPayload?: SiteRenamed;
4347
- /** Emitted when meta site was permanently deleted. */
4348
- hardDeleted?: SiteHardDeleted;
4349
- /** Emitted on a namespace change. */
4350
- namespaceChanged?: NamespaceChanged;
4351
- /** Emitted when Studio is attached. */
4352
- studioAssigned?: StudioAssigned;
4353
- /** Emitted when Studio is detached. */
4354
- studioUnassigned?: StudioUnassigned;
4524
+ interface PaymentRefund {
4355
4525
  /**
4356
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
4357
- * the actual URL.
4358
- *
4359
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
4360
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4526
+ * Specific payment within the order to refund
4527
+ * @format GUID
4361
4528
  */
4362
- urlChanged?: SiteUrlChanged;
4363
- /** Site is marked as PurgedExternally */
4364
- sitePurgedExternally?: SitePurgedExternally;
4365
- /** Emitted when Odeditor is attached. */
4366
- odeditorAssigned?: OdeditorAssigned;
4367
- /** Emitted when Odeditor is detached. */
4368
- odeditorUnassigned?: OdeditorUnassigned;
4369
- /** Emitted when Picasso is attached. */
4370
- picassoAssigned?: PicassoAssigned;
4371
- /** Emitted when Picasso is detached. */
4372
- picassoUnassigned?: PicassoUnassigned;
4373
- /** Emitted when Wixel is attached. */
4374
- wixelAssigned?: WixelAssigned;
4375
- /** Emitted when Wixel is detached. */
4376
- wixelUnassigned?: WixelUnassigned;
4377
- /** Emitted when StudioTwo is attached. */
4378
- studioTwoAssigned?: StudioTwoAssigned;
4379
- /** Emitted when StudioTwo is detached. */
4380
- studioTwoUnassigned?: StudioTwoUnassigned;
4381
- /** Emitted when media from user domain is enabled. */
4382
- userDomainMediaEnabled?: UserDomainMediaEnabled;
4383
- /** Emitted when media from user domain is disabled. */
4384
- userDomainMediaDisabled?: UserDomainMediaDisabled;
4385
- /** Emitted when Editorless is attached. */
4386
- editorlessAssigned?: EditorlessAssigned;
4387
- /** Emitted when Editorless is detached. */
4388
- editorlessUnassigned?: EditorlessUnassigned;
4529
+ paymentId?: string;
4530
+ /** Refund amount. Not relevant for membership and gift card refunds. */
4531
+ amount?: Price;
4532
+ /**
4533
+ * Whether refund is made externally and manually (on the payment provider's side)
4534
+ * 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.
4535
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
4536
+ */
4537
+ externalRefund?: boolean;
4389
4538
  }
4390
- interface Asset {
4539
+ /** Business model of a refund request */
4540
+ interface RefundDetails {
4391
4541
  /**
4392
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4393
- * @maxLength 36
4542
+ * Order line item IDs and quantities that were refunded.
4543
+ * @maxSize 300
4394
4544
  */
4395
- appDefId?: string;
4545
+ items?: RefundItem[];
4546
+ /** Whether the shipping fee was also refunded. */
4547
+ shippingIncluded?: boolean;
4396
4548
  /**
4397
- * An instance id. For legacy reasons may be UUID or a string.
4549
+ * Reason for the refund, provided by customer (optional).
4398
4550
  * @maxLength 200
4399
4551
  */
4400
- instanceId?: string;
4401
- /** An application state. */
4402
- state?: StateWithLiterals;
4403
- }
4404
- declare enum State {
4405
- UNKNOWN = "UNKNOWN",
4406
- ENABLED = "ENABLED",
4407
- DISABLED = "DISABLED",
4408
- PENDING = "PENDING",
4409
- DEMO = "DEMO"
4410
- }
4411
- /** @enumType */
4412
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
4413
- interface SiteCreated {
4552
+ reason?: string | null;
4414
4553
  /**
4415
- * A template identifier (empty if not created from a template).
4416
- * @maxLength 36
4554
+ * Line items that were refunded.
4555
+ * @maxSize 300
4417
4556
  */
4418
- originTemplateId?: string;
4557
+ lineItems?: LineItemRefund[];
4419
4558
  /**
4420
- * An account id of the owner.
4421
- * @format GUID
4559
+ * Additional fees that were refunded.
4560
+ * @maxSize 100
4422
4561
  */
4423
- ownerId?: string;
4424
- /** A context in which meta site was created. */
4425
- context?: SiteCreatedContextWithLiterals;
4562
+ additionalFees?: AdditionalFeeRefund[];
4563
+ /** Shipping amount that was refunded. */
4564
+ shipping?: ShippingRefund;
4565
+ }
4566
+ interface RefundItem {
4426
4567
  /**
4427
- * A meta site id from which this site was created.
4428
- *
4429
- * In case of a creation from a template it's a template id.
4430
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
4568
+ * Line item ID the refunded line item.
4431
4569
  * @format GUID
4432
4570
  */
4433
- originMetaSiteId?: string | null;
4571
+ lineItemId?: string;
4434
4572
  /**
4435
- * A meta site name (URL slug).
4436
- * @maxLength 20
4573
+ * Line item quantity refunded.
4574
+ * @min 1
4575
+ * @max 100000
4437
4576
  */
4438
- siteName?: string;
4439
- /** A namespace. */
4440
- namespace?: NamespaceWithLiterals;
4441
- }
4442
- declare enum SiteCreatedContext {
4443
- /** A valid option, we don't expose all reasons why site might be created. */
4444
- OTHER = "OTHER",
4445
- /** A meta site was created from template. */
4446
- FROM_TEMPLATE = "FROM_TEMPLATE",
4447
- /** A meta site was created by copying of the transfferred meta site. */
4448
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
4449
- /** A copy of existing meta site. */
4450
- DUPLICATE = "DUPLICATE",
4451
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
4452
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
4453
- /** deprecated A meta site was created for Flash editor. */
4454
- FLASH = "FLASH"
4577
+ quantity?: number;
4455
4578
  }
4456
- /** @enumType */
4457
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
4458
- declare enum Namespace {
4459
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
4460
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
4461
- WIX = "WIX",
4462
- /** 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. */
4463
- SHOUT_OUT = "SHOUT_OUT",
4464
- /** 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. */
4465
- ALBUMS = "ALBUMS",
4466
- /** 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. */
4467
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
4468
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4469
- HOTELS = "HOTELS",
4470
- /** 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. */
4471
- CLUBS = "CLUBS",
4472
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
4473
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
4579
+ interface LineItemRefund {
4474
4580
  /**
4475
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
4476
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4581
+ * Line item ID.
4582
+ * @format GUID
4583
+ * @immutable
4477
4584
  */
4478
- DEV_SITE = "DEV_SITE",
4479
- /** 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. */
4480
- LOGOS = "LOGOS",
4481
- /** 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. */
4482
- VIDEO_MAKER = "VIDEO_MAKER",
4483
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4484
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
4485
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
4486
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4585
+ lineItemId?: string;
4487
4586
  /**
4488
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
4489
- *
4490
- * Meta site with this namespace will *not* be shown in a user's site list by default.
4587
+ * Refund quantity.
4588
+ * @min 1
4589
+ * @max 100000
4590
+ * @immutable
4491
4591
  */
4492
- HTML_DRAFT = "HTML_DRAFT",
4592
+ quantity?: number;
4593
+ }
4594
+ interface AdditionalFeeRefund {
4493
4595
  /**
4494
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
4495
- * Will be accessible from Site List and will not have a website app.
4496
- * Once the user attaches a site, the site will become a regular wixsite.
4497
- */
4498
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
4499
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
4500
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
4501
- /** It is to be used in the Business First efforts. */
4502
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
4503
- /** Bookings business flow with no site. */
4504
- ANYWHERE = "ANYWHERE",
4505
- /** Namespace for Headless Backoffice with no editor */
4506
- HEADLESS = "HEADLESS",
4596
+ * Additional fee ID.
4597
+ * @format GUID
4598
+ * @immutable
4599
+ */
4600
+ additionalFeeId?: string;
4507
4601
  /**
4508
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
4509
- * The site will be used for account level CSM feature for enterprise
4602
+ * Refund amount.
4603
+ * @immutable
4510
4604
  */
4511
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
4512
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
4513
- RISE = "RISE",
4605
+ amount?: Price;
4606
+ }
4607
+ interface ShippingRefund {
4514
4608
  /**
4515
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
4516
- * There's a blank site behind the scene but it's blank).
4517
- * The Mobile company will be the owner of this namespace.
4609
+ * Refund amount.
4610
+ * @immutable
4518
4611
  */
4519
- BRANDED_FIRST = "BRANDED_FIRST",
4520
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
4521
- NOWNIA = "NOWNIA",
4612
+ amount?: Price;
4613
+ }
4614
+ interface RefundSideEffects {
4615
+ /** Inventory restock details as part of this refund. */
4616
+ restockInfo?: RestockInfo;
4617
+ /** Whether to send a refund confirmation email to the customer. */
4618
+ sendOrderRefundedEmail?: boolean;
4522
4619
  /**
4523
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
4524
- * The Partners company owns this namespace.
4620
+ * Custom message added to the refund confirmation email.
4621
+ * @minLength 1
4622
+ * @maxLength 1000
4525
4623
  */
4526
- UGC_TEMPLATE = "UGC_TEMPLATE",
4527
- /** Codux Headless Sites */
4528
- CODUX = "CODUX",
4529
- /** Bobb - AI Design Creator. */
4530
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
4624
+ customMessage?: string | null;
4625
+ }
4626
+ interface RestockInfo {
4627
+ /** Restock type. */
4628
+ type?: RestockTypeWithLiterals;
4531
4629
  /**
4532
- * Shared Blog Site is a unique single site across Enterprise account,
4533
- * This site will hold all Blog posts related to the Marketing product.
4630
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
4631
+ * @maxSize 300
4534
4632
  */
4535
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
4536
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4537
- STANDALONE_FORMS = "STANDALONE_FORMS",
4538
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
4539
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
4540
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
4541
- MIMIR = "MIMIR",
4542
- /** Wix Twins platform. */
4543
- TWINS = "TWINS",
4544
- /** Wix Nano. */
4545
- NANO = "NANO",
4546
- /** Base44 headless sites. */
4547
- BASE44 = "BASE44",
4548
- /** Wix Channels Sites */
4549
- CHANNELS = "CHANNELS",
4550
- /** Nautilus platform. */
4551
- NAUTILUS = "NAUTILUS",
4633
+ items?: RestockItem[];
4634
+ }
4635
+ declare enum RestockType {
4636
+ NO_ITEMS = "NO_ITEMS",
4637
+ ALL_ITEMS = "ALL_ITEMS",
4638
+ SOME_ITEMS = "SOME_ITEMS"
4639
+ }
4640
+ /** @enumType */
4641
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
4642
+ interface RestockItem {
4552
4643
  /**
4553
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
4554
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
4644
+ * ID of the line item being restocked.
4645
+ * @format GUID
4555
4646
  */
4556
- SYMPHONY = "SYMPHONY",
4557
- /** Nautilus platform app. */
4558
- NAUTILUS_APPS = "NAUTILUS_APPS",
4647
+ lineItemId?: string;
4559
4648
  /**
4560
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
4561
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
4649
+ * Line item quantity being restocked.
4650
+ * @min 1
4651
+ * @max 100000
4562
4652
  */
4563
- VIBU = "VIBU",
4653
+ quantity?: number;
4654
+ }
4655
+ interface TriggerRefundResponse {
4656
+ /** All order's transactions after the refunds were added */
4657
+ orderTransactions?: OrderTransactions;
4658
+ /** Created refund ID */
4659
+ refundId?: string | null;
4660
+ /** Payment ID's that the refund execution had failed for */
4661
+ failedPaymentIds?: ItemMetadata[];
4662
+ }
4663
+ /**
4664
+ * A record of all payments and refunds associated with an order.
4665
+ *
4666
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
4667
+ */
4668
+ interface OrderTransactions {
4564
4669
  /**
4565
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
4566
- * (an Enterprise account may have several), holding that BrandKit's brand definition
4567
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
4568
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
4670
+ * Order ID.
4671
+ * @format GUID
4569
4672
  */
4570
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
4673
+ orderId?: string;
4571
4674
  /**
4572
- * Dev-center development sites (com.wixpress.devcenter.dsm).
4573
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
4675
+ * Record of payments made to the merchant.
4676
+ * @maxSize 100
4574
4677
  */
4575
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
4678
+ payments?: Payment[];
4679
+ /**
4680
+ * Record of refunds made to the buyer.
4681
+ * @maxSize 300
4682
+ */
4683
+ refunds?: Refund[];
4576
4684
  }
4577
- /** @enumType */
4578
- 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';
4579
- /** Site transferred to another user. */
4580
- interface SiteTransferred {
4685
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
4686
+ /** Regular payment details. */
4687
+ regularPaymentDetails?: RegularPaymentDetails;
4688
+ /** Gift card payment details. */
4689
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4690
+ /** Membership payment details. */
4691
+ membershipPaymentDetails?: MembershipPaymentDetails;
4581
4692
  /**
4582
- * A previous owner id (user that transfers meta site).
4693
+ * Payment ID.
4583
4694
  * @format GUID
4695
+ * @readonly
4584
4696
  */
4585
- oldOwnerId?: string;
4697
+ id?: string | null;
4698
+ /** 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. */
4699
+ createdDate?: Date | null;
4586
4700
  /**
4587
- * A new owner id (user that accepts meta site).
4588
- * @format GUID
4701
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
4702
+ * @readonly
4589
4703
  */
4590
- newOwnerId?: string;
4591
- }
4592
- /** Soft deletion of the meta site. Could be restored. */
4593
- interface SiteDeleted {
4594
- /** A deletion context. */
4595
- deleteContext?: DeleteContext;
4596
- }
4597
- interface DeleteContext {
4598
- /** When the meta site was deleted. */
4599
- dateDeleted?: Date | null;
4600
- /** A status. */
4601
- deleteStatus?: DeleteStatusWithLiterals;
4704
+ updatedDate?: Date | null;
4705
+ /** Payment amount. */
4706
+ amount?: Price;
4602
4707
  /**
4603
- * A reason (flow).
4604
- * @maxLength 255
4708
+ * Whether refunds for this payment are disabled.
4709
+ * + `true`: This payment is not refundable.
4710
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
4605
4711
  */
4606
- deleteOrigin?: string;
4712
+ refundDisabled?: boolean;
4607
4713
  /**
4608
- * A service that deleted it.
4609
- * @maxLength 255
4714
+ * Whether receipt generation is allowed for this payment.
4715
+ * + `true`: This payment supports receipt generation.
4716
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
4717
+ * @readonly
4610
4718
  */
4611
- initiatorId?: string | null;
4719
+ supportReceiptGeneration?: boolean;
4720
+ /** Details about cash rounding applied to this payment, when relevant. */
4721
+ cashRounding?: CashRoundingDetails;
4722
+ /**
4723
+ * Overall payment status.
4724
+ *
4725
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
4726
+ */
4727
+ status?: PaymentStatusWithLiterals;
4728
+ /**
4729
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
4730
+ * @format GUID
4731
+ */
4732
+ chargeCorrelationId?: string | null;
4612
4733
  }
4613
- declare enum DeleteStatus {
4614
- UNKNOWN = "UNKNOWN",
4615
- TRASH = "TRASH",
4616
- DELETED = "DELETED",
4617
- PENDING_PURGE = "PENDING_PURGE",
4618
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
4734
+ /** @oneof */
4735
+ interface PaymentPaymentDetailsOneOf {
4736
+ /** Regular payment details. */
4737
+ regularPaymentDetails?: RegularPaymentDetails;
4738
+ /** Gift card payment details. */
4739
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
4740
+ /** Membership payment details. */
4741
+ membershipPaymentDetails?: MembershipPaymentDetails;
4619
4742
  }
4620
- /** @enumType */
4621
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
4622
- /** Restoration of the meta site. */
4623
- interface SiteUndeleted {
4743
+ /** @oneof */
4744
+ interface PaymentReceiptInfoOneOf {
4624
4745
  }
4625
- /** First publish of a meta site. Or subsequent publish after unpublish. */
4626
- interface SitePublished {
4746
+ /** @oneof */
4747
+ interface PaymentStatusDetailsOneOf {
4627
4748
  }
4628
- interface SiteUnpublished {
4749
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
4750
+ /** Credit card details. */
4751
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4629
4752
  /**
4630
- * A list of URLs previously associated with the meta site.
4631
- * @maxLength 4000
4632
- * @maxSize 10000
4753
+ * Wix Payments order ID.
4754
+ * @maxLength 100
4633
4755
  */
4634
- urls?: string[];
4635
- }
4636
- interface SiteMarkedAsTemplate {
4637
- }
4638
- interface SiteMarkedAsWixSite {
4639
- }
4640
- /**
4641
- * Represents a service provisioned a site.
4642
- *
4643
- * Note on `origin_instance_id`:
4644
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
4645
- * This is because of the following scenario:
4646
- *
4647
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
4648
- * such as a product catalog. When you create a site from this template, you inherit this
4649
- * default product catalog. However, if the template's product catalog is modified,
4650
- * your site will retain the catalog as it was at the time of site creation. This ensures that
4651
- * your site remains consistent with what you initially received and does not include any
4652
- * changes made to the original template afterward.
4653
- * To ensure this, the TPA on the template gets a new instance_id.
4654
- */
4655
- interface ServiceProvisioned {
4756
+ paymentOrderId?: string | null;
4656
4757
  /**
4657
- * Either UUID or EmbeddedServiceType.
4658
- * @maxLength 36
4758
+ * Payment gateway's transaction ID.
4759
+ * This field is only returned when the value of `offline_payment` is `false`.
4760
+ * @maxLength 100
4761
+ */
4762
+ gatewayTransactionId?: string | null;
4763
+ /**
4764
+ * Payment method.
4765
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4766
+ * Non-exhaustive list of supported values:
4767
+ * + `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`
4768
+ * @maxLength 150
4769
+ * @deprecated Payment method.
4770
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
4771
+ * Non-exhaustive list of supported values:
4772
+ * + `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`
4773
+ * @replacedBy payment_method_name
4774
+ * @targetRemovalDate 2026-07-01
4659
4775
  */
4660
- appDefId?: string;
4776
+ paymentMethod?: string | null;
4661
4777
  /**
4662
- * Not only UUID. Something here could be something weird.
4663
- * @maxLength 36
4778
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
4779
+ * @maxLength 100
4664
4780
  */
4665
- instanceId?: string;
4781
+ providerTransactionId?: string | null;
4782
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
4783
+ offlinePayment?: boolean;
4666
4784
  /**
4667
- * An instance id from which this instance is originated.
4668
- * @maxLength 36
4785
+ * Payment status.
4786
+ * @deprecated Payment status.
4787
+ * @replacedBy payment.status
4788
+ * @targetRemovalDate 2026-11-01
4669
4789
  */
4670
- originInstanceId?: string;
4790
+ status?: TransactionStatusWithLiterals;
4791
+ /** Whether there is a payment agreement that allows for future charges. */
4792
+ savedPaymentMethod?: boolean;
4793
+ /** Authorization details. */
4794
+ authorizationDetails?: AuthorizationDetails;
4671
4795
  /**
4672
- * A version.
4673
- * @maxLength 500
4796
+ * Record of chargebacks made by the buyer.
4797
+ * @maxSize 6
4674
4798
  */
4675
- version?: string | null;
4799
+ chargebacks?: Chargeback[];
4800
+ /** Platform fee amount associated with this payment. */
4801
+ platformFee?: Price;
4676
4802
  /**
4677
- * The origin meta site id
4678
- * @format GUID
4803
+ * Payment method with buyer and optional owner translations.
4804
+ * Non-exhaustive list of supported values:
4805
+ * + `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`
4679
4806
  */
4680
- originMetaSiteId?: string | null;
4807
+ paymentMethodName?: PaymentMethodName;
4681
4808
  }
4682
- interface ServiceRemoved {
4683
- /**
4684
- * Either UUID or EmbeddedServiceType.
4685
- * @maxLength 36
4686
- */
4687
- appDefId?: string;
4809
+ /** @oneof */
4810
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
4811
+ /** Credit card details. */
4812
+ creditCardDetails?: CreditCardPaymentMethodDetails;
4813
+ }
4814
+ declare enum TransactionStatus {
4815
+ UNDEFINED = "UNDEFINED",
4816
+ APPROVED = "APPROVED",
4817
+ PENDING = "PENDING",
4818
+ PENDING_MERCHANT = "PENDING_MERCHANT",
4819
+ CANCELED = "CANCELED",
4820
+ DECLINED = "DECLINED",
4821
+ REFUNDED = "REFUNDED",
4822
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
4823
+ AUTHORIZED = "AUTHORIZED",
4824
+ VOIDED = "VOIDED"
4825
+ }
4826
+ /** @enumType */
4827
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
4828
+ interface CreditCardPaymentMethodDetails {
4688
4829
  /**
4689
- * Not only UUID. Something here could be something weird.
4690
- * @maxLength 36
4830
+ * The last 4 digits of the card number.
4831
+ * @maxLength 4
4691
4832
  */
4692
- instanceId?: string;
4833
+ lastFourDigits?: string | null;
4693
4834
  /**
4694
- * A version.
4695
- * @maxLength 500
4835
+ * Card issuer's brand.
4836
+ * @maxLength 100
4696
4837
  */
4697
- version?: string | null;
4838
+ brand?: string | null;
4698
4839
  }
4699
- /** Rename of the site. Meaning, free public url has been changed as well. */
4700
- interface SiteRenamed {
4840
+ interface AuthorizationDetails {
4701
4841
  /**
4702
- * A new meta site name (URL slug).
4703
- * @maxLength 20
4842
+ * Whether the authorized payment is of a delayed capture.
4843
+ * @readonly
4704
4844
  */
4705
- newSiteName?: string;
4845
+ delayedCapture?: boolean;
4846
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4847
+ authorizedDate?: Date | null;
4706
4848
  /**
4707
- * A previous meta site name (URL slug).
4708
- * @maxLength 255
4849
+ * List of captures associated with payment
4850
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
4851
+ * @maxSize 1
4709
4852
  */
4710
- oldSiteName?: string;
4711
- }
4712
- /**
4713
- * Hard deletion of the meta site.
4714
- *
4715
- * Could not be restored. Therefore it's desirable to cleanup data.
4716
- */
4717
- interface SiteHardDeleted {
4718
- /** A deletion context. */
4719
- deleteContext?: DeleteContext;
4720
- }
4721
- interface NamespaceChanged {
4722
- /** A previous namespace. */
4723
- oldNamespace?: NamespaceWithLiterals;
4724
- /** A new namespace. */
4725
- newNamespace?: NamespaceWithLiterals;
4726
- }
4727
- /** Assigned Studio editor */
4728
- interface StudioAssigned {
4729
- }
4730
- /** Unassigned Studio editor */
4731
- interface StudioUnassigned {
4732
- }
4733
- /**
4734
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
4735
- *
4736
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
4737
- * with sites and its urls, you need to listen to another topic/event. Read about it:
4738
- *
4739
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
4740
- */
4741
- interface SiteUrlChanged {
4853
+ captures?: AuthorizationCapture[];
4854
+ /** Void associated with payment */
4855
+ void?: AuthorizationVoid;
4856
+ /** Scheduled action for this transaction */
4857
+ scheduledAction?: V1ScheduledAction;
4742
4858
  }
4743
- /**
4744
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
4745
- * Consumed by other teams to remove relevant data.
4746
- */
4747
- interface SitePurgedExternally {
4859
+ interface AuthorizationCapture {
4748
4860
  /**
4749
- * @maxLength 2048
4750
- * @maxSize 100
4751
- * @deprecated
4752
- * @targetRemovalDate 2025-04-15
4861
+ * Capture ID.
4862
+ * @format GUID
4863
+ * @readonly
4753
4864
  */
4754
- appDefId?: string[];
4755
- }
4756
- /** Assigned Odeditor */
4757
- interface OdeditorAssigned {
4758
- }
4759
- /** Unassigned Odeditor */
4760
- interface OdeditorUnassigned {
4761
- }
4762
- /** Assigned Picasso editor */
4763
- interface PicassoAssigned {
4764
- }
4765
- /** Unassigned Picasso */
4766
- interface PicassoUnassigned {
4767
- }
4768
- /** Assigned Wixel */
4769
- interface WixelAssigned {
4770
- }
4771
- /** Unassigned Wixel */
4772
- interface WixelUnassigned {
4773
- }
4774
- /** Assigned StudioTwo */
4775
- interface StudioTwoAssigned {
4776
- }
4777
- /** Unassigned StudioTwo */
4778
- interface StudioTwoUnassigned {
4779
- }
4780
- /** Media from user domain is enabled. */
4781
- interface UserDomainMediaEnabled {
4782
- }
4783
- /** Media from user domain is disabled. */
4784
- interface UserDomainMediaDisabled {
4785
- }
4786
- /** Assigned Editorless */
4787
- interface EditorlessAssigned {
4788
- }
4789
- /** Unassigned Editorless */
4790
- interface EditorlessUnassigned {
4865
+ id?: string | null;
4866
+ /** Status of this capture action */
4867
+ status?: AuthorizationCaptureStatusWithLiterals;
4868
+ /**
4869
+ * Amount of this capture
4870
+ * @immutable
4871
+ */
4872
+ amount?: Price;
4873
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4874
+ createdDate?: Date | null;
4875
+ /** In case of status is FAILED may contain failure details */
4876
+ failureDetails?: AuthorizationActionFailureDetails;
4791
4877
  }
4792
- interface HasCustomEmailConfigurationsRequest {
4878
+ declare enum AuthorizationCaptureStatus {
4879
+ /** Capture operation still in progress. */
4880
+ PENDING = "PENDING",
4881
+ /** Capture operation succeeded. */
4882
+ SUCCEEDED = "SUCCEEDED",
4883
+ /** Capture operation failed. */
4884
+ FAILED = "FAILED"
4793
4885
  }
4794
- interface HasCustomEmailConfigurationsResponse {
4795
- hasCustomConfigurations?: boolean;
4886
+ /** @enumType */
4887
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4888
+ interface AuthorizationActionFailureDetails {
4889
+ /** @maxLength 100 */
4890
+ failureCode?: string;
4796
4891
  }
4797
- interface AddToAutomationMigrationPopulationRequest {
4798
- /** When true, sends custom email configurations to automation system via email */
4799
- sendCustomEmailConfigs?: boolean;
4800
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
4801
- origin?: OriginWithLiterals;
4892
+ interface AuthorizationVoid {
4893
+ /** Status of this void action */
4894
+ status?: AuthorizationVoidStatusWithLiterals;
4895
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
4896
+ voidedDate?: Date | null;
4897
+ /** In case of status is FAILED may contain failure details */
4898
+ failureDetails?: AuthorizationActionFailureDetails;
4899
+ /** Reason of void action */
4900
+ reason?: ReasonWithLiterals;
4802
4901
  }
4803
- declare enum Origin {
4804
- OPT_IN = "OPT_IN",
4805
- MIGRATION = "MIGRATION"
4902
+ declare enum AuthorizationVoidStatus {
4903
+ /** Void operation still in progress. */
4904
+ PENDING = "PENDING",
4905
+ /** Void operation succeeded. */
4906
+ SUCCEEDED = "SUCCEEDED",
4907
+ /** Void operation failed. */
4908
+ FAILED = "FAILED"
4806
4909
  }
4807
4910
  /** @enumType */
4808
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
4809
- interface AddToAutomationMigrationPopulationResponse {
4810
- success?: boolean;
4911
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
4912
+ /** Reason the authorization was voided. */
4913
+ declare enum Reason {
4914
+ /** Authorization was voided by user. */
4915
+ MANUAL = "MANUAL",
4916
+ /** Authorization passed execution date. */
4917
+ SCHEDULED = "SCHEDULED"
4811
4918
  }
4812
- interface IsInAutomationMigrationPopulationRequest {
4919
+ /** @enumType */
4920
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
4921
+ interface V1ScheduledAction {
4922
+ /** Type of the action. */
4923
+ actionType?: ActionTypeWithLiterals;
4924
+ /** The date and time of the action. */
4925
+ executionDate?: Date | null;
4813
4926
  }
4814
- interface IsInAutomationMigrationPopulationResponse {
4815
- inPopulation?: boolean;
4927
+ declare enum ActionType {
4928
+ VOID = "VOID",
4929
+ CAPTURE = "CAPTURE"
4816
4930
  }
4817
- interface PreparePaymentCollectionRequest {
4818
- /**
4819
- * Ecom order ID.
4820
- * @minLength 1
4821
- * @maxLength 100
4822
- */
4823
- ecomOrderId: string;
4824
- /** Amount to collect */
4825
- amount: Price;
4826
- /**
4827
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4828
- * Existing payment gateway order will be updated with a new amount.
4829
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4830
- */
4831
- paymentGatewayOrderId?: string | null;
4931
+ /** @enumType */
4932
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
4933
+ interface Chargeback {
4832
4934
  /**
4833
- * Whether to delay capture of the payment.
4834
- * Default: false
4835
- * @deprecated Whether to delay capture of the payment.
4836
- * Default: false
4837
- * @replacedBy delayed_capture_settings.scheduled_action
4838
- * @targetRemovalDate 2024-09-30
4935
+ * Chargeback ID.
4936
+ * @format GUID
4937
+ * @readonly
4938
+ * @immutable
4839
4939
  */
4840
- delayedCapture?: boolean;
4841
- /** Delayed capture payment settings */
4842
- delayedCaptureSettings?: DelayedCaptureSettings;
4843
- }
4844
- interface RedirectUrls {
4940
+ id?: string;
4845
4941
  /**
4846
- * URL to redirect buyer in case of approved (successful) transaction
4847
- * @format WEB_URL
4942
+ * 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.
4943
+ * @readonly
4944
+ * @immutable
4848
4945
  */
4849
- successUrl?: string | null;
4946
+ createdDate?: Date | null;
4850
4947
  /**
4851
- * URL to redirect buyer in case of buyer canceled the transaction
4852
- * @format WEB_URL
4948
+ * 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.
4949
+ * @readonly
4853
4950
  */
4854
- cancelUrl?: string | null;
4951
+ updatedDate?: Date | null;
4855
4952
  /**
4856
- * URL to redirect buyer in case of failed/rejected transaction
4857
- * @format WEB_URL
4953
+ * Amount.
4954
+ * @readonly
4955
+ * @immutable
4858
4956
  */
4859
- errorUrl?: string | null;
4957
+ amount?: Price;
4860
4958
  /**
4861
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4862
- * @format WEB_URL
4959
+ * Reversal amount. Present only when status is REVERSED.
4960
+ * @readonly
4863
4961
  */
4864
- pendingUrl?: string | null;
4865
- }
4866
- interface DelayedCaptureSettings {
4867
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4868
- scheduledAction?: ScheduledActionWithLiterals;
4869
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4870
- delayDuration?: Duration;
4871
- }
4872
- declare enum ScheduledAction {
4873
- /** Whether payment will be auto-voided when duration passes */
4874
- VOID = "VOID",
4875
- /** Whether payment will be auto-captured when duration passes */
4876
- CAPTURE = "CAPTURE"
4877
- }
4878
- /** @enumType */
4879
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4880
- interface Duration {
4962
+ reversalAmount?: Price;
4881
4963
  /**
4882
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4883
- * @min 1
4964
+ * Status.
4965
+ *
4966
+ * Default: `"APPROVED"`.
4884
4967
  */
4885
- count?: number;
4886
- /** Duration unit: MINUTES, HOURS and DAYS */
4887
- unit?: DurationUnitWithLiterals;
4888
- }
4889
- declare enum DurationUnit {
4890
- MINUTES = "MINUTES",
4891
- HOURS = "HOURS",
4892
- DAYS = "DAYS"
4893
- }
4894
- /** @enumType */
4895
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4896
- interface PreparePaymentCollectionResponse {
4897
- /** Payment gateway order id which is associated with given payment */
4898
- paymentGatewayOrderId?: string;
4899
- }
4900
- interface GetPaymentCollectabilityStatusRequest {
4968
+ status?: ChargebackStatusWithLiterals;
4901
4969
  /**
4902
- * Ecom order ID.
4903
- * @minLength 1
4904
- * @maxLength 100
4970
+ * External chargeback ID.
4971
+ * @format GUID
4972
+ * @readonly
4973
+ * @immutable
4905
4974
  */
4906
- ecomOrderId: string;
4907
- }
4908
- interface GetPaymentCollectabilityStatusResponse {
4909
- /** Payment collectability status */
4910
- status?: PaymentCollectabilityStatusWithLiterals;
4911
- /** Collectable order amount */
4912
- amount?: Price;
4975
+ externalId?: string | null;
4913
4976
  }
4914
- declare enum PaymentCollectabilityStatus {
4915
- UNKNOWN = "UNKNOWN",
4916
- COLLECTABLE = "COLLECTABLE",
4917
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4918
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4919
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4920
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4921
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4922
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4923
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4924
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4925
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4926
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4927
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4977
+ declare enum ChargebackStatus {
4978
+ /** Chargeback was approved. */
4979
+ APPROVED = "APPROVED",
4980
+ /** Chargeback was reversed. */
4981
+ REVERSED = "REVERSED"
4928
4982
  }
4929
4983
  /** @enumType */
4930
- 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';
4931
- interface RecordManuallyCollectedPaymentRequest {
4932
- /**
4933
- * Order ID.
4934
- * @minLength 1
4935
- * @maxLength 100
4936
- */
4937
- orderId: string;
4938
- /** Amount to be recorded as approved manual payment for given order */
4939
- amount: Price;
4940
- }
4941
- /**
4942
- * User-defined payment method name.
4943
- * Allows specifying either a predefined type or a custom name.
4944
- */
4945
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4946
- /** Predefined payment method. */
4947
- predefined?: PredefinedPaymentMethodWithLiterals;
4984
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
4985
+ interface PaymentMethodName {
4948
4986
  /**
4949
- * Custom payment method name provided by user.
4950
- *
4951
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4952
- * @minLength 1
4987
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
4953
4988
  * @maxLength 150
4954
4989
  */
4955
- custom?: string | null;
4956
- }
4957
- /** @oneof */
4958
- interface UserDefinedPaymentMethodNameKindOneOf {
4959
- /** Predefined payment method. */
4960
- predefined?: PredefinedPaymentMethodWithLiterals;
4990
+ buyerLanguageName?: string | null;
4961
4991
  /**
4962
- * Custom payment method name provided by user.
4992
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
4963
4993
  *
4964
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4965
- * @minLength 1
4994
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
4966
4995
  * @maxLength 150
4967
4996
  */
4968
- custom?: string | null;
4969
- }
4970
- /** Predefined payment method types for offline/manual payments. */
4971
- declare enum PredefinedPaymentMethod {
4972
- /** Cash payment. */
4973
- CASH = "CASH",
4974
- /** Bank transfer. */
4975
- BANK_TRANSFER = "BANK_TRANSFER",
4976
- /** Payment by check. */
4977
- CHECK = "CHECK"
4978
- }
4979
- /** @enumType */
4980
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4981
- interface RecordManuallyCollectedPaymentResponse {
4982
- }
4983
- interface MarkOrderAsPaidRequest {
4997
+ siteLanguageName?: string | null;
4984
4998
  /**
4985
- * Ecom order ID.
4986
- * @minLength 1
4987
- * @maxLength 100
4999
+ * User-provided payment method name.
5000
+ *
5001
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
4988
5002
  */
4989
- ecomOrderId: string;
4990
- }
4991
- interface MarkOrderAsPaidResponse {
4992
- /** Updated order. */
4993
- order?: Order;
5003
+ userDefinedName?: UserDefinedPaymentMethodName;
4994
5004
  }
4995
- interface BulkMarkOrdersAsPaidRequest {
5005
+ interface GiftCardPaymentDetails {
4996
5006
  /**
4997
- * IDs of orders to mark as paid.
4998
- * @minSize 1
4999
- * @maxSize 100
5000
- * @minLength 1
5007
+ * Gift card payment ID.
5001
5008
  * @maxLength 100
5002
5009
  */
5003
- ecomOrderIds: string[];
5004
- }
5005
- interface BulkMarkOrdersAsPaidResponse {
5010
+ giftCardPaymentId?: string;
5006
5011
  /**
5007
- * Items updated by the bulk action.
5008
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5012
+ * ID of the app that created the gift card.
5013
+ * @format GUID
5009
5014
  */
5010
- results?: BulkOrderResult[];
5011
- /** Bulk action metadata. */
5012
- bulkActionMetadata?: BulkActionMetadata;
5013
- }
5014
- interface BulkOrderResult {
5015
- /** Item metadata. */
5016
- itemMetadata?: ItemMetadata;
5015
+ appId?: string;
5017
5016
  /**
5018
- * Updated order.
5019
- *
5020
- * Returned when `returnFullEntity = true`.
5021
- */
5022
- item?: Order;
5023
- }
5024
- interface ItemMetadata {
5025
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5026
- id?: string | null;
5027
- /** Index of the item within the request array. Allows for correlation between request and response items. */
5028
- originalIndex?: number;
5029
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5030
- success?: boolean;
5031
- /** Details about the error in case of failure. */
5032
- error?: ApplicationError;
5033
- }
5034
- interface ApplicationError {
5035
- /** Error code. */
5036
- code?: string;
5037
- /** Description of the error. */
5038
- description?: string;
5039
- /** Data related to the error. */
5040
- data?: Record<string, any> | null;
5041
- }
5042
- interface BulkActionMetadata {
5043
- /** Number of items that were successfully processed. */
5044
- totalSuccesses?: number;
5045
- /** Number of items that couldn't be processed. */
5046
- totalFailures?: number;
5047
- /** Number of failures without details because detailed failure threshold was exceeded. */
5048
- undetailedFailures?: number;
5017
+ * Whether the gift card is voided.
5018
+ * @readonly
5019
+ * @deprecated Whether the gift card is voided.
5020
+ * @replacedBy payment.status
5021
+ * @targetRemovalDate 2026-11-01
5022
+ */
5023
+ voided?: boolean;
5024
+ /**
5025
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5026
+ * @maxLength 30
5027
+ * @immutable
5028
+ */
5029
+ obfuscatedCode?: string | null;
5049
5030
  }
5050
- interface GetRefundabilityStatusRequest {
5031
+ interface MembershipPaymentDetails {
5051
5032
  /**
5052
- * Order ID.
5033
+ * Membership ID.
5034
+ * @maxLength 200
5035
+ */
5036
+ membershipId?: string;
5037
+ /**
5038
+ * ID of the line item this membership applies to.
5053
5039
  * @minLength 1
5054
5040
  * @maxLength 100
5055
5041
  */
5056
- ecomOrderId: string;
5057
- }
5058
- interface GetRefundabilityStatusResponse {
5042
+ lineItemId?: string;
5059
5043
  /**
5060
- * Refundability details.
5061
- * @maxSize 300
5044
+ * Payment status.
5045
+ * @deprecated Payment status.
5046
+ * @replacedBy payment.status
5047
+ * @targetRemovalDate 2026-11-01
5062
5048
  */
5063
- refundabilities?: Refundability[];
5049
+ status?: MembershipPaymentStatusWithLiterals;
5050
+ /** Membership name. */
5051
+ name?: MembershipName;
5064
5052
  /**
5065
- * Whether the order supports refunding per item.
5066
- * @deprecated
5053
+ * The transaction ID in the membership system. Can be used to void the transaction.
5054
+ * @minLength 1
5055
+ * @maxLength 100
5067
5056
  */
5068
- refundablePerItem?: boolean;
5069
- }
5070
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5071
- /** Reason why payment is not refundable. */
5072
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5073
- /** Reason why payment is only refundable manually. */
5074
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5075
- /** Payment ID. */
5076
- paymentId?: string;
5077
- /** Payment refundability status. */
5078
- refundabilityStatus?: RefundableStatusWithLiterals;
5079
- /** Link to payment provider dashboard. */
5080
- providerLink?: string | null;
5081
- }
5082
- /** @oneof */
5083
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
5084
- /** Reason why payment is not refundable. */
5085
- nonRefundableReason?: NonRefundableReasonWithLiterals;
5086
- /** Reason why payment is only refundable manually. */
5087
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5088
- }
5089
- declare enum RefundableStatus {
5090
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
5091
- MANUAL = "MANUAL",
5092
- REFUNDABLE = "REFUNDABLE"
5093
- }
5094
- /** @enumType */
5095
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5096
- declare enum NonRefundableReason {
5097
- NONE = "NONE",
5098
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
5099
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5100
- INTERNAL_ERROR = "INTERNAL_ERROR",
5101
- NOT_PAID = "NOT_PAID",
5102
- ACCESS_DENIED = "ACCESS_DENIED",
5103
- ZERO_PRICE = "ZERO_PRICE",
5104
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5105
- PENDING_REFUND = "PENDING_REFUND",
5106
- FORBIDDEN = "FORBIDDEN",
5107
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5108
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
5109
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5057
+ externalTransactionId?: string | null;
5058
+ /**
5059
+ * Whether the membership is voided.
5060
+ * @readonly
5061
+ * @deprecated Whether the membership is voided.
5062
+ * @replacedBy payment.status
5063
+ * @targetRemovalDate 2026-11-01
5064
+ */
5065
+ voided?: boolean;
5066
+ /**
5067
+ * ID of the application providing this payment option.
5068
+ * @format GUID
5069
+ */
5070
+ providerAppId?: string;
5071
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5072
+ futureMembership?: FutureMembershipDetails;
5110
5073
  }
5111
- /** @enumType */
5112
- 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';
5113
- declare enum ManuallyRefundableReason {
5114
- EXPIRED = "EXPIRED",
5115
- NOT_SUPPORTED = "NOT_SUPPORTED",
5116
- OFFLINE = "OFFLINE",
5117
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5074
+ declare enum MembershipPaymentStatus {
5075
+ /** Payment was charged. */
5076
+ CHARGED = "CHARGED",
5077
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
5078
+ CHARGE_FAILED = "CHARGE_FAILED",
5079
+ /** Payment is pending. */
5080
+ CHARGE_PENDING = "CHARGE_PENDING",
5081
+ /** Payment was voided. */
5082
+ VOIDED = "VOIDED"
5118
5083
  }
5119
5084
  /** @enumType */
5120
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5121
- interface CreatePaymentGatewayOrderRequest {
5085
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5086
+ interface FutureMembershipDetails {
5122
5087
  /**
5123
- * Ecom order ID.
5124
- * @minLength 1
5125
- * @maxLength 100
5088
+ * ID of the plan line item in the order from which the membership will be created.
5089
+ * @format GUID
5126
5090
  */
5127
- ecomOrderId: string;
5128
- /** Information about the user who initiated the payment. */
5129
- chargedBy?: ChargedBy;
5091
+ lineItemId?: string;
5092
+ /**
5093
+ * ID of the benefit the future membership will grant.
5094
+ * @maxLength 200
5095
+ */
5096
+ benefitId?: string;
5130
5097
  }
5131
- interface ChargedBy {
5098
+ interface WixReceiptInfo {
5132
5099
  /**
5133
- * ID - id of the user who initiated the payment
5100
+ * Receipt ID
5134
5101
  * @format GUID
5135
5102
  */
5136
- id?: string;
5103
+ receiptId?: string;
5137
5104
  /**
5138
- * Full name - name of the user who initiated the payment
5105
+ * Display number of receipt
5139
5106
  * @minLength 1
5140
- * @maxLength 200
5107
+ * @maxLength 40
5141
5108
  */
5142
- fullName?: string | null;
5143
- }
5144
- interface CreatePaymentGatewayOrderResponse {
5145
- /** ID of the order created in the payment gateway */
5146
- paymentGatewayOrderId?: string;
5109
+ displayNumber?: string | null;
5147
5110
  }
5148
- interface ChargeMembershipsRequest {
5111
+ interface ExternalReceiptInfo {
5149
5112
  /**
5150
- * Order ID.
5151
- * @minLength 1
5113
+ * External receipt ID
5152
5114
  * @maxLength 100
5153
5115
  */
5154
- ecomOrderId: string;
5116
+ receiptId?: string | null;
5155
5117
  /**
5156
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5157
- * but a user which is using the membership on behalf of the a member
5118
+ * ID of the app providing the receipt
5158
5119
  * @format GUID
5159
5120
  */
5160
- memberId: string;
5121
+ appId?: string | null;
5161
5122
  /**
5162
- * List of items to be paid by memberships
5163
- * @minSize 1
5164
- * @maxSize 300
5123
+ * Display number of receipt
5124
+ * @minLength 1
5125
+ * @maxLength 40
5165
5126
  */
5166
- membershipCharges?: MembershipChargeItem[];
5127
+ displayNumber?: string | null;
5167
5128
  }
5168
- interface MembershipChargeItem {
5129
+ interface CashRoundingDetails {
5169
5130
  /**
5170
- * The id of used membership
5171
- * @minLength 1
5172
- * @maxLength 100
5131
+ * Payment amount before cash rounding was applied.
5132
+ * When provided, balance and status calculations use this value instead of `amount`
5133
+ * to prevent false overpayment or underpayment due to rounding.
5173
5134
  */
5174
- membershipId?: string;
5135
+ unroundedAmount?: Price;
5175
5136
  /**
5176
- * ID of the application providing this payment option
5137
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5138
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5139
+ * @readonly
5140
+ */
5141
+ roundingAdjustment?: CashRounding;
5142
+ }
5143
+ declare enum PaymentStatus {
5144
+ /** Payment was charged successfully. */
5145
+ APPROVED = "APPROVED",
5146
+ /** Payment is being processed and hasn't been confirmed yet. */
5147
+ PENDING = "PENDING",
5148
+ /** 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. */
5149
+ PENDING_MERCHANT = "PENDING_MERCHANT",
5150
+ /** Payment was canceled before it was charged. */
5151
+ CANCELED = "CANCELED",
5152
+ /** Payment was declined by the payment provider. */
5153
+ DECLINED = "DECLINED",
5154
+ /** Payment was fully refunded. */
5155
+ REFUNDED = "REFUNDED",
5156
+ /** Part of the payment amount was refunded. */
5157
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5158
+ /** 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. */
5159
+ AUTHORIZED = "AUTHORIZED",
5160
+ /**
5161
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5162
+ *
5163
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5164
+ */
5165
+ VOIDED = "VOIDED"
5166
+ }
5167
+ /** @enumType */
5168
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5169
+ interface CanceledStatusDetails {
5170
+ reason?: CanceledReasonWithLiterals;
5171
+ }
5172
+ declare enum CanceledReason {
5173
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
5174
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5175
+ /** Payment was not completed by user and expired. */
5176
+ EXPIRED = "EXPIRED"
5177
+ }
5178
+ /** @enumType */
5179
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5180
+ interface DeclinedStatusDetails {
5181
+ reason?: DeclinedReasonWithLiterals;
5182
+ }
5183
+ declare enum DeclinedReason {
5184
+ /** Corresponding charge failed. */
5185
+ CHARGE_FAILED = "CHARGE_FAILED",
5186
+ /** Payment details expired. */
5187
+ EXPIRED = "EXPIRED",
5188
+ /** Insufficient funds. */
5189
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5190
+ /** Gift card was disabled before charge was attempted. */
5191
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5192
+ }
5193
+ /** @enumType */
5194
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5195
+ interface VoidedStatusDetails {
5196
+ reason?: VoidedReasonWithLiterals;
5197
+ }
5198
+ declare enum VoidedReason {
5199
+ /** Payment was voided by merchant request. */
5200
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
5201
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5202
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5203
+ }
5204
+ /** @enumType */
5205
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5206
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5207
+ }
5208
+ /** @oneof */
5209
+ interface PaymentStatusDetailsStatusDetailsOneOf {
5210
+ }
5211
+ interface Refund {
5212
+ /**
5213
+ * Refund ID.
5177
5214
  * @format GUID
5215
+ * @readonly
5178
5216
  */
5179
- appId?: string;
5180
- /** The name of used membership */
5181
- membershipName?: MembershipName;
5182
- /** Additional data about this membership */
5183
- membershipAdditionalData?: Record<string, any> | null;
5184
- /** Catalog and item reference info. */
5185
- catalogReference?: CatalogReference;
5186
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5187
- serviceProperties?: ServiceProperties;
5217
+ id?: string;
5188
5218
  /**
5189
- * Usually would be the same as catalogReference.catalogItemId
5190
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5191
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5192
- * @minLength 1
5193
- * @maxLength 36
5219
+ * List of transactions.
5220
+ * @maxSize 50
5194
5221
  */
5195
- rootCatalogItemId?: string | null;
5222
+ transactions?: RefundTransaction[];
5223
+ /** Refund business details. */
5224
+ details?: RefundDetails;
5196
5225
  /**
5197
- * line item id of Checkout/Order line item
5198
- * @minLength 1
5199
- * @maxLength 100
5226
+ * 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.
5227
+ * @readonly
5228
+ * @immutable
5200
5229
  */
5201
- lineItemId?: string;
5202
- }
5203
- interface MembershipName {
5230
+ createdDate?: Date | null;
5204
5231
  /**
5205
- * Membership name in the site's original language.
5206
- * @maxLength 100
5232
+ * Aggregated refund summary.
5233
+ * @readonly
5207
5234
  */
5208
- original?: string;
5235
+ summary?: AggregatedRefundSummary;
5209
5236
  /**
5210
- * Membership name translated into the buyer's language.
5211
- *
5212
- * Default: The value of `original`
5213
- * @maxLength 100
5237
+ * ID of the app that initiated this refund.
5238
+ * @format GUID
5239
+ * @readonly
5240
+ * @immutable
5214
5241
  */
5215
- translated?: string | null;
5216
- }
5217
- interface ChargeMembershipsResponse {
5242
+ requestingServiceAppId?: string | null;
5218
5243
  }
5219
- interface TriggerRefundRequest {
5244
+ interface RefundTransaction {
5220
5245
  /**
5221
- * The order this refund related to
5222
- * @minLength 1
5223
- * @maxLength 100
5246
+ * ID of the payment associated with this refund.
5247
+ * @format GUID
5248
+ * @immutable
5224
5249
  */
5225
- ecomOrderId: string;
5250
+ paymentId?: string;
5226
5251
  /**
5227
- * Refund operations information
5228
- * @minSize 1
5229
- * @maxSize 1
5252
+ * Refund amount.
5253
+ * @immutable
5230
5254
  */
5231
- payments: PaymentRefund[];
5232
- /** Business model of a refund */
5233
- details?: RefundDetails;
5234
- /** Side effect details related to refund */
5235
- sideEffects?: RefundSideEffects;
5236
- }
5237
- interface PaymentRefund {
5255
+ amount?: Price;
5256
+ /** Refund status. */
5257
+ refundStatus?: RefundStatusWithLiterals;
5258
+ /** Optional details of current refund status. */
5259
+ refundStatusInfo?: RefundStatusInfo;
5238
5260
  /**
5239
- * Specific payment within the order to refund
5261
+ * Payment gateway's refund ID.
5262
+ * This field is only returned when the value of `external_refund` is `false`.
5240
5263
  * @format GUID
5241
5264
  */
5242
- paymentId?: string;
5243
- /** Refund amount. Not relevant for membership and gift card refunds. */
5244
- amount?: Price;
5265
+ gatewayRefundId?: string | null;
5266
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5267
+ providerRefundId?: string | null;
5245
5268
  /**
5246
- * Whether refund is made externally and manually (on the payment provider's side)
5247
- * 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.
5248
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5269
+ * Whether refund was made externally and manually on the payment provider's side.
5270
+ * @immutable
5249
5271
  */
5250
5272
  externalRefund?: boolean;
5251
5273
  }
5252
- interface RefundSideEffects {
5253
- /** Inventory restock details as part of this refund. */
5254
- restockInfo?: RestockInfo;
5255
- /** Whether to send a refund confirmation email to the customer. */
5256
- sendOrderRefundedEmail?: boolean;
5274
+ /** Refund transaction status. */
5275
+ declare enum RefundStatus {
5276
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5277
+ PENDING = "PENDING",
5278
+ /** Refund transaction succeeded. */
5279
+ SUCCEEDED = "SUCCEEDED",
5280
+ /** Refund transaction failed. */
5281
+ FAILED = "FAILED",
5282
+ /** Refund request acknowledged, and will be executed soon. */
5283
+ SCHEDULED = "SCHEDULED",
5284
+ /** Refund was initiated on payment provider side. */
5285
+ STARTED = "STARTED"
5286
+ }
5287
+ /** @enumType */
5288
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5289
+ interface RefundStatusInfo {
5257
5290
  /**
5258
- * Custom message added to the refund confirmation email.
5291
+ * Reason code for the refund's current status.
5292
+ *
5293
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5294
+ * @minLength 1
5295
+ * @maxLength 10
5296
+ */
5297
+ paymentGatewayReasonCode?: string | null;
5298
+ /**
5299
+ * Free text explanation of current refund status.
5259
5300
  * @minLength 1
5260
5301
  * @maxLength 1000
5261
5302
  */
5262
- customMessage?: string | null;
5303
+ description?: string | null;
5263
5304
  }
5264
- interface RestockInfo {
5265
- /** Restock type. */
5266
- type?: RestockTypeWithLiterals;
5305
+ interface AggregatedRefundSummary {
5306
+ /** Total amount requested for refund. */
5307
+ requestedRefund?: Price;
5308
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5309
+ pendingRefund?: Price;
5310
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5311
+ refunded?: Price;
5312
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
5313
+ failedRefundAmount?: Price;
5314
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
5315
+ pending?: boolean;
5316
+ /** Breakdown of refunded items. Available only after refund is complete. */
5317
+ breakdown?: RefundItemsBreakdown;
5318
+ }
5319
+ interface RefundItemsBreakdown {
5267
5320
  /**
5268
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5321
+ * Refunded line items and the amount refunded for each.
5269
5322
  * @maxSize 300
5270
5323
  */
5271
- items?: RestockItem[];
5272
- }
5273
- declare enum RestockType {
5274
- NO_ITEMS = "NO_ITEMS",
5275
- ALL_ITEMS = "ALL_ITEMS",
5276
- SOME_ITEMS = "SOME_ITEMS"
5324
+ lineItems?: LineItemRefundSummary[];
5277
5325
  }
5278
- /** @enumType */
5279
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5280
- interface RestockItem {
5326
+ interface LineItemRefundSummary {
5281
5327
  /**
5282
- * ID of the line item being restocked.
5328
+ * ID of the refunded line item.
5283
5329
  * @format GUID
5284
5330
  */
5285
5331
  lineItemId?: string;
5286
- /**
5287
- * Line item quantity being restocked.
5288
- * @min 1
5289
- * @max 100000
5290
- */
5291
- quantity?: number;
5292
- }
5293
- interface TriggerRefundResponse {
5294
- /** All order's transactions after the refunds were added */
5295
- orderTransactions?: OrderTransactions;
5296
- /** Created refund ID */
5297
- refundId?: string | null;
5298
- /** Payment ID's that the refund execution had failed for */
5299
- failedPaymentIds?: ItemMetadata[];
5332
+ /** Total refunded amount for the line item. */
5333
+ totalRefundedAmount?: Price;
5300
5334
  }
5301
- /**
5302
- * A record of all payments and refunds associated with an order.
5303
- *
5304
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5305
- */
5306
- interface OrderTransactions {
5307
- /**
5308
- * Order ID.
5309
- * @format GUID
5310
- */
5311
- orderId?: string;
5335
+ interface CalculateRefundRequest {
5312
5336
  /**
5313
- * Record of payments made to the merchant.
5314
- * @maxSize 100
5337
+ * Order ID
5338
+ * @minLength 1
5339
+ * @maxLength 100
5315
5340
  */
5316
- payments?: Payment[];
5341
+ ecomOrderId?: string;
5317
5342
  /**
5318
- * Record of refunds made to the buyer.
5343
+ * Refunded line items and quantity
5319
5344
  * @maxSize 300
5320
5345
  */
5321
- refunds?: Refund[];
5346
+ refundItems?: CalculateRefundItemRequest[];
5347
+ /** Should include shipping in refund calculation */
5348
+ refundShipping?: boolean;
5322
5349
  }
5323
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5324
- /** Regular payment details. */
5325
- regularPaymentDetails?: RegularPaymentDetails;
5326
- /** Gift card payment details. */
5327
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5328
- /** Membership payment details. */
5329
- membershipPaymentDetails?: MembershipPaymentDetails;
5350
+ interface CalculateRefundItemRequest {
5330
5351
  /**
5331
- * Payment ID.
5352
+ * ID of the line item being refunded
5332
5353
  * @format GUID
5333
- * @readonly
5334
- */
5335
- id?: string | null;
5336
- /** 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. */
5337
- createdDate?: Date | null;
5338
- /**
5339
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5340
- * @readonly
5341
- */
5342
- updatedDate?: Date | null;
5343
- /** Payment amount. */
5344
- amount?: Price;
5345
- /**
5346
- * Whether refunds for this payment are disabled.
5347
- * + `true`: This payment is not refundable.
5348
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5349
5354
  */
5350
- refundDisabled?: boolean;
5351
- /**
5352
- * Whether receipt generation is allowed for this payment.
5353
- * + `true`: This payment supports receipt generation.
5354
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5355
- * @readonly
5356
- */
5357
- supportReceiptGeneration?: boolean;
5358
- /** Details about cash rounding applied to this payment, when relevant. */
5359
- cashRounding?: CashRoundingDetails;
5355
+ id?: string;
5360
5356
  /**
5361
- * Overall payment status.
5362
- *
5363
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5357
+ * How much of that line item is being refunded
5358
+ * @min 1
5359
+ * @max 100000
5364
5360
  */
5365
- status?: PaymentStatusWithLiterals;
5361
+ quantity?: number;
5362
+ }
5363
+ interface CalculateRefundResponse {
5364
+ /** Total refundable amount */
5365
+ total?: Price;
5366
+ /** Tax cost of the order */
5367
+ tax?: Price;
5368
+ /** Discount given for this order */
5369
+ discount?: Price;
5370
+ /** Total cost of the order (without tax) */
5371
+ subtotal?: Price;
5372
+ /** Total shipping cost for order */
5373
+ shipping?: Price;
5374
+ /** Previous refund given on that order */
5375
+ previouslyRefundedAmount?: Price;
5366
5376
  /**
5367
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5368
- * @format GUID
5377
+ * The refundable items of that order
5378
+ * @maxSize 300
5369
5379
  */
5370
- chargeCorrelationId?: string | null;
5371
- }
5372
- /** @oneof */
5373
- interface PaymentPaymentDetailsOneOf {
5374
- /** Regular payment details. */
5375
- regularPaymentDetails?: RegularPaymentDetails;
5376
- /** Gift card payment details. */
5377
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5378
- /** Membership payment details. */
5379
- membershipPaymentDetails?: MembershipPaymentDetails;
5380
- }
5381
- /** @oneof */
5382
- interface PaymentReceiptInfoOneOf {
5383
- }
5384
- /** @oneof */
5385
- interface PaymentStatusDetailsOneOf {
5380
+ items?: CalculateRefundItemResponse[];
5386
5381
  }
5387
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5388
- /** Credit card details. */
5389
- creditCardDetails?: CreditCardPaymentMethodDetails;
5382
+ interface CalculateRefundItemResponse {
5390
5383
  /**
5391
- * Wix Payments order ID.
5392
- * @maxLength 100
5384
+ * Line item ID
5385
+ * @format GUID
5393
5386
  */
5394
- paymentOrderId?: string | null;
5387
+ id?: string;
5388
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5389
+ price?: Price;
5390
+ }
5391
+ interface VoidAuthorizedPaymentsRequest {
5395
5392
  /**
5396
- * Payment gateway's transaction ID.
5397
- * This field is only returned when the value of `offline_payment` is `false`.
5393
+ * Wix eCommerce order ID
5394
+ * @minLength 1
5398
5395
  * @maxLength 100
5399
5396
  */
5400
- gatewayTransactionId?: string | null;
5397
+ ecomOrderId: string;
5401
5398
  /**
5402
- * Payment method.
5403
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5404
- * Non-exhaustive list of supported values:
5405
- * + `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`
5406
- * @maxLength 150
5407
- * @deprecated Payment method.
5408
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5409
- * Non-exhaustive list of supported values:
5410
- * + `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`
5411
- * @replacedBy payment_method_name
5412
- * @targetRemovalDate 2026-07-01
5399
+ * Payment IDs
5400
+ * @minSize 1
5401
+ * @maxSize 100
5402
+ * @format GUID
5413
5403
  */
5414
- paymentMethod?: string | null;
5404
+ paymentIds: string[];
5405
+ }
5406
+ interface VoidAuthorizedPaymentsResponse {
5407
+ /** All order's transactions after the void was triggered */
5408
+ orderTransactions?: OrderTransactions;
5409
+ }
5410
+ interface CaptureAuthorizedPaymentsRequest {
5415
5411
  /**
5416
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5412
+ * Wix eCommerce order ID
5413
+ * @minLength 1
5417
5414
  * @maxLength 100
5418
5415
  */
5419
- providerTransactionId?: string | null;
5420
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5421
- offlinePayment?: boolean;
5416
+ ecomOrderId: string;
5422
5417
  /**
5423
- * Payment status.
5424
- * @deprecated Payment status.
5425
- * @replacedBy payment.status
5426
- * @targetRemovalDate 2026-11-01
5418
+ * Capture payments information
5419
+ * @minSize 1
5420
+ * @maxSize 100
5427
5421
  */
5428
- status?: TransactionStatusWithLiterals;
5429
- /** Whether there is a payment agreement that allows for future charges. */
5430
- savedPaymentMethod?: boolean;
5431
- /** Authorization details. */
5432
- authorizationDetails?: AuthorizationDetails;
5422
+ payments: PaymentCapture[];
5423
+ }
5424
+ interface PaymentCapture {
5433
5425
  /**
5434
- * Record of chargebacks made by the buyer.
5435
- * @maxSize 6
5426
+ * Payment ID
5427
+ * @format GUID
5436
5428
  */
5437
- chargebacks?: Chargeback[];
5438
- /** Platform fee amount associated with this payment. */
5439
- platformFee?: Price;
5429
+ paymentId?: string | null;
5440
5430
  /**
5441
- * Payment method with buyer and optional owner translations.
5442
- * Non-exhaustive list of supported values:
5443
- * + `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`
5431
+ * Capture amount.
5432
+ * If not provided - full authorized amount will be captured.
5444
5433
  */
5445
- paymentMethodName?: PaymentMethodName;
5446
- }
5447
- /** @oneof */
5448
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5449
- /** Credit card details. */
5450
- creditCardDetails?: CreditCardPaymentMethodDetails;
5434
+ amount?: Price;
5451
5435
  }
5452
- declare enum TransactionStatus {
5453
- UNDEFINED = "UNDEFINED",
5454
- APPROVED = "APPROVED",
5455
- PENDING = "PENDING",
5456
- PENDING_MERCHANT = "PENDING_MERCHANT",
5457
- CANCELED = "CANCELED",
5458
- DECLINED = "DECLINED",
5459
- REFUNDED = "REFUNDED",
5460
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5461
- AUTHORIZED = "AUTHORIZED",
5462
- VOIDED = "VOIDED"
5436
+ interface CaptureAuthorizedPaymentsResponse {
5437
+ /** All order's transactions after the capture was triggered */
5438
+ orderTransactions?: OrderTransactions;
5463
5439
  }
5464
- /** @enumType */
5465
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5466
- interface CreditCardPaymentMethodDetails {
5467
- /**
5468
- * The last 4 digits of the card number.
5469
- * @maxLength 4
5470
- */
5471
- lastFourDigits?: string | null;
5440
+ interface ChargeSavedPaymentMethodRequest {
5472
5441
  /**
5473
- * Card issuer's brand.
5442
+ * Ecom Order ID.
5443
+ * @minLength 1
5474
5444
  * @maxLength 100
5475
5445
  */
5476
- brand?: string | null;
5446
+ ecomOrderId?: string;
5447
+ /** Amount to be charged */
5448
+ amount?: Price;
5477
5449
  }
5478
- interface AuthorizationDetails {
5479
- /**
5480
- * Whether the authorized payment is of a delayed capture.
5481
- * @readonly
5482
- */
5483
- delayedCapture?: boolean;
5484
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5485
- authorizedDate?: Date | null;
5450
+ interface ChargeSavedPaymentMethodResponse {
5451
+ /** Payment gateway's order ID (e.g Wix Payments) */
5452
+ paymentGatewayOrderId?: string;
5453
+ }
5454
+ interface SendBuyerConfirmationEmailRequest {
5455
+ /** @format GUID */
5456
+ orderId?: string;
5457
+ }
5458
+ interface SendBuyerConfirmationEmailResponse {
5459
+ }
5460
+ interface SendBuyerPaymentsReceivedEmailRequest {
5486
5461
  /**
5487
- * List of captures associated with payment
5488
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5489
- * @maxSize 1
5462
+ * @minLength 1
5463
+ * @maxLength 100
5490
5464
  */
5491
- captures?: AuthorizationCapture[];
5492
- /** Void associated with payment */
5493
- void?: AuthorizationVoid;
5494
- /** Scheduled action for this transaction */
5495
- scheduledAction?: V1ScheduledAction;
5465
+ orderId?: string;
5496
5466
  }
5497
- interface AuthorizationCapture {
5467
+ interface SendBuyerPaymentsReceivedEmailResponse {
5468
+ }
5469
+ interface SendBuyerPickupConfirmationEmailRequest {
5498
5470
  /**
5499
- * Capture ID.
5500
- * @format GUID
5501
- * @readonly
5471
+ * @minLength 1
5472
+ * @maxLength 100
5502
5473
  */
5503
- id?: string | null;
5504
- /** Status of this capture action */
5505
- status?: AuthorizationCaptureStatusWithLiterals;
5474
+ orderId?: string;
5475
+ }
5476
+ interface SendBuyerPickupConfirmationEmailResponse {
5477
+ }
5478
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
5506
5479
  /**
5507
- * Amount of this capture
5508
- * @immutable
5480
+ * IDs of orders to send pickup emails for.
5481
+ * @minSize 1
5482
+ * @maxSize 300
5509
5483
  */
5510
- amount?: Price;
5511
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5512
- createdDate?: Date | null;
5513
- /** In case of status is FAILED may contain failure details */
5514
- failureDetails?: AuthorizationActionFailureDetails;
5484
+ orderIds?: string[];
5515
5485
  }
5516
- declare enum AuthorizationCaptureStatus {
5517
- /** Capture operation still in progress. */
5518
- PENDING = "PENDING",
5519
- /** Capture operation succeeded. */
5520
- SUCCEEDED = "SUCCEEDED",
5521
- /** Capture operation failed. */
5522
- FAILED = "FAILED"
5486
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
5523
5487
  }
5524
- /** @enumType */
5525
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5526
- interface AuthorizationActionFailureDetails {
5527
- /** @maxLength 100 */
5528
- failureCode?: string;
5488
+ interface SendBuyerShippingConfirmationEmailRequest {
5489
+ /**
5490
+ * @minLength 1
5491
+ * @maxLength 100
5492
+ */
5493
+ orderId?: string;
5529
5494
  }
5530
- interface AuthorizationVoid {
5531
- /** Status of this void action */
5532
- status?: AuthorizationVoidStatusWithLiterals;
5533
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5534
- voidedDate?: Date | null;
5535
- /** In case of status is FAILED may contain failure details */
5536
- failureDetails?: AuthorizationActionFailureDetails;
5537
- /** Reason of void action */
5538
- reason?: ReasonWithLiterals;
5495
+ interface SendBuyerShippingConfirmationEmailResponse {
5539
5496
  }
5540
- declare enum AuthorizationVoidStatus {
5541
- /** Void operation still in progress. */
5542
- PENDING = "PENDING",
5543
- /** Void operation succeeded. */
5544
- SUCCEEDED = "SUCCEEDED",
5545
- /** Void operation failed. */
5546
- FAILED = "FAILED"
5497
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
5498
+ /**
5499
+ * IDs of orders to send pickup emails for.
5500
+ * @minSize 1
5501
+ * @maxSize 300
5502
+ */
5503
+ orderIds?: string[];
5547
5504
  }
5548
- /** @enumType */
5549
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5550
- /** Reason the authorization was voided. */
5551
- declare enum Reason {
5552
- /** Authorization was voided by user. */
5553
- MANUAL = "MANUAL",
5554
- /** Authorization passed execution date. */
5555
- SCHEDULED = "SCHEDULED"
5505
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
5556
5506
  }
5557
- /** @enumType */
5558
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5559
- interface V1ScheduledAction {
5560
- /** Type of the action. */
5561
- actionType?: ActionTypeWithLiterals;
5562
- /** The date and time of the action. */
5563
- executionDate?: Date | null;
5507
+ interface SendMerchantOrderReceivedNotificationRequest {
5508
+ /**
5509
+ * @minLength 1
5510
+ * @maxLength 100
5511
+ */
5512
+ orderId?: string;
5564
5513
  }
5565
- declare enum ActionType {
5566
- VOID = "VOID",
5567
- CAPTURE = "CAPTURE"
5514
+ interface SendMerchantOrderReceivedNotificationResponse {
5568
5515
  }
5569
- /** @enumType */
5570
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5571
- interface Chargeback {
5516
+ interface SendCancelRefundEmailRequest {
5572
5517
  /**
5573
- * Chargeback ID.
5574
- * @format GUID
5575
- * @readonly
5576
- * @immutable
5518
+ * The ID of order that is canceled/refunded
5519
+ * @minLength 1
5520
+ * @maxLength 100
5577
5521
  */
5578
- id?: string;
5522
+ orderId?: string;
5579
5523
  /**
5580
- * 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.
5581
- * @readonly
5582
- * @immutable
5524
+ * Personal note added to the email (optional)
5525
+ * @minLength 1
5526
+ * @maxLength 1000
5583
5527
  */
5584
- createdDate?: Date | null;
5528
+ customMessage?: string | null;
5529
+ /** Refund amount */
5530
+ refundAmount?: Price;
5585
5531
  /**
5586
- * 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.
5587
- * @readonly
5532
+ * Refund ID. (Optional)
5533
+ * @format GUID
5588
5534
  */
5589
- updatedDate?: Date | null;
5535
+ refundId?: string | null;
5536
+ }
5537
+ interface SendCancelRefundEmailResponse {
5538
+ }
5539
+ interface SendRefundEmailRequest {
5590
5540
  /**
5591
- * Amount.
5592
- * @readonly
5593
- * @immutable
5541
+ * The ID of order that is refunded
5542
+ * @format GUID
5594
5543
  */
5595
- amount?: Price;
5544
+ orderId?: string;
5596
5545
  /**
5597
- * Reversal amount. Present only when status is REVERSED.
5598
- * @readonly
5546
+ * Refund ID
5547
+ * @format GUID
5599
5548
  */
5600
- reversalAmount?: Price;
5549
+ refundId?: string;
5601
5550
  /**
5602
- * Status.
5603
- *
5604
- * Default: `"APPROVED"`.
5551
+ * Personal note added to the email (optional)
5552
+ * @minLength 1
5553
+ * @maxLength 1000
5605
5554
  */
5606
- status?: ChargebackStatusWithLiterals;
5555
+ customMessage?: string | null;
5556
+ }
5557
+ interface SendRefundEmailResponse {
5558
+ }
5559
+ interface SendFulfillmentEmailRequest {
5560
+ /** @format GUID */
5561
+ orderId?: string;
5562
+ /** @format GUID */
5563
+ fulfillerId?: string;
5564
+ }
5565
+ interface SendFulfillmentEmailResponse {
5566
+ }
5567
+ interface SendMerchantOrderReceivedPushRequest {
5607
5568
  /**
5608
- * External chargeback ID.
5609
- * @format GUID
5610
- * @readonly
5611
- * @immutable
5569
+ * @minLength 1
5570
+ * @maxLength 100
5612
5571
  */
5613
- externalId?: string | null;
5572
+ orderId?: string;
5614
5573
  }
5615
- declare enum ChargebackStatus {
5616
- /** Chargeback was approved. */
5617
- APPROVED = "APPROVED",
5618
- /** Chargeback was reversed. */
5619
- REVERSED = "REVERSED"
5574
+ interface SendMerchantOrderReceivedPushResponse {
5575
+ }
5576
+ interface PreviewEmailByTypeRequest {
5577
+ emailType?: PreviewEmailTypeWithLiterals;
5578
+ }
5579
+ declare enum PreviewEmailType {
5580
+ ORDER_PLACED = "ORDER_PLACED",
5581
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
5582
+ ORDER_SHIPPED = "ORDER_SHIPPED",
5583
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
5620
5584
  }
5621
5585
  /** @enumType */
5622
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5623
- interface PaymentMethodName {
5586
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
5587
+ interface PreviewEmailByTypeResponse {
5588
+ emailPreview?: string;
5589
+ }
5590
+ interface PreviewRefundEmailRequest {
5624
5591
  /**
5625
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5626
- * @maxLength 150
5592
+ * @minLength 1
5593
+ * @maxLength 100
5627
5594
  */
5628
- buyerLanguageName?: string | null;
5595
+ orderId?: string;
5596
+ /** Refund amount */
5597
+ refundAmount?: Price;
5598
+ /** Refund business details */
5599
+ details?: RefundDetails;
5629
5600
  /**
5630
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5631
- *
5632
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5633
- * @maxLength 150
5601
+ * Personal note added to the email (optional)
5602
+ * @minLength 1
5603
+ * @maxLength 1000
5634
5604
  */
5635
- siteLanguageName?: string | null;
5605
+ customMessage?: string | null;
5636
5606
  /**
5637
- * User-provided payment method name.
5638
- *
5639
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5607
+ * Refund ID. (Optional)
5608
+ * @format GUID
5640
5609
  */
5641
- userDefinedName?: UserDefinedPaymentMethodName;
5610
+ refundId?: string | null;
5642
5611
  }
5643
- interface GiftCardPaymentDetails {
5612
+ interface PreviewRefundEmailResponse {
5613
+ emailPreview?: string;
5614
+ }
5615
+ interface PreviewCancelEmailRequest {
5644
5616
  /**
5645
- * Gift card payment ID.
5617
+ * @minLength 1
5646
5618
  * @maxLength 100
5647
5619
  */
5648
- giftCardPaymentId?: string;
5620
+ orderId?: string;
5649
5621
  /**
5650
- * ID of the app that created the gift card.
5651
- * @format GUID
5622
+ * Personal note added to the email (optional)
5623
+ * @minLength 1
5624
+ * @maxLength 1000
5652
5625
  */
5653
- appId?: string;
5626
+ customMessage?: string | null;
5627
+ }
5628
+ interface PreviewCancelEmailResponse {
5629
+ emailPreview?: string;
5630
+ }
5631
+ interface PreviewCancelRefundEmailRequest {
5654
5632
  /**
5655
- * Whether the gift card is voided.
5656
- * @readonly
5657
- * @deprecated Whether the gift card is voided.
5658
- * @replacedBy payment.status
5659
- * @targetRemovalDate 2026-11-01
5633
+ * @minLength 1
5634
+ * @maxLength 100
5660
5635
  */
5661
- voided?: boolean;
5636
+ orderId?: string;
5662
5637
  /**
5663
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5664
- * @maxLength 30
5665
- * @immutable
5638
+ * Personal note added to the email (optional)
5639
+ * @minLength 1
5640
+ * @maxLength 1000
5666
5641
  */
5667
- obfuscatedCode?: string | null;
5642
+ customMessage?: string | null;
5643
+ /** Refund amount */
5644
+ refundAmount?: Price;
5645
+ /**
5646
+ * Refund ID. (Optional)
5647
+ * @format GUID
5648
+ */
5649
+ refundId?: string | null;
5668
5650
  }
5669
- interface MembershipPaymentDetails {
5651
+ interface PreviewCancelRefundEmailResponse {
5652
+ emailPreview?: string;
5653
+ }
5654
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
5655
+ }
5656
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5657
+ emailPreview?: string;
5658
+ }
5659
+ interface PreviewBuyerConfirmationEmailRequest {
5660
+ }
5661
+ interface PreviewBuyerConfirmationEmailResponse {
5662
+ emailPreview?: string;
5663
+ }
5664
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5665
+ }
5666
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5667
+ emailPreview?: string;
5668
+ }
5669
+ interface PreviewShippingConfirmationEmailRequest {
5670
+ }
5671
+ interface PreviewShippingConfirmationEmailResponse {
5672
+ emailPreview?: string;
5673
+ }
5674
+ interface PreviewResendDownloadLinksEmailRequest {
5675
+ }
5676
+ interface PreviewResendDownloadLinksEmailResponse {
5677
+ emailPreview?: string;
5678
+ }
5679
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5680
+ /** Emitted on a meta site creation. */
5681
+ siteCreated?: SiteCreated;
5682
+ /** Emitted on a meta site transfer completion. */
5683
+ siteTransferred?: SiteTransferred;
5684
+ /** Emitted on a meta site deletion. */
5685
+ siteDeleted?: SiteDeleted;
5686
+ /** Emitted on a meta site restoration. */
5687
+ siteUndeleted?: SiteUndeleted;
5688
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5689
+ sitePublished?: SitePublished;
5690
+ /** Emitted on a meta site unpublish. */
5691
+ siteUnpublished?: SiteUnpublished;
5692
+ /** Emitted when meta site is marked as template. */
5693
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5694
+ /** Emitted when meta site is marked as a WixSite. */
5695
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5696
+ /** Emitted when an application is provisioned (installed). */
5697
+ serviceProvisioned?: ServiceProvisioned;
5698
+ /** Emitted when an application is removed (uninstalled). */
5699
+ serviceRemoved?: ServiceRemoved;
5700
+ /** Emitted when meta site name (URL slug) is changed. */
5701
+ siteRenamedPayload?: SiteRenamed;
5702
+ /** Emitted when meta site was permanently deleted. */
5703
+ hardDeleted?: SiteHardDeleted;
5704
+ /** Emitted on a namespace change. */
5705
+ namespaceChanged?: NamespaceChanged;
5706
+ /** Emitted when Studio is attached. */
5707
+ studioAssigned?: StudioAssigned;
5708
+ /** Emitted when Studio is detached. */
5709
+ studioUnassigned?: StudioUnassigned;
5670
5710
  /**
5671
- * Membership ID.
5672
- * @maxLength 200
5711
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5712
+ * the actual URL.
5713
+ *
5714
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5715
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5673
5716
  */
5674
- membershipId?: string;
5717
+ urlChanged?: SiteUrlChanged;
5718
+ /** Site is marked as PurgedExternally */
5719
+ sitePurgedExternally?: SitePurgedExternally;
5720
+ /** Emitted when Odeditor is attached. */
5721
+ odeditorAssigned?: OdeditorAssigned;
5722
+ /** Emitted when Odeditor is detached. */
5723
+ odeditorUnassigned?: OdeditorUnassigned;
5724
+ /** Emitted when Picasso is attached. */
5725
+ picassoAssigned?: PicassoAssigned;
5726
+ /** Emitted when Picasso is detached. */
5727
+ picassoUnassigned?: PicassoUnassigned;
5728
+ /** Emitted when Wixel is attached. */
5729
+ wixelAssigned?: WixelAssigned;
5730
+ /** Emitted when Wixel is detached. */
5731
+ wixelUnassigned?: WixelUnassigned;
5732
+ /** Emitted when StudioTwo is attached. */
5733
+ studioTwoAssigned?: StudioTwoAssigned;
5734
+ /** Emitted when StudioTwo is detached. */
5735
+ studioTwoUnassigned?: StudioTwoUnassigned;
5736
+ /** Emitted when media from user domain is enabled. */
5737
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5738
+ /** Emitted when media from user domain is disabled. */
5739
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5740
+ /** Emitted when Editorless is attached. */
5741
+ editorlessAssigned?: EditorlessAssigned;
5742
+ /** Emitted when Editorless is detached. */
5743
+ editorlessUnassigned?: EditorlessUnassigned;
5675
5744
  /**
5676
- * ID of the line item this membership applies to.
5677
- * @minLength 1
5678
- * @maxLength 100
5745
+ * A meta site id.
5746
+ * @format GUID
5679
5747
  */
5680
- lineItemId?: string;
5748
+ metaSiteId?: string;
5749
+ /** A meta site version. Monotonically increasing. */
5750
+ version?: string;
5751
+ /** A timestamp of the event. */
5752
+ timestamp?: string;
5681
5753
  /**
5682
- * Payment status.
5683
- * @deprecated Payment status.
5684
- * @replacedBy payment.status
5685
- * @targetRemovalDate 2026-11-01
5754
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5755
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5756
+ * @maxSize 4000
5686
5757
  */
5687
- status?: MembershipPaymentStatusWithLiterals;
5688
- /** Membership name. */
5689
- name?: MembershipName;
5758
+ assets?: Asset[];
5759
+ }
5760
+ /** @oneof */
5761
+ interface MetaSiteSpecialEventPayloadOneOf {
5762
+ /** Emitted on a meta site creation. */
5763
+ siteCreated?: SiteCreated;
5764
+ /** Emitted on a meta site transfer completion. */
5765
+ siteTransferred?: SiteTransferred;
5766
+ /** Emitted on a meta site deletion. */
5767
+ siteDeleted?: SiteDeleted;
5768
+ /** Emitted on a meta site restoration. */
5769
+ siteUndeleted?: SiteUndeleted;
5770
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5771
+ sitePublished?: SitePublished;
5772
+ /** Emitted on a meta site unpublish. */
5773
+ siteUnpublished?: SiteUnpublished;
5774
+ /** Emitted when meta site is marked as template. */
5775
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5776
+ /** Emitted when meta site is marked as a WixSite. */
5777
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5778
+ /** Emitted when an application is provisioned (installed). */
5779
+ serviceProvisioned?: ServiceProvisioned;
5780
+ /** Emitted when an application is removed (uninstalled). */
5781
+ serviceRemoved?: ServiceRemoved;
5782
+ /** Emitted when meta site name (URL slug) is changed. */
5783
+ siteRenamedPayload?: SiteRenamed;
5784
+ /** Emitted when meta site was permanently deleted. */
5785
+ hardDeleted?: SiteHardDeleted;
5786
+ /** Emitted on a namespace change. */
5787
+ namespaceChanged?: NamespaceChanged;
5788
+ /** Emitted when Studio is attached. */
5789
+ studioAssigned?: StudioAssigned;
5790
+ /** Emitted when Studio is detached. */
5791
+ studioUnassigned?: StudioUnassigned;
5690
5792
  /**
5691
- * The transaction ID in the membership system. Can be used to void the transaction.
5692
- * @minLength 1
5693
- * @maxLength 100
5793
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5794
+ * the actual URL.
5795
+ *
5796
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5797
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5694
5798
  */
5695
- externalTransactionId?: string | null;
5799
+ urlChanged?: SiteUrlChanged;
5800
+ /** Site is marked as PurgedExternally */
5801
+ sitePurgedExternally?: SitePurgedExternally;
5802
+ /** Emitted when Odeditor is attached. */
5803
+ odeditorAssigned?: OdeditorAssigned;
5804
+ /** Emitted when Odeditor is detached. */
5805
+ odeditorUnassigned?: OdeditorUnassigned;
5806
+ /** Emitted when Picasso is attached. */
5807
+ picassoAssigned?: PicassoAssigned;
5808
+ /** Emitted when Picasso is detached. */
5809
+ picassoUnassigned?: PicassoUnassigned;
5810
+ /** Emitted when Wixel is attached. */
5811
+ wixelAssigned?: WixelAssigned;
5812
+ /** Emitted when Wixel is detached. */
5813
+ wixelUnassigned?: WixelUnassigned;
5814
+ /** Emitted when StudioTwo is attached. */
5815
+ studioTwoAssigned?: StudioTwoAssigned;
5816
+ /** Emitted when StudioTwo is detached. */
5817
+ studioTwoUnassigned?: StudioTwoUnassigned;
5818
+ /** Emitted when media from user domain is enabled. */
5819
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5820
+ /** Emitted when media from user domain is disabled. */
5821
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5822
+ /** Emitted when Editorless is attached. */
5823
+ editorlessAssigned?: EditorlessAssigned;
5824
+ /** Emitted when Editorless is detached. */
5825
+ editorlessUnassigned?: EditorlessUnassigned;
5826
+ }
5827
+ interface Asset {
5696
5828
  /**
5697
- * Whether the membership is voided.
5698
- * @readonly
5699
- * @deprecated Whether the membership is voided.
5700
- * @replacedBy payment.status
5701
- * @targetRemovalDate 2026-11-01
5829
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5830
+ * @maxLength 36
5702
5831
  */
5703
- voided?: boolean;
5832
+ appDefId?: string;
5704
5833
  /**
5705
- * ID of the application providing this payment option.
5706
- * @format GUID
5834
+ * An instance id. For legacy reasons may be UUID or a string.
5835
+ * @maxLength 200
5707
5836
  */
5708
- providerAppId?: string;
5709
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5710
- futureMembership?: FutureMembershipDetails;
5837
+ instanceId?: string;
5838
+ /** An application state. */
5839
+ state?: StateWithLiterals;
5711
5840
  }
5712
- declare enum MembershipPaymentStatus {
5713
- /** Payment was charged. */
5714
- CHARGED = "CHARGED",
5715
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5716
- CHARGE_FAILED = "CHARGE_FAILED",
5717
- /** Payment is pending. */
5718
- CHARGE_PENDING = "CHARGE_PENDING",
5719
- /** Payment was voided. */
5720
- VOIDED = "VOIDED"
5841
+ declare enum State {
5842
+ UNKNOWN = "UNKNOWN",
5843
+ ENABLED = "ENABLED",
5844
+ DISABLED = "DISABLED",
5845
+ PENDING = "PENDING",
5846
+ DEMO = "DEMO"
5721
5847
  }
5722
5848
  /** @enumType */
5723
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5724
- interface FutureMembershipDetails {
5849
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5850
+ interface SiteCreated {
5725
5851
  /**
5726
- * ID of the plan line item in the order from which the membership will be created.
5727
- * @format GUID
5852
+ * A template identifier (empty if not created from a template).
5853
+ * @maxLength 36
5728
5854
  */
5729
- lineItemId?: string;
5855
+ originTemplateId?: string;
5730
5856
  /**
5731
- * ID of the benefit the future membership will grant.
5732
- * @maxLength 200
5857
+ * An account id of the owner.
5858
+ * @format GUID
5733
5859
  */
5734
- benefitId?: string;
5735
- }
5736
- interface WixReceiptInfo {
5860
+ ownerId?: string;
5861
+ /** A context in which meta site was created. */
5862
+ context?: SiteCreatedContextWithLiterals;
5737
5863
  /**
5738
- * Receipt ID
5864
+ * A meta site id from which this site was created.
5865
+ *
5866
+ * In case of a creation from a template it's a template id.
5867
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5739
5868
  * @format GUID
5740
5869
  */
5741
- receiptId?: string;
5870
+ originMetaSiteId?: string | null;
5742
5871
  /**
5743
- * Display number of receipt
5744
- * @minLength 1
5745
- * @maxLength 40
5872
+ * A meta site name (URL slug).
5873
+ * @maxLength 20
5746
5874
  */
5747
- displayNumber?: string | null;
5875
+ siteName?: string;
5876
+ /** A namespace. */
5877
+ namespace?: NamespaceWithLiterals;
5748
5878
  }
5749
- interface ExternalReceiptInfo {
5879
+ declare enum SiteCreatedContext {
5880
+ /** A valid option, we don't expose all reasons why site might be created. */
5881
+ OTHER = "OTHER",
5882
+ /** A meta site was created from template. */
5883
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5884
+ /** A meta site was created by copying of the transfferred meta site. */
5885
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5886
+ /** A copy of existing meta site. */
5887
+ DUPLICATE = "DUPLICATE",
5888
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5889
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5890
+ /** deprecated A meta site was created for Flash editor. */
5891
+ FLASH = "FLASH"
5892
+ }
5893
+ /** @enumType */
5894
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5895
+ declare enum Namespace {
5896
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5897
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5898
+ WIX = "WIX",
5899
+ /** 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. */
5900
+ SHOUT_OUT = "SHOUT_OUT",
5901
+ /** 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. */
5902
+ ALBUMS = "ALBUMS",
5903
+ /** 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. */
5904
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5905
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5906
+ HOTELS = "HOTELS",
5907
+ /** 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. */
5908
+ CLUBS = "CLUBS",
5909
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5910
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5750
5911
  /**
5751
- * External receipt ID
5752
- * @maxLength 100
5912
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5913
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5753
5914
  */
5754
- receiptId?: string | null;
5915
+ DEV_SITE = "DEV_SITE",
5916
+ /** 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. */
5917
+ LOGOS = "LOGOS",
5918
+ /** 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. */
5919
+ VIDEO_MAKER = "VIDEO_MAKER",
5920
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5921
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5922
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5923
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5755
5924
  /**
5756
- * ID of the app providing the receipt
5757
- * @format GUID
5925
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5926
+ *
5927
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5758
5928
  */
5759
- appId?: string | null;
5929
+ HTML_DRAFT = "HTML_DRAFT",
5760
5930
  /**
5761
- * Display number of receipt
5762
- * @minLength 1
5763
- * @maxLength 40
5931
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5932
+ * Will be accessible from Site List and will not have a website app.
5933
+ * Once the user attaches a site, the site will become a regular wixsite.
5764
5934
  */
5765
- displayNumber?: string | null;
5766
- }
5767
- interface CashRoundingDetails {
5935
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5936
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5937
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5938
+ /** It is to be used in the Business First efforts. */
5939
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5940
+ /** Bookings business flow with no site. */
5941
+ ANYWHERE = "ANYWHERE",
5942
+ /** Namespace for Headless Backoffice with no editor */
5943
+ HEADLESS = "HEADLESS",
5768
5944
  /**
5769
- * Payment amount before cash rounding was applied.
5770
- * When provided, balance and status calculations use this value instead of `amount`
5771
- * to prevent false overpayment or underpayment due to rounding.
5945
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5946
+ * The site will be used for account level CSM feature for enterprise
5772
5947
  */
5773
- unroundedAmount?: Price;
5948
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5949
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5950
+ RISE = "RISE",
5774
5951
  /**
5775
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5776
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5777
- * @readonly
5952
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5953
+ * There's a blank site behind the scene but it's blank).
5954
+ * The Mobile company will be the owner of this namespace.
5778
5955
  */
5779
- roundingAdjustment?: CashRounding;
5780
- }
5781
- declare enum PaymentStatus {
5782
- /** Payment was charged successfully. */
5783
- APPROVED = "APPROVED",
5784
- /** Payment is being processed and hasn't been confirmed yet. */
5785
- PENDING = "PENDING",
5786
- /** 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. */
5787
- PENDING_MERCHANT = "PENDING_MERCHANT",
5788
- /** Payment was canceled before it was charged. */
5789
- CANCELED = "CANCELED",
5790
- /** Payment was declined by the payment provider. */
5791
- DECLINED = "DECLINED",
5792
- /** Payment was fully refunded. */
5793
- REFUNDED = "REFUNDED",
5794
- /** Part of the payment amount was refunded. */
5795
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5796
- /** 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. */
5797
- AUTHORIZED = "AUTHORIZED",
5956
+ BRANDED_FIRST = "BRANDED_FIRST",
5957
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5958
+ NOWNIA = "NOWNIA",
5798
5959
  /**
5799
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5800
- *
5801
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5960
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5961
+ * The Partners company owns this namespace.
5802
5962
  */
5803
- VOIDED = "VOIDED"
5804
- }
5805
- /** @enumType */
5806
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5807
- interface CanceledStatusDetails {
5808
- reason?: CanceledReasonWithLiterals;
5809
- }
5810
- declare enum CanceledReason {
5811
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5812
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5813
- /** Payment was not completed by user and expired. */
5814
- EXPIRED = "EXPIRED"
5815
- }
5816
- /** @enumType */
5817
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5818
- interface DeclinedStatusDetails {
5819
- reason?: DeclinedReasonWithLiterals;
5820
- }
5821
- declare enum DeclinedReason {
5822
- /** Corresponding charge failed. */
5823
- CHARGE_FAILED = "CHARGE_FAILED",
5824
- /** Payment details expired. */
5825
- EXPIRED = "EXPIRED",
5826
- /** Insufficient funds. */
5827
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5828
- /** Gift card was disabled before charge was attempted. */
5829
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5830
- }
5831
- /** @enumType */
5832
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5833
- interface VoidedStatusDetails {
5834
- reason?: VoidedReasonWithLiterals;
5835
- }
5836
- declare enum VoidedReason {
5837
- /** Payment was voided by merchant request. */
5838
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5839
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5840
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5841
- }
5842
- /** @enumType */
5843
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5844
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5845
- }
5846
- /** @oneof */
5847
- interface PaymentStatusDetailsStatusDetailsOneOf {
5848
- }
5849
- interface Refund {
5963
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5964
+ /** Codux Headless Sites */
5965
+ CODUX = "CODUX",
5966
+ /** Bobb - AI Design Creator. */
5967
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5850
5968
  /**
5851
- * Refund ID.
5852
- * @format GUID
5853
- * @readonly
5969
+ * Shared Blog Site is a unique single site across Enterprise account,
5970
+ * This site will hold all Blog posts related to the Marketing product.
5854
5971
  */
5855
- id?: string;
5972
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5973
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5974
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5975
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5976
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5977
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5978
+ MIMIR = "MIMIR",
5979
+ /** Wix Twins platform. */
5980
+ TWINS = "TWINS",
5981
+ /** Wix Nano. */
5982
+ NANO = "NANO",
5983
+ /** Base44 headless sites. */
5984
+ BASE44 = "BASE44",
5985
+ /** Wix Channels Sites */
5986
+ CHANNELS = "CHANNELS",
5987
+ /** Nautilus platform. */
5988
+ NAUTILUS = "NAUTILUS",
5856
5989
  /**
5857
- * List of transactions.
5858
- * @maxSize 50
5990
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5991
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5859
5992
  */
5860
- transactions?: RefundTransaction[];
5861
- /** Refund business details. */
5862
- details?: RefundDetails;
5993
+ SYMPHONY = "SYMPHONY",
5994
+ /** Nautilus platform app. */
5995
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5863
5996
  /**
5864
- * 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.
5865
- * @readonly
5866
- * @immutable
5997
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5998
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5867
5999
  */
5868
- createdDate?: Date | null;
6000
+ VIBU = "VIBU",
5869
6001
  /**
5870
- * Aggregated refund summary.
5871
- * @readonly
6002
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6003
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
6004
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6005
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5872
6006
  */
5873
- summary?: AggregatedRefundSummary;
6007
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5874
6008
  /**
5875
- * ID of the app that initiated this refund.
5876
- * @format GUID
5877
- * @readonly
5878
- * @immutable
6009
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
6010
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5879
6011
  */
5880
- requestingServiceAppId?: string | null;
6012
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5881
6013
  }
5882
- interface RefundTransaction {
6014
+ /** @enumType */
6015
+ 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';
6016
+ /** Site transferred to another user. */
6017
+ interface SiteTransferred {
5883
6018
  /**
5884
- * ID of the payment associated with this refund.
6019
+ * A previous owner id (user that transfers meta site).
5885
6020
  * @format GUID
5886
- * @immutable
5887
6021
  */
5888
- paymentId?: string;
6022
+ oldOwnerId?: string;
5889
6023
  /**
5890
- * Refund amount.
5891
- * @immutable
6024
+ * A new owner id (user that accepts meta site).
6025
+ * @format GUID
5892
6026
  */
5893
- amount?: Price;
5894
- /** Refund status. */
5895
- refundStatus?: RefundStatusWithLiterals;
5896
- /** Optional details of current refund status. */
5897
- refundStatusInfo?: RefundStatusInfo;
6027
+ newOwnerId?: string;
6028
+ }
6029
+ /** Soft deletion of the meta site. Could be restored. */
6030
+ interface SiteDeleted {
6031
+ /** A deletion context. */
6032
+ deleteContext?: DeleteContext;
6033
+ }
6034
+ interface DeleteContext {
6035
+ /** When the meta site was deleted. */
6036
+ dateDeleted?: Date | null;
6037
+ /** A status. */
6038
+ deleteStatus?: DeleteStatusWithLiterals;
5898
6039
  /**
5899
- * Payment gateway's refund ID.
5900
- * This field is only returned when the value of `external_refund` is `false`.
5901
- * @format GUID
6040
+ * A reason (flow).
6041
+ * @maxLength 255
5902
6042
  */
5903
- gatewayRefundId?: string | null;
5904
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5905
- providerRefundId?: string | null;
6043
+ deleteOrigin?: string;
5906
6044
  /**
5907
- * Whether refund was made externally and manually on the payment provider's side.
5908
- * @immutable
6045
+ * A service that deleted it.
6046
+ * @maxLength 255
5909
6047
  */
5910
- externalRefund?: boolean;
6048
+ initiatorId?: string | null;
5911
6049
  }
5912
- /** Refund transaction status. */
5913
- declare enum RefundStatus {
5914
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5915
- PENDING = "PENDING",
5916
- /** Refund transaction succeeded. */
5917
- SUCCEEDED = "SUCCEEDED",
5918
- /** Refund transaction failed. */
5919
- FAILED = "FAILED",
5920
- /** Refund request acknowledged, and will be executed soon. */
5921
- SCHEDULED = "SCHEDULED",
5922
- /** Refund was initiated on payment provider side. */
5923
- STARTED = "STARTED"
6050
+ declare enum DeleteStatus {
6051
+ UNKNOWN = "UNKNOWN",
6052
+ TRASH = "TRASH",
6053
+ DELETED = "DELETED",
6054
+ PENDING_PURGE = "PENDING_PURGE",
6055
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5924
6056
  }
5925
6057
  /** @enumType */
5926
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5927
- interface RefundStatusInfo {
5928
- /**
5929
- * Reason code for the refund's current status.
5930
- *
5931
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5932
- * @minLength 1
5933
- * @maxLength 10
5934
- */
5935
- paymentGatewayReasonCode?: string | null;
6058
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6059
+ /** Restoration of the meta site. */
6060
+ interface SiteUndeleted {
6061
+ }
6062
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
6063
+ interface SitePublished {
6064
+ }
6065
+ interface SiteUnpublished {
5936
6066
  /**
5937
- * Free text explanation of current refund status.
5938
- * @minLength 1
5939
- * @maxLength 1000
6067
+ * A list of URLs previously associated with the meta site.
6068
+ * @maxLength 4000
6069
+ * @maxSize 10000
5940
6070
  */
5941
- description?: string | null;
6071
+ urls?: string[];
5942
6072
  }
5943
- interface AggregatedRefundSummary {
5944
- /** Total amount requested for refund. */
5945
- requestedRefund?: Price;
5946
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5947
- pendingRefund?: Price;
5948
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5949
- refunded?: Price;
5950
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5951
- failedRefundAmount?: Price;
5952
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5953
- pending?: boolean;
5954
- /** Breakdown of refunded items. Available only after refund is complete. */
5955
- breakdown?: RefundItemsBreakdown;
6073
+ interface SiteMarkedAsTemplate {
5956
6074
  }
5957
- interface RefundItemsBreakdown {
6075
+ interface SiteMarkedAsWixSite {
6076
+ }
6077
+ /**
6078
+ * Represents a service provisioned a site.
6079
+ *
6080
+ * Note on `origin_instance_id`:
6081
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6082
+ * This is because of the following scenario:
6083
+ *
6084
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
6085
+ * such as a product catalog. When you create a site from this template, you inherit this
6086
+ * default product catalog. However, if the template's product catalog is modified,
6087
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
6088
+ * your site remains consistent with what you initially received and does not include any
6089
+ * changes made to the original template afterward.
6090
+ * To ensure this, the TPA on the template gets a new instance_id.
6091
+ */
6092
+ interface ServiceProvisioned {
5958
6093
  /**
5959
- * Refunded line items and the amount refunded for each.
5960
- * @maxSize 300
6094
+ * Either UUID or EmbeddedServiceType.
6095
+ * @maxLength 36
5961
6096
  */
5962
- lineItems?: LineItemRefundSummary[];
5963
- }
5964
- interface LineItemRefundSummary {
6097
+ appDefId?: string;
5965
6098
  /**
5966
- * ID of the refunded line item.
5967
- * @format GUID
6099
+ * Not only UUID. Something here could be something weird.
6100
+ * @maxLength 36
5968
6101
  */
5969
- lineItemId?: string;
5970
- /** Total refunded amount for the line item. */
5971
- totalRefundedAmount?: Price;
5972
- }
5973
- interface CalculateRefundRequest {
6102
+ instanceId?: string;
5974
6103
  /**
5975
- * Order ID
5976
- * @minLength 1
5977
- * @maxLength 100
6104
+ * An instance id from which this instance is originated.
6105
+ * @maxLength 36
5978
6106
  */
5979
- ecomOrderId?: string;
6107
+ originInstanceId?: string;
5980
6108
  /**
5981
- * Refunded line items and quantity
5982
- * @maxSize 300
6109
+ * A version.
6110
+ * @maxLength 500
5983
6111
  */
5984
- refundItems?: CalculateRefundItemRequest[];
5985
- /** Should include shipping in refund calculation */
5986
- refundShipping?: boolean;
5987
- }
5988
- interface CalculateRefundItemRequest {
6112
+ version?: string | null;
5989
6113
  /**
5990
- * ID of the line item being refunded
6114
+ * The origin meta site id
5991
6115
  * @format GUID
5992
6116
  */
5993
- id?: string;
6117
+ originMetaSiteId?: string | null;
6118
+ }
6119
+ interface ServiceRemoved {
5994
6120
  /**
5995
- * How much of that line item is being refunded
5996
- * @min 1
5997
- * @max 100000
6121
+ * Either UUID or EmbeddedServiceType.
6122
+ * @maxLength 36
5998
6123
  */
5999
- quantity?: number;
6000
- }
6001
- interface CalculateRefundResponse {
6002
- /** Total refundable amount */
6003
- total?: Price;
6004
- /** Tax cost of the order */
6005
- tax?: Price;
6006
- /** Discount given for this order */
6007
- discount?: Price;
6008
- /** Total cost of the order (without tax) */
6009
- subtotal?: Price;
6010
- /** Total shipping cost for order */
6011
- shipping?: Price;
6012
- /** Previous refund given on that order */
6013
- previouslyRefundedAmount?: Price;
6124
+ appDefId?: string;
6014
6125
  /**
6015
- * The refundable items of that order
6016
- * @maxSize 300
6126
+ * Not only UUID. Something here could be something weird.
6127
+ * @maxLength 36
6017
6128
  */
6018
- items?: CalculateRefundItemResponse[];
6019
- }
6020
- interface CalculateRefundItemResponse {
6129
+ instanceId?: string;
6021
6130
  /**
6022
- * Line item ID
6023
- * @format GUID
6131
+ * A version.
6132
+ * @maxLength 500
6024
6133
  */
6025
- id?: string;
6026
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6027
- price?: Price;
6134
+ version?: string | null;
6028
6135
  }
6029
- interface VoidAuthorizedPaymentsRequest {
6136
+ /** Rename of the site. Meaning, free public url has been changed as well. */
6137
+ interface SiteRenamed {
6030
6138
  /**
6031
- * Wix eCommerce order ID
6032
- * @minLength 1
6033
- * @maxLength 100
6139
+ * A new meta site name (URL slug).
6140
+ * @maxLength 20
6034
6141
  */
6035
- ecomOrderId: string;
6142
+ newSiteName?: string;
6036
6143
  /**
6037
- * Payment IDs
6038
- * @minSize 1
6039
- * @maxSize 100
6040
- * @format GUID
6144
+ * A previous meta site name (URL slug).
6145
+ * @maxLength 255
6041
6146
  */
6042
- paymentIds: string[];
6147
+ oldSiteName?: string;
6043
6148
  }
6044
- interface VoidAuthorizedPaymentsResponse {
6045
- /** All order's transactions after the void was triggered */
6046
- orderTransactions?: OrderTransactions;
6149
+ /**
6150
+ * Hard deletion of the meta site.
6151
+ *
6152
+ * Could not be restored. Therefore it's desirable to cleanup data.
6153
+ */
6154
+ interface SiteHardDeleted {
6155
+ /** A deletion context. */
6156
+ deleteContext?: DeleteContext;
6047
6157
  }
6048
- interface CaptureAuthorizedPaymentsRequest {
6049
- /**
6050
- * Wix eCommerce order ID
6051
- * @minLength 1
6052
- * @maxLength 100
6053
- */
6054
- ecomOrderId: string;
6158
+ interface NamespaceChanged {
6159
+ /** A previous namespace. */
6160
+ oldNamespace?: NamespaceWithLiterals;
6161
+ /** A new namespace. */
6162
+ newNamespace?: NamespaceWithLiterals;
6163
+ }
6164
+ /** Assigned Studio editor */
6165
+ interface StudioAssigned {
6166
+ }
6167
+ /** Unassigned Studio editor */
6168
+ interface StudioUnassigned {
6169
+ }
6170
+ /**
6171
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6172
+ *
6173
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6174
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
6175
+ *
6176
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6177
+ */
6178
+ interface SiteUrlChanged {
6179
+ }
6180
+ /**
6181
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6182
+ * Consumed by other teams to remove relevant data.
6183
+ */
6184
+ interface SitePurgedExternally {
6055
6185
  /**
6056
- * Capture payments information
6057
- * @minSize 1
6186
+ * @maxLength 2048
6058
6187
  * @maxSize 100
6188
+ * @deprecated
6189
+ * @targetRemovalDate 2025-04-15
6059
6190
  */
6060
- payments: PaymentCapture[];
6191
+ appDefId?: string[];
6061
6192
  }
6062
- interface PaymentCapture {
6063
- /**
6064
- * Payment ID
6065
- * @format GUID
6066
- */
6067
- paymentId?: string | null;
6068
- /**
6069
- * Capture amount.
6070
- * If not provided - full authorized amount will be captured.
6071
- */
6072
- amount?: Price;
6193
+ /** Assigned Odeditor */
6194
+ interface OdeditorAssigned {
6073
6195
  }
6074
- interface CaptureAuthorizedPaymentsResponse {
6075
- /** All order's transactions after the capture was triggered */
6076
- orderTransactions?: OrderTransactions;
6196
+ /** Unassigned Odeditor */
6197
+ interface OdeditorUnassigned {
6077
6198
  }
6078
- interface ChargeSavedPaymentMethodRequest {
6079
- /**
6080
- * Ecom Order ID.
6081
- * @minLength 1
6082
- * @maxLength 100
6083
- */
6084
- ecomOrderId?: string;
6085
- /** Amount to be charged */
6086
- amount?: Price;
6199
+ /** Assigned Picasso editor */
6200
+ interface PicassoAssigned {
6087
6201
  }
6088
- interface ChargeSavedPaymentMethodResponse {
6089
- /** Payment gateway's order ID (e.g Wix Payments) */
6090
- paymentGatewayOrderId?: string;
6202
+ /** Unassigned Picasso */
6203
+ interface PicassoUnassigned {
6091
6204
  }
6092
- interface V1TriggerReindexRequest {
6093
- /** @format GUID */
6094
- metasiteId?: string;
6095
- /**
6096
- * @minLength 1
6097
- * @maxLength 100
6098
- * @maxSize 100
6099
- */
6100
- orderIds?: string[];
6205
+ /** Assigned Wixel */
6206
+ interface WixelAssigned {
6101
6207
  }
6102
- interface V1TriggerReindexResponse {
6208
+ /** Unassigned Wixel */
6209
+ interface WixelUnassigned {
6103
6210
  }
6104
- interface V1TriggerReindexOrderRequest {
6105
- /** @format GUID */
6106
- metasiteId?: string;
6107
- /**
6108
- * @minLength 1
6109
- * @maxLength 100
6110
- */
6111
- orderId?: string;
6211
+ /** Assigned StudioTwo */
6212
+ interface StudioTwoAssigned {
6213
+ }
6214
+ /** Unassigned StudioTwo */
6215
+ interface StudioTwoUnassigned {
6216
+ }
6217
+ /** Media from user domain is enabled. */
6218
+ interface UserDomainMediaEnabled {
6219
+ }
6220
+ /** Media from user domain is disabled. */
6221
+ interface UserDomainMediaDisabled {
6222
+ }
6223
+ /** Assigned Editorless */
6224
+ interface EditorlessAssigned {
6225
+ }
6226
+ /** Unassigned Editorless */
6227
+ interface EditorlessUnassigned {
6228
+ }
6229
+ interface HasCustomEmailConfigurationsRequest {
6230
+ }
6231
+ interface HasCustomEmailConfigurationsResponse {
6232
+ hasCustomConfigurations?: boolean;
6233
+ }
6234
+ interface AddToAutomationMigrationPopulationRequest {
6235
+ /** When true, sends custom email configurations to automation system via email */
6236
+ sendCustomEmailConfigs?: boolean;
6237
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6238
+ origin?: OriginWithLiterals;
6239
+ }
6240
+ declare enum Origin {
6241
+ OPT_IN = "OPT_IN",
6242
+ MIGRATION = "MIGRATION"
6243
+ }
6244
+ /** @enumType */
6245
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6246
+ interface AddToAutomationMigrationPopulationResponse {
6247
+ success?: boolean;
6248
+ }
6249
+ interface IsInAutomationMigrationPopulationRequest {
6250
+ }
6251
+ interface IsInAutomationMigrationPopulationResponse {
6252
+ inPopulation?: boolean;
6112
6253
  }
6113
6254
  interface DiffmatokyPayload {
6114
6255
  left?: string;
@@ -8119,4 +8260,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
8119
8260
  declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
8120
8261
  declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
8121
8262
 
8122
- export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };
8263
+ export { type AccountInfo as AccountInfoOriginal, type ActionEvent as ActionEventOriginal, ActionType as ActionTypeOriginal, type ActionTypeWithLiterals as ActionTypeWithLiteralsOriginal, type ActivityContentOneOf as ActivityContentOneOfOriginal, type Activity as ActivityOriginal, ActivityType as ActivityTypeOriginal, type ActivityTypeWithLiterals as ActivityTypeWithLiteralsOriginal, type AddActivitiesRequest as AddActivitiesRequestOriginal, type AddActivitiesResponse as AddActivitiesResponseOriginal, type AddActivityRequest as AddActivityRequestOriginal, type AddActivityResponse as AddActivityResponseOriginal, type AddInternalActivityRequest as AddInternalActivityRequestOriginal, type AddInternalActivityResponse as AddInternalActivityResponseOriginal, type AddToAutomationMigrationPopulationRequest as AddToAutomationMigrationPopulationRequestOriginal, type AddToAutomationMigrationPopulationResponse as AddToAutomationMigrationPopulationResponseOriginal, type AdditionalFeeDeltaDeltaOneOf as AdditionalFeeDeltaDeltaOneOfOriginal, type AdditionalFeeDelta as AdditionalFeeDeltaOriginal, type AdditionalFee as AdditionalFeeOriginal, type AdditionalFeeRefund as AdditionalFeeRefundOriginal, AdditionalFeeSource as AdditionalFeeSourceOriginal, type AdditionalFeeSourceWithLiterals as AdditionalFeeSourceWithLiteralsOriginal, type AddressDescription as AddressDescriptionOriginal, type AddressLocation as AddressLocationOriginal, type Address as AddressOriginal, type AddressWithContact as AddressWithContactOriginal, AdjustmentType as AdjustmentTypeOriginal, type AdjustmentTypeWithLiterals as AdjustmentTypeWithLiteralsOriginal, type AggregateOrdersRequest as AggregateOrdersRequestOriginal, type AggregateOrdersResponse as AggregateOrdersResponseOriginal, type AggregatedRefundSummary as AggregatedRefundSummaryOriginal, type ApplicationError as ApplicationErrorOriginal, type AppliedDiscountDeltaDeltaOneOf as AppliedDiscountDeltaDeltaOneOfOriginal, type AppliedDiscountDelta as AppliedDiscountDeltaOriginal, type AppliedDiscountDiscountSourceOneOf as AppliedDiscountDiscountSourceOneOfOriginal, type AppliedDiscount as AppliedDiscountOriginal, type ArchiveOrderRequest as ArchiveOrderRequestOriginal, type ArchiveOrderResponse as ArchiveOrderResponseOriginal, type Asset as AssetOriginal, AttributionSource as AttributionSourceOriginal, type AttributionSourceWithLiterals as AttributionSourceWithLiteralsOriginal, type AuthorizationActionFailureDetails as AuthorizationActionFailureDetailsOriginal, type AuthorizationCapture as AuthorizationCaptureOriginal, AuthorizationCaptureStatus as AuthorizationCaptureStatusOriginal, type AuthorizationCaptureStatusWithLiterals as AuthorizationCaptureStatusWithLiteralsOriginal, type AuthorizationDetails as AuthorizationDetailsOriginal, type AuthorizationVoid as AuthorizationVoidOriginal, AuthorizationVoidStatus as AuthorizationVoidStatusOriginal, type AuthorizationVoidStatusWithLiterals as AuthorizationVoidStatusWithLiteralsOriginal, type AuthorizedPaymentCaptured as AuthorizedPaymentCapturedOriginal, type AuthorizedPaymentCreated as AuthorizedPaymentCreatedOriginal, type AuthorizedPaymentVoided as AuthorizedPaymentVoidedOriginal, type Balance as BalanceOriginal, type BalanceSummary as BalanceSummaryOriginal, BaseRateSource as BaseRateSourceOriginal, type BaseRateSourceWithLiterals as BaseRateSourceWithLiteralsOriginal, type BigDecimalWrapper as BigDecimalWrapperOriginal, type BillingAdjustment as BillingAdjustmentOriginal, type BillingAdjustmentPriceSummary as BillingAdjustmentPriceSummaryOriginal, type BillingSettings as BillingSettingsOriginal, type BulkActionMetadata as BulkActionMetadataOriginal, type BulkArchiveOrdersByFilterRequest as BulkArchiveOrdersByFilterRequestOriginal, type BulkArchiveOrdersByFilterResponse as BulkArchiveOrdersByFilterResponseOriginal, type BulkArchiveOrdersRequest as BulkArchiveOrdersRequestOriginal, type BulkArchiveOrdersResponse as BulkArchiveOrdersResponseOriginal, type BulkDeleteImportedOrdersRequest as BulkDeleteImportedOrdersRequestOriginal, type BulkDeleteImportedOrdersResponse as BulkDeleteImportedOrdersResponseOriginal, type BulkMarkAsFulfilledByFilterRequest as BulkMarkAsFulfilledByFilterRequestOriginal, type BulkMarkAsFulfilledByFilterResponse as BulkMarkAsFulfilledByFilterResponseOriginal, type BulkMarkAsFulfilledRequest as BulkMarkAsFulfilledRequestOriginal, type BulkMarkAsFulfilledResponse as BulkMarkAsFulfilledResponseOriginal, type BulkMarkAsUnfulfilledByFilterRequest as BulkMarkAsUnfulfilledByFilterRequestOriginal, type BulkMarkAsUnfulfilledByFilterResponse as BulkMarkAsUnfulfilledByFilterResponseOriginal, type BulkMarkAsUnfulfilledRequest as BulkMarkAsUnfulfilledRequestOriginal, type BulkMarkAsUnfulfilledResponse as BulkMarkAsUnfulfilledResponseOriginal, type BulkMarkOrdersAsPaidRequest as BulkMarkOrdersAsPaidRequestOriginal, type BulkMarkOrdersAsPaidResponse as BulkMarkOrdersAsPaidResponseOriginal, type BulkOrderResult as BulkOrderResultOriginal, type BulkSendBuyerPickupConfirmationEmailsRequest as BulkSendBuyerPickupConfirmationEmailsRequestOriginal, type BulkSendBuyerPickupConfirmationEmailsResponse as BulkSendBuyerPickupConfirmationEmailsResponseOriginal, type BulkSendBuyerShippingConfirmationEmailsRequest as BulkSendBuyerShippingConfirmationEmailsRequestOriginal, type BulkSendBuyerShippingConfirmationEmailsResponse as BulkSendBuyerShippingConfirmationEmailsResponseOriginal, type BulkSetBusinessLocationRequest as BulkSetBusinessLocationRequestOriginal, type BulkSetBusinessLocationResponse as BulkSetBusinessLocationResponseOriginal, type BulkSetBusinessLocationResult as BulkSetBusinessLocationResultOriginal, type BulkUnArchiveOrdersByFilterRequest as BulkUnArchiveOrdersByFilterRequestOriginal, type BulkUnArchiveOrdersByFilterResponse as BulkUnArchiveOrdersByFilterResponseOriginal, type BulkUnArchiveOrdersRequest as BulkUnArchiveOrdersRequestOriginal, type BulkUnArchiveOrdersResponse as BulkUnArchiveOrdersResponseOriginal, type BulkUpdateOrderTagsRequest as BulkUpdateOrderTagsRequestOriginal, type BulkUpdateOrderTagsResponse as BulkUpdateOrderTagsResponseOriginal, type BulkUpdateOrderTagsResult as BulkUpdateOrderTagsResultOriginal, type BulkUpdateOrdersRequest as BulkUpdateOrdersRequestOriginal, type BulkUpdateOrdersResponse as BulkUpdateOrdersResponseOriginal, type BuyerInfoIdOneOf as BuyerInfoIdOneOfOriginal, type BuyerInfo as BuyerInfoOriginal, type BuyerInfoUpdate as BuyerInfoUpdateOriginal, type CalculateRefundItemRequest as CalculateRefundItemRequestOriginal, type CalculateRefundItemResponse as CalculateRefundItemResponseOriginal, type CalculateRefundRequest as CalculateRefundRequestOriginal, type CalculateRefundResponse as CalculateRefundResponseOriginal, type CalculatedTax as CalculatedTaxOriginal, type CalculatedTaxes as CalculatedTaxesOriginal, type CancelOrderApplicationErrors as CancelOrderApplicationErrorsOriginal, type CancelOrderRequest as CancelOrderRequestOriginal, type CancelOrderResponse as CancelOrderResponseOriginal, type Cancel as CancelOriginal, CanceledReason as CanceledReasonOriginal, type CanceledReasonWithLiterals as CanceledReasonWithLiteralsOriginal, type CanceledStatusDetails as CanceledStatusDetailsOriginal, type CaptureAuthorizedPaymentsApplicationErrors as CaptureAuthorizedPaymentsApplicationErrorsOriginal, type CaptureAuthorizedPaymentsRequest as CaptureAuthorizedPaymentsRequestOriginal, type CaptureAuthorizedPaymentsResponse as CaptureAuthorizedPaymentsResponseOriginal, type CashRoundingDetails as CashRoundingDetailsOriginal, type CashRounding as CashRoundingOriginal, type CatalogReference as CatalogReferenceOriginal, type ChannelInfo as ChannelInfoOriginal, ChannelType as ChannelTypeOriginal, type ChannelTypeWithLiterals as ChannelTypeWithLiteralsOriginal, type ChargeMembershipsRequest as ChargeMembershipsRequestOriginal, type ChargeMembershipsResponse as ChargeMembershipsResponseOriginal, type ChargeSavedPaymentMethodRequest as ChargeSavedPaymentMethodRequestOriginal, type ChargeSavedPaymentMethodResponse as ChargeSavedPaymentMethodResponseOriginal, ChargeType as ChargeTypeOriginal, type ChargeTypeWithLiterals as ChargeTypeWithLiteralsOriginal, type ChargebackCreated as ChargebackCreatedOriginal, type Chargeback as ChargebackOriginal, type ChargebackReversed as ChargebackReversedOriginal, ChargebackStatus as ChargebackStatusOriginal, type ChargebackStatusWithLiterals as ChargebackStatusWithLiteralsOriginal, type ChargedBy as ChargedByOriginal, type Color as ColorOriginal, type CommitDeltasRequest as CommitDeltasRequestOriginal, type CommitDeltasResponse as CommitDeltasResponseOriginal, type CommittedDiffs as CommittedDiffsOriginal, type CommittedDiffsShippingUpdateInfoOneOf as CommittedDiffsShippingUpdateInfoOneOfOriginal, type CommonAddress as CommonAddressOriginal, type CommonAddressStreetOneOf as CommonAddressStreetOneOfOriginal, type Company as CompanyOriginal, type Complete as CompleteOriginal, type Coupon as CouponOriginal, type CreateOrderApplicationErrors as CreateOrderApplicationErrorsOriginal, type CreateOrderRequest as CreateOrderRequestOriginal, type CreateOrderResponse as CreateOrderResponseOriginal, type CreatePaymentGatewayOrderRequest as CreatePaymentGatewayOrderRequestOriginal, type CreatePaymentGatewayOrderResponse as CreatePaymentGatewayOrderResponseOriginal, type CreatedBy as CreatedByOriginal, type CreatedByStringOneOf as CreatedByStringOneOfOriginal, type CreditCardDetails as CreditCardDetailsOriginal, type CreditCardPaymentMethodDetails as CreditCardPaymentMethodDetailsOriginal, type CrossBorderAdjustmentUpdate as CrossBorderAdjustmentUpdateOriginal, type CrossBorderCalculation as CrossBorderCalculationOriginal, CrossBorderNotApplicableReason as CrossBorderNotApplicableReasonOriginal, type CrossBorderNotApplicableReasonWithLiterals as CrossBorderNotApplicableReasonWithLiteralsOriginal, type CrossBorderPriceAdjustment as CrossBorderPriceAdjustmentOriginal, CrossBorderRepricingMode as CrossBorderRepricingModeOriginal, type CrossBorderRepricingModeWithLiterals as CrossBorderRepricingModeWithLiteralsOriginal, type CrossBorderRepricing as CrossBorderRepricingOriginal, type CurrencyConversionDetails as CurrencyConversionDetailsOriginal, type CursorPagingMetadata as CursorPagingMetadataOriginal, type CursorPaging as CursorPagingOriginal, type CursorSearch as CursorSearchOriginal, type CursorSearchPagingMethodOneOf as CursorSearchPagingMethodOneOfOriginal, type Cursors as CursorsOriginal, type CustomActivity as CustomActivityOriginal, type CustomAllowedActions as CustomAllowedActionsOriginal, CustomFieldGroup as CustomFieldGroupOriginal, type CustomFieldGroupWithLiterals as CustomFieldGroupWithLiteralsOriginal, type CustomField as CustomFieldOriginal, type CustomFieldValue as CustomFieldValueOriginal, type Customer as CustomerOriginal, type CyclePriceOverride as CyclePriceOverrideOriginal, type DecimalQuantity as DecimalQuantityOriginal, type DecimalQuantityUnitOneOf as DecimalQuantityUnitOneOfOriginal, type DecimalQuantityUpdate as DecimalQuantityUpdateOriginal, DeclinedReason as DeclinedReasonOriginal, type DeclinedReasonWithLiterals as DeclinedReasonWithLiteralsOriginal, type DeclinedStatusDetails as DeclinedStatusDetailsOriginal, type DecrementData as DecrementDataOriginal, type DecrementItemsQuantityRequest as DecrementItemsQuantityRequestOriginal, type DecrementItemsQuantityResponse as DecrementItemsQuantityResponseOriginal, type DelayedCaptureSettings as DelayedCaptureSettingsOriginal, type DeleteActivityRequest as DeleteActivityRequestOriginal, type DeleteActivityResponse as DeleteActivityResponseOriginal, type DeleteByFilterOperation as DeleteByFilterOperationOriginal, type DeleteByIdsOperation as DeleteByIdsOperationOriginal, type DeleteContext as DeleteContextOriginal, DeleteStatus as DeleteStatusOriginal, type DeleteStatusWithLiterals as DeleteStatusWithLiteralsOriginal, type DeliveryLogisticsAddressOneOf as DeliveryLogisticsAddressOneOfOriginal, type DeliveryLogistics as DeliveryLogisticsOriginal, type DeliveryTimeSlot as DeliveryTimeSlotOriginal, DeltaPaymentOptionType as DeltaPaymentOptionTypeOriginal, type DeltaPaymentOptionTypeWithLiterals as DeltaPaymentOptionTypeWithLiteralsOriginal, type Deposit as DepositOriginal, DepositType as DepositTypeOriginal, type DepositTypeWithLiterals as DepositTypeWithLiteralsOriginal, type DescriptionLineDescriptionLineValueOneOf as DescriptionLineDescriptionLineValueOneOfOriginal, type DescriptionLineName as DescriptionLineNameOriginal, type DescriptionLine as DescriptionLineOriginal, DescriptionLineType as DescriptionLineTypeOriginal, type DescriptionLineTypeWithLiterals as DescriptionLineTypeWithLiteralsOriginal, type DescriptionLineValueOneOf as DescriptionLineValueOneOfOriginal, type DiffmatokyPayload as DiffmatokyPayloadOriginal, type DigitalFile as DigitalFileOriginal, type Dimensions as DimensionsOriginal, DimensionsUnit as DimensionsUnitOriginal, type DimensionsUnitWithLiterals as DimensionsUnitWithLiteralsOriginal, type DiscountOneDiscountTypeOneOf as DiscountOneDiscountTypeOneOfOriginal, type Discount as DiscountOriginal, DiscountReason as DiscountReasonOriginal, type DiscountReasonWithLiterals as DiscountReasonWithLiteralsOriginal, type DiscountRuleName as DiscountRuleNameOriginal, type DiscountRule as DiscountRuleOriginal, DiscountType as DiscountTypeOriginal, type DiscountTypeWithLiterals as DiscountTypeWithLiteralsOriginal, type DomainEventBodyOneOf as DomainEventBodyOneOfOriginal, type DomainEvent as DomainEventOriginal, type DownloadLinkSent as DownloadLinkSentOriginal, type DraftOrderChangesApplied as DraftOrderChangesAppliedOriginal, type DraftOrderCommitSettings as DraftOrderCommitSettingsOriginal, type DraftOrderDiffsBillingUpdateInfoOneOf as DraftOrderDiffsBillingUpdateInfoOneOfOriginal, type DraftOrderDiffsBuyerUpdateInfoOneOf as DraftOrderDiffsBuyerUpdateInfoOneOfOriginal, type DraftOrderDiffs as DraftOrderDiffsOriginal, type DraftOrderDiffsRecipientUpdateInfoOneOf as DraftOrderDiffsRecipientUpdateInfoOneOfOriginal, type DraftOrderDiffsShippingUpdateInfoOneOf as DraftOrderDiffsShippingUpdateInfoOneOfOriginal, type Duration as DurationOriginal, DurationUnit as DurationUnitOriginal, type DurationUnitWithLiterals as DurationUnitWithLiteralsOriginal, type EditorlessAssigned as EditorlessAssignedOriginal, type EditorlessUnassigned as EditorlessUnassignedOriginal, type EmailEdited as EmailEditedOriginal, type Email as EmailOriginal, type Empty as EmptyOriginal, type EntityCreatedEvent as EntityCreatedEventOriginal, type EntityDeletedEvent as EntityDeletedEventOriginal, type EntityUpdatedEvent as EntityUpdatedEventOriginal, type ErrorInformation as ErrorInformationOriginal, type ExtendedFields as ExtendedFieldsOriginal, type ExternalReceiptInfo as ExternalReceiptInfoOriginal, type ExternalReceipt as ExternalReceiptOriginal, type FocalPoint as FocalPointOriginal, type FormIdentifier as FormIdentifierOriginal, type FormInfo as FormInfoOriginal, type FreeTrialPeriod as FreeTrialPeriodOriginal, type FulfillerEmailSent as FulfillerEmailSentOriginal, FulfillmentStatus as FulfillmentStatusOriginal, type FulfillmentStatusUpdated as FulfillmentStatusUpdatedOriginal, type FulfillmentStatusWithLiterals as FulfillmentStatusWithLiteralsOriginal, type FulfillmentStatusesAggregate as FulfillmentStatusesAggregateOriginal, type FullAddressContactDetails as FullAddressContactDetailsOriginal, type FutureMembershipDetails as FutureMembershipDetailsOriginal, type GetOrderApplicationErrors as GetOrderApplicationErrorsOriginal, type GetOrderRequest as GetOrderRequestOriginal, type GetOrderResponse as GetOrderResponseOriginal, type GetPaymentCollectabilityStatusRequest as GetPaymentCollectabilityStatusRequestOriginal, type GetPaymentCollectabilityStatusResponse as GetPaymentCollectabilityStatusResponseOriginal, type GetRefundabilityStatusRequest as GetRefundabilityStatusRequestOriginal, type GetRefundabilityStatusResponse as GetRefundabilityStatusResponseOriginal, type GetShipmentsRequest as GetShipmentsRequestOriginal, type GetShipmentsResponse as GetShipmentsResponseOriginal, type GiftCardPaymentDetails as GiftCardPaymentDetailsOriginal, type GiftCardPaymentRefund as GiftCardPaymentRefundOriginal, type HasCustomEmailConfigurationsRequest as HasCustomEmailConfigurationsRequestOriginal, type HasCustomEmailConfigurationsResponse as HasCustomEmailConfigurationsResponseOriginal, type IdAndVersion as IdAndVersionOriginal, type IdentificationDataIdOneOf as IdentificationDataIdOneOfOriginal, type IdentificationData as IdentificationDataOriginal, type Image as ImageOriginal, type ImportOrderApplicationErrors as ImportOrderApplicationErrorsOriginal, type ImportOrderRequest as ImportOrderRequestOriginal, type ImportOrderResponse as ImportOrderResponseOriginal, type ImportedOrderDeleted as ImportedOrderDeletedOriginal, type InternalActivityContentOneOf as InternalActivityContentOneOfOriginal, type InternalActivity as InternalActivityOriginal, type InternalDocument as InternalDocumentOriginal, type InternalDocumentUpdateByFilterOperation as InternalDocumentUpdateByFilterOperationOriginal, type InternalDocumentUpdateOperation as InternalDocumentUpdateOperationOriginal, type InternalQueryOrdersRequest as InternalQueryOrdersRequestOriginal, type InternalQueryOrdersResponse as InternalQueryOrdersResponseOriginal, type InternalUpdateExistingOperation as InternalUpdateExistingOperationOriginal, InventoryAction as InventoryActionOriginal, type InventoryActionWithLiterals as InventoryActionWithLiteralsOriginal, type InventoryUpdateDetails as InventoryUpdateDetailsOriginal, type InvoiceAdded as InvoiceAddedOriginal, type InvoiceDates as InvoiceDatesOriginal, type InvoiceDynamicPriceTotals as InvoiceDynamicPriceTotalsOriginal, type InvoiceFields as InvoiceFieldsOriginal, type InvoiceSentEvent as InvoiceSentEventOriginal, type InvoiceSent as InvoiceSentOriginal, InvoiceStatus as InvoiceStatusOriginal, type InvoiceStatusWithLiterals as InvoiceStatusWithLiteralsOriginal, type InvoicesPayment as InvoicesPaymentOriginal, type IsInAutomationMigrationPopulationRequest as IsInAutomationMigrationPopulationRequestOriginal, type IsInAutomationMigrationPopulationResponse as IsInAutomationMigrationPopulationResponseOriginal, type ItemChangedDetails as ItemChangedDetailsOriginal, type ItemCombinationLineItem as ItemCombinationLineItemOriginal, type ItemCombination as ItemCombinationOriginal, type ItemMetadata as ItemMetadataOriginal, type ItemModifier as ItemModifierOriginal, type ItemTaxFullDetails as ItemTaxFullDetailsOriginal, type ItemTypeItemTypeDataOneOf as ItemTypeItemTypeDataOneOfOriginal, type ItemType as ItemTypeOriginal, ItemTypePreset as ItemTypePresetOriginal, type ItemTypePresetWithLiterals as ItemTypePresetWithLiteralsOriginal, type ItemizedFee as ItemizedFeeOriginal, JurisdictionType as JurisdictionTypeOriginal, type JurisdictionTypeWithLiterals as JurisdictionTypeWithLiteralsOriginal, type LineItemAmount as LineItemAmountOriginal, type LineItemChanges as LineItemChangesOriginal, type LineItemDeltaDeltaOneOf as LineItemDeltaDeltaOneOfOriginal, type LineItemDelta as LineItemDeltaOriginal, type LineItemDescriptionLineChange as LineItemDescriptionLineChangeOriginal, type LineItemDiscount as LineItemDiscountOriginal, type LineItemExchangeData as LineItemExchangeDataOriginal, type LineItemMetaData as LineItemMetaDataOriginal, type LineItemModifiersChange as LineItemModifiersChangeOriginal, type LineItem as LineItemOriginal, type LineItemPriceChange as LineItemPriceChangeOriginal, type LineItemProductNameChange as LineItemProductNameChangeOriginal, type LineItemQuantityChange as LineItemQuantityChangeOriginal, LineItemQuantityChangeType as LineItemQuantityChangeTypeOriginal, type LineItemQuantityChangeTypeWithLiterals as LineItemQuantityChangeTypeWithLiteralsOriginal, type LineItemRefund as LineItemRefundOriginal, type LineItemRefundSummary as LineItemRefundSummaryOriginal, type LineItemTaxBreakdown as LineItemTaxBreakdownOriginal, type LineItemTaxInfo as LineItemTaxInfoOriginal, type LineItemTax as LineItemTaxOriginal, type LineItemUpdate as LineItemUpdateOriginal, type LineItems as LineItemsOriginal, type Locale as LocaleOriginal, type LocationAndQuantity as LocationAndQuantityOriginal, type Location as LocationOriginal, type ManagedAdditionalFee as ManagedAdditionalFeeOriginal, type ManagedDiscount as ManagedDiscountOriginal, type ManagedLineItem as ManagedLineItemOriginal, ManuallyRefundableReason as ManuallyRefundableReasonOriginal, type ManuallyRefundableReasonWithLiterals as ManuallyRefundableReasonWithLiteralsOriginal, type MarkAsFulfilledRequest as MarkAsFulfilledRequestOriginal, type MarkAsFulfilledResponse as MarkAsFulfilledResponseOriginal, type MarkAsUnfulfilledRequest as MarkAsUnfulfilledRequestOriginal, type MarkAsUnfulfilledResponse as MarkAsUnfulfilledResponseOriginal, type MarkOrderAsPaidRequest as MarkOrderAsPaidRequestOriginal, type MarkOrderAsPaidResponse as MarkOrderAsPaidResponseOriginal, type MarkOrderAsSeenByHumanRequest as MarkOrderAsSeenByHumanRequestOriginal, type MarkOrderAsSeenByHumanResponse as MarkOrderAsSeenByHumanResponseOriginal, type MaskedOrderLineItem as MaskedOrderLineItemOriginal, type MaskedOrder as MaskedOrderOriginal, MeasurementUnit as MeasurementUnitOriginal, type MeasurementUnitWithLiterals as MeasurementUnitWithLiteralsOriginal, type MembershipChargeItem as MembershipChargeItemOriginal, type MembershipName as MembershipNameOriginal, type MembershipPaymentDetails as MembershipPaymentDetailsOriginal, type MembershipPaymentRefund as MembershipPaymentRefundOriginal, MembershipPaymentStatus as MembershipPaymentStatusOriginal, type MembershipPaymentStatusWithLiterals as MembershipPaymentStatusWithLiteralsOriginal, type MerchantComment as MerchantCommentOriginal, type MerchantDiscountMerchantDiscountReasonOneOf as MerchantDiscountMerchantDiscountReasonOneOfOriginal, type MerchantDiscount as MerchantDiscountOriginal, type MessageEnvelope as MessageEnvelopeOriginal, type MetaData as MetaDataOriginal, type MetaSiteSpecialEvent as MetaSiteSpecialEventOriginal, type MetaSiteSpecialEventPayloadOneOf as MetaSiteSpecialEventPayloadOneOfOriginal, type ModifierGroup as ModifierGroupOriginal, type NamespaceChanged as NamespaceChangedOriginal, Namespace as NamespaceOriginal, type NamespaceWithLiterals as NamespaceWithLiteralsOriginal, type NewExchangeOrderCreated as NewExchangeOrderCreatedOriginal, NonRefundableReason as NonRefundableReasonOriginal, type NonRefundableReasonWithLiterals as NonRefundableReasonWithLiteralsOriginal, type OdeditorAssigned as OdeditorAssignedOriginal, type OdeditorUnassigned as OdeditorUnassignedOriginal, OrderActionType as OrderActionTypeOriginal, type OrderActionTypeWithLiterals as OrderActionTypeWithLiteralsOriginal, OrderActivityTypeEnumActivityType as OrderActivityTypeEnumActivityTypeOriginal, type OrderActivityTypeEnumActivityTypeWithLiterals as OrderActivityTypeEnumActivityTypeWithLiteralsOriginal, OrderApprovalStrategy as OrderApprovalStrategyOriginal, type OrderApprovalStrategyWithLiterals as OrderApprovalStrategyWithLiteralsOriginal, type OrderApproved as OrderApprovedOriginal, type OrderCanceledEventOrderCanceled as OrderCanceledEventOrderCanceledOriginal, type OrderCanceled as OrderCanceledOriginal, type OrderChange as OrderChangeOriginal, type OrderChangeValueOneOf as OrderChangeValueOneOfOriginal, type OrderCreateNotifications as OrderCreateNotificationsOriginal, type OrderCreatedFromExchange as OrderCreatedFromExchangeOriginal, type OrderCreationSettingsEditableByOneOf as OrderCreationSettingsEditableByOneOfOriginal, type OrderCreationSettings as OrderCreationSettingsOriginal, type OrderDeltasCommitted as OrderDeltasCommittedOriginal, type OrderFulfilled as OrderFulfilledOriginal, type OrderImported as OrderImportedOriginal, type OrderItemsRestocked as OrderItemsRestockedOriginal, type OrderLineItemChangedDetails as OrderLineItemChangedDetailsOriginal, type OrderLineItem as OrderLineItemOriginal, type OrderNotFulfilled as OrderNotFulfilledOriginal, type Order as OrderOriginal, type OrderPaid as OrderPaidOriginal, type OrderPartiallyPaid as OrderPartiallyPaidOriginal, type OrderPending as OrderPendingOriginal, type OrderPlaced as OrderPlacedOriginal, type OrderRefunded as OrderRefundedOriginal, type OrderRejectedEventOrderRejected as OrderRejectedEventOrderRejectedOriginal, type OrderRejected as OrderRejectedOriginal, type OrderSettingsAllowedActionsOneOf as OrderSettingsAllowedActionsOneOfOriginal, type OrderSettingsEditableByOneOf as OrderSettingsEditableByOneOfOriginal, type OrderSettings as OrderSettingsOriginal, OrderStatus as OrderStatusOriginal, type OrderStatusWithLiterals as OrderStatusWithLiteralsOriginal, type OrderTaxBreakdown as OrderTaxBreakdownOriginal, type OrderTaxInfo as OrderTaxInfoOriginal, type OrderTransactions as OrderTransactionsOriginal, type OrdersExperiments as OrdersExperimentsOriginal, Origin as OriginOriginal, type OriginWithLiterals as OriginWithLiteralsOriginal, type OwnerApps as OwnerAppsOriginal, type PaymentCanceled as PaymentCanceledOriginal, type PaymentCanceledPaymentDetailsOneOf as PaymentCanceledPaymentDetailsOneOfOriginal, type PaymentCapture as PaymentCaptureOriginal, PaymentCollectabilityStatus as PaymentCollectabilityStatusOriginal, type PaymentCollectabilityStatusWithLiterals as PaymentCollectabilityStatusWithLiteralsOriginal, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as PaymentCollectionCreatePaymentGatewayOrderApplicationErrorsOriginal, type PaymentCollectionMarkOrderAsPaidApplicationErrors as PaymentCollectionMarkOrderAsPaidApplicationErrorsOriginal, type PaymentDeclined as PaymentDeclinedOriginal, type PaymentDeclinedPaymentDetailsOneOf as PaymentDeclinedPaymentDetailsOneOfOriginal, type PaymentMethodName as PaymentMethodNameOriginal, PaymentOptionType as PaymentOptionTypeOriginal, type PaymentOptionTypeWithLiterals as PaymentOptionTypeWithLiteralsOriginal, type Payment as PaymentOriginal, type PaymentPaymentDetailsOneOf as PaymentPaymentDetailsOneOfOriginal, type PaymentPending as PaymentPendingOriginal, type PaymentPendingPaymentDetailsOneOf as PaymentPendingPaymentDetailsOneOfOriginal, type PaymentReceiptInfoOneOf as PaymentReceiptInfoOneOfOriginal, type PaymentRefundFailed as PaymentRefundFailedOriginal, type PaymentRefund as PaymentRefundOriginal, type PaymentRefunded as PaymentRefundedOriginal, type PaymentStatusDetailsOneOf as PaymentStatusDetailsOneOfOriginal, type PaymentStatusDetails as PaymentStatusDetailsOriginal, type PaymentStatusDetailsStatusDetailsOneOf as PaymentStatusDetailsStatusDetailsOneOfOriginal, PaymentStatusEnumPaymentStatus as PaymentStatusEnumPaymentStatusOriginal, type PaymentStatusEnumPaymentStatusWithLiterals as PaymentStatusEnumPaymentStatusWithLiteralsOriginal, PaymentStatus as PaymentStatusOriginal, type PaymentStatusUpdated as PaymentStatusUpdatedOriginal, type PaymentStatusWithLiterals as PaymentStatusWithLiteralsOriginal, type Payments as PaymentsOriginal, type Phone as PhoneOriginal, type PhysicalProperties as PhysicalPropertiesOriginal, type PicassoAssigned as PicassoAssignedOriginal, type PicassoUnassigned as PicassoUnassignedOriginal, type PickupAddress as PickupAddressOriginal, type PickupDetails as PickupDetailsOriginal, PickupMethod as PickupMethodOriginal, type PickupMethodWithLiterals as PickupMethodWithLiteralsOriginal, type PickupReadyEmailSent as PickupReadyEmailSentOriginal, Placement as PlacementOriginal, type PlacementWithLiterals as PlacementWithLiteralsOriginal, type PlainTextValue as PlainTextValueOriginal, type PlatformFee as PlatformFeeOriginal, type PlatformFeeSummary as PlatformFeeSummaryOriginal, type PlatformPagingMetadata as PlatformPagingMetadataOriginal, type PlatformPaging as PlatformPagingOriginal, type PlatformQuery as PlatformQueryOriginal, type PlatformQueryPagingMethodOneOf as PlatformQueryPagingMethodOneOfOriginal, PredefinedPaymentMethod as PredefinedPaymentMethodOriginal, type PredefinedPaymentMethodWithLiterals as PredefinedPaymentMethodWithLiteralsOriginal, type PreparePaymentCollectionApplicationErrors as PreparePaymentCollectionApplicationErrorsOriginal, type PreparePaymentCollectionRequest as PreparePaymentCollectionRequestOriginal, type PreparePaymentCollectionResponse as PreparePaymentCollectionResponseOriginal, type PreviewBuyerConfirmationEmailRequest as PreviewBuyerConfirmationEmailRequestOriginal, type PreviewBuyerConfirmationEmailResponse as PreviewBuyerConfirmationEmailResponseOriginal, type PreviewBuyerPaymentsReceivedEmailRequest as PreviewBuyerPaymentsReceivedEmailRequestOriginal, type PreviewBuyerPaymentsReceivedEmailResponse as PreviewBuyerPaymentsReceivedEmailResponseOriginal, type PreviewBuyerPickupConfirmationEmailRequest as PreviewBuyerPickupConfirmationEmailRequestOriginal, type PreviewBuyerPickupConfirmationEmailResponse as PreviewBuyerPickupConfirmationEmailResponseOriginal, type PreviewCancelEmailRequest as PreviewCancelEmailRequestOriginal, type PreviewCancelEmailResponse as PreviewCancelEmailResponseOriginal, type PreviewCancelRefundEmailRequest as PreviewCancelRefundEmailRequestOriginal, type PreviewCancelRefundEmailResponse as PreviewCancelRefundEmailResponseOriginal, type PreviewEmailByTypeRequest as PreviewEmailByTypeRequestOriginal, type PreviewEmailByTypeResponse as PreviewEmailByTypeResponseOriginal, PreviewEmailType as PreviewEmailTypeOriginal, type PreviewEmailTypeWithLiterals as PreviewEmailTypeWithLiteralsOriginal, type PreviewRefundEmailRequest as PreviewRefundEmailRequestOriginal, type PreviewRefundEmailResponse as PreviewRefundEmailResponseOriginal, type PreviewResendDownloadLinksEmailRequest as PreviewResendDownloadLinksEmailRequestOriginal, type PreviewResendDownloadLinksEmailResponse as PreviewResendDownloadLinksEmailResponseOriginal, type PreviewShippingConfirmationEmailRequest as PreviewShippingConfirmationEmailRequestOriginal, type PreviewShippingConfirmationEmailResponse as PreviewShippingConfirmationEmailResponseOriginal, type PriceDescription as PriceDescriptionOriginal, type Price as PriceOriginal, type PriceSummary as PriceSummaryOriginal, type ProductName as ProductNameOriginal, ProductPeriodAlignment as ProductPeriodAlignmentOriginal, type ProductPeriodAlignmentWithLiterals as ProductPeriodAlignmentWithLiteralsOriginal, type PublicActivityContentOneOf as PublicActivityContentOneOfOriginal, type PublicActivity as PublicActivityOriginal, type QueryOrderRequest as QueryOrderRequestOriginal, type QueryOrderResponse as QueryOrderResponseOriginal, type QuotesAddress as QuotesAddressOriginal, Reason as ReasonOriginal, type ReasonWithLiterals as ReasonWithLiteralsOriginal, type ReceiptCreated as ReceiptCreatedOriginal, type ReceiptCreatedReceiptInfoOneOf as ReceiptCreatedReceiptInfoOneOfOriginal, type ReceiptSent as ReceiptSentOriginal, type ReceiptSentReceiptInfoOneOf as ReceiptSentReceiptInfoOneOfOriginal, type RecordManuallyCollectedPaymentApplicationErrors as RecordManuallyCollectedPaymentApplicationErrorsOriginal, type RecordManuallyCollectedPaymentRequest as RecordManuallyCollectedPaymentRequestOriginal, type RecordManuallyCollectedPaymentResponse as RecordManuallyCollectedPaymentResponseOriginal, type RedirectUrls as RedirectUrlsOriginal, type RefundDetails as RefundDetailsOriginal, type RefundInitiated as RefundInitiatedOriginal, type RefundItem as RefundItemOriginal, type RefundItemsBreakdown as RefundItemsBreakdownOriginal, type Refund as RefundOriginal, type RefundSideEffects as RefundSideEffectsOriginal, type RefundStatusInfo as RefundStatusInfoOriginal, RefundStatus as RefundStatusOriginal, type RefundStatusWithLiterals as RefundStatusWithLiteralsOriginal, type RefundTransaction as RefundTransactionOriginal, type RefundabilityAdditionalRefundabilityInfoOneOf as RefundabilityAdditionalRefundabilityInfoOneOfOriginal, type Refundability as RefundabilityOriginal, RefundableStatus as RefundableStatusOriginal, type RefundableStatusWithLiterals as RefundableStatusWithLiteralsOriginal, type RefundedAsStoreCredit as RefundedAsStoreCreditOriginal, type RefundedPaymentKindOneOf as RefundedPaymentKindOneOfOriginal, type RefundedPayment as RefundedPaymentOriginal, type RegularPaymentDetails as RegularPaymentDetailsOriginal, type RegularPaymentDetailsPaymentMethodDetailsOneOf as RegularPaymentDetailsPaymentMethodDetailsOneOfOriginal, type RegularPayment as RegularPaymentOriginal, type RegularPaymentPaymentMethodDetailsOneOf as RegularPaymentPaymentMethodDetailsOneOfOriginal, type RegularPaymentRefund as RegularPaymentRefundOriginal, RepriceStatus as RepriceStatusOriginal, type RepriceStatusWithLiterals as RepriceStatusWithLiteralsOriginal, type Reschedule as RescheduleOriginal, type RestockInfo as RestockInfoOriginal, type RestockItem as RestockItemOriginal, type RestockLocation as RestockLocationOriginal, RestockType as RestockTypeOriginal, type RestockTypeWithLiterals as RestockTypeWithLiteralsOriginal, type RestoreInfo as RestoreInfoOriginal, type SavedPaymentMethod as SavedPaymentMethodOriginal, ScheduledAction as ScheduledActionOriginal, type ScheduledActionWithLiterals as ScheduledActionWithLiteralsOriginal, type SearchOrdersRequest as SearchOrdersRequestOriginal, type SearchOrdersResponse as SearchOrdersResponseOriginal, type SendBuyerConfirmationEmailRequest as SendBuyerConfirmationEmailRequestOriginal, type SendBuyerConfirmationEmailResponse as SendBuyerConfirmationEmailResponseOriginal, type SendBuyerPaymentsReceivedEmailRequest as SendBuyerPaymentsReceivedEmailRequestOriginal, type SendBuyerPaymentsReceivedEmailResponse as SendBuyerPaymentsReceivedEmailResponseOriginal, type SendBuyerPickupConfirmationEmailRequest as SendBuyerPickupConfirmationEmailRequestOriginal, type SendBuyerPickupConfirmationEmailResponse as SendBuyerPickupConfirmationEmailResponseOriginal, type SendBuyerShippingConfirmationEmailRequest as SendBuyerShippingConfirmationEmailRequestOriginal, type SendBuyerShippingConfirmationEmailResponse as SendBuyerShippingConfirmationEmailResponseOriginal, type SendCancelRefundEmailRequest as SendCancelRefundEmailRequestOriginal, type SendCancelRefundEmailResponse as SendCancelRefundEmailResponseOriginal, type SendFulfillmentEmailRequest as SendFulfillmentEmailRequestOriginal, type SendFulfillmentEmailResponse as SendFulfillmentEmailResponseOriginal, type SendMerchantOrderReceivedNotificationRequest as SendMerchantOrderReceivedNotificationRequestOriginal, type SendMerchantOrderReceivedNotificationResponse as SendMerchantOrderReceivedNotificationResponseOriginal, type SendMerchantOrderReceivedPushRequest as SendMerchantOrderReceivedPushRequestOriginal, type SendMerchantOrderReceivedPushResponse as SendMerchantOrderReceivedPushResponseOriginal, type SendOrderUpdatedDomainEventRequest as SendOrderUpdatedDomainEventRequestOriginal, type SendOrderUpdatedDomainEventResponse as SendOrderUpdatedDomainEventResponseOriginal, type SendRefundEmailRequest as SendRefundEmailRequestOriginal, type SendRefundEmailResponse as SendRefundEmailResponseOriginal, type ServiceProperties as ServicePropertiesOriginal, type ServiceProvisioned as ServiceProvisionedOriginal, type ServiceRemoved as ServiceRemovedOriginal, type SetOrderNumberCounterApplicationErrors as SetOrderNumberCounterApplicationErrorsOriginal, type SetOrderNumberCounterRequest as SetOrderNumberCounterRequestOriginal, type SetOrderNumberCounterResponse as SetOrderNumberCounterResponseOriginal, type ShippingAddressEdited as ShippingAddressEditedOriginal, type ShippingConfirmationEmailSent as ShippingConfirmationEmailSentOriginal, type ShippingContactDetails as ShippingContactDetailsOriginal, type ShippingInformationChange as ShippingInformationChangeOriginal, type ShippingInformation as ShippingInformationOriginal, type ShippingPrice as ShippingPriceOriginal, type ShippingRefund as ShippingRefundOriginal, type ShippingRegion as ShippingRegionOriginal, SiteCreatedContext as SiteCreatedContextOriginal, type SiteCreatedContextWithLiterals as SiteCreatedContextWithLiteralsOriginal, type SiteCreated as SiteCreatedOriginal, type SiteDeleted as SiteDeletedOriginal, type SiteHardDeleted as SiteHardDeletedOriginal, type SiteMarkedAsTemplate as SiteMarkedAsTemplateOriginal, type SiteMarkedAsWixSite as SiteMarkedAsWixSiteOriginal, type SitePublished as SitePublishedOriginal, type SitePurgedExternally as SitePurgedExternallyOriginal, type SiteRenamed as SiteRenamedOriginal, type SiteTransferred as SiteTransferredOriginal, type SiteUndeleted as SiteUndeletedOriginal, type SiteUnpublished as SiteUnpublishedOriginal, type SiteUrlChanged as SiteUrlChangedOriginal, SortOrder as SortOrderOriginal, type SortOrderWithLiterals as SortOrderWithLiteralsOriginal, type Sorting as SortingOriginal, type Source as SourceOriginal, SourceType as SourceTypeOriginal, type SourceTypeWithLiterals as SourceTypeWithLiteralsOriginal, SpecificItemsCouponBehavior as SpecificItemsCouponBehaviorOriginal, type SpecificItemsCouponBehaviorWithLiterals as SpecificItemsCouponBehaviorWithLiteralsOriginal, type StandardDetails as StandardDetailsOriginal, State as StateOriginal, type StateWithLiterals as StateWithLiteralsOriginal, type StreetAddress as StreetAddressOriginal, type StudioAssigned as StudioAssignedOriginal, type StudioTwoAssigned as StudioTwoAssignedOriginal, type StudioTwoUnassigned as StudioTwoUnassignedOriginal, type StudioUnassigned as StudioUnassignedOriginal, type Subdivision as SubdivisionOriginal, SubdivisionType as SubdivisionTypeOriginal, type SubdivisionTypeWithLiterals as SubdivisionTypeWithLiteralsOriginal, type SubscriptionDescription as SubscriptionDescriptionOriginal, SubscriptionFrequency as SubscriptionFrequencyOriginal, type SubscriptionFrequencyWithLiterals as SubscriptionFrequencyWithLiteralsOriginal, type SubscriptionInfo as SubscriptionInfoOriginal, type SubscriptionSettings as SubscriptionSettingsOriginal, type SubscriptionTitle as SubscriptionTitleOriginal, type TagList as TagListOriginal, type Tags as TagsOriginal, type TagsTagList as TagsTagListOriginal, type TagsTags as TagsTagsOriginal, type TaskActionActionOneOf as TaskActionActionOneOfOriginal, type TaskAction as TaskActionOriginal, type TaskKey as TaskKeyOriginal, type Task as TaskOriginal, type TaxSummary as TaxSummaryOriginal, type TaxableAddress as TaxableAddressOriginal, type TaxableAddressTaxableAddressDataOneOf as TaxableAddressTaxableAddressDataOneOfOriginal, TaxableAddressType as TaxableAddressTypeOriginal, type TaxableAddressTypeWithLiterals as TaxableAddressTypeWithLiteralsOriginal, type TotalPriceChange as TotalPriceChangeOriginal, type TotalPrice as TotalPriceOriginal, type TrackingLinkAdded as TrackingLinkAddedOriginal, type TrackingNumberAdded as TrackingNumberAddedOriginal, type TrackingNumberEdited as TrackingNumberEditedOriginal, TransactionStatus as TransactionStatusOriginal, type TransactionStatusWithLiterals as TransactionStatusWithLiteralsOriginal, type TranslatableString as TranslatableStringOriginal, type TranslatedValue as TranslatedValueOriginal, type TriggerRefundApplicationErrors as TriggerRefundApplicationErrorsOriginal, type TriggerRefundRequest as TriggerRefundRequestOriginal, type TriggerRefundResponse as TriggerRefundResponseOriginal, type TriggerReindexOrderRequest as TriggerReindexOrderRequestOriginal, type TriggerReindexRequest as TriggerReindexRequestOriginal, type TriggerReindexResponse as TriggerReindexResponseOriginal, type UnArchiveOrderRequest as UnArchiveOrderRequestOriginal, type UnArchiveOrderResponse as UnArchiveOrderResponseOriginal, type UpdateActivityRequest as UpdateActivityRequestOriginal, type UpdateActivityResponse as UpdateActivityResponseOriginal, type UpdateBillingContactDetailsRequest as UpdateBillingContactDetailsRequestOriginal, type UpdateBillingContactDetailsResponse as UpdateBillingContactDetailsResponseOriginal, type UpdateBuyerEmailRequest as UpdateBuyerEmailRequestOriginal, type UpdateBuyerEmailResponse as UpdateBuyerEmailResponseOriginal, type UpdateBuyerInfoRequest as UpdateBuyerInfoRequestOriginal, type UpdateBuyerInfoResponse as UpdateBuyerInfoResponseOriginal, type UpdateInternalDocumentsEventOperationOneOf as UpdateInternalDocumentsEventOperationOneOfOriginal, type UpdateInternalDocumentsEvent as UpdateInternalDocumentsEventOriginal, type UpdateLineItemsDescriptionLinesRequest as UpdateLineItemsDescriptionLinesRequestOriginal, type UpdateLineItemsDescriptionLinesResponse as UpdateLineItemsDescriptionLinesResponseOriginal, type UpdateOrderApplicationErrors as UpdateOrderApplicationErrorsOriginal, type UpdateOrderLineItemRequest as UpdateOrderLineItemRequestOriginal, type UpdateOrderLineItemResponse as UpdateOrderLineItemResponseOriginal, type UpdateOrderLineItemsRequest as UpdateOrderLineItemsRequestOriginal, type UpdateOrderLineItemsResponse as UpdateOrderLineItemsResponseOriginal, type UpdateOrderRequest as UpdateOrderRequestOriginal, type UpdateOrderResponse as UpdateOrderResponseOriginal, type UpdateOrderShippingAddressRequest as UpdateOrderShippingAddressRequestOriginal, type UpdateOrderShippingAddressResponse as UpdateOrderShippingAddressResponseOriginal, type UpdateOrderStatusApplicationErrors as UpdateOrderStatusApplicationErrorsOriginal, type UpdateOrderStatusRequest as UpdateOrderStatusRequestOriginal, type UpdateOrderStatusResponse as UpdateOrderStatusResponseOriginal, type UserDefinedPaymentMethodNameKindOneOf as UserDefinedPaymentMethodNameKindOneOfOriginal, type UserDefinedPaymentMethodName as UserDefinedPaymentMethodNameOriginal, type UserDomainMediaDisabled as UserDomainMediaDisabledOriginal, type UserDomainMediaEnabled as UserDomainMediaEnabledOriginal, type V1BulkMarkOrdersAsPaidRequest as V1BulkMarkOrdersAsPaidRequestOriginal, type V1BulkMarkOrdersAsPaidResponse as V1BulkMarkOrdersAsPaidResponseOriginal, type V1CreatePaymentGatewayOrderRequest as V1CreatePaymentGatewayOrderRequestOriginal, type V1CreatePaymentGatewayOrderResponse as V1CreatePaymentGatewayOrderResponseOriginal, type V1LineItemDeltaDeltaOneOf as V1LineItemDeltaDeltaOneOfOriginal, type V1LineItemDelta as V1LineItemDeltaOriginal, type V1MarkOrderAsPaidRequest as V1MarkOrderAsPaidRequestOriginal, type V1MarkOrderAsPaidResponse as V1MarkOrderAsPaidResponseOriginal, type V1RestockItem as V1RestockItemOriginal, type V1ScheduledAction as V1ScheduledActionOriginal, type V1ShippingInformation as V1ShippingInformationOriginal, type V1TriggerReindexOrderRequest as V1TriggerReindexOrderRequestOriginal, type V1TriggerReindexRequest as V1TriggerReindexRequestOriginal, type V1TriggerReindexResponse as V1TriggerReindexResponseOriginal, type Value as ValueOriginal, ValueType as ValueTypeOriginal, type ValueTypeWithLiterals as ValueTypeWithLiteralsOriginal, type VatId as VatIdOriginal, VatType as VatTypeOriginal, type VatTypeWithLiterals as VatTypeWithLiteralsOriginal, type VersionedDeleteByIdsOperation as VersionedDeleteByIdsOperationOriginal, type VersionedDocumentId as VersionedDocumentIdOriginal, type VersionedDocumentUpdateOperation as VersionedDocumentUpdateOperationOriginal, VersioningMode as VersioningModeOriginal, type VersioningModeWithLiterals as VersioningModeWithLiteralsOriginal, type VoidAuthorizedPaymentsApplicationErrors as VoidAuthorizedPaymentsApplicationErrorsOriginal, type VoidAuthorizedPaymentsRequest as VoidAuthorizedPaymentsRequestOriginal, type VoidAuthorizedPaymentsResponse as VoidAuthorizedPaymentsResponseOriginal, VoidedReason as VoidedReasonOriginal, type VoidedReasonWithLiterals as VoidedReasonWithLiteralsOriginal, type VoidedStatusDetails as VoidedStatusDetailsOriginal, WebhookIdentityType as WebhookIdentityTypeOriginal, type WebhookIdentityTypeWithLiterals as WebhookIdentityTypeWithLiteralsOriginal, WeightUnit as WeightUnitOriginal, type WeightUnitWithLiterals as WeightUnitWithLiteralsOriginal, type WixReceiptInfo as WixReceiptInfoOriginal, type WixReceipt as WixReceiptOriginal, type WixelAssigned as WixelAssignedOriginal, type WixelUnassigned as WixelUnassignedOriginal, type __PublicMethodMetaInfo, addActivities, addActivity, aggregateOrders, bulkDeleteImportedOrders, bulkUpdateOrderTags, bulkUpdateOrders, cancelOrder, captureAuthorizedPayments, chargeMemberships, createOrder, deleteActivity, getOrder, getPaymentCollectabilityStatus, getRefundabilityStatus, importOrder, paymentCollectionBulkMarkOrdersAsPaid, paymentCollectionCreatePaymentGatewayOrder, paymentCollectionMarkOrderAsPaid, preparePaymentCollection, recordManuallyCollectedPayment, searchOrders, setOrderNumberCounter, triggerRefund, updateActivity, updateOrder, updateOrderLineItem, updateOrderStatus, voidAuthorizedPayments };