@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 { ep as ImportOrderRequest$1, I as ImportOrderResponse$1, eq as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, er as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, ev as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, ez as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, eA as RecordManuallyCollectedPaymentRequest$1, eD as RecordManuallyCollectedPaymentResponse$1, eE as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, eF as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, eK as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, eN as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, eP as ChargeMembershipsRequest$1, eS as ChargeMembershipsResponse$1, eT as TriggerRefundRequest$1, p as TriggerRefundResponse$1, fA as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, fB as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, gV as GetOrderRequest$1, gW as GetOrderResponse$1, h6 as SearchOrdersRequest$1, x as SearchOrdersResponse$1, ha as CreateOrderRequest$1, he as CreateOrderResponse$1, hf as UpdateOrderRequest$1, hg as UpdateOrderResponse$1, hh as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hM as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ib as AddActivityRequest$1, N as AddActivityResponse$1, id as AddActivitiesRequest$1, W as AddActivitiesResponse$1, ie as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ig as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, im as CancelOrderRequest$1, a0 as CancelOrderResponse$1, io as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iM as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iQ as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-CQe1Ioz_.js';
1
+ import { ex as ImportOrderRequest$1, I as ImportOrderResponse$1, ey as SetOrderNumberCounterRequest$1, b as SetOrderNumberCounterResponse$1, ez as BulkDeleteImportedOrdersRequest$1, B as BulkDeleteImportedOrdersResponse$1, fU as PreparePaymentCollectionRequest$1, e as PreparePaymentCollectionResponse$1, fY as GetPaymentCollectabilityStatusRequest$1, G as GetPaymentCollectabilityStatusResponse$1, fZ as RecordManuallyCollectedPaymentRequest$1, g0 as RecordManuallyCollectedPaymentResponse$1, g1 as MarkOrderAsPaidRequest$1, M as MarkOrderAsPaidResponse$1, g2 as BulkMarkOrdersAsPaidRequest$1, j as BulkMarkOrdersAsPaidResponse$1, g7 as GetRefundabilityStatusRequest$1, k as GetRefundabilityStatusResponse$1, ga as CreatePaymentGatewayOrderRequest$1, C as CreatePaymentGatewayOrderResponse$1, gc as ChargeMembershipsRequest$1, gf as ChargeMembershipsResponse$1, gg as TriggerRefundRequest$1, p as TriggerRefundResponse$1, gU as VoidAuthorizedPaymentsRequest$1, V as VoidAuthorizedPaymentsResponse$1, gV as CaptureAuthorizedPaymentsRequest$1, t as CaptureAuthorizedPaymentsResponse$1, h1 as GetOrderRequest$1, h2 as GetOrderResponse$1, he as SearchOrdersRequest$1, x as SearchOrdersResponse$1, hi as CreateOrderRequest$1, hm as CreateOrderResponse$1, hn as UpdateOrderRequest$1, ho as UpdateOrderResponse$1, hp as BulkUpdateOrdersRequest$1, F as BulkUpdateOrdersResponse$1, hU as UpdateOrderLineItemRequest$1, K as UpdateOrderLineItemResponse$1, ik as AddActivityRequest$1, N as AddActivityResponse$1, im as AddActivitiesRequest$1, W as AddActivitiesResponse$1, io as UpdateActivityRequest$1, Y as UpdateActivityResponse$1, ip as DeleteActivityRequest$1, _ as DeleteActivityResponse$1, iv as CancelOrderRequest$1, a0 as CancelOrderResponse$1, iw as UpdateOrderStatusRequest$1, a3 as UpdateOrderStatusResponse$1, iU as AggregateOrdersRequest$1, a6 as AggregateOrdersResponse$1, iY as BulkUpdateOrderTagsRequest$1, a8 as BulkUpdateOrderTagsResponse$1 } from './ecom-v1-order-orders.universal-CaKWoBtD.js';
2
2
  import '@wix/sdk-types';
3
3
 
4
4
  /**
@@ -70,6 +70,13 @@ interface Order {
70
70
  * @immutable
71
71
  */
72
72
  taxIncludedInPrices?: boolean;
73
+ /**
74
+ * Cross-border repricing marker of the order: whether repricing is in force for it and which base tax region it uses. Set once at creation; an edit never changes it. One per order, unlike the per-line `CrossBorderPriceAdjustment` record.
75
+ * @internal
76
+ * @readonly
77
+ * @immutable
78
+ */
79
+ crossBorderRepricing?: CrossBorderRepricing;
73
80
  /**
74
81
  * Site language in which original values are shown.
75
82
  * @readonly
@@ -477,6 +484,12 @@ interface OrderLineItem {
477
484
  * @readonly
478
485
  */
479
486
  serviceProperties?: ServiceProperties;
487
+ /**
488
+ * Cross-border repricing record of this line item on a site whose catalog prices include tax: the catalog price, the base region's tax removed from it and the rate used.
489
+ * @internal
490
+ * @readonly
491
+ */
492
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
480
493
  }
