@wix/auto_sdk_ecom_orders 1.0.316 → 1.0.318

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