@wix/auto_sdk_ecom_orders 1.0.317 → 1.0.319

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