481
494
  interface ProductName {
482
495
  /**
@@ -937,10 +950,16 @@ interface DigitalFile {
937
950
  interface SubscriptionInfo {
938
951
  /**
939
952
  * Subscription ID.
953
+ *
954
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
955
+ * 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).
940
956
  * @format GUID
941
957
  */
942
958
  id?: string | null;
943
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
959
+ /**
960
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
961
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
962
+ */
944
963
  cycleNumber?: number;
945
964
  /**
946
965
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -1016,7 +1035,7 @@ interface SubscriptionDescription {
1016
1035
  translated?: string | null;
1017
1036
  }
1018
1037
  interface SubscriptionSettings {
1019
- /** Frequency of recurring payment. */
1038
+ /** Frequency unit of the billing cycle. */
1020
1039
  frequency?: SubscriptionFrequencyWithLiterals;
1021
1040
  /**
1022
1041
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -1024,16 +1043,20 @@ interface SubscriptionSettings {
1024
1043
  * @max 3650
1025
1044
  */
1026
1045
  interval?: number | null;
1027
- /** Whether subscription is renewed automatically at the end of each period. */
1046
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
1028
1047
  autoRenewal?: boolean;
1029
1048
  /**
1030
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1049
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
1031
1050
  * @min 1
1032
1051
  */
1033
1052
  billingCycles?: number | null;
1034
- /** Whether to allow the customer to cancel the subscription. */
1053
+ /** Whether the buyer can cancel the subscription. */
1035
1054
  enableCustomerCancellation?: boolean;
1036
- /** Period until first cycle starts. If None => no free trial */
1055
+ /**
1056
+ * Free trial period before the first billing cycle starts.
1057
+ *
1058
+ * Returned only when the subscription has a free trial.
1059
+ */
1037
1060
  freeTrialPeriod?: FreeTrialPeriod;
1038
1061
  /**
1039
1062
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1062,7 +1085,7 @@ declare enum SubscriptionFrequency {
1062
1085
  /** @enumType */
1063
1086
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1064
1087
  interface FreeTrialPeriod {
1065
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1088
+ /** Frequency unit of the free trial period. */
1066
1089
  frequency?: SubscriptionFrequencyWithLiterals;
1067
1090
  /**
1068
1091
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -1347,6 +1370,76 @@ interface ServiceProperties {
1347
1370
  */
1348
1371
  endDate?: Date | null;
1349
1372
  }
1373
+ /**
1374
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1375
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1376
+ *
1377
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1378
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1379
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1380
+ */
1381
+ interface CrossBorderPriceAdjustment {
1382
+ /**
1383
+ * ID of the tax region whose tax is built into the catalog prices.
1384
+ * @format GUID
1385
+ */
1386
+ baseTaxRegionId?: string;
1387
+ /**
1388
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1389
+ * @format GUID
1390
+ */
1391
+ destinationTaxRegionId?: string | null;
1392
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1393
+ catalogPrice?: Price;
1394
+ /** 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. */
1395
+ baseTaxAmount?: Price;
1396
+ /** Outcome of the repricing for this line. */
1397
+ status?: RepriceStatusWithLiterals;
1398
+ /** 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`. */
1399
+ baseRateSource?: BaseRateSourceWithLiterals;
1400
+ /**
1401
+ * 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.
1402
+ * @format DECIMAL_VALUE
1403
+ * @decimalValue options { gte:0, maxScale:6 }
1404
+ */
1405
+ baseRate?: string | null;
1406
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1407
+ baseRateCapturedDate?: Date | null;
1408
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1409
+ destinationTaxIncluded?: boolean | null;
1410
+ }
1411
+ /** Outcome of the repricing for one line. */
1412
+ declare enum RepriceStatus {
1413
+ /** Base tax removed and the destination's tax applied. */
1414
+ APPLIED = "APPLIED",
1415
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1416
+ KEPT = "KEPT",
1417
+ /** 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`. */
1418
+ STRIP_ONLY = "STRIP_ONLY",
1419
+ /** The destination is the base region. Nothing was removed. */
1420
+ SAME_REGION = "SAME_REGION",
1421
+ /** 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. */
1422
+ SAME_COUNTRY = "SAME_COUNTRY",
1423
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1424
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1425
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1426
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1427
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1428
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1429
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1430
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1431
+ }
1432
+ /** @enumType */
1433
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1434
+ /** Where the base region's rate came from. */
1435
+ declare enum BaseRateSource {
1436
+ /** The manual tax calculator computed the base tax for this calculation. */
1437
+ MANUAL_SPI = "MANUAL_SPI",
1438
+ /** The rate captured from Avalara by the embedded-rate probe. */
1439
+ AVALARA_PROBE = "AVALARA_PROBE"
1440
+ }
1441
+ /** @enumType */
1442
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1350
1443
  /** Buyer information. */
1351
1444
  interface BuyerInfo extends BuyerInfoIdOneOf {
1352
1445
  /**
@@ -1470,6 +1563,25 @@ interface CurrencyConversionDetails {
1470
1563
  */
1471
1564
  conversionRate?: string | null;
1472
1565
  }
1566
+ /** 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`. */
1567
+ interface CrossBorderRepricing {
1568
+ /**
1569
+ * 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.
1570
+ *
1571
+ * Default: `false`
1572
+ */
1573
+ enabled?: boolean;
1574
+ /**
1575
+ * ID of the tax region whose tax is built into the catalog prices, as used for this order.
1576
+ * @format GUID
1577
+ */
1578
+ baseTaxRegionId?: string | null;
1579
+ /**
1580
+ * ID of the base region's tax calculator when the order was placed.
1581
+ * @format GUID
1582
+ */
1583
+ baseCalculatorId?: string | null;
1584
+ }
1473
1585
  interface PriceSummary {
1474
1586
  /** Subtotal of all line items, before discounts and before tax. */
1475
1587
  subtotal?: Price;
@@ -1773,6 +1885,12 @@ interface ShippingPrice {
1773
1885
  * @readonly
1774
1886
  */
1775
1887
  discount?: Price;
1888
+ /**
1889
+ * Cross-border repricing record of the shipping cost on a site whose catalog prices include tax.
1890
+ * @internal
1891
+ * @readonly
1892
+ */
1893
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
1776
1894
  }
1777
1895
  interface ShippingRegion {
1778
1896
  /**
@@ -1850,6 +1968,12 @@ interface OrderTaxInfo {
1850
1968
  * @readonly
1851
1969
  */
1852
1970
  totalExempt?: Price;
1971
+ /**
1972
+ * Cross-border repricing outcome of the last calculation that produced this tax: whether the lines were repriced for the destination's tax, in which mode, and when they weren't, why. Replaced on every edit, unlike the order's `crossBorderRepricing` marker.
1973
+ * @internal
1974
+ * @readonly
1975
+ */
1976
+ crossBorderCalculation?: CrossBorderCalculation;
1853
1977
  }
1854
1978
  /**
1855
1979
  * The summary of the tax breakdown for all the line items. It will hold for each tax name, the aggregated tax amount paid for it and the tax rate.
@@ -1892,6 +2016,56 @@ interface OrderTaxBreakdown {
1892
2016
  */
1893
2017
  aggregatedExemptAmount?: Price;
1894
2018
  }
2019
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
2020
+ interface CrossBorderCalculation {
2021
+ /** Whether the calculation repriced the lines for the destination's tax. */
2022
+ applied?: boolean;
2023
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
2024
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
2025
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
2026
+ mode?: CrossBorderRepricingModeWithLiterals;
2027
+ /**
2028
+ * Request ID of the calculation, for log correlation.
2029
+ * @maxLength 100
2030
+ */
2031
+ requestId?: string | null;
2032
+ }
2033
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
2034
+ declare enum CrossBorderNotApplicableReason {
2035
+ /** The repricing feature toggle is off. */
2036
+ FEATURE_DISABLED = "FEATURE_DISABLED",
2037
+ /** The site hasn't opted in to cross-border repricing. */
2038
+ NOT_OPTED_IN = "NOT_OPTED_IN",
2039
+ /** The site's prices no longer include tax. */
2040
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
2041
+ /** The base tax region doesn't exist on the site. */
2042
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
2043
+ /** The base region uses the manual calculator and has no tax mapping. */
2044
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
2045
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
2046
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
2047
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
2048
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
2049
+ /** The line items were repriced. Repricing the shipping option failed. */
2050
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
2051
+ /** The line items were repriced. Repricing the additional fees failed. */
2052
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
2053
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
2054
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
2055
+ }
2056
+ /** @enumType */
2057
+ 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';
2058
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
2059
+ declare enum CrossBorderRepricingMode {
2060
+ /** Nothing is repriced. */
2061
+ DISABLED = "DISABLED",
2062
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
2063
+ STRIP_ONLY = "STRIP_ONLY",
2064
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
2065
+ FULL = "FULL"
2066
+ }
2067
+ /** @enumType */
2068
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1895
2069
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1896
2070
  /** Coupon applied by the customer. */
1897
2071
  coupon?: Coupon;
@@ -3422,6 +3596,12 @@ interface AdditionalFee {
3422
3596
  source?: AdditionalFeeSourceWithLiterals;
3423
3597
  /** Address type tax was calculated against for this fee. */
3424
3598
  taxableAddress?: TaxableAddress;
3599
+ /**
3600
+ * Cross-border repricing record of the fee on a site whose catalog prices include tax.
3601
+ * @internal
3602
+ * @readonly
3603
+ */
3604
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
3425
3605
  }
3426
3606
  declare enum AdditionalFeeSource {
3427
3607
  /** The additional fee was added by an additional fee service plugin. */
@@ -4202,6 +4382,13 @@ interface OrderLineItemChangedDetails {
4202
4382
  * @internal
4203
4383
  */
4204
4384
  decimalQuantityUpdate?: DecimalQuantityUpdate;
4385
+ /**
4386
+ * Cross-border repricing record of the line item after the change.
4387
+ *
4388
+ * Set empty to state that the line item no longer carries a record. When omitted, the stored record is kept.
4389
+ * @internal
4390
+ */
4391
+ crossBorderAdjustmentUpdate?: CrossBorderAdjustmentUpdate;
4205
4392
  }
4206
4393
  /** Type of selected payment option for catalog item */
4207
4394
  declare enum DeltaPaymentOptionType {
@@ -4225,6 +4412,13 @@ interface DecimalQuantityUpdate {
4225
4412
  */
4226
4413
  decimalQuantity?: DecimalQuantity;
4227
4414
  }
4415
+ interface CrossBorderAdjustmentUpdate {
4416
+ /**
4417
+ * Cross-border repricing record of the line item.
4418
+ * @internal
4419
+ */
4420
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
4421
+ }
4228
4422
  interface LineItemDelta extends LineItemDeltaDeltaOneOf {
4229
4423
  lineItemAdded?: boolean;
4230
4424
  changedDetails?: ItemChangedDetails;
@@ -4581,2328 +4775,2328 @@ interface BulkDeleteImportedOrdersResponse {
4581
4775
  */
4582
4776
  jobId?: string;
4583
4777
  }
4584
- interface V1TriggerReindexRequest {
4778
+ interface SendBuyerConfirmationEmailRequest {
4585
4779
  /** @format GUID */
4586
- metasiteId?: string;
4780
+ orderId?: string;
4781
+ }
4782
+ interface SendBuyerConfirmationEmailResponse {
4783
+ }
4784
+ interface SendBuyerPaymentsReceivedEmailRequest {
4587
4785
  /**
4588
4786
  * @minLength 1
4589
4787
  * @maxLength 100
4590
- * @maxSize 100
4591
4788
  */
4592
- orderIds?: string[];
4789
+ orderId?: string;
4593
4790
  }
4594
- interface V1TriggerReindexResponse {
4791
+ interface SendBuyerPaymentsReceivedEmailResponse {
4595
4792
  }
4596
- interface V1TriggerReindexOrderRequest {
4597
- /** @format GUID */
4598
- metasiteId?: string;
4793
+ interface SendBuyerPickupConfirmationEmailRequest {
4599
4794
  /**
4600
4795
  * @minLength 1
4601
4796
  * @maxLength 100
4602
4797
  */
4603
4798
  orderId?: string;
4604
4799
  }
4605
- interface PreparePaymentCollectionRequest {
4800
+ interface SendBuyerPickupConfirmationEmailResponse {
4801
+ }
4802
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4803
+ /**
4804
+ * IDs of orders to send pickup emails for.
4805
+ * @minSize 1
4806
+ * @maxSize 300
4807
+ */
4808
+ orderIds?: string[];
4809
+ }
4810
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4811
+ }
4812
+ interface SendBuyerShippingConfirmationEmailRequest {
4606
4813
  /**
4607
- * Ecom order ID.
4608
4814
  * @minLength 1
4609
4815
  * @maxLength 100
4610
4816
  */
4611
- ecomOrderId: string;
4612
- /** Amount to collect */
4613
- amount: Price;
4817
+ orderId?: string;
4818
+ }
4819
+ interface SendBuyerShippingConfirmationEmailResponse {
4820
+ }
4821
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4614
4822
  /**
4615
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4616
- * Existing payment gateway order will be updated with a new amount.
4617
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4823
+ * IDs of orders to send pickup emails for.
4824
+ * @minSize 1
4825
+ * @maxSize 300
4618
4826
  */
4619
- paymentGatewayOrderId?: string | null;
4827
+ orderIds?: string[];
4828
+ }
4829
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4830
+ }
4831
+ interface SendMerchantOrderReceivedNotificationRequest {
4620
4832
  /**
4621
- * Whether to delay capture of the payment.
4622
- * Default: false
4623
- * @deprecated Whether to delay capture of the payment.
4624
- * Default: false
4625
- * @replacedBy delayed_capture_settings.scheduled_action
4626
- * @targetRemovalDate 2024-09-30
4833
+ * @minLength 1
4834
+ * @maxLength 100
4627
4835
  */
4628
- delayedCapture?: boolean;
4836
+ orderId?: string;
4837
+ }
4838
+ interface SendMerchantOrderReceivedNotificationResponse {
4839
+ }
4840
+ interface SendCancelRefundEmailRequest {
4629
4841
  /**
4630
- * Specifies whether payment collection is initiated by Merchant or User of User
4631
- * Default: `true`
4632
- * @internal
4842
+ * The ID of order that is canceled/refunded
4843
+ * @minLength 1
4844
+ * @maxLength 100
4633
4845
  */
4634
- merchantInitiated?: boolean | null;
4846
+ orderId?: string;
4635
4847
  /**
4636
- * Redirect urls which are used to return buyer to third party system.
4637
- * @internal
4848
+ * Personal note added to the email (optional)
4849
+ * @minLength 1
4850
+ * @maxLength 1000
4638
4851
  */
4639
- redirectUrls?: RedirectUrls;
4640
- /** Delayed capture payment settings */
4641
- delayedCaptureSettings?: DelayedCaptureSettings;
4642
- }
4643
- interface RedirectUrls {
4852
+ customMessage?: string | null;
4853
+ /** Refund amount */
4854
+ refundAmount?: Price;
4644
4855
  /**
4645
- * URL to redirect buyer in case of approved (successful) transaction
4646
- * @format WEB_URL
4856
+ * Refund ID. (Optional)
4857
+ * @format GUID
4647
4858
  */
4648
- successUrl?: string | null;
4859
+ refundId?: string | null;
4860
+ }
4861
+ interface SendCancelRefundEmailResponse {
4862
+ }
4863
+ interface SendRefundEmailRequest {
4649
4864
  /**
4650
- * URL to redirect buyer in case of buyer canceled the transaction
4651
- * @format WEB_URL
4865
+ * The ID of order that is refunded
4866
+ * @format GUID
4652
4867
  */
4653
- cancelUrl?: string | null;
4868
+ orderId?: string;
4654
4869
  /**
4655
- * URL to redirect buyer in case of failed/rejected transaction
4656
- * @format WEB_URL
4870
+ * Refund ID
4871
+ * @format GUID
4657
4872
  */
4658
- errorUrl?: string | null;
4873
+ refundId?: string;
4659
4874
  /**
4660
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4661
- * @format WEB_URL
4875
+ * Personal note added to the email (optional)
4876
+ * @minLength 1
4877
+ * @maxLength 1000
4662
4878
  */
4663
- pendingUrl?: string | null;
4879
+ customMessage?: string | null;
4664
4880
  }
4665
- interface DelayedCaptureSettings {
4666
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4667
- scheduledAction?: ScheduledActionWithLiterals;
4668
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4669
- delayDuration?: Duration;
4881
+ interface SendRefundEmailResponse {
4670
4882
  }
4671
- declare enum ScheduledAction {
4672
- /** Whether payment will be auto-voided when duration passes */
4673
- VOID = "VOID",
4674
- /** Whether payment will be auto-captured when duration passes */
4675
- CAPTURE = "CAPTURE"
4883
+ interface SendFulfillmentEmailRequest {
4884
+ /** @format GUID */
4885
+ orderId?: string;
4886
+ /** @format GUID */
4887
+ fulfillerId?: string;
4676
4888
  }
4677
- /** @enumType */
4678
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4679
- interface Duration {
4889
+ interface SendFulfillmentEmailResponse {
4890
+ }
4891
+ interface SendMerchantOrderReceivedPushRequest {
4680
4892
  /**
4681
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4682
- * @min 1
4893
+ * @minLength 1
4894
+ * @maxLength 100
4683
4895
  */
4684
- count?: number;
4685
- /** Duration unit: MINUTES, HOURS and DAYS */
4686
- unit?: DurationUnitWithLiterals;
4896
+ orderId?: string;
4687
4897
  }
4688
- declare enum DurationUnit {
4689
- MINUTES = "MINUTES",
4690
- HOURS = "HOURS",
4691
- DAYS = "DAYS"
4898
+ interface SendMerchantOrderReceivedPushResponse {
4899
+ }
4900
+ interface PreviewEmailByTypeRequest {
4901
+ emailType?: PreviewEmailTypeWithLiterals;
4902
+ }
4903
+ declare enum PreviewEmailType {
4904
+ ORDER_PLACED = "ORDER_PLACED",
4905
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4906
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4907
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4692
4908
  }
4693
4909
  /** @enumType */
4694
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4695
- interface PreparePaymentCollectionResponse {
4696
- /** Payment gateway order id which is associated with given payment */
4697
- paymentGatewayOrderId?: string;
4910
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4911
+ interface PreviewEmailByTypeResponse {
4912
+ emailPreview?: string;
4698
4913
  }
4699
- interface GetPaymentCollectabilityStatusRequest {
4914
+ interface PreviewRefundEmailRequest {
4700
4915
  /**
4701
- * Ecom order ID.
4702
4916
  * @minLength 1
4703
4917
  * @maxLength 100
4704
4918
  */
4705
- ecomOrderId: string;
4706
- }
4707
- interface GetPaymentCollectabilityStatusResponse {
4708
- /** Payment collectability status */
4709
- status?: PaymentCollectabilityStatusWithLiterals;
4710
- /** Collectable order amount */
4711
- amount?: Price;
4919
+ orderId?: string;
4920
+ /** Refund amount */
4921
+ refundAmount?: Price;
4922
+ /** Refund business details */
4923
+ details?: RefundDetails;
4712
4924
  /**
4713
- * Whether authorization supported
4714
- * @internal
4715
- */
4716
- authorizationSupported?: boolean;
4925
+ * Personal note added to the email (optional)
4926
+ * @minLength 1
4927
+ * @maxLength 1000
4928
+ */
4929
+ customMessage?: string | null;
4717
4930
  /**
4718
- * Whether custom amount is supported for payment collection
4719
- * @internal
4931
+ * Refund ID. (Optional)
4932
+ * @format GUID
4720
4933
  */
4721
- customAmountSupported?: boolean;
4722
- }
4723
- declare enum PaymentCollectabilityStatus {
4724
- UNKNOWN = "UNKNOWN",
4725
- COLLECTABLE = "COLLECTABLE",
4726
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4727
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4728
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4729
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4730
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4731
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4732
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4733
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4734
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4735
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4736
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4934
+ refundId?: string | null;
4737
4935
  }
4738
- /** @enumType */
4739
- 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';
4740
- interface RecordManuallyCollectedPaymentRequest {
4936
+ /** Business model of a refund request */
4937
+ interface RefundDetails {
4741
4938
  /**
4742
- * Order ID.
4743
- * @minLength 1
4744
- * @maxLength 100
4939
+ * Order line item IDs and quantities that were refunded.
4940
+ * @maxSize 300
4745
4941
  */
4746
- orderId: string;
4747
- /** Amount to be recorded as approved manual payment for given order */
4748
- amount: Price;
4942
+ items?: RefundItem[];
4943
+ /** Whether the shipping fee was also refunded. */
4944
+ shippingIncluded?: boolean;
4749
4945
  /**
4750
- * Payment method name provided by user.
4751
- *
4752
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4753
- * @internal
4946
+ * Reason for the refund, provided by customer (optional).
4947
+ * @maxLength 200
4754
4948
  */
4755
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4756
- }
4757
- /**
4758
- * User-defined payment method name.
4759
- * Allows specifying either a predefined type or a custom name.
4760
- */
4761
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4762
- /** Predefined payment method. */
4763
- predefined?: PredefinedPaymentMethodWithLiterals;
4949
+ reason?: string | null;
4764
4950
  /**
4765
- * Custom payment method name provided by user.
4766
- *
4767
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4768
- * @minLength 1
4769
- * @maxLength 150
4951
+ * Line items that were refunded.
4952
+ * @maxSize 300
4770
4953
  */
4771
- custom?: string | null;
4772
- }
4773
- /** @oneof */
4774
- interface UserDefinedPaymentMethodNameKindOneOf {
4775
- /** Predefined payment method. */
4776
- predefined?: PredefinedPaymentMethodWithLiterals;
4954
+ lineItems?: LineItemRefund[];
4777
4955
  /**
4778
- * Custom payment method name provided by user.
4779
- *
4780
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4781
- * @minLength 1
4782
- * @maxLength 150
4956
+ * Additional fees that were refunded.
4957
+ * @maxSize 100
4783
4958
  */
4784
- custom?: string | null;
4785
- }
4786
- /** Predefined payment method types for offline/manual payments. */
4787
- declare enum PredefinedPaymentMethod {
4788
- /** Cash payment. */
4789
- CASH = "CASH",
4790
- /** Bank transfer. */
4791
- BANK_TRANSFER = "BANK_TRANSFER",
4792
- /** Payment by check. */
4793
- CHECK = "CHECK"
4794
- }
4795
- /** @enumType */
4796
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4797
- interface RecordManuallyCollectedPaymentResponse {
4959
+ additionalFees?: AdditionalFeeRefund[];
4960
+ /** Shipping amount that was refunded. */
4961
+ shipping?: ShippingRefund;
4798
4962
  }
4799
- interface MarkOrderAsPaidRequest {
4963
+ interface RefundItem {
4800
4964
  /**
4801
- * Ecom order ID.
4802
- * @minLength 1
4803
- * @maxLength 100
4965
+ * Line item ID the refunded line item.
4966
+ * @format GUID
4804
4967
  */
4805
- ecomOrderId: string;
4968
+ lineItemId?: string;
4806
4969
  /**
4807
- * Payment method name provided by user.
4808
- *
4809
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4810
- * @internal
4970
+ * Line item quantity refunded.
4971
+ * @min 1
4972
+ * @max 100000
4811
4973
  */
4812
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4813
- }
4814
- interface MarkOrderAsPaidResponse {
4815
- /** Updated order. */
4816
- order?: Order;
4974
+ quantity?: number;
4817
4975
  }
4818
- interface BulkMarkOrdersAsPaidRequest {
4976
+ interface LineItemRefund {
4819
4977
  /**
4820
- * IDs of orders to mark as paid.
4821
- * @minSize 1
4822
- * @maxSize 100
4823
- * @minLength 1
4824
- * @maxLength 100
4978
+ * Line item ID.
4979
+ * @format GUID
4980
+ * @immutable
4825
4981
  */
4826
- ecomOrderIds: string[];
4982
+ lineItemId?: string;
4983
+ /**
4984
+ * Refund quantity.
4985
+ * @min 1
4986
+ * @max 100000
4987
+ * @immutable
4988
+ */
4989
+ quantity?: number;
4827
4990
  }
4828
- interface BulkMarkOrdersAsPaidResponse {
4991
+ interface AdditionalFeeRefund {
4829
4992
  /**
4830
- * Items updated by the bulk action.
4831
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4993
+ * Additional fee ID.
4994
+ * @format GUID
4995
+ * @immutable
4832
4996
  */
4833
- results?: BulkOrderResult[];
4834
- /** Bulk action metadata. */
4835
- bulkActionMetadata?: BulkActionMetadata;
4997
+ additionalFeeId?: string;
4998
+ /**
4999
+ * Refund amount.
5000
+ * @immutable
5001
+ */
5002
+ amount?: Price;
4836
5003
  }
4837
- interface BulkOrderResult {
4838
- /** Item metadata. */
4839
- itemMetadata?: ItemMetadata;
5004
+ interface ShippingRefund {
4840
5005
  /**
4841
- * Updated order.
4842
- *
4843
- * Returned when `returnFullEntity = true`.
5006
+ * Refund amount.
5007
+ * @immutable
4844
5008
  */
4845
- item?: Order;
5009
+ amount?: Price;
4846
5010
  }
4847
- interface ItemMetadata {
4848
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4849
- id?: string | null;
4850
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4851
- originalIndex?: number;
4852
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4853
- success?: boolean;
4854
- /** Details about the error in case of failure. */
4855
- error?: ApplicationError;
5011
+ interface PreviewRefundEmailResponse {
5012
+ emailPreview?: string;
4856
5013
  }
4857
- interface ApplicationError {
4858
- /** Error code. */
4859
- code?: string;
4860
- /** Description of the error. */
4861
- description?: string;
4862
- /** Data related to the error. */
4863
- data?: Record<string, any> | null;
5014
+ interface PreviewCancelEmailRequest {
5015
+ /**
5016
+ * @minLength 1
5017
+ * @maxLength 100
5018
+ */
5019
+ orderId?: string;
5020
+ /**
5021
+ * Personal note added to the email (optional)
5022
+ * @minLength 1
5023
+ * @maxLength 1000
5024
+ */
5025
+ customMessage?: string | null;
4864
5026
  }
4865
- interface BulkActionMetadata {
4866
- /** Number of items that were successfully processed. */
4867
- totalSuccesses?: number;
4868
- /** Number of items that couldn't be processed. */
4869
- totalFailures?: number;
4870
- /** Number of failures without details because detailed failure threshold was exceeded. */
4871
- undetailedFailures?: number;
5027
+ interface PreviewCancelEmailResponse {
5028
+ emailPreview?: string;
4872
5029
  }
4873
- interface GetRefundabilityStatusRequest {
5030
+ interface PreviewCancelRefundEmailRequest {
4874
5031
  /**
4875
- * Order ID.
4876
5032
  * @minLength 1
4877
5033
  * @maxLength 100
4878
5034
  */
4879
- ecomOrderId: string;
4880
- }
4881
- interface GetRefundabilityStatusResponse {
5035
+ orderId?: string;
4882
5036
  /**
4883
- * Refundability details.
4884
- * @maxSize 300
5037
+ * Personal note added to the email (optional)
5038
+ * @minLength 1
5039
+ * @maxLength 1000
4885
5040
  */
4886
- refundabilities?: Refundability[];
5041
+ customMessage?: string | null;
5042
+ /** Refund amount */
5043
+ refundAmount?: Price;
4887
5044
  /**
4888
- * Whether the order supports refunding per item.
4889
- * @deprecated
5045
+ * Refund ID. (Optional)
5046
+ * @format GUID
4890
5047
  */
4891
- refundablePerItem?: boolean;
5048
+ refundId?: string | null;
4892
5049
  }
4893
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4894
- /** Reason why payment is not refundable. */
4895
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4896
- /** Reason why payment is only refundable manually. */
4897
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4898
- /** Payment ID. */
4899
- paymentId?: string;
4900
- /** Payment refundability status. */
4901
- refundabilityStatus?: RefundableStatusWithLiterals;
4902
- /** Link to payment provider dashboard. */
4903
- providerLink?: string | null;
5050
+ interface PreviewCancelRefundEmailResponse {
5051
+ emailPreview?: string;
4904
5052
  }
4905
- /** @oneof */
4906
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4907
- /** Reason why payment is not refundable. */
4908
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4909
- /** Reason why payment is only refundable manually. */
4910
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5053
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4911
5054
  }
4912
- declare enum RefundableStatus {
4913
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4914
- MANUAL = "MANUAL",
4915
- REFUNDABLE = "REFUNDABLE"
5055
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
5056
+ emailPreview?: string;
4916
5057
  }
4917
- /** @enumType */
4918
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4919
- declare enum NonRefundableReason {
4920
- NONE = "NONE",
4921
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4922
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4923
- INTERNAL_ERROR = "INTERNAL_ERROR",
4924
- NOT_PAID = "NOT_PAID",
4925
- ACCESS_DENIED = "ACCESS_DENIED",
4926
- ZERO_PRICE = "ZERO_PRICE",
4927
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4928
- PENDING_REFUND = "PENDING_REFUND",
4929
- FORBIDDEN = "FORBIDDEN",
4930
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4931
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4932
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4933
- }
4934
- /** @enumType */
4935
- 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';
4936
- declare enum ManuallyRefundableReason {
4937
- EXPIRED = "EXPIRED",
4938
- NOT_SUPPORTED = "NOT_SUPPORTED",
4939
- OFFLINE = "OFFLINE",
4940
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4941
- }
4942
- /** @enumType */
4943
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4944
- interface CreatePaymentGatewayOrderRequest {
4945
- /**
4946
- * Ecom order ID.
4947
- * @minLength 1
4948
- * @maxLength 100
4949
- */
4950
- ecomOrderId: string;
4951
- /** Information about the user who initiated the payment. */
4952
- chargedBy?: ChargedBy;
4953
- /**
4954
- * Whether to delay capture of the payment.
4955
- *
4956
- * Default: false
4957
- * @internal
4958
- */
4959
- delayedCapture?: boolean;
4960
- }
4961
- interface ChargedBy {
4962
- /**
4963
- * ID - id of the user who initiated the payment
4964
- * @format GUID
4965
- */
4966
- id?: string;
4967
- /**
4968
- * Full name - name of the user who initiated the payment
4969
- * @minLength 1
4970
- * @maxLength 200
4971
- */
4972
- fullName?: string | null;
4973
- }
4974
- interface CreatePaymentGatewayOrderResponse {
4975
- /** ID of the order created in the payment gateway */
4976
- paymentGatewayOrderId?: string;
4977
- }
4978
- interface ChargeMembershipsRequest {
4979
- /**
4980
- * Order ID.
4981
- * @minLength 1
4982
- * @maxLength 100
4983
- */
4984
- ecomOrderId: string;
4985
- /**
4986
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4987
- * but a user which is using the membership on behalf of the a member
4988
- * @format GUID
4989
- */
4990
- memberId: string;
4991
- /**
4992
- * List of items to be paid by memberships
4993
- * @minSize 1
4994
- * @maxSize 300
4995
- */
4996
- membershipCharges?: MembershipChargeItem[];
5058
+ interface PreviewBuyerConfirmationEmailRequest {
4997
5059
  }
4998
- interface MembershipChargeItem {
4999
- /**
5000
- * The id of used membership
5001
- * @minLength 1
5002
- * @maxLength 100
5003
- */
5004
- membershipId?: string;
5005
- /**
5006
- * ID of the application providing this payment option
5007
- * @format GUID
5008
- */
5009
- appId?: string;
5010
- /** The name of used membership */
5011
- membershipName?: MembershipName;
5012
- /** Additional data about this membership */
5013
- membershipAdditionalData?: Record<string, any> | null;
5014
- /** Catalog and item reference info. */
5015
- catalogReference?: CatalogReference;
5016
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
5017
- serviceProperties?: ServiceProperties;
5018
- /**
5019
- * Usually would be the same as catalogReference.catalogItemId
5020
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
5021
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5022
- * @minLength 1
5023
- * @maxLength 36
5024
- */
5025
- rootCatalogItemId?: string | null;
5026
- /**
5027
- * line item id of Checkout/Order line item
5028
- * @minLength 1
5029
- * @maxLength 100
5030
- */
5031
- lineItemId?: string;
5060
+ interface PreviewBuyerConfirmationEmailResponse {
5061
+ emailPreview?: string;
5032
5062
  }
5033
- interface MembershipName {
5034
- /**
5035
- * Membership name in the site's original language.
5036
- * @maxLength 100
5037
- */
5038
- original?: string;
5039
- /**
5040
- * Membership name translated into the buyer's language.
5041
- *
5042
- * Default: The value of `original`
5043
- * @maxLength 100
5044
- */
5045
- translated?: string | null;
5063
+ interface PreviewBuyerPickupConfirmationEmailRequest {
5046
5064
  }
5047
- interface ChargeMembershipsResponse {
5065
+ interface PreviewBuyerPickupConfirmationEmailResponse {
5066
+ emailPreview?: string;
5048
5067
  }
5049
- interface TriggerRefundRequest {
5050
- /**
5051
- * The order this refund related to
5052
- * @minLength 1
5053
- * @maxLength 100
5054
- */
5055
- ecomOrderId: string;
5056
- /**
5057
- * Refund operations information
5058
- * @minSize 1
5059
- * @maxSize 1
5060
- */
5061
- payments: PaymentRefund[];
5062
- /** Business model of a refund */
5063
- details?: RefundDetails;
5064
- /** Side effect details related to refund */
5065
- sideEffects?: RefundSideEffects;
5068
+ interface PreviewShippingConfirmationEmailRequest {
5066
5069
  }
5067
- interface PaymentRefund {
5068
- /**
5069
- * Specific payment within the order to refund
5070
- * @format GUID
5071
- */
5072
- paymentId?: string;
5073
- /** Refund amount. Not relevant for membership and gift card refunds. */
5074
- amount?: Price;
5075
- /**
5076
- * Whether refund is made externally and manually (on the payment provider's side)
5077
- * 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.
5078
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5079
- */
5080
- externalRefund?: boolean;
5081
- /**
5082
- * Gateway refund id. When param is present, new refund is not created.
5083
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5084
- * and all side effects from request will be executed.
5085
- * @internal
5086
- * @minLength 1
5087
- * @maxLength 100
5088
- */
5089
- gatewayRefundId?: string | null;
5070
+ interface PreviewShippingConfirmationEmailResponse {
5071
+ emailPreview?: string;
5090
5072
  }
5091
- /** Business model of a refund request */
5092
- interface RefundDetails {
5093
- /**
5094
- * Order line item IDs and quantities that were refunded.
5095
- * @maxSize 300
5096
- */
5097
- items?: RefundItem[];
5098
- /** Whether the shipping fee was also refunded. */
5099
- shippingIncluded?: boolean;
5100
- /**
5101
- * Reason for the refund, provided by customer (optional).
5102
- * @maxLength 200
5103
- */
5104
- reason?: string | null;
5105
- /**
5106
- * Line items that were refunded.
5107
- * @maxSize 300
5108
- */
5109
- lineItems?: LineItemRefund[];
5110
- /**
5111
- * Additional fees that were refunded.
5112
- * @maxSize 100
5113
- */
5114
- additionalFees?: AdditionalFeeRefund[];
5115
- /** Shipping amount that was refunded. */
5116
- shipping?: ShippingRefund;
5073
+ interface PreviewResendDownloadLinksEmailRequest {
5117
5074
  }
5118
- interface RefundItem {
5119
- /**
5120
- * Line item ID the refunded line item.
5121
- * @format GUID
5122
- */
5123
- lineItemId?: string;
5124
- /**
5125
- * Line item quantity refunded.
5126
- * @min 1
5127
- * @max 100000
5128
- */
5129
- quantity?: number;
5075
+ interface PreviewResendDownloadLinksEmailResponse {
5076
+ emailPreview?: string;
5130
5077
  }
5131
- interface LineItemRefund {
5132
- /**
5133
- * Line item ID.
5134
- * @format GUID
5135
- * @immutable
5136
- */
5137
- lineItemId?: string;
5078
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
5079
+ /** Emitted on a meta site creation. */
5080
+ siteCreated?: SiteCreated;
5081
+ /** Emitted on a meta site transfer completion. */
5082
+ siteTransferred?: SiteTransferred;
5083
+ /** Emitted on a meta site deletion. */
5084
+ siteDeleted?: SiteDeleted;
5085
+ /** Emitted on a meta site restoration. */
5086
+ siteUndeleted?: SiteUndeleted;
5087
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5088
+ sitePublished?: SitePublished;
5089
+ /** Emitted on a meta site unpublish. */
5090
+ siteUnpublished?: SiteUnpublished;
5091
+ /** Emitted when meta site is marked as template. */
5092
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5093
+ /** Emitted when meta site is marked as a WixSite. */
5094
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5095
+ /** Emitted when an application is provisioned (installed). */
5096
+ serviceProvisioned?: ServiceProvisioned;
5097
+ /** Emitted when an application is removed (uninstalled). */
5098
+ serviceRemoved?: ServiceRemoved;
5099
+ /** Emitted when meta site name (URL slug) is changed. */
5100
+ siteRenamedPayload?: SiteRenamed;
5101
+ /** Emitted when meta site was permanently deleted. */
5102
+ hardDeleted?: SiteHardDeleted;
5103
+ /** Emitted on a namespace change. */
5104
+ namespaceChanged?: NamespaceChanged;
5105
+ /** Emitted when Studio is attached. */
5106
+ studioAssigned?: StudioAssigned;
5107
+ /** Emitted when Studio is detached. */
5108
+ studioUnassigned?: StudioUnassigned;
5138
5109
  /**
5139
- * Refund quantity.
5140
- * @min 1
5141
- * @max 100000
5142
- * @immutable
5110
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5111
+ * the actual URL.
5112
+ *
5113
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5114
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5143
5115
  */
5144
- quantity?: number;
5145
- }
5146
- interface AdditionalFeeRefund {
5116
+ urlChanged?: SiteUrlChanged;
5117
+ /** Site is marked as PurgedExternally */
5118
+ sitePurgedExternally?: SitePurgedExternally;
5119
+ /** Emitted when Odeditor is attached. */
5120
+ odeditorAssigned?: OdeditorAssigned;
5121
+ /** Emitted when Odeditor is detached. */
5122
+ odeditorUnassigned?: OdeditorUnassigned;
5123
+ /** Emitted when Picasso is attached. */
5124
+ picassoAssigned?: PicassoAssigned;
5125
+ /** Emitted when Picasso is detached. */
5126
+ picassoUnassigned?: PicassoUnassigned;
5127
+ /** Emitted when Wixel is attached. */
5128
+ wixelAssigned?: WixelAssigned;
5129
+ /** Emitted when Wixel is detached. */
5130
+ wixelUnassigned?: WixelUnassigned;
5131
+ /** Emitted when StudioTwo is attached. */
5132
+ studioTwoAssigned?: StudioTwoAssigned;
5133
+ /** Emitted when StudioTwo is detached. */
5134
+ studioTwoUnassigned?: StudioTwoUnassigned;
5135
+ /** Emitted when media from user domain is enabled. */
5136
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5137
+ /** Emitted when media from user domain is disabled. */
5138
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5139
+ /** Emitted when Editorless is attached. */
5140
+ editorlessAssigned?: EditorlessAssigned;
5141
+ /** Emitted when Editorless is detached. */
5142
+ editorlessUnassigned?: EditorlessUnassigned;
5147
5143
  /**
5148
- * Additional fee ID.
5144
+ * A meta site id.
5149
5145
  * @format GUID
5150
- * @immutable
5151
- */
5152
- additionalFeeId?: string;
5153
- /**
5154
- * Refund amount.
5155
- * @immutable
5156
5146
  */
5157
- amount?: Price;
5158
- }
5159
- interface ShippingRefund {
5147
+ metaSiteId?: string;
5148
+ /** A meta site version. Monotonically increasing. */
5149
+ version?: string;
5150
+ /** A timestamp of the event. */
5151
+ timestamp?: string;
5160
5152
  /**
5161
- * Refund amount.
5162
- * @immutable
5153
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5154
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5155
+ * @maxSize 4000
5163
5156
  */
5164
- amount?: Price;
5157
+ assets?: Asset[];
5165
5158
  }
5166
- interface RefundSideEffects {
5167
- /** Inventory restock details as part of this refund. */
5168
- restockInfo?: RestockInfo;
5169
- /** Whether to send a refund confirmation email to the customer. */
5170
- sendOrderRefundedEmail?: boolean;
5159
+ /** @oneof */
5160
+ interface MetaSiteSpecialEventPayloadOneOf {
5161
+ /** Emitted on a meta site creation. */
5162
+ siteCreated?: SiteCreated;
5163
+ /** Emitted on a meta site transfer completion. */
5164
+ siteTransferred?: SiteTransferred;
5165
+ /** Emitted on a meta site deletion. */
5166
+ siteDeleted?: SiteDeleted;
5167
+ /** Emitted on a meta site restoration. */
5168
+ siteUndeleted?: SiteUndeleted;
5169
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5170
+ sitePublished?: SitePublished;
5171
+ /** Emitted on a meta site unpublish. */
5172
+ siteUnpublished?: SiteUnpublished;
5173
+ /** Emitted when meta site is marked as template. */
5174
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5175
+ /** Emitted when meta site is marked as a WixSite. */
5176
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5177
+ /** Emitted when an application is provisioned (installed). */
5178
+ serviceProvisioned?: ServiceProvisioned;
5179
+ /** Emitted when an application is removed (uninstalled). */
5180
+ serviceRemoved?: ServiceRemoved;
5181
+ /** Emitted when meta site name (URL slug) is changed. */
5182
+ siteRenamedPayload?: SiteRenamed;
5183
+ /** Emitted when meta site was permanently deleted. */
5184
+ hardDeleted?: SiteHardDeleted;
5185
+ /** Emitted on a namespace change. */
5186
+ namespaceChanged?: NamespaceChanged;
5187
+ /** Emitted when Studio is attached. */
5188
+ studioAssigned?: StudioAssigned;
5189
+ /** Emitted when Studio is detached. */
5190
+ studioUnassigned?: StudioUnassigned;
5171
5191
  /**
5172
- * Custom message added to the refund confirmation email.
5173
- * @minLength 1
5174
- * @maxLength 1000
5192
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5193
+ * the actual URL.
5194
+ *
5195
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5196
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
5175
5197
  */
5176
- customMessage?: string | null;
5198
+ urlChanged?: SiteUrlChanged;
5199
+ /** Site is marked as PurgedExternally */
5200
+ sitePurgedExternally?: SitePurgedExternally;
5201
+ /** Emitted when Odeditor is attached. */
5202
+ odeditorAssigned?: OdeditorAssigned;
5203
+ /** Emitted when Odeditor is detached. */
5204
+ odeditorUnassigned?: OdeditorUnassigned;
5205
+ /** Emitted when Picasso is attached. */
5206
+ picassoAssigned?: PicassoAssigned;
5207
+ /** Emitted when Picasso is detached. */
5208
+ picassoUnassigned?: PicassoUnassigned;
5209
+ /** Emitted when Wixel is attached. */
5210
+ wixelAssigned?: WixelAssigned;
5211
+ /** Emitted when Wixel is detached. */
5212
+ wixelUnassigned?: WixelUnassigned;
5213
+ /** Emitted when StudioTwo is attached. */
5214
+ studioTwoAssigned?: StudioTwoAssigned;
5215
+ /** Emitted when StudioTwo is detached. */
5216
+ studioTwoUnassigned?: StudioTwoUnassigned;
5217
+ /** Emitted when media from user domain is enabled. */
5218
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5219
+ /** Emitted when media from user domain is disabled. */
5220
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5221
+ /** Emitted when Editorless is attached. */
5222
+ editorlessAssigned?: EditorlessAssigned;
5223
+ /** Emitted when Editorless is detached. */
5224
+ editorlessUnassigned?: EditorlessUnassigned;
5177
5225
  }
5178
- interface RestockInfo {
5179
- /** Restock type. */
5180
- type?: RestockTypeWithLiterals;
5226
+ interface Asset {
5181
5227
  /**
5182
- * Deprecated, use items instead
5183
- * @internal
5184
- * @maxSize 300
5185
- * @deprecated
5228
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
5229
+ * @maxLength 36
5186
5230
  */
5187
- lineItemIds?: string[];
5231
+ appDefId?: string;
5188
5232
  /**
5189
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5190
- * @maxSize 300
5233
+ * An instance id. For legacy reasons may be UUID or a string.
5234
+ * @maxLength 200
5191
5235
  */
5192
- items?: RestockItem[];
5236
+ instanceId?: string;
5237
+ /** An application state. */
5238
+ state?: StateWithLiterals;
5193
5239
  }
5194
- declare enum RestockType {
5195
- NO_ITEMS = "NO_ITEMS",
5196
- ALL_ITEMS = "ALL_ITEMS",
5197
- SOME_ITEMS = "SOME_ITEMS"
5240
+ declare enum State {
5241
+ UNKNOWN = "UNKNOWN",
5242
+ ENABLED = "ENABLED",
5243
+ DISABLED = "DISABLED",
5244
+ PENDING = "PENDING",
5245
+ DEMO = "DEMO"
5198
5246
  }
5199
5247
  /** @enumType */
5200
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5201
- interface RestockItem {
5248
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5249
+ interface SiteCreated {
5202
5250
  /**
5203
- * ID of the line item being restocked.
5251
+ * A template identifier (empty if not created from a template).
5252
+ * @maxLength 36
5253
+ */
5254
+ originTemplateId?: string;
5255
+ /**
5256
+ * An account id of the owner.
5204
5257
  * @format GUID
5205
5258
  */
5206
- lineItemId?: string;
5259
+ ownerId?: string;
5260
+ /** A context in which meta site was created. */
5261
+ context?: SiteCreatedContextWithLiterals;
5207
5262
  /**
5208
- * Line item quantity being restocked.
5209
- * @min 1
5210
- * @max 100000
5263
+ * A meta site id from which this site was created.
5264
+ *
5265
+ * In case of a creation from a template it's a template id.
5266
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5267
+ * @format GUID
5211
5268
  */
5212
- quantity?: number;
5269
+ originMetaSiteId?: string | null;
5213
5270
  /**
5214
- * Per-location breakdown of restock quantities.
5215
- * @internal
5216
- * @maxSize 5
5271
+ * A meta site name (URL slug).
5272
+ * @maxLength 20
5217
5273
  */
5218
- restockLocations?: RestockLocation[];
5274
+ siteName?: string;
5275
+ /** A namespace. */
5276
+ namespace?: NamespaceWithLiterals;
5219
5277
  }
5220
- interface TriggerRefundResponse {
5221
- /** All order's transactions after the refunds were added */
5222
- orderTransactions?: OrderTransactions;
5223
- /** Created refund ID */
5224
- refundId?: string | null;
5225
- /** Payment ID's that the refund execution had failed for */
5226
- failedPaymentIds?: ItemMetadata[];
5278
+ declare enum SiteCreatedContext {
5279
+ /** A valid option, we don't expose all reasons why site might be created. */
5280
+ OTHER = "OTHER",
5281
+ /** A meta site was created from template. */
5282
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5283
+ /** A meta site was created by copying of the transfferred meta site. */
5284
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5285
+ /** A copy of existing meta site. */
5286
+ DUPLICATE = "DUPLICATE",
5287
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5288
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5289
+ /** deprecated A meta site was created for Flash editor. */
5290
+ FLASH = "FLASH"
5227
5291
  }
5228
- /**
5229
- * A record of all payments and refunds associated with an order.
5230
- *
5231
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5232
- */
5233
- interface OrderTransactions {
5292
+ /** @enumType */
5293
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5294
+ declare enum Namespace {
5295
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5296
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5297
+ WIX = "WIX",
5298
+ /** 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. */
5299
+ SHOUT_OUT = "SHOUT_OUT",
5300
+ /** 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. */
5301
+ ALBUMS = "ALBUMS",
5302
+ /** 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. */
5303
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5304
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5305
+ HOTELS = "HOTELS",
5306
+ /** 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. */
5307
+ CLUBS = "CLUBS",
5308
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5309
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5234
5310
  /**
5235
- * Order ID.
5236
- * @format GUID
5311
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5312
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
5237
5313
  */
5238
- orderId?: string;
5314
+ DEV_SITE = "DEV_SITE",
5315
+ /** 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. */
5316
+ LOGOS = "LOGOS",
5317
+ /** 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. */
5318
+ VIDEO_MAKER = "VIDEO_MAKER",
5319
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5320
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5321
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5322
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
5239
5323
  /**
5240
- * Record of payments made to the merchant.
5241
- * @maxSize 100
5324
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5325
+ *
5326
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
5242
5327
  */
5243
- payments?: Payment[];
5328
+ HTML_DRAFT = "HTML_DRAFT",
5244
5329
  /**
5245
- * Record of refunds made to the buyer.
5246
- * @maxSize 300
5330
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5331
+ * Will be accessible from Site List and will not have a website app.
5332
+ * Once the user attaches a site, the site will become a regular wixsite.
5247
5333
  */
5248
- refunds?: Refund[];
5249
- }
5250
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5251
- /** Regular payment details. */
5252
- regularPaymentDetails?: RegularPaymentDetails;
5253
- /** Gift card payment details. */
5254
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5255
- /** Membership payment details. */
5256
- membershipPaymentDetails?: MembershipPaymentDetails;
5334
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5335
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5336
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5337
+ /** It is to be used in the Business First efforts. */
5338
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5339
+ /** Bookings business flow with no site. */
5340
+ ANYWHERE = "ANYWHERE",
5341
+ /** Namespace for Headless Backoffice with no editor */
5342
+ HEADLESS = "HEADLESS",
5257
5343
  /**
5258
- * Receipt created by Wix
5259
- * @internal
5344
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5345
+ * The site will be used for account level CSM feature for enterprise
5260
5346
  */
5261
- wixReceipt?: WixReceiptInfo;
5347
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5348
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5349
+ RISE = "RISE",
5262
5350
  /**
5263
- * Receipt created by an external system.
5264
- * @internal
5351
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5352
+ * There's a blank site behind the scene but it's blank).
5353
+ * The Mobile company will be the owner of this namespace.
5265
5354
  */
5266
- externalReceipt?: ExternalReceiptInfo;
5267
- /** @internal */
5268
- canceled?: CanceledStatusDetails;
5269
- /** @internal */
5270
- declined?: DeclinedStatusDetails;
5271
- /** @internal */
5272
- voided?: VoidedStatusDetails;
5355
+ BRANDED_FIRST = "BRANDED_FIRST",
5356
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5357
+ NOWNIA = "NOWNIA",
5273
5358
  /**
5274
- * Payment ID.
5275
- * @format GUID
5276
- * @readonly
5359
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5360
+ * The Partners company owns this namespace.
5277
5361
  */
5278
- id?: string | null;
5279
- /** 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. */
5280
- createdDate?: Date | null;
5362
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5363
+ /** Codux Headless Sites */
5364
+ CODUX = "CODUX",
5365
+ /** Bobb - AI Design Creator. */
5366
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5281
5367
  /**
5282
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5283
- * @readonly
5368
+ * Shared Blog Site is a unique single site across Enterprise account,
5369
+ * This site will hold all Blog posts related to the Marketing product.
5284
5370
  */
5285
- updatedDate?: Date | null;
5286
- /** Payment amount. */
5287
- amount?: Price;
5371
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5372
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5373
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5374
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5375
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5376
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5377
+ MIMIR = "MIMIR",
5378
+ /** Wix Twins platform. */
5379
+ TWINS = "TWINS",
5380
+ /** Wix Nano. */
5381
+ NANO = "NANO",
5382
+ /** Base44 headless sites. */
5383
+ BASE44 = "BASE44",
5384
+ /** Wix Channels Sites */
5385
+ CHANNELS = "CHANNELS",
5386
+ /** Nautilus platform. */
5387
+ NAUTILUS = "NAUTILUS",
5288
5388
  /**
5289
- * Whether refunds for this payment are disabled.
5290
- * + `true`: This payment is not refundable.
5291
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5389
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5390
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5292
5391
  */
5293
- refundDisabled?: boolean;
5392
+ SYMPHONY = "SYMPHONY",
5393
+ /** Nautilus platform app. */
5394
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5294
5395
  /**
5295
- * Whether receipt generation is allowed for this payment.
5296
- * + `true`: This payment supports receipt generation.
5297
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5298
- * @readonly
5396
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5397
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5299
5398
  */
5300
- supportReceiptGeneration?: boolean;
5301
- /** Details about cash rounding applied to this payment, when relevant. */
5302
- cashRounding?: CashRoundingDetails;
5399
+ VIBU = "VIBU",
5303
5400
  /**
5304
- * Overall payment status.
5305
- *
5306
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5401
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5402
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5403
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5404
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5307
5405
  */
5308
- status?: PaymentStatusWithLiterals;
5406
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5309
5407
  /**
5310
- * Detailed payment status information including gateway reason codes and status-specific details.
5311
- * @internal
5408
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5409
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5312
5410
  */
5313
- paymentStatusDetails?: PaymentStatusDetails;
5411
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5412
+ }
5413
+ /** @enumType */
5414
+ 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';
5415
+ /** Site transferred to another user. */
5416
+ interface SiteTransferred {
5314
5417
  /**
5315
- * Location where the payment was processed.
5316
- * @internal
5418
+ * A previous owner id (user that transfers meta site).
5317
5419
  * @format GUID
5318
- * @immutable
5319
5420
  */
5320
- locationId?: string | null;
5421
+ oldOwnerId?: string;
5321
5422
  /**
5322
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5423
+ * A new owner id (user that accepts meta site).
5323
5424
  * @format GUID
5324
5425
  */
5325
- chargeCorrelationId?: string | null;
5426
+ newOwnerId?: string;
5326
5427
  }
5327
- /** @oneof */
5328
- interface PaymentPaymentDetailsOneOf {
5329
- /** Regular payment details. */
5330
- regularPaymentDetails?: RegularPaymentDetails;
5331
- /** Gift card payment details. */
5332
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5333
- /** Membership payment details. */
5334
- membershipPaymentDetails?: MembershipPaymentDetails;
5428
+ /** Soft deletion of the meta site. Could be restored. */
5429
+ interface SiteDeleted {
5430
+ /** A deletion context. */
5431
+ deleteContext?: DeleteContext;
5335
5432
  }
5336
- /** @oneof */
5337
- interface PaymentReceiptInfoOneOf {
5433
+ interface DeleteContext {
5434
+ /** When the meta site was deleted. */
5435
+ dateDeleted?: Date | null;
5436
+ /** A status. */
5437
+ deleteStatus?: DeleteStatusWithLiterals;
5338
5438
  /**
5339
- * Receipt created by Wix
5340
- * @internal
5439
+ * A reason (flow).
5440
+ * @maxLength 255
5341
5441
  */
5342
- wixReceipt?: WixReceiptInfo;
5442
+ deleteOrigin?: string;
5343
5443
  /**
5344
- * Receipt created by an external system.
5345
- * @internal
5444
+ * A service that deleted it.
5445
+ * @maxLength 255
5346
5446
  */
5347
- externalReceipt?: ExternalReceiptInfo;
5447
+ initiatorId?: string | null;
5348
5448
  }
5349
- /** @oneof */
5350
- interface PaymentStatusDetailsOneOf {
5351
- /** @internal */
5352
- canceled?: CanceledStatusDetails;
5353
- /** @internal */
5354
- declined?: DeclinedStatusDetails;
5355
- /** @internal */
5356
- voided?: VoidedStatusDetails;
5449
+ declare enum DeleteStatus {
5450
+ UNKNOWN = "UNKNOWN",
5451
+ TRASH = "TRASH",
5452
+ DELETED = "DELETED",
5453
+ PENDING_PURGE = "PENDING_PURGE",
5454
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5357
5455
  }
5358
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5359
- /** Credit card details. */
5360
- creditCardDetails?: CreditCardPaymentMethodDetails;
5456
+ /** @enumType */
5457
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5458
+ /** Restoration of the meta site. */
5459
+ interface SiteUndeleted {
5460
+ }
5461
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5462
+ interface SitePublished {
5463
+ }
5464
+ interface SiteUnpublished {
5361
5465
  /**
5362
- * Wix Payments order ID.
5363
- * @maxLength 100
5466
+ * A list of URLs previously associated with the meta site.
5467
+ * @maxLength 4000
5468
+ * @maxSize 10000
5364
5469
  */
5365
- paymentOrderId?: string | null;
5470
+ urls?: string[];
5471
+ }
5472
+ interface SiteMarkedAsTemplate {
5473
+ }
5474
+ interface SiteMarkedAsWixSite {
5475
+ }
5476
+ /**
5477
+ * Represents a service provisioned a site.
5478
+ *
5479
+ * Note on `origin_instance_id`:
5480
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5481
+ * This is because of the following scenario:
5482
+ *
5483
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5484
+ * such as a product catalog. When you create a site from this template, you inherit this
5485
+ * default product catalog. However, if the template's product catalog is modified,
5486
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5487
+ * your site remains consistent with what you initially received and does not include any
5488
+ * changes made to the original template afterward.
5489
+ * To ensure this, the TPA on the template gets a new instance_id.
5490
+ */
5491
+ interface ServiceProvisioned {
5366
5492
  /**
5367
- * Payment gateway's transaction ID.
5368
- * This field is only returned when the value of `offline_payment` is `false`.
5369
- * @maxLength 100
5493
+ * Either UUID or EmbeddedServiceType.
5494
+ * @maxLength 36
5370
5495
  */
5371
- gatewayTransactionId?: string | null;
5496
+ appDefId?: string;
5372
5497
  /**
5373
- * Payment method.
5374
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5375
- * Non-exhaustive list of supported values:
5376
- * + `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`
5377
- * @maxLength 150
5378
- * @deprecated Payment method.
5379
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5380
- * Non-exhaustive list of supported values:
5381
- * + `CreditCard`, `Alipay`, `AstropayCash`, `AstropayDBT`, `AstropayMBT`, `Bitcoin`, `BitPay`, `Cash`, `ConvenienceStore`, `EPay`, `Fake`, `Giropay`, `IDeal`, `InPerson`, `Klarna`, `MercadoPago`, `Netpay`, `NordeaSolo`, `Offline`, `PagSeguro`, `PayEasy`, `PayPal`, `Paysafecard`, `Paysafecash`, `PointOfSale`, `Poli`, `Privat24`, `Przelewy24`, `RapidTransfer`, `Sepa`, `Skrill`, `Sofort`, `Trustly`, `Neteller`, `Unionpay`, `UniPay`, `Yandex`
5382
- * @replacedBy payment_method_name
5383
- * @targetRemovalDate 2026-07-01
5498
+ * Not only UUID. Something here could be something weird.
5499
+ * @maxLength 36
5384
5500
  */
5385
- paymentMethod?: string | null;
5501
+ instanceId?: string;
5386
5502
  /**
5387
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5388
- * @maxLength 100
5503
+ * An instance id from which this instance is originated.
5504
+ * @maxLength 36
5389
5505
  */
5390
- providerTransactionId?: string | null;
5391
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5392
- offlinePayment?: boolean;
5506
+ originInstanceId?: string;
5393
5507
  /**
5394
- * Payment status.
5395
- * @deprecated Payment status.
5396
- * @replacedBy payment.status
5397
- * @targetRemovalDate 2026-11-01
5508
+ * A version.
5509
+ * @maxLength 500
5398
5510
  */
5399
- status?: TransactionStatusWithLiterals;
5400
- /** Whether there is a payment agreement that allows for future charges. */
5401
- savedPaymentMethod?: boolean;
5402
- /** Authorization details. */
5403
- authorizationDetails?: AuthorizationDetails;
5511
+ version?: string | null;
5404
5512
  /**
5405
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5406
- * @internal
5407
- * @maxLength 300
5513
+ * The origin meta site id
5514
+ * @format GUID
5408
5515
  */
5409
- paymentProvider?: string | null;
5516
+ originMetaSiteId?: string | null;
5517
+ }
5518
+ interface ServiceRemoved {
5410
5519
  /**
5411
- * Record of chargebacks made by the buyer.
5412
- * @maxSize 6
5520
+ * Either UUID or EmbeddedServiceType.
5521
+ * @maxLength 36
5413
5522
  */
5414
- chargebacks?: Chargeback[];
5523
+ appDefId?: string;
5415
5524
  /**
5416
- * Payment method ID.
5417
- * @internal
5525
+ * Not only UUID. Something here could be something weird.
5418
5526
  * @maxLength 36
5419
5527
  */
5420
- paymentMethodId?: string | null;
5421
- /** Platform fee amount associated with this payment. */
5422
- platformFee?: Price;
5528
+ instanceId?: string;
5423
5529
  /**
5424
- * Payment method with buyer and optional owner translations.
5425
- * Non-exhaustive list of supported values:
5426
- * + `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`
5530
+ * A version.
5531
+ * @maxLength 500
5427
5532
  */
5428
- paymentMethodName?: PaymentMethodName;
5429
- }
5430
- /** @oneof */
5431
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5432
- /** Credit card details. */
5433
- creditCardDetails?: CreditCardPaymentMethodDetails;
5434
- }
5435
- declare enum TransactionStatus {
5436
- UNDEFINED = "UNDEFINED",
5437
- APPROVED = "APPROVED",
5438
- PENDING = "PENDING",
5439
- PENDING_MERCHANT = "PENDING_MERCHANT",
5440
- CANCELED = "CANCELED",
5441
- DECLINED = "DECLINED",
5442
- REFUNDED = "REFUNDED",
5443
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5444
- AUTHORIZED = "AUTHORIZED",
5445
- VOIDED = "VOIDED"
5533
+ version?: string | null;
5446
5534
  }
5447
- /** @enumType */
5448
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5449
- interface CreditCardPaymentMethodDetails {
5535
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5536
+ interface SiteRenamed {
5450
5537
  /**
5451
- * The last 4 digits of the card number.
5452
- * @maxLength 4
5538
+ * A new meta site name (URL slug).
5539
+ * @maxLength 20
5453
5540
  */
5454
- lastFourDigits?: string | null;
5541
+ newSiteName?: string;
5455
5542
  /**
5456
- * Card issuer's brand.
5457
- * @maxLength 100
5543
+ * A previous meta site name (URL slug).
5544
+ * @maxLength 255
5458
5545
  */
5459
- brand?: string | null;
5546
+ oldSiteName?: string;
5460
5547
  }
5461
- interface AuthorizationDetails {
5462
- /**
5463
- * Whether the authorized payment is of a delayed capture.
5464
- * @readonly
5465
- */
5466
- delayedCapture?: boolean;
5467
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5468
- authorizedDate?: Date | null;
5469
- /**
5470
- * List of captures associated with payment
5471
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5472
- * @maxSize 1
5473
- */
5474
- captures?: AuthorizationCapture[];
5475
- /** Void associated with payment */
5476
- void?: AuthorizationVoid;
5477
- /** Scheduled action for this transaction */
5478
- scheduledAction?: V1ScheduledAction;
5548
+ /**
5549
+ * Hard deletion of the meta site.
5550
+ *
5551
+ * Could not be restored. Therefore it's desirable to cleanup data.
5552
+ */
5553
+ interface SiteHardDeleted {
5554
+ /** A deletion context. */
5555
+ deleteContext?: DeleteContext;
5479
5556
  }
5480
- interface AuthorizationCapture {
5481
- /**
5482
- * Capture ID.
5483
- * @format GUID
5484
- * @readonly
5485
- */
5486
- id?: string | null;
5487
- /** Status of this capture action */
5488
- status?: AuthorizationCaptureStatusWithLiterals;
5557
+ interface NamespaceChanged {
5558
+ /** A previous namespace. */
5559
+ oldNamespace?: NamespaceWithLiterals;
5560
+ /** A new namespace. */
5561
+ newNamespace?: NamespaceWithLiterals;
5562
+ }
5563
+ /** Assigned Studio editor */
5564
+ interface StudioAssigned {
5565
+ }
5566
+ /** Unassigned Studio editor */
5567
+ interface StudioUnassigned {
5568
+ }
5569
+ /**
5570
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5571
+ *
5572
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5573
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5574
+ *
5575
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5576
+ */
5577
+ interface SiteUrlChanged {
5578
+ }
5579
+ /**
5580
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5581
+ * Consumed by other teams to remove relevant data.
5582
+ */
5583
+ interface SitePurgedExternally {
5489
5584
  /**
5490
- * Amount of this capture
5491
- * @immutable
5585
+ * @maxLength 2048
5586
+ * @maxSize 100
5587
+ * @deprecated
5588
+ * @targetRemovalDate 2025-04-15
5492
5589
  */
5493
- amount?: Price;
5494
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5495
- createdDate?: Date | null;
5496
- /** In case of status is FAILED may contain failure details */
5497
- failureDetails?: AuthorizationActionFailureDetails;
5590
+ appDefId?: string[];
5498
5591
  }
5499
- declare enum AuthorizationCaptureStatus {
5500
- /** Capture operation still in progress. */
5501
- PENDING = "PENDING",
5502
- /** Capture operation succeeded. */
5503
- SUCCEEDED = "SUCCEEDED",
5504
- /** Capture operation failed. */
5505
- FAILED = "FAILED"
5592
+ /** Assigned Odeditor */
5593
+ interface OdeditorAssigned {
5506
5594
  }
5507
- /** @enumType */
5508
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5509
- interface AuthorizationActionFailureDetails {
5510
- /** @maxLength 100 */
5511
- failureCode?: string;
5595
+ /** Unassigned Odeditor */
5596
+ interface OdeditorUnassigned {
5512
5597
  }
5513
- interface AuthorizationVoid {
5514
- /** Status of this void action */
5515
- status?: AuthorizationVoidStatusWithLiterals;
5516
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5517
- voidedDate?: Date | null;
5518
- /** In case of status is FAILED may contain failure details */
5519
- failureDetails?: AuthorizationActionFailureDetails;
5520
- /** Reason of void action */
5521
- reason?: ReasonWithLiterals;
5598
+ /** Assigned Picasso editor */
5599
+ interface PicassoAssigned {
5522
5600
  }
5523
- declare enum AuthorizationVoidStatus {
5524
- /** Void operation still in progress. */
5525
- PENDING = "PENDING",
5526
- /** Void operation succeeded. */
5527
- SUCCEEDED = "SUCCEEDED",
5528
- /** Void operation failed. */
5529
- FAILED = "FAILED"
5601
+ /** Unassigned Picasso */
5602
+ interface PicassoUnassigned {
5530
5603
  }
5531
- /** @enumType */
5532
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5533
- /** Reason the authorization was voided. */
5534
- declare enum Reason {
5535
- /** Authorization was voided by user. */
5536
- MANUAL = "MANUAL",
5537
- /** Authorization passed execution date. */
5538
- SCHEDULED = "SCHEDULED"
5604
+ /** Assigned Wixel */
5605
+ interface WixelAssigned {
5539
5606
  }
5540
- /** @enumType */
5541
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5542
- interface V1ScheduledAction {
5543
- /** Type of the action. */
5544
- actionType?: ActionTypeWithLiterals;
5545
- /** The date and time of the action. */
5546
- executionDate?: Date | null;
5607
+ /** Unassigned Wixel */
5608
+ interface WixelUnassigned {
5547
5609
  }
5548
- declare enum ActionType {
5549
- VOID = "VOID",
5550
- CAPTURE = "CAPTURE"
5610
+ /** Assigned StudioTwo */
5611
+ interface StudioTwoAssigned {
5612
+ }
5613
+ /** Unassigned StudioTwo */
5614
+ interface StudioTwoUnassigned {
5615
+ }
5616
+ /** Media from user domain is enabled. */
5617
+ interface UserDomainMediaEnabled {
5618
+ }
5619
+ /** Media from user domain is disabled. */
5620
+ interface UserDomainMediaDisabled {
5621
+ }
5622
+ /** Assigned Editorless */
5623
+ interface EditorlessAssigned {
5624
+ }
5625
+ /** Unassigned Editorless */
5626
+ interface EditorlessUnassigned {
5627
+ }
5628
+ interface HasCustomEmailConfigurationsRequest {
5629
+ }
5630
+ interface HasCustomEmailConfigurationsResponse {
5631
+ hasCustomConfigurations?: boolean;
5632
+ }
5633
+ interface AddToAutomationMigrationPopulationRequest {
5634
+ /** When true, sends custom email configurations to automation system via email */
5635
+ sendCustomEmailConfigs?: boolean;
5636
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5637
+ origin?: OriginWithLiterals;
5638
+ }
5639
+ declare enum Origin {
5640
+ OPT_IN = "OPT_IN",
5641
+ MIGRATION = "MIGRATION"
5551
5642
  }
5552
5643
  /** @enumType */
5553
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5554
- interface Chargeback {
5555
- /**
5556
- * Chargeback ID.
5557
- * @format GUID
5558
- * @readonly
5559
- * @immutable
5560
- */
5561
- id?: string;
5562
- /**
5563
- * 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.
5564
- * @readonly
5565
- * @immutable
5566
- */
5567
- createdDate?: Date | null;
5644
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5645
+ interface AddToAutomationMigrationPopulationResponse {
5646
+ success?: boolean;
5647
+ }
5648
+ interface IsInAutomationMigrationPopulationRequest {
5649
+ }
5650
+ interface IsInAutomationMigrationPopulationResponse {
5651
+ inPopulation?: boolean;
5652
+ }
5653
+ interface PreparePaymentCollectionRequest {
5568
5654
  /**
5569
- * 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.
5570
- * @readonly
5655
+ * Ecom order ID.
5656
+ * @minLength 1
5657
+ * @maxLength 100
5571
5658
  */
5572
- updatedDate?: Date | null;
5659
+ ecomOrderId: string;
5660
+ /** Amount to collect */
5661
+ amount: Price;
5573
5662
  /**
5574
- * Amount.
5575
- * @readonly
5576
- * @immutable
5663
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5664
+ * Existing payment gateway order will be updated with a new amount.
5665
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5577
5666
  */
5578
- amount?: Price;
5667
+ paymentGatewayOrderId?: string | null;
5579
5668
  /**
5580
- * Reversal amount. Present only when status is REVERSED.
5581
- * @readonly
5669
+ * Whether to delay capture of the payment.
5670
+ * Default: false
5671
+ * @deprecated Whether to delay capture of the payment.
5672
+ * Default: false
5673
+ * @replacedBy delayed_capture_settings.scheduled_action
5674
+ * @targetRemovalDate 2024-09-30
5582
5675
  */
5583
- reversalAmount?: Price;
5676
+ delayedCapture?: boolean;
5584
5677
  /**
5585
- * Status.
5586
- *
5587
- * Default: `"APPROVED"`.
5678
+ * Specifies whether payment collection is initiated by Merchant or User of User
5679
+ * Default: `true`
5680
+ * @internal
5588
5681
  */
5589
- status?: ChargebackStatusWithLiterals;
5682
+ merchantInitiated?: boolean | null;
5590
5683
  /**
5591
- * External chargeback ID.
5592
- * @format GUID
5593
- * @readonly
5594
- * @immutable
5684
+ * Redirect urls which are used to return buyer to third party system.
5685
+ * @internal
5595
5686
  */
5596
- externalId?: string | null;
5597
- }
5598
- declare enum ChargebackStatus {
5599
- /** Chargeback was approved. */
5600
- APPROVED = "APPROVED",
5601
- /** Chargeback was reversed. */
5602
- REVERSED = "REVERSED"
5687
+ redirectUrls?: RedirectUrls;
5688
+ /** Delayed capture payment settings */
5689
+ delayedCaptureSettings?: DelayedCaptureSettings;
5603
5690
  }
5604
- /** @enumType */
5605
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5606
- interface PaymentMethodName {
5691
+ interface RedirectUrls {
5607
5692
  /**
5608
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5609
- * @maxLength 150
5693
+ * URL to redirect buyer in case of approved (successful) transaction
5694
+ * @format WEB_URL
5610
5695
  */
5611
- buyerLanguageName?: string | null;
5696
+ successUrl?: string | null;
5612
5697
  /**
5613
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5614
- *
5615
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5616
- * @maxLength 150
5698
+ * URL to redirect buyer in case of buyer canceled the transaction
5699
+ * @format WEB_URL
5617
5700
  */
5618
- siteLanguageName?: string | null;
5701
+ cancelUrl?: string | null;
5619
5702
  /**
5620
- * User-provided payment method name.
5621
- *
5622
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5703
+ * URL to redirect buyer in case of failed/rejected transaction
5704
+ * @format WEB_URL
5623
5705
  */
5624
- userDefinedName?: UserDefinedPaymentMethodName;
5625
- }
5626
- interface GiftCardPaymentDetails {
5706
+ errorUrl?: string | null;
5627
5707
  /**
5628
- * Gift card payment ID.
5629
- * @maxLength 100
5708
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5709
+ * @format WEB_URL
5630
5710
  */
5631
- giftCardPaymentId?: string;
5711
+ pendingUrl?: string | null;
5712
+ }
5713
+ interface DelayedCaptureSettings {
5714
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5715
+ scheduledAction?: ScheduledActionWithLiterals;
5716
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5717
+ delayDuration?: Duration;
5718
+ }
5719
+ declare enum ScheduledAction {
5720
+ /** Whether payment will be auto-voided when duration passes */
5721
+ VOID = "VOID",
5722
+ /** Whether payment will be auto-captured when duration passes */
5723
+ CAPTURE = "CAPTURE"
5724
+ }
5725
+ /** @enumType */
5726
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5727
+ interface Duration {
5632
5728
  /**
5633
- * Gift card ID.
5634
- * @internal
5635
- * @deprecated
5729
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5730
+ * @min 1
5636
5731
  */
5637
- giftCardId?: string;
5732
+ count?: number;
5733
+ /** Duration unit: MINUTES, HOURS and DAYS */
5734
+ unit?: DurationUnitWithLiterals;
5735
+ }
5736
+ declare enum DurationUnit {
5737
+ MINUTES = "MINUTES",
5738
+ HOURS = "HOURS",
5739
+ DAYS = "DAYS"
5740
+ }
5741
+ /** @enumType */
5742
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5743
+ interface PreparePaymentCollectionResponse {
5744
+ /** Payment gateway order id which is associated with given payment */
5745
+ paymentGatewayOrderId?: string;
5746
+ }
5747
+ interface GetPaymentCollectabilityStatusRequest {
5638
5748
  /**
5639
- * ID of the app that created the gift card.
5640
- * @format GUID
5749
+ * Ecom order ID.
5750
+ * @minLength 1
5751
+ * @maxLength 100
5641
5752
  */
5642
- appId?: string;
5753
+ ecomOrderId: string;
5754
+ }
5755
+ interface GetPaymentCollectabilityStatusResponse {
5756
+ /** Payment collectability status */
5757
+ status?: PaymentCollectabilityStatusWithLiterals;
5758
+ /** Collectable order amount */
5759
+ amount?: Price;
5643
5760
  /**
5644
- * Whether the gift card is voided.
5645
- * @readonly
5646
- * @deprecated Whether the gift card is voided.
5647
- * @replacedBy payment.status
5648
- * @targetRemovalDate 2026-11-01
5761
+ * Whether authorization supported
5762
+ * @internal
5649
5763
  */
5650
- voided?: boolean;
5764
+ authorizationSupported?: boolean;
5651
5765
  /**
5652
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5653
- * @maxLength 30
5654
- * @immutable
5766
+ * Whether custom amount is supported for payment collection
5767
+ * @internal
5655
5768
  */
5656
- obfuscatedCode?: string | null;
5769
+ customAmountSupported?: boolean;
5657
5770
  }
5658
- interface MembershipPaymentDetails {
5659
- /**
5660
- * Membership ID.
5661
- * @maxLength 200
5662
- */
5663
- membershipId?: string;
5771
+ declare enum PaymentCollectabilityStatus {
5772
+ UNKNOWN = "UNKNOWN",
5773
+ COLLECTABLE = "COLLECTABLE",
5774
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5775
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5776
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5777
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5778
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5779
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5780
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5781
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5782
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5783
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5784
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5785
+ }
5786
+ /** @enumType */
5787
+ 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';
5788
+ interface RecordManuallyCollectedPaymentRequest {
5664
5789
  /**
5665
- * ID of the line item this membership applies to.
5790
+ * Order ID.
5666
5791
  * @minLength 1
5667
5792
  * @maxLength 100
5668
5793
  */
5669
- lineItemId?: string;
5794
+ orderId: string;
5795
+ /** Amount to be recorded as approved manual payment for given order */
5796
+ amount: Price;
5670
5797
  /**
5671
- * Payment status.
5672
- * @deprecated Payment status.
5673
- * @replacedBy payment.status
5674
- * @targetRemovalDate 2026-11-01
5798
+ * Payment method name provided by user.
5799
+ *
5800
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5801
+ * @internal
5675
5802
  */
5676
- status?: MembershipPaymentStatusWithLiterals;
5677
- /** Membership name. */
5678
- name?: MembershipName;
5803
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5804
+ }
5805
+ /**
5806
+ * User-defined payment method name.
5807
+ * Allows specifying either a predefined type or a custom name.
5808
+ */
5809
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5810
+ /** Predefined payment method. */
5811
+ predefined?: PredefinedPaymentMethodWithLiterals;
5679
5812
  /**
5680
- * The transaction ID in the membership system. Can be used to void the transaction.
5813
+ * Custom payment method name provided by user.
5814
+ *
5815
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5681
5816
  * @minLength 1
5682
- * @maxLength 100
5683
- */
5684
- externalTransactionId?: string | null;
5685
- /**
5686
- * Whether the membership is voided.
5687
- * @readonly
5688
- * @deprecated Whether the membership is voided.
5689
- * @replacedBy payment.status
5690
- * @targetRemovalDate 2026-11-01
5817
+ * @maxLength 150
5691
5818
  */
5692
- voided?: boolean;
5819
+ custom?: string | null;
5820
+ }
5821
+ /** @oneof */
5822
+ interface UserDefinedPaymentMethodNameKindOneOf {
5823
+ /** Predefined payment method. */
5824
+ predefined?: PredefinedPaymentMethodWithLiterals;
5693
5825
  /**
5694
- * ID of the application providing this payment option.
5695
- * @format GUID
5826
+ * Custom payment method name provided by user.
5827
+ *
5828
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5829
+ * @minLength 1
5830
+ * @maxLength 150
5696
5831
  */
5697
- providerAppId?: string;
5698
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5699
- futureMembership?: FutureMembershipDetails;
5832
+ custom?: string | null;
5700
5833
  }
5701
- declare enum MembershipPaymentStatus {
5702
- /** Payment was charged. */
5703
- CHARGED = "CHARGED",
5704
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5705
- CHARGE_FAILED = "CHARGE_FAILED",
5706
- /** Payment is pending. */
5707
- CHARGE_PENDING = "CHARGE_PENDING",
5708
- /** Payment was voided. */
5709
- VOIDED = "VOIDED"
5834
+ /** Predefined payment method types for offline/manual payments. */
5835
+ declare enum PredefinedPaymentMethod {
5836
+ /** Cash payment. */
5837
+ CASH = "CASH",
5838
+ /** Bank transfer. */
5839
+ BANK_TRANSFER = "BANK_TRANSFER",
5840
+ /** Payment by check. */
5841
+ CHECK = "CHECK"
5710
5842
  }
5711
5843
  /** @enumType */
5712
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5713
- interface FutureMembershipDetails {
5844
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5845
+ interface RecordManuallyCollectedPaymentResponse {
5846
+ }
5847
+ interface MarkOrderAsPaidRequest {
5714
5848
  /**
5715
- * ID of the plan line item in the order from which the membership will be created.
5716
- * @format GUID
5849
+ * Ecom order ID.
5850
+ * @minLength 1
5851
+ * @maxLength 100
5717
5852
  */
5718
- lineItemId?: string;
5853
+ ecomOrderId: string;
5719
5854
  /**
5720
- * ID of the benefit the future membership will grant.
5721
- * @maxLength 200
5855
+ * Payment method name provided by user.
5856
+ *
5857
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5858
+ * @internal
5722
5859
  */
5723
- benefitId?: string;
5860
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5724
5861
  }
5725
- interface WixReceiptInfo {
5726
- /**
5727
- * Receipt ID
5728
- * @format GUID
5729
- */
5730
- receiptId?: string;
5862
+ interface MarkOrderAsPaidResponse {
5863
+ /** Updated order. */
5864
+ order?: Order;
5865
+ }
5866
+ interface BulkMarkOrdersAsPaidRequest {
5731
5867
  /**
5732
- * Display number of receipt
5868
+ * IDs of orders to mark as paid.
5869
+ * @minSize 1
5870
+ * @maxSize 100
5733
5871
  * @minLength 1
5734
- * @maxLength 40
5872
+ * @maxLength 100
5735
5873
  */
5736
- displayNumber?: string | null;
5874
+ ecomOrderIds: string[];
5737
5875
  }
5738
- interface ExternalReceiptInfo {
5876
+ interface BulkMarkOrdersAsPaidResponse {
5739
5877
  /**
5740
- * External receipt ID
5741
- * @maxLength 100
5878
+ * Items updated by the bulk action.
5879
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5742
5880
  */
5743
- receiptId?: string | null;
5881
+ results?: BulkOrderResult[];
5882
+ /** Bulk action metadata. */
5883
+ bulkActionMetadata?: BulkActionMetadata;
5884
+ }
5885
+ interface BulkOrderResult {
5886
+ /** Item metadata. */
5887
+ itemMetadata?: ItemMetadata;
5744
5888
  /**
5745
- * ID of the app providing the receipt
5746
- * @format GUID
5889
+ * Updated order.
5890
+ *
5891
+ * Returned when `returnFullEntity = true`.
5747
5892
  */
5748
- appId?: string | null;
5893
+ item?: Order;
5894
+ }
5895
+ interface ItemMetadata {
5896
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5897
+ id?: string | null;
5898
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5899
+ originalIndex?: number;
5900
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5901
+ success?: boolean;
5902
+ /** Details about the error in case of failure. */
5903
+ error?: ApplicationError;
5904
+ }
5905
+ interface ApplicationError {
5906
+ /** Error code. */
5907
+ code?: string;
5908
+ /** Description of the error. */
5909
+ description?: string;
5910
+ /** Data related to the error. */
5911
+ data?: Record<string, any> | null;
5912
+ }
5913
+ interface BulkActionMetadata {
5914
+ /** Number of items that were successfully processed. */
5915
+ totalSuccesses?: number;
5916
+ /** Number of items that couldn't be processed. */
5917
+ totalFailures?: number;
5918
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5919
+ undetailedFailures?: number;
5920
+ }
5921
+ interface GetRefundabilityStatusRequest {
5749
5922
  /**
5750
- * Display number of receipt
5923
+ * Order ID.
5751
5924
  * @minLength 1
5752
- * @maxLength 40
5925
+ * @maxLength 100
5753
5926
  */
5754
- displayNumber?: string | null;
5927
+ ecomOrderId: string;
5755
5928
  }
5756
- interface CashRoundingDetails {
5757
- /**
5758
- * Payment amount before cash rounding was applied.
5759
- * When provided, balance and status calculations use this value instead of `amount`
5760
- * to prevent false overpayment or underpayment due to rounding.
5761
- */
5762
- unroundedAmount?: Price;
5929
+ interface GetRefundabilityStatusResponse {
5763
5930
  /**
5764
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5765
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5766
- * @readonly
5931
+ * Refundability details.
5932
+ * @maxSize 300
5767
5933
  */
5768
- roundingAdjustment?: CashRounding;
5769
- }
5770
- declare enum PaymentStatus {
5771
- /** Payment was charged successfully. */
5772
- APPROVED = "APPROVED",
5773
- /** Payment is being processed and hasn't been confirmed yet. */
5774
- PENDING = "PENDING",
5775
- /** 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. */
5776
- PENDING_MERCHANT = "PENDING_MERCHANT",
5777
- /** Payment was canceled before it was charged. */
5778
- CANCELED = "CANCELED",
5779
- /** Payment was declined by the payment provider. */
5780
- DECLINED = "DECLINED",
5781
- /** Payment was fully refunded. */
5782
- REFUNDED = "REFUNDED",
5783
- /** Part of the payment amount was refunded. */
5784
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5785
- /** 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. */
5786
- AUTHORIZED = "AUTHORIZED",
5934
+ refundabilities?: Refundability[];
5787
5935
  /**
5788
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5789
- *
5790
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
5936
+ * Whether the order supports refunding per item.
5937
+ * @deprecated
5791
5938
  */
5792
- VOIDED = "VOIDED"
5793
- }
5794
- /** @enumType */
5795
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5796
- interface CanceledStatusDetails {
5797
- reason?: CanceledReasonWithLiterals;
5939
+ refundablePerItem?: boolean;
5798
5940
  }
5799
- declare enum CanceledReason {
5800
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5801
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5802
- /** Payment was not completed by user and expired. */
5803
- EXPIRED = "EXPIRED"
5941
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5942
+ /** Reason why payment is not refundable. */
5943
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5944
+ /** Reason why payment is only refundable manually. */
5945
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5946
+ /** Payment ID. */
5947
+ paymentId?: string;
5948
+ /** Payment refundability status. */
5949
+ refundabilityStatus?: RefundableStatusWithLiterals;
5950
+ /** Link to payment provider dashboard. */
5951
+ providerLink?: string | null;
5804
5952
  }
5805
- /** @enumType */
5806
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5807
- interface DeclinedStatusDetails {
5808
- reason?: DeclinedReasonWithLiterals;
5953
+ /** @oneof */
5954
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5955
+ /** Reason why payment is not refundable. */
5956
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5957
+ /** Reason why payment is only refundable manually. */
5958
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5809
5959
  }
5810
- declare enum DeclinedReason {
5811
- /** Corresponding charge failed. */
5812
- CHARGE_FAILED = "CHARGE_FAILED",
5813
- /** Payment details expired. */
5814
- EXPIRED = "EXPIRED",
5815
- /** Insufficient funds. */
5816
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5817
- /** Gift card was disabled before charge was attempted. */
5818
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
5960
+ declare enum RefundableStatus {
5961
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5962
+ MANUAL = "MANUAL",
5963
+ REFUNDABLE = "REFUNDABLE"
5819
5964
  }
5820
5965
  /** @enumType */
5821
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5822
- interface VoidedStatusDetails {
5823
- reason?: VoidedReasonWithLiterals;
5966
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5967
+ declare enum NonRefundableReason {
5968
+ NONE = "NONE",
5969
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5970
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5971
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5972
+ NOT_PAID = "NOT_PAID",
5973
+ ACCESS_DENIED = "ACCESS_DENIED",
5974
+ ZERO_PRICE = "ZERO_PRICE",
5975
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5976
+ PENDING_REFUND = "PENDING_REFUND",
5977
+ FORBIDDEN = "FORBIDDEN",
5978
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5979
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5980
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5824
5981
  }
5825
- declare enum VoidedReason {
5826
- /** Payment was voided by merchant request. */
5827
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5828
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5829
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
5982
+ /** @enumType */
5983
+ 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';
5984
+ declare enum ManuallyRefundableReason {
5985
+ EXPIRED = "EXPIRED",
5986
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5987
+ OFFLINE = "OFFLINE",
5988
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5830
5989
  }
5831
5990
  /** @enumType */
5832
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5833
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5834
- /** @internal */
5835
- canceled?: CanceledStatusDetails;
5836
- /** @internal */
5837
- declined?: DeclinedStatusDetails;
5838
- /** @internal */
5839
- voided?: VoidedStatusDetails;
5991
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5992
+ interface CreatePaymentGatewayOrderRequest {
5840
5993
  /**
5841
- * Reason code from the payment gateway.
5842
- * @internal
5994
+ * Ecom order ID.
5843
5995
  * @minLength 1
5844
- * @maxLength 10
5996
+ * @maxLength 100
5845
5997
  */
5846
- paymentGatewayReasonCode?: string | null;
5847
- }
5848
- /** @oneof */
5849
- interface PaymentStatusDetailsStatusDetailsOneOf {
5850
- /** @internal */
5851
- canceled?: CanceledStatusDetails;
5852
- /** @internal */
5853
- declined?: DeclinedStatusDetails;
5854
- /** @internal */
5855
- voided?: VoidedStatusDetails;
5998
+ ecomOrderId: string;
5999
+ /** Information about the user who initiated the payment. */
6000
+ chargedBy?: ChargedBy;
6001
+ /**
6002
+ * Whether to delay capture of the payment.
6003
+ *
6004
+ * Default: false
6005
+ * @internal
6006
+ */
6007
+ delayedCapture?: boolean;
5856
6008
  }
5857
- interface Refund {
6009
+ interface ChargedBy {
5858
6010
  /**
5859
- * Refund ID.
6011
+ * ID - id of the user who initiated the payment
5860
6012
  * @format GUID
5861
- * @readonly
5862
6013
  */
5863
6014
  id?: string;
5864
6015
  /**
5865
- * List of transactions.
5866
- * @maxSize 50
6016
+ * Full name - name of the user who initiated the payment
6017
+ * @minLength 1
6018
+ * @maxLength 200
5867
6019
  */
5868
- transactions?: RefundTransaction[];
5869
- /** Refund business details. */
5870
- details?: RefundDetails;
6020
+ fullName?: string | null;
6021
+ }
6022
+ interface CreatePaymentGatewayOrderResponse {
6023
+ /** ID of the order created in the payment gateway */
6024
+ paymentGatewayOrderId?: string;
6025
+ }
6026
+ interface ChargeMembershipsRequest {
5871
6027
  /**
5872
- * 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.
5873
- * @readonly
5874
- * @immutable
6028
+ * Order ID.
6029
+ * @minLength 1
6030
+ * @maxLength 100
5875
6031
  */
5876
- createdDate?: Date | null;
6032
+ ecomOrderId: string;
5877
6033
  /**
5878
- * Aggregated refund summary.
5879
- * @readonly
6034
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
6035
+ * but a user which is using the membership on behalf of the a member
6036
+ * @format GUID
5880
6037
  */
5881
- summary?: AggregatedRefundSummary;
6038
+ memberId: string;
5882
6039
  /**
5883
- * ID of the app that initiated this refund.
5884
- * @format GUID
5885
- * @readonly
5886
- * @immutable
6040
+ * List of items to be paid by memberships
6041
+ * @minSize 1
6042
+ * @maxSize 300
5887
6043
  */
5888
- requestingServiceAppId?: string | null;
6044
+ membershipCharges?: MembershipChargeItem[];
5889
6045
  }
5890
- interface RefundTransaction {
6046
+ interface MembershipChargeItem {
5891
6047
  /**
5892
- * ID of the payment associated with this refund.
6048
+ * The id of used membership
6049
+ * @minLength 1
6050
+ * @maxLength 100
6051
+ */
6052
+ membershipId?: string;
6053
+ /**
6054
+ * ID of the application providing this payment option
5893
6055
  * @format GUID
5894
- * @immutable
5895
6056
  */
5896
- paymentId?: string;
6057
+ appId?: string;
6058
+ /** The name of used membership */
6059
+ membershipName?: MembershipName;
6060
+ /** Additional data about this membership */
6061
+ membershipAdditionalData?: Record<string, any> | null;
6062
+ /** Catalog and item reference info. */
6063
+ catalogReference?: CatalogReference;
6064
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
6065
+ serviceProperties?: ServiceProperties;
5897
6066
  /**
5898
- * Refund amount.
5899
- * @immutable
6067
+ * Usually would be the same as catalogReference.catalogItemId
6068
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
6069
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
6070
+ * @minLength 1
6071
+ * @maxLength 36
5900
6072
  */
5901
- amount?: Price;
5902
- /** Refund status. */
5903
- refundStatus?: RefundStatusWithLiterals;
5904
- /** Optional details of current refund status. */
5905
- refundStatusInfo?: RefundStatusInfo;
6073
+ rootCatalogItemId?: string | null;
5906
6074
  /**
5907
- * Payment gateway's refund ID.
5908
- * This field is only returned when the value of `external_refund` is `false`.
5909
- * @format GUID
6075
+ * line item id of Checkout/Order line item
6076
+ * @minLength 1
6077
+ * @maxLength 100
5910
6078
  */
5911
- gatewayRefundId?: string | null;
5912
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5913
- providerRefundId?: string | null;
6079
+ lineItemId?: string;
6080
+ }
6081
+ interface MembershipName {
5914
6082
  /**
5915
- * Whether refund was made externally and manually on the payment provider's side.
5916
- * @immutable
6083
+ * Membership name in the site's original language.
6084
+ * @maxLength 100
5917
6085
  */
5918
- externalRefund?: boolean;
6086
+ original?: string;
5919
6087
  /**
5920
- * Location where the refund was processed.
5921
- * @internal
5922
- * @format GUID
5923
- * @immutable
6088
+ * Membership name translated into the buyer's language.
6089
+ *
6090
+ * Default: The value of `original`
6091
+ * @maxLength 100
5924
6092
  */
5925
- locationId?: string | null;
6093
+ translated?: string | null;
5926
6094
  }
5927
- /** Refund transaction status. */
5928
- declare enum RefundStatus {
5929
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5930
- PENDING = "PENDING",
5931
- /** Refund transaction succeeded. */
5932
- SUCCEEDED = "SUCCEEDED",
5933
- /** Refund transaction failed. */
5934
- FAILED = "FAILED",
5935
- /** Refund request acknowledged, and will be executed soon. */
5936
- SCHEDULED = "SCHEDULED",
5937
- /** Refund was initiated on payment provider side. */
5938
- STARTED = "STARTED"
6095
+ interface ChargeMembershipsResponse {
5939
6096
  }
5940
- /** @enumType */
5941
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5942
- interface RefundStatusInfo {
6097
+ interface TriggerRefundRequest {
6098
+ /**
6099
+ * The order this refund related to
6100
+ * @minLength 1
6101
+ * @maxLength 100
6102
+ */
6103
+ ecomOrderId: string;
6104
+ /**
6105
+ * Refund operations information
6106
+ * @minSize 1
6107
+ * @maxSize 1
6108
+ */
6109
+ payments: PaymentRefund[];
6110
+ /** Business model of a refund */
6111
+ details?: RefundDetails;
6112
+ /** Side effect details related to refund */
6113
+ sideEffects?: RefundSideEffects;
6114
+ }
6115
+ interface PaymentRefund {
6116
+ /**
6117
+ * Specific payment within the order to refund
6118
+ * @format GUID
6119
+ */
6120
+ paymentId?: string;
6121
+ /** Refund amount. Not relevant for membership and gift card refunds. */
6122
+ amount?: Price;
5943
6123
  /**
5944
- * Reason code for the refund's current status.
5945
- *
5946
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6124
+ * Whether refund is made externally and manually (on the payment provider's side)
6125
+ * 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.
6126
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
6127
+ */
6128
+ externalRefund?: boolean;
6129
+ /**
6130
+ * Gateway refund id. When param is present, new refund is not created.
6131
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6132
+ * and all side effects from request will be executed.
6133
+ * @internal
5947
6134
  * @minLength 1
5948
- * @maxLength 10
6135
+ * @maxLength 100
5949
6136
  */
5950
- paymentGatewayReasonCode?: string | null;
6137
+ gatewayRefundId?: string | null;
6138
+ }
6139
+ interface RefundSideEffects {
6140
+ /** Inventory restock details as part of this refund. */
6141
+ restockInfo?: RestockInfo;
6142
+ /** Whether to send a refund confirmation email to the customer. */
6143
+ sendOrderRefundedEmail?: boolean;
5951
6144
  /**
5952
- * Free text explanation of current refund status.
6145
+ * Custom message added to the refund confirmation email.
5953
6146
  * @minLength 1
5954
6147
  * @maxLength 1000
5955
6148
  */
5956
- description?: string | null;
5957
- }
5958
- interface AggregatedRefundSummary {
5959
- /** Total amount requested for refund. */
5960
- requestedRefund?: Price;
5961
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5962
- pendingRefund?: Price;
5963
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5964
- refunded?: Price;
5965
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5966
- failedRefundAmount?: Price;
5967
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5968
- pending?: boolean;
5969
- /** Breakdown of refunded items. Available only after refund is complete. */
5970
- breakdown?: RefundItemsBreakdown;
6149
+ customMessage?: string | null;
5971
6150
  }
5972
- interface RefundItemsBreakdown {
6151
+ interface RestockInfo {
6152
+ /** Restock type. */
6153
+ type?: RestockTypeWithLiterals;
5973
6154
  /**
5974
- * Refunded line items and the amount refunded for each.
6155
+ * Deprecated, use items instead
6156
+ * @internal
5975
6157
  * @maxSize 300
6158
+ * @deprecated
5976
6159
  */
5977
- lineItems?: LineItemRefundSummary[];
6160
+ lineItemIds?: string[];
6161
+ /**
6162
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6163
+ * @maxSize 300
6164
+ */
6165
+ items?: RestockItem[];
5978
6166
  }
5979
- interface LineItemRefundSummary {
6167
+ declare enum RestockType {
6168
+ NO_ITEMS = "NO_ITEMS",
6169
+ ALL_ITEMS = "ALL_ITEMS",
6170
+ SOME_ITEMS = "SOME_ITEMS"
6171
+ }
6172
+ /** @enumType */
6173
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6174
+ interface RestockItem {
5980
6175
  /**
5981
- * ID of the refunded line item.
6176
+ * ID of the line item being restocked.
5982
6177
  * @format GUID
5983
6178
  */
5984
6179
  lineItemId?: string;
5985
- /** Total refunded amount for the line item. */
5986
- totalRefundedAmount?: Price;
5987
- }
5988
- interface CalculateRefundRequest {
5989
6180
  /**
5990
- * Order ID
5991
- * @minLength 1
5992
- * @maxLength 100
6181
+ * Line item quantity being restocked.
6182
+ * @min 1
6183
+ * @max 100000
5993
6184
  */
5994
- ecomOrderId?: string;
6185
+ quantity?: number;
5995
6186
  /**
5996
- * Refunded line items and quantity
5997
- * @maxSize 300
6187
+ * Per-location breakdown of restock quantities.
6188
+ * @internal
6189
+ * @maxSize 5
5998
6190
  */
5999
- refundItems?: CalculateRefundItemRequest[];
6000
- /** Should include shipping in refund calculation */
6001
- refundShipping?: boolean;
6191
+ restockLocations?: RestockLocation[];
6002
6192
  }
6003
- interface CalculateRefundItemRequest {
6193
+ interface TriggerRefundResponse {
6194
+ /** All order's transactions after the refunds were added */
6195
+ orderTransactions?: OrderTransactions;
6196
+ /** Created refund ID */
6197
+ refundId?: string | null;
6198
+ /** Payment ID's that the refund execution had failed for */
6199
+ failedPaymentIds?: ItemMetadata[];
6200
+ }
6201
+ /**
6202
+ * A record of all payments and refunds associated with an order.
6203
+ *
6204
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6205
+ */
6206
+ interface OrderTransactions {
6004
6207
  /**
6005
- * ID of the line item being refunded
6208
+ * Order ID.
6006
6209
  * @format GUID
6007
6210
  */
6008
- id?: string;
6211
+ orderId?: string;
6009
6212
  /**
6010
- * How much of that line item is being refunded
6011
- * @min 1
6012
- * @max 100000
6213
+ * Record of payments made to the merchant.
6214
+ * @maxSize 100
6013
6215
  */
6014
- quantity?: number;
6015
- }
6016
- interface CalculateRefundResponse {
6017
- /** Total refundable amount */
6018
- total?: Price;
6019
- /** Tax cost of the order */
6020
- tax?: Price;
6021
- /** Discount given for this order */
6022
- discount?: Price;
6023
- /** Total cost of the order (without tax) */
6024
- subtotal?: Price;
6025
- /** Total shipping cost for order */
6026
- shipping?: Price;
6027
- /** Previous refund given on that order */
6028
- previouslyRefundedAmount?: Price;
6216
+ payments?: Payment[];
6029
6217
  /**
6030
- * The refundable items of that order
6218
+ * Record of refunds made to the buyer.
6031
6219
  * @maxSize 300
6032
6220
  */
6033
- items?: CalculateRefundItemResponse[];
6221
+ refunds?: Refund[];
6034
6222
  }
6035
- interface CalculateRefundItemResponse {
6223
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6224
+ /** Regular payment details. */
6225
+ regularPaymentDetails?: RegularPaymentDetails;
6226
+ /** Gift card payment details. */
6227
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6228
+ /** Membership payment details. */
6229
+ membershipPaymentDetails?: MembershipPaymentDetails;
6036
6230
  /**
6037
- * Line item ID
6231
+ * Receipt created by Wix
6232
+ * @internal
6233
+ */
6234
+ wixReceipt?: WixReceiptInfo;
6235
+ /**
6236
+ * Receipt created by an external system.
6237
+ * @internal
6238
+ */
6239
+ externalReceipt?: ExternalReceiptInfo;
6240
+ /** @internal */
6241
+ canceled?: CanceledStatusDetails;
6242
+ /** @internal */
6243
+ declined?: DeclinedStatusDetails;
6244
+ /** @internal */
6245
+ voided?: VoidedStatusDetails;
6246
+ /**
6247
+ * Payment ID.
6038
6248
  * @format GUID
6249
+ * @readonly
6039
6250
  */
6040
- id?: string;
6041
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6042
- price?: Price;
6043
- }
6044
- interface VoidAuthorizedPaymentsRequest {
6251
+ id?: string | null;
6252
+ /** 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. */
6253
+ createdDate?: Date | null;
6045
6254
  /**
6046
- * Wix eCommerce order ID
6047
- * @minLength 1
6048
- * @maxLength 100
6255
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
6256
+ * @readonly
6049
6257
  */
6050
- ecomOrderId: string;
6258
+ updatedDate?: Date | null;
6259
+ /** Payment amount. */
6260
+ amount?: Price;
6051
6261
  /**
6052
- * Payment IDs
6053
- * @minSize 1
6054
- * @maxSize 100
6262
+ * Whether refunds for this payment are disabled.
6263
+ * + `true`: This payment is not refundable.
6264
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
6265
+ */
6266
+ refundDisabled?: boolean;
6267
+ /**
6268
+ * Whether receipt generation is allowed for this payment.
6269
+ * + `true`: This payment supports receipt generation.
6270
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6271
+ * @readonly
6272
+ */
6273
+ supportReceiptGeneration?: boolean;
6274
+ /** Details about cash rounding applied to this payment, when relevant. */
6275
+ cashRounding?: CashRoundingDetails;
6276
+ /**
6277
+ * Overall payment status.
6278
+ *
6279
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
6280
+ */
6281
+ status?: PaymentStatusWithLiterals;
6282
+ /**
6283
+ * Detailed payment status information including gateway reason codes and status-specific details.
6284
+ * @internal
6285
+ */
6286
+ paymentStatusDetails?: PaymentStatusDetails;
6287
+ /**
6288
+ * Location where the payment was processed.
6289
+ * @internal
6055
6290
  * @format GUID
6291
+ * @immutable
6056
6292
  */
6057
- paymentIds: string[];
6293
+ locationId?: string | null;
6294
+ /**
6295
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6296
+ * @format GUID
6297
+ */
6298
+ chargeCorrelationId?: string | null;
6058
6299
  }
6059
- interface VoidAuthorizedPaymentsResponse {
6060
- /** All order's transactions after the void was triggered */
6061
- orderTransactions?: OrderTransactions;
6300
+ /** @oneof */
6301
+ interface PaymentPaymentDetailsOneOf {
6302
+ /** Regular payment details. */
6303
+ regularPaymentDetails?: RegularPaymentDetails;
6304
+ /** Gift card payment details. */
6305
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6306
+ /** Membership payment details. */
6307
+ membershipPaymentDetails?: MembershipPaymentDetails;
6062
6308
  }
6063
- interface CaptureAuthorizedPaymentsRequest {
6309
+ /** @oneof */
6310
+ interface PaymentReceiptInfoOneOf {
6064
6311
  /**
6065
- * Wix eCommerce order ID
6066
- * @minLength 1
6067
- * @maxLength 100
6312
+ * Receipt created by Wix
6313
+ * @internal
6068
6314
  */
6069
- ecomOrderId: string;
6315
+ wixReceipt?: WixReceiptInfo;
6316
+ /**
6317
+ * Receipt created by an external system.
6318
+ * @internal
6319
+ */
6320
+ externalReceipt?: ExternalReceiptInfo;
6321
+ }
6322
+ /** @oneof */
6323
+ interface PaymentStatusDetailsOneOf {
6324
+ /** @internal */
6325
+ canceled?: CanceledStatusDetails;
6326
+ /** @internal */
6327
+ declined?: DeclinedStatusDetails;
6328
+ /** @internal */
6329
+ voided?: VoidedStatusDetails;
6330
+ }
6331
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6332
+ /** Credit card details. */
6333
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6070
6334
  /**
6071
- * Capture payments information
6072
- * @minSize 1
6073
- * @maxSize 100
6335
+ * Wix Payments order ID.
6336
+ * @maxLength 100
6074
6337
  */
6075
- payments: PaymentCapture[];
6076
- }
6077
- interface PaymentCapture {
6338
+ paymentOrderId?: string | null;
6078
6339
  /**
6079
- * Payment ID
6080
- * @format GUID
6340
+ * Payment gateway's transaction ID.
6341
+ * This field is only returned when the value of `offline_payment` is `false`.
6342
+ * @maxLength 100
6081
6343
  */
6082
- paymentId?: string | null;
6344
+ gatewayTransactionId?: string | null;
6083
6345
  /**
6084
- * Capture amount.
6085
- * If not provided - full authorized amount will be captured.
6346
+ * Payment method.
6347
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6348
+ * Non-exhaustive list of supported values:
6349
+ * + `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`
6350
+ * @maxLength 150
6351
+ * @deprecated Payment method.
6352
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6353
+ * Non-exhaustive list of supported values:
6354
+ * + `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`
6355
+ * @replacedBy payment_method_name
6356
+ * @targetRemovalDate 2026-07-01
6086
6357
  */
6087
- amount?: Price;
6088
- }
6089
- interface CaptureAuthorizedPaymentsResponse {
6090
- /** All order's transactions after the capture was triggered */
6091
- orderTransactions?: OrderTransactions;
6092
- }
6093
- interface ChargeSavedPaymentMethodRequest {
6358
+ paymentMethod?: string | null;
6094
6359
  /**
6095
- * Ecom Order ID.
6096
- * @minLength 1
6360
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6097
6361
  * @maxLength 100
6098
6362
  */
6099
- ecomOrderId?: string;
6100
- /** Amount to be charged */
6101
- amount?: Price;
6102
- }
6103
- interface ChargeSavedPaymentMethodResponse {
6104
- /** Payment gateway's order ID (e.g Wix Payments) */
6105
- paymentGatewayOrderId?: string;
6106
- }
6107
- interface SendBuyerConfirmationEmailRequest {
6108
- /** @format GUID */
6109
- orderId?: string;
6110
- }
6111
- interface SendBuyerConfirmationEmailResponse {
6112
- }
6113
- interface SendBuyerPaymentsReceivedEmailRequest {
6363
+ providerTransactionId?: string | null;
6364
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6365
+ offlinePayment?: boolean;
6114
6366
  /**
6115
- * @minLength 1
6116
- * @maxLength 100
6367
+ * Payment status.
6368
+ * @deprecated Payment status.
6369
+ * @replacedBy payment.status
6370
+ * @targetRemovalDate 2026-11-01
6117
6371
  */
6118
- orderId?: string;
6119
- }
6120
- interface SendBuyerPaymentsReceivedEmailResponse {
6121
- }
6122
- interface SendBuyerPickupConfirmationEmailRequest {
6372
+ status?: TransactionStatusWithLiterals;
6373
+ /** Whether there is a payment agreement that allows for future charges. */
6374
+ savedPaymentMethod?: boolean;
6375
+ /** Authorization details. */
6376
+ authorizationDetails?: AuthorizationDetails;
6123
6377
  /**
6124
- * @minLength 1
6125
- * @maxLength 100
6378
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6379
+ * @internal
6380
+ * @maxLength 300
6126
6381
  */
6127
- orderId?: string;
6128
- }
6129
- interface SendBuyerPickupConfirmationEmailResponse {
6130
- }
6131
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6382
+ paymentProvider?: string | null;
6132
6383
  /**
6133
- * IDs of orders to send pickup emails for.
6134
- * @minSize 1
6135
- * @maxSize 300
6384
+ * Record of chargebacks made by the buyer.
6385
+ * @maxSize 6
6136
6386
  */
6137
- orderIds?: string[];
6138
- }
6139
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6140
- }
6141
- interface SendBuyerShippingConfirmationEmailRequest {
6387
+ chargebacks?: Chargeback[];
6142
6388
  /**
6143
- * @minLength 1
6144
- * @maxLength 100
6389
+ * Payment method ID.
6390
+ * @internal
6391
+ * @maxLength 36
6145
6392
  */
6146
- orderId?: string;
6147
- }
6148
- interface SendBuyerShippingConfirmationEmailResponse {
6149
- }
6150
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6393
+ paymentMethodId?: string | null;
6394
+ /** Platform fee amount associated with this payment. */
6395
+ platformFee?: Price;
6151
6396
  /**
6152
- * IDs of orders to send pickup emails for.
6153
- * @minSize 1
6154
- * @maxSize 300
6397
+ * Payment method with buyer and optional owner translations.
6398
+ * Non-exhaustive list of supported values:
6399
+ * + `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`
6155
6400
  */
6156
- orderIds?: string[];
6401
+ paymentMethodName?: PaymentMethodName;
6157
6402
  }
6158
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6403
+ /** @oneof */
6404
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6405
+ /** Credit card details. */
6406
+ creditCardDetails?: CreditCardPaymentMethodDetails;
6159
6407
  }
6160
- interface SendMerchantOrderReceivedNotificationRequest {
6408
+ declare enum TransactionStatus {
6409
+ UNDEFINED = "UNDEFINED",
6410
+ APPROVED = "APPROVED",
6411
+ PENDING = "PENDING",
6412
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6413
+ CANCELED = "CANCELED",
6414
+ DECLINED = "DECLINED",
6415
+ REFUNDED = "REFUNDED",
6416
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6417
+ AUTHORIZED = "AUTHORIZED",
6418
+ VOIDED = "VOIDED"
6419
+ }
6420
+ /** @enumType */
6421
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6422
+ interface CreditCardPaymentMethodDetails {
6161
6423
  /**
6162
- * @minLength 1
6163
- * @maxLength 100
6424
+ * The last 4 digits of the card number.
6425
+ * @maxLength 4
6164
6426
  */
6165
- orderId?: string;
6166
- }
6167
- interface SendMerchantOrderReceivedNotificationResponse {
6168
- }
6169
- interface SendCancelRefundEmailRequest {
6427
+ lastFourDigits?: string | null;
6170
6428
  /**
6171
- * The ID of order that is canceled/refunded
6172
- * @minLength 1
6429
+ * Card issuer's brand.
6173
6430
  * @maxLength 100
6174
6431
  */
6175
- orderId?: string;
6432
+ brand?: string | null;
6433
+ }
6434
+ interface AuthorizationDetails {
6176
6435
  /**
6177
- * Personal note added to the email (optional)
6178
- * @minLength 1
6179
- * @maxLength 1000
6436
+ * Whether the authorized payment is of a delayed capture.
6437
+ * @readonly
6180
6438
  */
6181
- customMessage?: string | null;
6182
- /** Refund amount */
6183
- refundAmount?: Price;
6439
+ delayedCapture?: boolean;
6440
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6441
+ authorizedDate?: Date | null;
6184
6442
  /**
6185
- * Refund ID. (Optional)
6186
- * @format GUID
6443
+ * List of captures associated with payment
6444
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6445
+ * @maxSize 1
6187
6446
  */
6188
- refundId?: string | null;
6189
- }
6190
- interface SendCancelRefundEmailResponse {
6447
+ captures?: AuthorizationCapture[];
6448
+ /** Void associated with payment */
6449
+ void?: AuthorizationVoid;
6450
+ /** Scheduled action for this transaction */
6451
+ scheduledAction?: V1ScheduledAction;
6191
6452
  }
6192
- interface SendRefundEmailRequest {
6193
- /**
6194
- * The ID of order that is refunded
6195
- * @format GUID
6196
- */
6197
- orderId?: string;
6453
+ interface AuthorizationCapture {
6198
6454
  /**
6199
- * Refund ID
6455
+ * Capture ID.
6200
6456
  * @format GUID
6457
+ * @readonly
6201
6458
  */
6202
- refundId?: string;
6459
+ id?: string | null;
6460
+ /** Status of this capture action */
6461
+ status?: AuthorizationCaptureStatusWithLiterals;
6203
6462
  /**
6204
- * Personal note added to the email (optional)
6205
- * @minLength 1
6206
- * @maxLength 1000
6463
+ * Amount of this capture
6464
+ * @immutable
6207
6465
  */
6208
- customMessage?: string | null;
6466
+ amount?: Price;
6467
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6468
+ createdDate?: Date | null;
6469
+ /** In case of status is FAILED may contain failure details */
6470
+ failureDetails?: AuthorizationActionFailureDetails;
6209
6471
  }
6210
- interface SendRefundEmailResponse {
6472
+ declare enum AuthorizationCaptureStatus {
6473
+ /** Capture operation still in progress. */
6474
+ PENDING = "PENDING",
6475
+ /** Capture operation succeeded. */
6476
+ SUCCEEDED = "SUCCEEDED",
6477
+ /** Capture operation failed. */
6478
+ FAILED = "FAILED"
6211
6479
  }
6212
- interface SendFulfillmentEmailRequest {
6213
- /** @format GUID */
6214
- orderId?: string;
6215
- /** @format GUID */
6216
- fulfillerId?: string;
6480
+ /** @enumType */
6481
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6482
+ interface AuthorizationActionFailureDetails {
6483
+ /** @maxLength 100 */
6484
+ failureCode?: string;
6217
6485
  }
6218
- interface SendFulfillmentEmailResponse {
6486
+ interface AuthorizationVoid {
6487
+ /** Status of this void action */
6488
+ status?: AuthorizationVoidStatusWithLiterals;
6489
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6490
+ voidedDate?: Date | null;
6491
+ /** In case of status is FAILED may contain failure details */
6492
+ failureDetails?: AuthorizationActionFailureDetails;
6493
+ /** Reason of void action */
6494
+ reason?: ReasonWithLiterals;
6219
6495
  }
6220
- interface SendMerchantOrderReceivedPushRequest {
6221
- /**
6222
- * @minLength 1
6223
- * @maxLength 100
6224
- */
6225
- orderId?: string;
6496
+ declare enum AuthorizationVoidStatus {
6497
+ /** Void operation still in progress. */
6498
+ PENDING = "PENDING",
6499
+ /** Void operation succeeded. */
6500
+ SUCCEEDED = "SUCCEEDED",
6501
+ /** Void operation failed. */
6502
+ FAILED = "FAILED"
6226
6503
  }
6227
- interface SendMerchantOrderReceivedPushResponse {
6504
+ /** @enumType */
6505
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6506
+ /** Reason the authorization was voided. */
6507
+ declare enum Reason {
6508
+ /** Authorization was voided by user. */
6509
+ MANUAL = "MANUAL",
6510
+ /** Authorization passed execution date. */
6511
+ SCHEDULED = "SCHEDULED"
6228
6512
  }
6229
- interface PreviewEmailByTypeRequest {
6230
- emailType?: PreviewEmailTypeWithLiterals;
6513
+ /** @enumType */
6514
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6515
+ interface V1ScheduledAction {
6516
+ /** Type of the action. */
6517
+ actionType?: ActionTypeWithLiterals;
6518
+ /** The date and time of the action. */
6519
+ executionDate?: Date | null;
6231
6520
  }
6232
- declare enum PreviewEmailType {
6233
- ORDER_PLACED = "ORDER_PLACED",
6234
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6235
- ORDER_SHIPPED = "ORDER_SHIPPED",
6236
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6521
+ declare enum ActionType {
6522
+ VOID = "VOID",
6523
+ CAPTURE = "CAPTURE"
6237
6524
  }
6238
6525
  /** @enumType */
6239
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6240
- interface PreviewEmailByTypeResponse {
6241
- emailPreview?: string;
6242
- }
6243
- interface PreviewRefundEmailRequest {
6244
- /**
6245
- * @minLength 1
6246
- * @maxLength 100
6247
- */
6248
- orderId?: string;
6249
- /** Refund amount */
6250
- refundAmount?: Price;
6251
- /** Refund business details */
6252
- details?: RefundDetails;
6526
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6527
+ interface Chargeback {
6253
6528
  /**
6254
- * Personal note added to the email (optional)
6255
- * @minLength 1
6256
- * @maxLength 1000
6529
+ * Chargeback ID.
6530
+ * @format GUID
6531
+ * @readonly
6532
+ * @immutable
6257
6533
  */
6258
- customMessage?: string | null;
6534
+ id?: string;
6259
6535
  /**
6260
- * Refund ID. (Optional)
6261
- * @format GUID
6536
+ * 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.
6537
+ * @readonly
6538
+ * @immutable
6262
6539
  */
6263
- refundId?: string | null;
6264
- }
6265
- interface PreviewRefundEmailResponse {
6266
- emailPreview?: string;
6267
- }
6268
- interface PreviewCancelEmailRequest {
6540
+ createdDate?: Date | null;
6269
6541
  /**
6270
- * @minLength 1
6271
- * @maxLength 100
6542
+ * 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.
6543
+ * @readonly
6272
6544
  */
6273
- orderId?: string;
6545
+ updatedDate?: Date | null;
6274
6546
  /**
6275
- * Personal note added to the email (optional)
6276
- * @minLength 1
6277
- * @maxLength 1000
6547
+ * Amount.
6548
+ * @readonly
6549
+ * @immutable
6278
6550
  */
6279
- customMessage?: string | null;
6280
- }
6281
- interface PreviewCancelEmailResponse {
6282
- emailPreview?: string;
6283
- }
6284
- interface PreviewCancelRefundEmailRequest {
6551
+ amount?: Price;
6285
6552
  /**
6286
- * @minLength 1
6287
- * @maxLength 100
6553
+ * Reversal amount. Present only when status is REVERSED.
6554
+ * @readonly
6288
6555
  */
6289
- orderId?: string;
6556
+ reversalAmount?: Price;
6290
6557
  /**
6291
- * Personal note added to the email (optional)
6292
- * @minLength 1
6293
- * @maxLength 1000
6558
+ * Status.
6559
+ *
6560
+ * Default: `"APPROVED"`.
6294
6561
  */
6295
- customMessage?: string | null;
6296
- /** Refund amount */
6297
- refundAmount?: Price;
6562
+ status?: ChargebackStatusWithLiterals;
6298
6563
  /**
6299
- * Refund ID. (Optional)
6564
+ * External chargeback ID.
6300
6565
  * @format GUID
6566
+ * @readonly
6567
+ * @immutable
6301
6568
  */
6302
- refundId?: string | null;
6303
- }
6304
- interface PreviewCancelRefundEmailResponse {
6305
- emailPreview?: string;
6306
- }
6307
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6308
- }
6309
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6310
- emailPreview?: string;
6311
- }
6312
- interface PreviewBuyerConfirmationEmailRequest {
6313
- }
6314
- interface PreviewBuyerConfirmationEmailResponse {
6315
- emailPreview?: string;
6316
- }
6317
- interface PreviewBuyerPickupConfirmationEmailRequest {
6318
- }
6319
- interface PreviewBuyerPickupConfirmationEmailResponse {
6320
- emailPreview?: string;
6321
- }
6322
- interface PreviewShippingConfirmationEmailRequest {
6323
- }
6324
- interface PreviewShippingConfirmationEmailResponse {
6325
- emailPreview?: string;
6326
- }
6327
- interface PreviewResendDownloadLinksEmailRequest {
6569
+ externalId?: string | null;
6328
6570
  }
6329
- interface PreviewResendDownloadLinksEmailResponse {
6330
- emailPreview?: string;
6571
+ declare enum ChargebackStatus {
6572
+ /** Chargeback was approved. */
6573
+ APPROVED = "APPROVED",
6574
+ /** Chargeback was reversed. */
6575
+ REVERSED = "REVERSED"
6331
6576
  }
6332
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6333
- /** Emitted on a meta site creation. */
6334
- siteCreated?: SiteCreated;
6335
- /** Emitted on a meta site transfer completion. */
6336
- siteTransferred?: SiteTransferred;
6337
- /** Emitted on a meta site deletion. */
6338
- siteDeleted?: SiteDeleted;
6339
- /** Emitted on a meta site restoration. */
6340
- siteUndeleted?: SiteUndeleted;
6341
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6342
- sitePublished?: SitePublished;
6343
- /** Emitted on a meta site unpublish. */
6344
- siteUnpublished?: SiteUnpublished;
6345
- /** Emitted when meta site is marked as template. */
6346
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6347
- /** Emitted when meta site is marked as a WixSite. */
6348
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6349
- /** Emitted when an application is provisioned (installed). */
6350
- serviceProvisioned?: ServiceProvisioned;
6351
- /** Emitted when an application is removed (uninstalled). */
6352
- serviceRemoved?: ServiceRemoved;
6353
- /** Emitted when meta site name (URL slug) is changed. */
6354
- siteRenamedPayload?: SiteRenamed;
6355
- /** Emitted when meta site was permanently deleted. */
6356
- hardDeleted?: SiteHardDeleted;
6357
- /** Emitted on a namespace change. */
6358
- namespaceChanged?: NamespaceChanged;
6359
- /** Emitted when Studio is attached. */
6360
- studioAssigned?: StudioAssigned;
6361
- /** Emitted when Studio is detached. */
6362
- studioUnassigned?: StudioUnassigned;
6577
+ /** @enumType */
6578
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6579
+ interface PaymentMethodName {
6363
6580
  /**
6364
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6365
- * the actual URL.
6366
- *
6367
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6368
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6581
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6582
+ * @maxLength 150
6369
6583
  */
6370
- urlChanged?: SiteUrlChanged;
6371
- /** Site is marked as PurgedExternally */
6372
- sitePurgedExternally?: SitePurgedExternally;
6373
- /** Emitted when Odeditor is attached. */
6374
- odeditorAssigned?: OdeditorAssigned;
6375
- /** Emitted when Odeditor is detached. */
6376
- odeditorUnassigned?: OdeditorUnassigned;
6377
- /** Emitted when Picasso is attached. */
6378
- picassoAssigned?: PicassoAssigned;
6379
- /** Emitted when Picasso is detached. */
6380
- picassoUnassigned?: PicassoUnassigned;
6381
- /** Emitted when Wixel is attached. */
6382
- wixelAssigned?: WixelAssigned;
6383
- /** Emitted when Wixel is detached. */
6384
- wixelUnassigned?: WixelUnassigned;
6385
- /** Emitted when StudioTwo is attached. */
6386
- studioTwoAssigned?: StudioTwoAssigned;
6387
- /** Emitted when StudioTwo is detached. */
6388
- studioTwoUnassigned?: StudioTwoUnassigned;
6389
- /** Emitted when media from user domain is enabled. */
6390
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6391
- /** Emitted when media from user domain is disabled. */
6392
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6393
- /** Emitted when Editorless is attached. */
6394
- editorlessAssigned?: EditorlessAssigned;
6395
- /** Emitted when Editorless is detached. */
6396
- editorlessUnassigned?: EditorlessUnassigned;
6584
+ buyerLanguageName?: string | null;
6397
6585
  /**
6398
- * A meta site id.
6399
- * @format GUID
6586
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6587
+ *
6588
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6589
+ * @maxLength 150
6400
6590
  */
6401
- metaSiteId?: string;
6402
- /** A meta site version. Monotonically increasing. */
6403
- version?: string;
6404
- /** A timestamp of the event. */
6405
- timestamp?: string;
6591
+ siteLanguageName?: string | null;
6406
6592
  /**
6407
- * TODO(meta-site): Change validation once validations are disabled for consumers
6408
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6409
- * @maxSize 4000
6593
+ * User-provided payment method name.
6594
+ *
6595
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6410
6596
  */
6411
- assets?: Asset[];
6597
+ userDefinedName?: UserDefinedPaymentMethodName;
6412
6598
  }
6413
- /** @oneof */
6414
- interface MetaSiteSpecialEventPayloadOneOf {
6415
- /** Emitted on a meta site creation. */
6416
- siteCreated?: SiteCreated;
6417
- /** Emitted on a meta site transfer completion. */
6418
- siteTransferred?: SiteTransferred;
6419
- /** Emitted on a meta site deletion. */
6420
- siteDeleted?: SiteDeleted;
6421
- /** Emitted on a meta site restoration. */
6422
- siteUndeleted?: SiteUndeleted;
6423
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6424
- sitePublished?: SitePublished;
6425
- /** Emitted on a meta site unpublish. */
6426
- siteUnpublished?: SiteUnpublished;
6427
- /** Emitted when meta site is marked as template. */
6428
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6429
- /** Emitted when meta site is marked as a WixSite. */
6430
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6431
- /** Emitted when an application is provisioned (installed). */
6432
- serviceProvisioned?: ServiceProvisioned;
6433
- /** Emitted when an application is removed (uninstalled). */
6434
- serviceRemoved?: ServiceRemoved;
6435
- /** Emitted when meta site name (URL slug) is changed. */
6436
- siteRenamedPayload?: SiteRenamed;
6437
- /** Emitted when meta site was permanently deleted. */
6438
- hardDeleted?: SiteHardDeleted;
6439
- /** Emitted on a namespace change. */
6440
- namespaceChanged?: NamespaceChanged;
6441
- /** Emitted when Studio is attached. */
6442
- studioAssigned?: StudioAssigned;
6443
- /** Emitted when Studio is detached. */
6444
- studioUnassigned?: StudioUnassigned;
6599
+ interface GiftCardPaymentDetails {
6600
+ /**
6601
+ * Gift card payment ID.
6602
+ * @maxLength 100
6603
+ */
6604
+ giftCardPaymentId?: string;
6605
+ /**
6606
+ * Gift card ID.
6607
+ * @internal
6608
+ * @deprecated
6609
+ */
6610
+ giftCardId?: string;
6445
6611
  /**
6446
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6447
- * the actual URL.
6448
- *
6449
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6450
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6612
+ * ID of the app that created the gift card.
6613
+ * @format GUID
6451
6614
  */
6452
- urlChanged?: SiteUrlChanged;
6453
- /** Site is marked as PurgedExternally */
6454
- sitePurgedExternally?: SitePurgedExternally;
6455
- /** Emitted when Odeditor is attached. */
6456
- odeditorAssigned?: OdeditorAssigned;
6457
- /** Emitted when Odeditor is detached. */
6458
- odeditorUnassigned?: OdeditorUnassigned;
6459
- /** Emitted when Picasso is attached. */
6460
- picassoAssigned?: PicassoAssigned;
6461
- /** Emitted when Picasso is detached. */
6462
- picassoUnassigned?: PicassoUnassigned;
6463
- /** Emitted when Wixel is attached. */
6464
- wixelAssigned?: WixelAssigned;
6465
- /** Emitted when Wixel is detached. */
6466
- wixelUnassigned?: WixelUnassigned;
6467
- /** Emitted when StudioTwo is attached. */
6468
- studioTwoAssigned?: StudioTwoAssigned;
6469
- /** Emitted when StudioTwo is detached. */
6470
- studioTwoUnassigned?: StudioTwoUnassigned;
6471
- /** Emitted when media from user domain is enabled. */
6472
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6473
- /** Emitted when media from user domain is disabled. */
6474
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6475
- /** Emitted when Editorless is attached. */
6476
- editorlessAssigned?: EditorlessAssigned;
6477
- /** Emitted when Editorless is detached. */
6478
- editorlessUnassigned?: EditorlessUnassigned;
6479
- }
6480
- interface Asset {
6615
+ appId?: string;
6481
6616
  /**
6482
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6483
- * @maxLength 36
6617
+ * Whether the gift card is voided.
6618
+ * @readonly
6619
+ * @deprecated Whether the gift card is voided.
6620
+ * @replacedBy payment.status
6621
+ * @targetRemovalDate 2026-11-01
6484
6622
  */
6485
- appDefId?: string;
6623
+ voided?: boolean;
6486
6624
  /**
6487
- * An instance id. For legacy reasons may be UUID or a string.
6625
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6626
+ * @maxLength 30
6627
+ * @immutable
6628
+ */
6629
+ obfuscatedCode?: string | null;
6630
+ }
6631
+ interface MembershipPaymentDetails {
6632
+ /**
6633
+ * Membership ID.
6488
6634
  * @maxLength 200
6489
6635
  */
6490
- instanceId?: string;
6491
- /** An application state. */
6492
- state?: StateWithLiterals;
6636
+ membershipId?: string;
6637
+ /**
6638
+ * ID of the line item this membership applies to.
6639
+ * @minLength 1
6640
+ * @maxLength 100
6641
+ */
6642
+ lineItemId?: string;
6643
+ /**
6644
+ * Payment status.
6645
+ * @deprecated Payment status.
6646
+ * @replacedBy payment.status
6647
+ * @targetRemovalDate 2026-11-01
6648
+ */
6649
+ status?: MembershipPaymentStatusWithLiterals;
6650
+ /** Membership name. */
6651
+ name?: MembershipName;
6652
+ /**
6653
+ * The transaction ID in the membership system. Can be used to void the transaction.
6654
+ * @minLength 1
6655
+ * @maxLength 100
6656
+ */
6657
+ externalTransactionId?: string | null;
6658
+ /**
6659
+ * Whether the membership is voided.
6660
+ * @readonly
6661
+ * @deprecated Whether the membership is voided.
6662
+ * @replacedBy payment.status
6663
+ * @targetRemovalDate 2026-11-01
6664
+ */
6665
+ voided?: boolean;
6666
+ /**
6667
+ * ID of the application providing this payment option.
6668
+ * @format GUID
6669
+ */
6670
+ providerAppId?: string;
6671
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6672
+ futureMembership?: FutureMembershipDetails;
6493
6673
  }
6494
- declare enum State {
6495
- UNKNOWN = "UNKNOWN",
6496
- ENABLED = "ENABLED",
6497
- DISABLED = "DISABLED",
6498
- PENDING = "PENDING",
6499
- DEMO = "DEMO"
6674
+ declare enum MembershipPaymentStatus {
6675
+ /** Payment was charged. */
6676
+ CHARGED = "CHARGED",
6677
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6678
+ CHARGE_FAILED = "CHARGE_FAILED",
6679
+ /** Payment is pending. */
6680
+ CHARGE_PENDING = "CHARGE_PENDING",
6681
+ /** Payment was voided. */
6682
+ VOIDED = "VOIDED"
6500
6683
  }
6501
6684
  /** @enumType */
6502
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6503
- interface SiteCreated {
6685
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6686
+ interface FutureMembershipDetails {
6504
6687
  /**
6505
- * A template identifier (empty if not created from a template).
6506
- * @maxLength 36
6688
+ * ID of the plan line item in the order from which the membership will be created.
6689
+ * @format GUID
6507
6690
  */
6508
- originTemplateId?: string;
6691
+ lineItemId?: string;
6509
6692
  /**
6510
- * An account id of the owner.
6511
- * @format GUID
6693
+ * ID of the benefit the future membership will grant.
6694
+ * @maxLength 200
6512
6695
  */
6513
- ownerId?: string;
6514
- /** A context in which meta site was created. */
6515
- context?: SiteCreatedContextWithLiterals;
6696
+ benefitId?: string;
6697
+ }
6698
+ interface WixReceiptInfo {
6516
6699
  /**
6517
- * A meta site id from which this site was created.
6518
- *
6519
- * In case of a creation from a template it's a template id.
6520
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6700
+ * Receipt ID
6521
6701
  * @format GUID
6522
6702
  */
6523
- originMetaSiteId?: string | null;
6703
+ receiptId?: string;
6524
6704
  /**
6525
- * A meta site name (URL slug).
6526
- * @maxLength 20
6705
+ * Display number of receipt
6706
+ * @minLength 1
6707
+ * @maxLength 40
6527
6708
  */
6528
- siteName?: string;
6529
- /** A namespace. */
6530
- namespace?: NamespaceWithLiterals;
6531
- }
6532
- declare enum SiteCreatedContext {
6533
- /** A valid option, we don't expose all reasons why site might be created. */
6534
- OTHER = "OTHER",
6535
- /** A meta site was created from template. */
6536
- FROM_TEMPLATE = "FROM_TEMPLATE",
6537
- /** A meta site was created by copying of the transfferred meta site. */
6538
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6539
- /** A copy of existing meta site. */
6540
- DUPLICATE = "DUPLICATE",
6541
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6542
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6543
- /** deprecated A meta site was created for Flash editor. */
6544
- FLASH = "FLASH"
6709
+ displayNumber?: string | null;
6545
6710
  }
6546
- /** @enumType */
6547
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6548
- declare enum Namespace {
6549
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6550
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6551
- WIX = "WIX",
6552
- /** 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. */
6553
- SHOUT_OUT = "SHOUT_OUT",
6554
- /** 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. */
6555
- ALBUMS = "ALBUMS",
6556
- /** 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. */
6557
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6558
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6559
- HOTELS = "HOTELS",
6560
- /** 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. */
6561
- CLUBS = "CLUBS",
6562
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6563
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6711
+ interface ExternalReceiptInfo {
6564
6712
  /**
6565
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6566
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6713
+ * External receipt ID
6714
+ * @maxLength 100
6567
6715
  */
6568
- DEV_SITE = "DEV_SITE",
6569
- /** 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. */
6570
- LOGOS = "LOGOS",
6571
- /** 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. */
6572
- VIDEO_MAKER = "VIDEO_MAKER",
6573
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6574
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6575
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6576
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6716
+ receiptId?: string | null;
6577
6717
  /**
6578
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6579
- *
6580
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6718
+ * ID of the app providing the receipt
6719
+ * @format GUID
6581
6720
  */
6582
- HTML_DRAFT = "HTML_DRAFT",
6721
+ appId?: string | null;
6583
6722
  /**
6584
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6585
- * Will be accessible from Site List and will not have a website app.
6586
- * Once the user attaches a site, the site will become a regular wixsite.
6723
+ * Display number of receipt
6724
+ * @minLength 1
6725
+ * @maxLength 40
6587
6726
  */
6588
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6589
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6590
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6591
- /** It is to be used in the Business First efforts. */
6592
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6593
- /** Bookings business flow with no site. */
6594
- ANYWHERE = "ANYWHERE",
6595
- /** Namespace for Headless Backoffice with no editor */
6596
- HEADLESS = "HEADLESS",
6727
+ displayNumber?: string | null;
6728
+ }
6729
+ interface CashRoundingDetails {
6597
6730
  /**
6598
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6599
- * The site will be used for account level CSM feature for enterprise
6731
+ * Payment amount before cash rounding was applied.
6732
+ * When provided, balance and status calculations use this value instead of `amount`
6733
+ * to prevent false overpayment or underpayment due to rounding.
6600
6734
  */
6601
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6602
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6603
- RISE = "RISE",
6735
+ unroundedAmount?: Price;
6736
+ /**
6737
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6738
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6739
+ * @readonly
6740
+ */
6741
+ roundingAdjustment?: CashRounding;
6742
+ }
6743
+ declare enum PaymentStatus {
6744
+ /** Payment was charged successfully. */
6745
+ APPROVED = "APPROVED",
6746
+ /** Payment is being processed and hasn't been confirmed yet. */
6747
+ PENDING = "PENDING",
6748
+ /** 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. */
6749
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6750
+ /** Payment was canceled before it was charged. */
6751
+ CANCELED = "CANCELED",
6752
+ /** Payment was declined by the payment provider. */
6753
+ DECLINED = "DECLINED",
6754
+ /** Payment was fully refunded. */
6755
+ REFUNDED = "REFUNDED",
6756
+ /** Part of the payment amount was refunded. */
6757
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6758
+ /** 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. */
6759
+ AUTHORIZED = "AUTHORIZED",
6604
6760
  /**
6605
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6606
- * There's a blank site behind the scene but it's blank).
6607
- * The Mobile company will be the owner of this namespace.
6761
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6762
+ *
6763
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6608
6764
  */
6609
- BRANDED_FIRST = "BRANDED_FIRST",
6610
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6611
- NOWNIA = "NOWNIA",
6765
+ VOIDED = "VOIDED"
6766
+ }
6767
+ /** @enumType */
6768
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6769
+ interface CanceledStatusDetails {
6770
+ reason?: CanceledReasonWithLiterals;
6771
+ }
6772
+ declare enum CanceledReason {
6773
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6774
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6775
+ /** Payment was not completed by user and expired. */
6776
+ EXPIRED = "EXPIRED"
6777
+ }
6778
+ /** @enumType */
6779
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6780
+ interface DeclinedStatusDetails {
6781
+ reason?: DeclinedReasonWithLiterals;
6782
+ }
6783
+ declare enum DeclinedReason {
6784
+ /** Corresponding charge failed. */
6785
+ CHARGE_FAILED = "CHARGE_FAILED",
6786
+ /** Payment details expired. */
6787
+ EXPIRED = "EXPIRED",
6788
+ /** Insufficient funds. */
6789
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6790
+ /** Gift card was disabled before charge was attempted. */
6791
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6792
+ }
6793
+ /** @enumType */
6794
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6795
+ interface VoidedStatusDetails {
6796
+ reason?: VoidedReasonWithLiterals;
6797
+ }
6798
+ declare enum VoidedReason {
6799
+ /** Payment was voided by merchant request. */
6800
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6801
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6802
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6803
+ }
6804
+ /** @enumType */
6805
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6806
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6807
+ /** @internal */
6808
+ canceled?: CanceledStatusDetails;
6809
+ /** @internal */
6810
+ declined?: DeclinedStatusDetails;
6811
+ /** @internal */
6812
+ voided?: VoidedStatusDetails;
6612
6813
  /**
6613
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6614
- * The Partners company owns this namespace.
6814
+ * Reason code from the payment gateway.
6815
+ * @internal
6816
+ * @minLength 1
6817
+ * @maxLength 10
6615
6818
  */
6616
- UGC_TEMPLATE = "UGC_TEMPLATE",
6617
- /** Codux Headless Sites */
6618
- CODUX = "CODUX",
6619
- /** Bobb - AI Design Creator. */
6620
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6819
+ paymentGatewayReasonCode?: string | null;
6820
+ }
6821
+ /** @oneof */
6822
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6823
+ /** @internal */
6824
+ canceled?: CanceledStatusDetails;
6825
+ /** @internal */
6826
+ declined?: DeclinedStatusDetails;
6827
+ /** @internal */
6828
+ voided?: VoidedStatusDetails;
6829
+ }
6830
+ interface Refund {
6621
6831
  /**
6622
- * Shared Blog Site is a unique single site across Enterprise account,
6623
- * This site will hold all Blog posts related to the Marketing product.
6832
+ * Refund ID.
6833
+ * @format GUID
6834
+ * @readonly
6624
6835
  */
6625
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6626
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6627
- STANDALONE_FORMS = "STANDALONE_FORMS",
6628
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6629
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6630
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6631
- MIMIR = "MIMIR",
6632
- /** Wix Twins platform. */
6633
- TWINS = "TWINS",
6634
- /** Wix Nano. */
6635
- NANO = "NANO",
6636
- /** Base44 headless sites. */
6637
- BASE44 = "BASE44",
6638
- /** Wix Channels Sites */
6639
- CHANNELS = "CHANNELS",
6640
- /** Nautilus platform. */
6641
- NAUTILUS = "NAUTILUS",
6836
+ id?: string;
6642
6837
  /**
6643
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6644
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6838
+ * List of transactions.
6839
+ * @maxSize 50
6645
6840
  */
6646
- SYMPHONY = "SYMPHONY",
6647
- /** Nautilus platform app. */
6648
- NAUTILUS_APPS = "NAUTILUS_APPS",
6841
+ transactions?: RefundTransaction[];
6842
+ /** Refund business details. */
6843
+ details?: RefundDetails;
6649
6844
  /**
6650
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6651
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6845
+ * 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.
6846
+ * @readonly
6847
+ * @immutable
6652
6848
  */
6653
- VIBU = "VIBU",
6849
+ createdDate?: Date | null;
6654
6850
  /**
6655
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6656
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6657
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6658
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6851
+ * Aggregated refund summary.
6852
+ * @readonly
6659
6853
  */
6660
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6854
+ summary?: AggregatedRefundSummary;
6661
6855
  /**
6662
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6663
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6856
+ * ID of the app that initiated this refund.
6857
+ * @format GUID
6858
+ * @readonly
6859
+ * @immutable
6664
6860
  */
6665
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6861
+ requestingServiceAppId?: string | null;
6666
6862
  }
6667
- /** @enumType */
6668
- 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';
6669
- /** Site transferred to another user. */
6670
- interface SiteTransferred {
6863
+ interface RefundTransaction {
6671
6864
  /**
6672
- * A previous owner id (user that transfers meta site).
6865
+ * ID of the payment associated with this refund.
6673
6866
  * @format GUID
6867
+ * @immutable
6674
6868
  */
6675
- oldOwnerId?: string;
6869
+ paymentId?: string;
6676
6870
  /**
6677
- * A new owner id (user that accepts meta site).
6871
+ * Refund amount.
6872
+ * @immutable
6873
+ */
6874
+ amount?: Price;
6875
+ /** Refund status. */
6876
+ refundStatus?: RefundStatusWithLiterals;
6877
+ /** Optional details of current refund status. */
6878
+ refundStatusInfo?: RefundStatusInfo;
6879
+ /**
6880
+ * Payment gateway's refund ID.
6881
+ * This field is only returned when the value of `external_refund` is `false`.
6678
6882
  * @format GUID
6679
6883
  */
6680
- newOwnerId?: string;
6681
- }
6682
- /** Soft deletion of the meta site. Could be restored. */
6683
- interface SiteDeleted {
6684
- /** A deletion context. */
6685
- deleteContext?: DeleteContext;
6686
- }
6687
- interface DeleteContext {
6688
- /** When the meta site was deleted. */
6689
- dateDeleted?: Date | null;
6690
- /** A status. */
6691
- deleteStatus?: DeleteStatusWithLiterals;
6884
+ gatewayRefundId?: string | null;
6885
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6886
+ providerRefundId?: string | null;
6692
6887
  /**
6693
- * A reason (flow).
6694
- * @maxLength 255
6888
+ * Whether refund was made externally and manually on the payment provider's side.
6889
+ * @immutable
6695
6890
  */
6696
- deleteOrigin?: string;
6891
+ externalRefund?: boolean;
6697
6892
  /**
6698
- * A service that deleted it.
6699
- * @maxLength 255
6893
+ * Location where the refund was processed.
6894
+ * @internal
6895
+ * @format GUID
6896
+ * @immutable
6700
6897
  */
6701
- initiatorId?: string | null;
6898
+ locationId?: string | null;
6702
6899
  }
6703
- declare enum DeleteStatus {
6704
- UNKNOWN = "UNKNOWN",
6705
- TRASH = "TRASH",
6706
- DELETED = "DELETED",
6707
- PENDING_PURGE = "PENDING_PURGE",
6708
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6900
+ /** Refund transaction status. */
6901
+ declare enum RefundStatus {
6902
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6903
+ PENDING = "PENDING",
6904
+ /** Refund transaction succeeded. */
6905
+ SUCCEEDED = "SUCCEEDED",
6906
+ /** Refund transaction failed. */
6907
+ FAILED = "FAILED",
6908
+ /** Refund request acknowledged, and will be executed soon. */
6909
+ SCHEDULED = "SCHEDULED",
6910
+ /** Refund was initiated on payment provider side. */
6911
+ STARTED = "STARTED"
6709
6912
  }
6710
6913
  /** @enumType */
6711
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6712
- /** Restoration of the meta site. */
6713
- interface SiteUndeleted {
6714
- }
6715
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6716
- interface SitePublished {
6717
- }
6718
- interface SiteUnpublished {
6914
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6915
+ interface RefundStatusInfo {
6719
6916
  /**
6720
- * A list of URLs previously associated with the meta site.
6721
- * @maxLength 4000
6722
- * @maxSize 10000
6917
+ * Reason code for the refund's current status.
6918
+ *
6919
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6920
+ * @minLength 1
6921
+ * @maxLength 10
6723
6922
  */
6724
- urls?: string[];
6725
- }
6726
- interface SiteMarkedAsTemplate {
6727
- }
6728
- interface SiteMarkedAsWixSite {
6923
+ paymentGatewayReasonCode?: string | null;
6924
+ /**
6925
+ * Free text explanation of current refund status.
6926
+ * @minLength 1
6927
+ * @maxLength 1000
6928
+ */
6929
+ description?: string | null;
6729
6930
  }
6730
- /**
6731
- * Represents a service provisioned a site.
6732
- *
6733
- * Note on `origin_instance_id`:
6734
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6735
- * This is because of the following scenario:
6736
- *
6737
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6738
- * such as a product catalog. When you create a site from this template, you inherit this
6739
- * default product catalog. However, if the template's product catalog is modified,
6740
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6741
- * your site remains consistent with what you initially received and does not include any
6742
- * changes made to the original template afterward.
6743
- * To ensure this, the TPA on the template gets a new instance_id.
6744
- */
6745
- interface ServiceProvisioned {
6931
+ interface AggregatedRefundSummary {
6932
+ /** Total amount requested for refund. */
6933
+ requestedRefund?: Price;
6934
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6935
+ pendingRefund?: Price;
6936
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6937
+ refunded?: Price;
6938
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6939
+ failedRefundAmount?: Price;
6940
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6941
+ pending?: boolean;
6942
+ /** Breakdown of refunded items. Available only after refund is complete. */
6943
+ breakdown?: RefundItemsBreakdown;
6944
+ }
6945
+ interface RefundItemsBreakdown {
6746
6946
  /**
6747
- * Either UUID or EmbeddedServiceType.
6748
- * @maxLength 36
6947
+ * Refunded line items and the amount refunded for each.
6948
+ * @maxSize 300
6749
6949
  */
6750
- appDefId?: string;
6950
+ lineItems?: LineItemRefundSummary[];
6951
+ }
6952
+ interface LineItemRefundSummary {
6751
6953
  /**
6752
- * Not only UUID. Something here could be something weird.
6753
- * @maxLength 36
6954
+ * ID of the refunded line item.
6955
+ * @format GUID
6754
6956
  */
6755
- instanceId?: string;
6957
+ lineItemId?: string;
6958
+ /** Total refunded amount for the line item. */
6959
+ totalRefundedAmount?: Price;
6960
+ }
6961
+ interface CalculateRefundRequest {
6756
6962
  /**
6757
- * An instance id from which this instance is originated.
6758
- * @maxLength 36
6963
+ * Order ID
6964
+ * @minLength 1
6965
+ * @maxLength 100
6759
6966
  */
6760
- originInstanceId?: string;
6967
+ ecomOrderId?: string;
6761
6968
  /**
6762
- * A version.
6763
- * @maxLength 500
6969
+ * Refunded line items and quantity
6970
+ * @maxSize 300
6764
6971
  */
6765
- version?: string | null;
6972
+ refundItems?: CalculateRefundItemRequest[];
6973
+ /** Should include shipping in refund calculation */
6974
+ refundShipping?: boolean;
6975
+ }
6976
+ interface CalculateRefundItemRequest {
6766
6977
  /**
6767
- * The origin meta site id
6978
+ * ID of the line item being refunded
6768
6979
  * @format GUID
6769
6980
  */
6770
- originMetaSiteId?: string | null;
6771
- }
6772
- interface ServiceRemoved {
6981
+ id?: string;
6773
6982
  /**
6774
- * Either UUID or EmbeddedServiceType.
6775
- * @maxLength 36
6983
+ * How much of that line item is being refunded
6984
+ * @min 1
6985
+ * @max 100000
6776
6986
  */
6777
- appDefId?: string;
6987
+ quantity?: number;
6988
+ }
6989
+ interface CalculateRefundResponse {
6990
+ /** Total refundable amount */
6991
+ total?: Price;
6992
+ /** Tax cost of the order */
6993
+ tax?: Price;
6994
+ /** Discount given for this order */
6995
+ discount?: Price;
6996
+ /** Total cost of the order (without tax) */
6997
+ subtotal?: Price;
6998
+ /** Total shipping cost for order */
6999
+ shipping?: Price;
7000
+ /** Previous refund given on that order */
7001
+ previouslyRefundedAmount?: Price;
6778
7002
  /**
6779
- * Not only UUID. Something here could be something weird.
6780
- * @maxLength 36
7003
+ * The refundable items of that order
7004
+ * @maxSize 300
6781
7005
  */
6782
- instanceId?: string;
7006
+ items?: CalculateRefundItemResponse[];
7007
+ }
7008
+ interface CalculateRefundItemResponse {
6783
7009
  /**
6784
- * A version.
6785
- * @maxLength 500
7010
+ * Line item ID
7011
+ * @format GUID
6786
7012
  */
6787
- version?: string | null;
7013
+ id?: string;
7014
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
7015
+ price?: Price;
6788
7016
  }
6789
- /** Rename of the site. Meaning, free public url has been changed as well. */
6790
- interface SiteRenamed {
7017
+ interface VoidAuthorizedPaymentsRequest {
6791
7018
  /**
6792
- * A new meta site name (URL slug).
6793
- * @maxLength 20
7019
+ * Wix eCommerce order ID
7020
+ * @minLength 1
7021
+ * @maxLength 100
6794
7022
  */
6795
- newSiteName?: string;
7023
+ ecomOrderId: string;
6796
7024
  /**
6797
- * A previous meta site name (URL slug).
6798
- * @maxLength 255
7025
+ * Payment IDs
7026
+ * @minSize 1
7027
+ * @maxSize 100
7028
+ * @format GUID
6799
7029
  */
6800
- oldSiteName?: string;
6801
- }
6802
- /**
6803
- * Hard deletion of the meta site.
6804
- *
6805
- * Could not be restored. Therefore it's desirable to cleanup data.
6806
- */
6807
- interface SiteHardDeleted {
6808
- /** A deletion context. */
6809
- deleteContext?: DeleteContext;
6810
- }
6811
- interface NamespaceChanged {
6812
- /** A previous namespace. */
6813
- oldNamespace?: NamespaceWithLiterals;
6814
- /** A new namespace. */
6815
- newNamespace?: NamespaceWithLiterals;
6816
- }
6817
- /** Assigned Studio editor */
6818
- interface StudioAssigned {
6819
- }
6820
- /** Unassigned Studio editor */
6821
- interface StudioUnassigned {
7030
+ paymentIds: string[];
6822
7031
  }
6823
- /**
6824
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6825
- *
6826
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6827
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6828
- *
6829
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6830
- */
6831
- interface SiteUrlChanged {
7032
+ interface VoidAuthorizedPaymentsResponse {
7033
+ /** All order's transactions after the void was triggered */
7034
+ orderTransactions?: OrderTransactions;
6832
7035
  }
6833
- /**
6834
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6835
- * Consumed by other teams to remove relevant data.
6836
- */
6837
- interface SitePurgedExternally {
7036
+ interface CaptureAuthorizedPaymentsRequest {
6838
7037
  /**
6839
- * @maxLength 2048
7038
+ * Wix eCommerce order ID
7039
+ * @minLength 1
7040
+ * @maxLength 100
7041
+ */
7042
+ ecomOrderId: string;
7043
+ /**
7044
+ * Capture payments information
7045
+ * @minSize 1
6840
7046
  * @maxSize 100
6841
- * @deprecated
6842
- * @targetRemovalDate 2025-04-15
6843
7047
  */
6844
- appDefId?: string[];
6845
- }
6846
- /** Assigned Odeditor */
6847
- interface OdeditorAssigned {
6848
- }
6849
- /** Unassigned Odeditor */
6850
- interface OdeditorUnassigned {
6851
- }
6852
- /** Assigned Picasso editor */
6853
- interface PicassoAssigned {
6854
- }
6855
- /** Unassigned Picasso */
6856
- interface PicassoUnassigned {
6857
- }
6858
- /** Assigned Wixel */
6859
- interface WixelAssigned {
6860
- }
6861
- /** Unassigned Wixel */
6862
- interface WixelUnassigned {
6863
- }
6864
- /** Assigned StudioTwo */
6865
- interface StudioTwoAssigned {
6866
- }
6867
- /** Unassigned StudioTwo */
6868
- interface StudioTwoUnassigned {
6869
- }
6870
- /** Media from user domain is enabled. */
6871
- interface UserDomainMediaEnabled {
6872
- }
6873
- /** Media from user domain is disabled. */
6874
- interface UserDomainMediaDisabled {
6875
- }
6876
- /** Assigned Editorless */
6877
- interface EditorlessAssigned {
6878
- }
6879
- /** Unassigned Editorless */
6880
- interface EditorlessUnassigned {
7048
+ payments: PaymentCapture[];
6881
7049
  }
6882
- interface HasCustomEmailConfigurationsRequest {
7050
+ interface PaymentCapture {
7051
+ /**
7052
+ * Payment ID
7053
+ * @format GUID
7054
+ */
7055
+ paymentId?: string | null;
7056
+ /**
7057
+ * Capture amount.
7058
+ * If not provided - full authorized amount will be captured.
7059
+ */
7060
+ amount?: Price;
6883
7061
  }
6884
- interface HasCustomEmailConfigurationsResponse {
6885
- hasCustomConfigurations?: boolean;
7062
+ interface CaptureAuthorizedPaymentsResponse {
7063
+ /** All order's transactions after the capture was triggered */
7064
+ orderTransactions?: OrderTransactions;
6886
7065
  }
6887
- interface AddToAutomationMigrationPopulationRequest {
6888
- /** When true, sends custom email configurations to automation system via email */
6889
- sendCustomEmailConfigs?: boolean;
6890
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6891
- origin?: OriginWithLiterals;
7066
+ interface ChargeSavedPaymentMethodRequest {
7067
+ /**
7068
+ * Ecom Order ID.
7069
+ * @minLength 1
7070
+ * @maxLength 100
7071
+ */
7072
+ ecomOrderId?: string;
7073
+ /** Amount to be charged */
7074
+ amount?: Price;
6892
7075
  }
6893
- declare enum Origin {
6894
- OPT_IN = "OPT_IN",
6895
- MIGRATION = "MIGRATION"
7076
+ interface ChargeSavedPaymentMethodResponse {
7077
+ /** Payment gateway's order ID (e.g Wix Payments) */
7078
+ paymentGatewayOrderId?: string;
6896
7079
  }
6897
- /** @enumType */
6898
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6899
- interface AddToAutomationMigrationPopulationResponse {
6900
- success?: boolean;
7080
+ interface V1TriggerReindexRequest {
7081
+ /** @format GUID */
7082
+ metasiteId?: string;
7083
+ /**
7084
+ * @minLength 1
7085
+ * @maxLength 100
7086
+ * @maxSize 100
7087
+ */
7088
+ orderIds?: string[];
6901
7089
  }
6902
- interface IsInAutomationMigrationPopulationRequest {
7090
+ interface V1TriggerReindexResponse {
6903
7091
  }
6904
- interface IsInAutomationMigrationPopulationResponse {
6905
- inPopulation?: boolean;
7092
+ interface V1TriggerReindexOrderRequest {
7093
+ /** @format GUID */
7094
+ metasiteId?: string;
7095
+ /**
7096
+ * @minLength 1
7097
+ * @maxLength 100
7098
+ */
7099
+ orderId?: string;
6906
7100
  }
6907
7101
  interface DiffmatokyPayload {
6908
7102
  left?: string;
@@ -9136,4 +9330,4 @@ declare function updateOrderStatus(): __PublicMethodMetaInfo<'POST', {
9136
9330
  declare function aggregateOrders(): __PublicMethodMetaInfo<'POST', {}, AggregateOrdersRequest$1, AggregateOrdersRequest, AggregateOrdersResponse$1, AggregateOrdersResponse>;
9137
9331
  declare function bulkUpdateOrderTags(): __PublicMethodMetaInfo<'POST', {}, BulkUpdateOrderTagsRequest$1, BulkUpdateOrderTagsRequest, BulkUpdateOrderTagsResponse$1, BulkUpdateOrderTagsResponse>;
9138
9332
 
9139
- 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 };
9333
+ 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 };