@wix/auto_sdk_ecom_orders 1.0.317 → 1.0.319

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (29) hide show
  1. package/build/cjs/{ecom-v1-order-orders.universal-C1f2gjpe.d.ts → ecom-v1-order-orders.universal-DkuT45RM.d.ts} +1847 -1696
  2. package/build/cjs/index.d.ts +2 -2
  3. package/build/cjs/index.js +197 -86
  4. package/build/cjs/index.js.map +1 -1
  5. package/build/cjs/index.typings.d.ts +2 -2
  6. package/build/cjs/index.typings.js +154 -85
  7. package/build/cjs/index.typings.js.map +1 -1
  8. package/build/cjs/meta.d.ts +1848 -1697
  9. package/build/cjs/meta.js +154 -85
  10. package/build/cjs/meta.js.map +1 -1
  11. package/build/es/{ecom-v1-order-orders.universal-C1f2gjpe.d.mts → ecom-v1-order-orders.universal-DkuT45RM.d.mts} +1847 -1696
  12. package/build/es/index.d.mts +2 -2
  13. package/build/es/index.mjs +193 -86
  14. package/build/es/index.mjs.map +1 -1
  15. package/build/es/index.typings.d.mts +2 -2
  16. package/build/es/index.typings.mjs +150 -85
  17. package/build/es/index.typings.mjs.map +1 -1
  18. package/build/es/meta.d.mts +1848 -1697
  19. package/build/es/meta.mjs +150 -85
  20. package/build/es/meta.mjs.map +1 -1
  21. package/build/internal/cjs/{ecom-v1-order-orders.universal-CQe1Ioz_.d.ts → ecom-v1-order-orders.universal-CaKWoBtD.d.ts} +2010 -1803
  22. package/build/internal/cjs/index.d.ts +2 -2
  23. package/build/internal/cjs/index.typings.d.ts +2 -2
  24. package/build/internal/cjs/meta.d.ts +2024 -1830
  25. package/build/internal/es/{ecom-v1-order-orders.universal-CQe1Ioz_.d.mts → ecom-v1-order-orders.universal-CaKWoBtD.d.mts} +2010 -1803
  26. package/build/internal/es/index.d.mts +2 -2
  27. package/build/internal/es/index.typings.d.mts +2 -2
  28. package/build/internal/es/meta.d.mts +2024 -1830
  29. package/package.json +2 -2
@@ -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
@@ -478,6 +485,12 @@ interface OrderLineItem {
478
485
  * @readonly
479
486
  */
480
487
  serviceProperties?: ServiceProperties;
488
+ /**
489
+ * 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.
490
+ * @internal
491
+ * @readonly
492
+ */
493
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
481
494
  }
482
495
  interface ProductName {
483
496
  /**
@@ -896,10 +909,16 @@ interface DigitalFile {
896
909
  interface SubscriptionInfo {
897
910
  /**
898
911
  * Subscription ID.
912
+ *
913
+ * For a subscription bought through Wix eCommerce, this is the ID of the subscription contract the order was created from.
914
+ * To retrieve the subscription contract, call [Get Subscription Contract](https://dev.wix.com/docs/api-reference/business-solutions/e-commerce/payments/subscriptions/subscription-contracts/get-subscription-contract).
899
915
  * @format GUID
900
916
  */
901
917
  _id?: string | null;
902
- /** Subscription cycle. For example, if this order is for the 3rd cycle of a subscription, value will be `3`. */
918
+ /**
919
+ * Billing cycle the order is for. For example, `3` for the third billing cycle of a subscription.
920
+ * When a subscription starts with a free trial, the order created at checkout is for cycle `0`.
921
+ */
903
922
  cycleNumber?: number;
904
923
  /**
905
924
  * Subscription option title. For example, `"Monthly coffee Subscription"`.
@@ -975,7 +994,7 @@ interface SubscriptionDescription {
975
994
  translated?: string | null;
976
995
  }
977
996
  interface SubscriptionSettings {
978
- /** Frequency of recurring payment. */
997
+ /** Frequency unit of the billing cycle. */
979
998
  frequency?: SubscriptionFrequencyWithLiterals;
980
999
  /**
981
1000
  * Number of frequency units in a billing cycle. For example, frequency `MONTH` with interval `3` means billing every 3 months.
@@ -983,16 +1002,20 @@ interface SubscriptionSettings {
983
1002
  * @max 3650
984
1003
  */
985
1004
  interval?: number | null;
986
- /** Whether subscription is renewed automatically at the end of each period. */
1005
+ /** Whether the subscription renews automatically at the end of each billing cycle. */
987
1006
  autoRenewal?: boolean;
988
1007
  /**
989
- * Number of billing cycles before subscription ends. Ignored if `autoRenewal: true`.
1008
+ * Number of billing cycles before the subscription ends. Ignored when `autoRenewal` is `true`.
990
1009
  * @min 1
991
1010
  */
992
1011
  billingCycles?: number | null;
993
- /** Whether to allow the customer to cancel the subscription. */
1012
+ /** Whether the buyer can cancel the subscription. */
994
1013
  enableCustomerCancellation?: boolean;
995
- /** Period until first cycle starts. If None => no free trial */
1014
+ /**
1015
+ * Free trial period before the first billing cycle starts.
1016
+ *
1017
+ * Returned only when the subscription has a free trial.
1018
+ */
996
1019
  freeTrialPeriod?: FreeTrialPeriod;
997
1020
  /**
998
1021
  * The date the subscription will start. The subscription will be charged either now or according to freeTrialDays.
@@ -1021,7 +1044,7 @@ declare enum SubscriptionFrequency {
1021
1044
  /** @enumType */
1022
1045
  type SubscriptionFrequencyWithLiterals = SubscriptionFrequency | 'UNDEFINED' | 'DAY' | 'WEEK' | 'MONTH' | 'YEAR';
1023
1046
  interface FreeTrialPeriod {
1024
- /** Frequency of period. Values: DAY, WEEK, MONTH, YEAR */
1047
+ /** Frequency unit of the free trial period. */
1025
1048
  frequency?: SubscriptionFrequencyWithLiterals;
1026
1049
  /**
1027
1050
  * Number of frequency units in the free trial period. For example, frequency `MONTH` with interval `3` means a 3-month free trial.
@@ -1306,6 +1329,76 @@ interface ServiceProperties {
1306
1329
  */
1307
1330
  endDate?: Date | null;
1308
1331
  }
1332
+ /**
1333
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1334
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1335
+ *
1336
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1337
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1338
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1339
+ */
1340
+ interface CrossBorderPriceAdjustment {
1341
+ /**
1342
+ * ID of the tax region whose tax is built into the catalog prices.
1343
+ * @format GUID
1344
+ */
1345
+ baseTaxRegionId?: string;
1346
+ /**
1347
+ * ID of the tax region resolved for the destination. Absent when no region matched.
1348
+ * @format GUID
1349
+ */
1350
+ destinationTaxRegionId?: string | null;
1351
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1352
+ catalogPrice?: Price;
1353
+ /** 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. */
1354
+ baseTaxAmount?: Price;
1355
+ /** Outcome of the repricing for this line. */
1356
+ status?: RepriceStatusWithLiterals;
1357
+ /** 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`. */
1358
+ baseRateSource?: BaseRateSourceWithLiterals;
1359
+ /**
1360
+ * 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.
1361
+ * @format DECIMAL_VALUE
1362
+ * @decimalValue options { gte:0, maxScale:6 }
1363
+ */
1364
+ baseRate?: string | null;
1365
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1366
+ baseRateCapturedDate?: Date | null;
1367
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1368
+ destinationTaxIncluded?: boolean | null;
1369
+ }
1370
+ /** Outcome of the repricing for one line. */
1371
+ declare enum RepriceStatus {
1372
+ /** Base tax removed and the destination's tax applied. */
1373
+ APPLIED = "APPLIED",
1374
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
1375
+ KEPT = "KEPT",
1376
+ /** 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`. */
1377
+ STRIP_ONLY = "STRIP_ONLY",
1378
+ /** The destination is the base region. Nothing was removed. */
1379
+ SAME_REGION = "SAME_REGION",
1380
+ /** 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. */
1381
+ SAME_COUNTRY = "SAME_COUNTRY",
1382
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1383
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1384
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1385
+ NOT_APPLICABLE = "NOT_APPLICABLE",
1386
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1387
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1388
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1389
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1390
+ }
1391
+ /** @enumType */
1392
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1393
+ /** Where the base region's rate came from. */
1394
+ declare enum BaseRateSource {
1395
+ /** The manual tax calculator computed the base tax for this calculation. */
1396
+ MANUAL_SPI = "MANUAL_SPI",
1397
+ /** The rate captured from Avalara by the embedded-rate probe. */
1398
+ AVALARA_PROBE = "AVALARA_PROBE"
1399
+ }
1400
+ /** @enumType */
1401
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1309
1402
  /** Buyer information. */
1310
1403
  interface BuyerInfo extends BuyerInfoIdOneOf {
1311
1404
  /**
@@ -1429,6 +1522,25 @@ interface CurrencyConversionDetails {
1429
1522
  */
1430
1523
  conversionRate?: string | null;
1431
1524
  }
1525
+ /** 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`. */
1526
+ interface CrossBorderRepricing {
1527
+ /**
1528
+ * 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.
1529
+ *
1530
+ * Default: `false`
1531
+ */
1532
+ enabled?: boolean;
1533
+ /**
1534
+ * ID of the tax region whose tax is built into the catalog prices, as used for this order.
1535
+ * @format GUID
1536
+ */
1537
+ baseTaxRegionId?: string | null;
1538
+ /**
1539
+ * ID of the base region's tax calculator when the order was placed.
1540
+ * @format GUID
1541
+ */
1542
+ baseCalculatorId?: string | null;
1543
+ }
1432
1544
  interface PriceSummary {
1433
1545
  /** Subtotal of all line items, before discounts and before tax. */
1434
1546
  subtotal?: Price;
@@ -1732,6 +1844,12 @@ interface ShippingPrice {
1732
1844
  * @readonly
1733
1845
  */
1734
1846
  discount?: Price;
1847
+ /**
1848
+ * Cross-border repricing record of the shipping cost on a site whose catalog prices include tax.
1849
+ * @internal
1850
+ * @readonly
1851
+ */
1852
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
1735
1853
  }
1736
1854
  interface ShippingRegion {
1737
1855
  /**
@@ -1809,6 +1927,12 @@ interface OrderTaxInfo {
1809
1927
  * @readonly
1810
1928
  */
1811
1929
  totalExempt?: Price;
1930
+ /**
1931
+ * 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.
1932
+ * @internal
1933
+ * @readonly
1934
+ */
1935
+ crossBorderCalculation?: CrossBorderCalculation;
1812
1936
  }
1813
1937
  /**
1814
1938
  * 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.
@@ -1851,6 +1975,56 @@ interface OrderTaxBreakdown {
1851
1975
  */
1852
1976
  aggregatedExemptAmount?: Price;
1853
1977
  }
1978
+ /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
1979
+ interface CrossBorderCalculation {
1980
+ /** Whether the calculation repriced the lines for the destination's tax. */
1981
+ applied?: boolean;
1982
+ /** Why the calculation didn't reprice the lines. Meaningful only when `applied` is `false`. */
1983
+ reason?: CrossBorderNotApplicableReasonWithLiterals;
1984
+ /** Mode the calculation ran in. `FULL` when the request set no mode. */
1985
+ mode?: CrossBorderRepricingModeWithLiterals;
1986
+ /**
1987
+ * Request ID of the calculation, for log correlation.
1988
+ * @maxLength 100
1989
+ */
1990
+ requestId?: string | null;
1991
+ }
1992
+ /** Why a cross-border repricing calculation didn't reprice the lines. */
1993
+ declare enum CrossBorderNotApplicableReason {
1994
+ /** The repricing feature toggle is off. */
1995
+ FEATURE_DISABLED = "FEATURE_DISABLED",
1996
+ /** The site hasn't opted in to cross-border repricing. */
1997
+ NOT_OPTED_IN = "NOT_OPTED_IN",
1998
+ /** The site's prices no longer include tax. */
1999
+ TAX_INCLUSIVE_PRICING_OFF = "TAX_INCLUSIVE_PRICING_OFF",
2000
+ /** The base tax region doesn't exist on the site. */
2001
+ BASE_TAX_REGION_NOT_FOUND = "BASE_TAX_REGION_NOT_FOUND",
2002
+ /** The base region uses the manual calculator and has no tax mapping. */
2003
+ BASE_REGION_HAS_NO_MANUAL_MAPPING = "BASE_REGION_HAS_NO_MANUAL_MAPPING",
2004
+ /** No embedded rate is stored for one of the tax groups in the calculation. */
2005
+ EMBEDDED_RATE_MISSING = "EMBEDDED_RATE_MISSING",
2006
+ /** Removing the base tax or applying the destination's tax failed for a line item. */
2007
+ CROSS_BORDER_REPRICING_FAILED = "CROSS_BORDER_REPRICING_FAILED",
2008
+ /** The line items were repriced. Repricing the shipping option failed. */
2009
+ SHIPPING_REPRICING_FAILED = "SHIPPING_REPRICING_FAILED",
2010
+ /** The line items were repriced. Repricing the additional fees failed. */
2011
+ FEES_REPRICING_FAILED = "FEES_REPRICING_FAILED",
2012
+ /** The site's tax settings couldn't be read, so the calculation couldn't tell whether the site opted in. */
2013
+ SETTINGS_UNAVAILABLE = "SETTINGS_UNAVAILABLE"
2014
+ }
2015
+ /** @enumType */
2016
+ 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';
2017
+ /** How a cross-border repricing calculation is asked to run. This is the requested mode; a line's outcome is `CrossBorderPriceAdjustment.RepriceStatus`. */
2018
+ declare enum CrossBorderRepricingMode {
2019
+ /** Nothing is repriced. */
2020
+ DISABLED = "DISABLED",
2021
+ /** Base tax removed and no destination tax applied. A line repriced this way has the outcome `CrossBorderPriceAdjustment.RepriceStatus.STRIP_ONLY`. */
2022
+ STRIP_ONLY = "STRIP_ONLY",
2023
+ /** Base tax removed and the destination's tax applied. A request that sets no mode runs this way. */
2024
+ FULL = "FULL"
2025
+ }
2026
+ /** @enumType */
2027
+ type CrossBorderRepricingModeWithLiterals = CrossBorderRepricingMode | 'DISABLED' | 'STRIP_ONLY' | 'FULL';
1854
2028
  interface AppliedDiscount extends AppliedDiscountDiscountSourceOneOf {
1855
2029
  /** Coupon applied by the customer. */
1856
2030
  coupon?: Coupon;
@@ -3381,6 +3555,12 @@ interface AdditionalFee {
3381
3555
  source?: AdditionalFeeSourceWithLiterals;
3382
3556
  /** Address type tax was calculated against for this fee. */
3383
3557
  taxableAddress?: TaxableAddress;
3558
+ /**
3559
+ * Cross-border repricing record of the fee on a site whose catalog prices include tax.
3560
+ * @internal
3561
+ * @readonly
3562
+ */
3563
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
3384
3564
  }
3385
3565
  declare enum AdditionalFeeSource {
3386
3566
  /** The additional fee was added by an additional fee service plugin. */
@@ -4162,6 +4342,13 @@ interface OrderLineItemChangedDetails {
4162
4342
  * @internal
4163
4343
  */
4164
4344
  decimalQuantityUpdate?: DecimalQuantityUpdate;
4345
+ /**
4346
+ * Cross-border repricing record of the line item after the change.
4347
+ *
4348
+ * Set empty to state that the line item no longer carries a record. When omitted, the stored record is kept.
4349
+ * @internal
4350
+ */
4351
+ crossBorderAdjustmentUpdate?: CrossBorderAdjustmentUpdate;
4165
4352
  }
4166
4353
  /** Type of selected payment option for catalog item */
4167
4354
  declare enum DeltaPaymentOptionType {
@@ -4185,6 +4372,13 @@ interface DecimalQuantityUpdate {
4185
4372
  */
4186
4373
  decimalQuantity?: DecimalQuantity;
4187
4374
  }
4375
+ interface CrossBorderAdjustmentUpdate {
4376
+ /**
4377
+ * Cross-border repricing record of the line item.
4378
+ * @internal
4379
+ */
4380
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
4381
+ }
4188
4382
  interface LineItemDelta extends LineItemDeltaDeltaOneOf {
4189
4383
  lineItemAdded?: boolean;
4190
4384
  changedDetails?: ItemChangedDetails;
@@ -4497,2328 +4691,2328 @@ interface BulkDeleteImportedOrdersResponse {
4497
4691
  */
4498
4692
  jobId?: string;
4499
4693
  }
4500
- interface V1TriggerReindexRequest {
4694
+ interface SendBuyerConfirmationEmailRequest {
4501
4695
  /** @format GUID */
4502
- metasiteId?: string;
4696
+ orderId?: string;
4697
+ }
4698
+ interface SendBuyerConfirmationEmailResponse {
4699
+ }
4700
+ interface SendBuyerPaymentsReceivedEmailRequest {
4503
4701
  /**
4504
4702
  * @minLength 1
4505
4703
  * @maxLength 100
4506
- * @maxSize 100
4507
4704
  */
4508
- orderIds?: string[];
4705
+ orderId?: string;
4509
4706
  }
4510
- interface V1TriggerReindexResponse {
4707
+ interface SendBuyerPaymentsReceivedEmailResponse {
4511
4708
  }
4512
- interface V1TriggerReindexOrderRequest {
4513
- /** @format GUID */
4514
- metasiteId?: string;
4709
+ interface SendBuyerPickupConfirmationEmailRequest {
4515
4710
  /**
4516
4711
  * @minLength 1
4517
4712
  * @maxLength 100
4518
4713
  */
4519
4714
  orderId?: string;
4520
4715
  }
4521
- interface PreparePaymentCollectionRequest {
4716
+ interface SendBuyerPickupConfirmationEmailResponse {
4717
+ }
4718
+ interface BulkSendBuyerPickupConfirmationEmailsRequest {
4719
+ /**
4720
+ * IDs of orders to send pickup emails for.
4721
+ * @minSize 1
4722
+ * @maxSize 300
4723
+ */
4724
+ orderIds?: string[];
4725
+ }
4726
+ interface BulkSendBuyerPickupConfirmationEmailsResponse {
4727
+ }
4728
+ interface SendBuyerShippingConfirmationEmailRequest {
4522
4729
  /**
4523
- * Ecom order ID.
4524
4730
  * @minLength 1
4525
4731
  * @maxLength 100
4526
4732
  */
4527
- ecomOrderId: string;
4528
- /** Amount to collect */
4529
- amount: Price;
4733
+ orderId?: string;
4734
+ }
4735
+ interface SendBuyerShippingConfirmationEmailResponse {
4736
+ }
4737
+ interface BulkSendBuyerShippingConfirmationEmailsRequest {
4530
4738
  /**
4531
- * Optional parameter. When present, payment collection will be performed using given payment gateway order.
4532
- * Existing payment gateway order will be updated with a new amount.
4533
- * When parameter is absent, new payment gateway order will be created and used for payment collection.
4739
+ * IDs of orders to send pickup emails for.
4740
+ * @minSize 1
4741
+ * @maxSize 300
4534
4742
  */
4535
- paymentGatewayOrderId?: string | null;
4743
+ orderIds?: string[];
4744
+ }
4745
+ interface BulkSendBuyerShippingConfirmationEmailsResponse {
4746
+ }
4747
+ interface SendMerchantOrderReceivedNotificationRequest {
4536
4748
  /**
4537
- * Whether to delay capture of the payment.
4538
- * Default: false
4539
- * @deprecated Whether to delay capture of the payment.
4540
- * Default: false
4541
- * @replacedBy delayed_capture_settings.scheduled_action
4542
- * @targetRemovalDate 2024-09-30
4749
+ * @minLength 1
4750
+ * @maxLength 100
4543
4751
  */
4544
- delayedCapture?: boolean;
4752
+ orderId?: string;
4753
+ }
4754
+ interface SendMerchantOrderReceivedNotificationResponse {
4755
+ }
4756
+ interface SendCancelRefundEmailRequest {
4545
4757
  /**
4546
- * Specifies whether payment collection is initiated by Merchant or User of User
4547
- * Default: `true`
4548
- * @internal
4758
+ * The ID of order that is canceled/refunded
4759
+ * @minLength 1
4760
+ * @maxLength 100
4549
4761
  */
4550
- merchantInitiated?: boolean | null;
4762
+ orderId?: string;
4551
4763
  /**
4552
- * Redirect urls which are used to return buyer to third party system.
4553
- * @internal
4764
+ * Personal note added to the email (optional)
4765
+ * @minLength 1
4766
+ * @maxLength 1000
4554
4767
  */
4555
- redirectUrls?: RedirectUrls;
4556
- /** Delayed capture payment settings */
4557
- delayedCaptureSettings?: DelayedCaptureSettings;
4558
- }
4559
- interface RedirectUrls {
4768
+ customMessage?: string | null;
4769
+ /** Refund amount */
4770
+ refundAmount?: Price;
4560
4771
  /**
4561
- * URL to redirect buyer in case of approved (successful) transaction
4562
- * @format WEB_URL
4772
+ * Refund ID. (Optional)
4773
+ * @format GUID
4563
4774
  */
4564
- successUrl?: string | null;
4775
+ refundId?: string | null;
4776
+ }
4777
+ interface SendCancelRefundEmailResponse {
4778
+ }
4779
+ interface SendRefundEmailRequest {
4565
4780
  /**
4566
- * URL to redirect buyer in case of buyer canceled the transaction
4567
- * @format WEB_URL
4781
+ * The ID of order that is refunded
4782
+ * @format GUID
4568
4783
  */
4569
- cancelUrl?: string | null;
4784
+ orderId?: string;
4570
4785
  /**
4571
- * URL to redirect buyer in case of failed/rejected transaction
4572
- * @format WEB_URL
4786
+ * Refund ID
4787
+ * @format GUID
4573
4788
  */
4574
- errorUrl?: string | null;
4789
+ refundId?: string;
4575
4790
  /**
4576
- * URL to redirect buyer in case of pending transaction (that might take some time to process)
4577
- * @format WEB_URL
4791
+ * Personal note added to the email (optional)
4792
+ * @minLength 1
4793
+ * @maxLength 1000
4578
4794
  */
4579
- pendingUrl?: string | null;
4795
+ customMessage?: string | null;
4580
4796
  }
4581
- interface DelayedCaptureSettings {
4582
- /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
4583
- scheduledAction?: ScheduledActionWithLiterals;
4584
- /** Delay duration before execution. Optional - if not set, providers default period will be used */
4585
- delayDuration?: Duration;
4797
+ interface SendRefundEmailResponse {
4586
4798
  }
4587
- declare enum ScheduledAction {
4588
- /** Whether payment will be auto-voided when duration passes */
4589
- VOID = "VOID",
4590
- /** Whether payment will be auto-captured when duration passes */
4591
- CAPTURE = "CAPTURE"
4799
+ interface SendFulfillmentEmailRequest {
4800
+ /** @format GUID */
4801
+ orderId?: string;
4802
+ /** @format GUID */
4803
+ fulfillerId?: string;
4592
4804
  }
4593
- /** @enumType */
4594
- type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
4595
- interface Duration {
4805
+ interface SendFulfillmentEmailResponse {
4806
+ }
4807
+ interface SendMerchantOrderReceivedPushRequest {
4596
4808
  /**
4597
- * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
4598
- * @min 1
4809
+ * @minLength 1
4810
+ * @maxLength 100
4599
4811
  */
4600
- count?: number;
4601
- /** Duration unit: MINUTES, HOURS and DAYS */
4602
- unit?: DurationUnitWithLiterals;
4812
+ orderId?: string;
4603
4813
  }
4604
- declare enum DurationUnit {
4605
- MINUTES = "MINUTES",
4606
- HOURS = "HOURS",
4607
- DAYS = "DAYS"
4814
+ interface SendMerchantOrderReceivedPushResponse {
4815
+ }
4816
+ interface PreviewEmailByTypeRequest {
4817
+ emailType?: PreviewEmailTypeWithLiterals;
4818
+ }
4819
+ declare enum PreviewEmailType {
4820
+ ORDER_PLACED = "ORDER_PLACED",
4821
+ DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
4822
+ ORDER_SHIPPED = "ORDER_SHIPPED",
4823
+ ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
4608
4824
  }
4609
4825
  /** @enumType */
4610
- type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
4611
- interface PreparePaymentCollectionResponse {
4612
- /** Payment gateway order id which is associated with given payment */
4613
- paymentGatewayOrderId?: string;
4826
+ type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
4827
+ interface PreviewEmailByTypeResponse {
4828
+ emailPreview?: string;
4614
4829
  }
4615
- interface GetPaymentCollectabilityStatusRequest {
4830
+ interface PreviewRefundEmailRequest {
4616
4831
  /**
4617
- * Ecom order ID.
4618
4832
  * @minLength 1
4619
4833
  * @maxLength 100
4620
4834
  */
4621
- ecomOrderId: string;
4622
- }
4623
- interface GetPaymentCollectabilityStatusResponse {
4624
- /** Payment collectability status */
4625
- status?: PaymentCollectabilityStatusWithLiterals;
4626
- /** Collectable order amount */
4627
- amount?: Price;
4835
+ orderId?: string;
4836
+ /** Refund amount */
4837
+ refundAmount?: Price;
4838
+ /** Refund business details */
4839
+ details?: RefundDetails;
4628
4840
  /**
4629
- * Whether authorization supported
4630
- * @internal
4631
- */
4632
- authorizationSupported?: boolean;
4841
+ * Personal note added to the email (optional)
4842
+ * @minLength 1
4843
+ * @maxLength 1000
4844
+ */
4845
+ customMessage?: string | null;
4633
4846
  /**
4634
- * Whether custom amount is supported for payment collection
4635
- * @internal
4847
+ * Refund ID. (Optional)
4848
+ * @format GUID
4636
4849
  */
4637
- customAmountSupported?: boolean;
4638
- }
4639
- declare enum PaymentCollectabilityStatus {
4640
- UNKNOWN = "UNKNOWN",
4641
- COLLECTABLE = "COLLECTABLE",
4642
- NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
4643
- NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
4644
- NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
4645
- NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
4646
- NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
4647
- NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
4648
- NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
4649
- NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
4650
- NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
4651
- NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
4652
- NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
4850
+ refundId?: string | null;
4653
4851
  }
4654
- /** @enumType */
4655
- 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';
4656
- interface RecordManuallyCollectedPaymentRequest {
4852
+ /** Business model of a refund request */
4853
+ interface RefundDetails {
4657
4854
  /**
4658
- * Order ID.
4659
- * @minLength 1
4660
- * @maxLength 100
4855
+ * Order line item IDs and quantities that were refunded.
4856
+ * @maxSize 300
4661
4857
  */
4662
- orderId: string;
4663
- /** Amount to be recorded as approved manual payment for given order */
4664
- amount: Price;
4858
+ items?: RefundItem[];
4859
+ /** Whether the shipping fee was also refunded. */
4860
+ shippingIncluded?: boolean;
4665
4861
  /**
4666
- * Payment method name provided by user.
4667
- *
4668
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4669
- * @internal
4862
+ * Reason for the refund, provided by customer (optional).
4863
+ * @maxLength 200
4670
4864
  */
4671
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4672
- }
4673
- /**
4674
- * User-defined payment method name.
4675
- * Allows specifying either a predefined type or a custom name.
4676
- */
4677
- interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
4678
- /** Predefined payment method. */
4679
- predefined?: PredefinedPaymentMethodWithLiterals;
4865
+ reason?: string | null;
4680
4866
  /**
4681
- * Custom payment method name provided by user.
4682
- *
4683
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4684
- * @minLength 1
4685
- * @maxLength 150
4867
+ * Line items that were refunded.
4868
+ * @maxSize 300
4686
4869
  */
4687
- custom?: string | null;
4688
- }
4689
- /** @oneof */
4690
- interface UserDefinedPaymentMethodNameKindOneOf {
4691
- /** Predefined payment method. */
4692
- predefined?: PredefinedPaymentMethodWithLiterals;
4870
+ lineItems?: LineItemRefund[];
4693
4871
  /**
4694
- * Custom payment method name provided by user.
4695
- *
4696
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4697
- * @minLength 1
4698
- * @maxLength 150
4872
+ * Additional fees that were refunded.
4873
+ * @maxSize 100
4699
4874
  */
4700
- custom?: string | null;
4701
- }
4702
- /** Predefined payment method types for offline/manual payments. */
4703
- declare enum PredefinedPaymentMethod {
4704
- /** Cash payment. */
4705
- CASH = "CASH",
4706
- /** Bank transfer. */
4707
- BANK_TRANSFER = "BANK_TRANSFER",
4708
- /** Payment by check. */
4709
- CHECK = "CHECK"
4710
- }
4711
- /** @enumType */
4712
- type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
4713
- interface RecordManuallyCollectedPaymentResponse {
4875
+ additionalFees?: AdditionalFeeRefund[];
4876
+ /** Shipping amount that was refunded. */
4877
+ shipping?: ShippingRefund;
4714
4878
  }
4715
- interface MarkOrderAsPaidRequest {
4879
+ interface RefundItem {
4716
4880
  /**
4717
- * Ecom order ID.
4718
- * @minLength 1
4719
- * @maxLength 100
4881
+ * Line item ID the refunded line item.
4882
+ * @format GUID
4720
4883
  */
4721
- ecomOrderId: string;
4884
+ lineItemId?: string;
4722
4885
  /**
4723
- * Payment method name provided by user.
4724
- *
4725
- * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
4726
- * @internal
4886
+ * Line item quantity refunded.
4887
+ * @min 1
4888
+ * @max 100000
4727
4889
  */
4728
- userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
4729
- }
4730
- interface MarkOrderAsPaidResponse {
4731
- /** Updated order. */
4732
- order?: Order;
4890
+ quantity?: number;
4733
4891
  }
4734
- interface BulkMarkOrdersAsPaidRequest {
4892
+ interface LineItemRefund {
4735
4893
  /**
4736
- * IDs of orders to mark as paid.
4737
- * @minSize 1
4738
- * @maxSize 100
4739
- * @minLength 1
4740
- * @maxLength 100
4894
+ * Line item ID.
4895
+ * @format GUID
4896
+ * @immutable
4741
4897
  */
4742
- ecomOrderIds: string[];
4898
+ lineItemId?: string;
4899
+ /**
4900
+ * Refund quantity.
4901
+ * @min 1
4902
+ * @max 100000
4903
+ * @immutable
4904
+ */
4905
+ quantity?: number;
4743
4906
  }
4744
- interface BulkMarkOrdersAsPaidResponse {
4907
+ interface AdditionalFeeRefund {
4745
4908
  /**
4746
- * Items updated by the bulk action.
4747
- * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
4909
+ * Additional fee ID.
4910
+ * @format GUID
4911
+ * @immutable
4748
4912
  */
4749
- results?: BulkOrderResult[];
4750
- /** Bulk action metadata. */
4751
- bulkActionMetadata?: BulkActionMetadata;
4913
+ additionalFeeId?: string;
4914
+ /**
4915
+ * Refund amount.
4916
+ * @immutable
4917
+ */
4918
+ amount?: Price;
4752
4919
  }
4753
- interface BulkOrderResult {
4754
- /** Item metadata. */
4755
- itemMetadata?: ItemMetadata;
4920
+ interface ShippingRefund {
4756
4921
  /**
4757
- * Updated order.
4758
- *
4759
- * Returned when `returnFullEntity = true`.
4922
+ * Refund amount.
4923
+ * @immutable
4760
4924
  */
4761
- item?: Order;
4925
+ amount?: Price;
4762
4926
  }
4763
- interface ItemMetadata {
4764
- /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
4765
- _id?: string | null;
4766
- /** Index of the item within the request array. Allows for correlation between request and response items. */
4767
- originalIndex?: number;
4768
- /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
4769
- success?: boolean;
4770
- /** Details about the error in case of failure. */
4771
- error?: ApplicationError;
4927
+ interface PreviewRefundEmailResponse {
4928
+ emailPreview?: string;
4772
4929
  }
4773
- interface ApplicationError {
4774
- /** Error code. */
4775
- code?: string;
4776
- /** Description of the error. */
4777
- description?: string;
4778
- /** Data related to the error. */
4779
- data?: Record<string, any> | null;
4930
+ interface PreviewCancelEmailRequest {
4931
+ /**
4932
+ * @minLength 1
4933
+ * @maxLength 100
4934
+ */
4935
+ orderId?: string;
4936
+ /**
4937
+ * Personal note added to the email (optional)
4938
+ * @minLength 1
4939
+ * @maxLength 1000
4940
+ */
4941
+ customMessage?: string | null;
4780
4942
  }
4781
- interface BulkActionMetadata {
4782
- /** Number of items that were successfully processed. */
4783
- totalSuccesses?: number;
4784
- /** Number of items that couldn't be processed. */
4785
- totalFailures?: number;
4786
- /** Number of failures without details because detailed failure threshold was exceeded. */
4787
- undetailedFailures?: number;
4943
+ interface PreviewCancelEmailResponse {
4944
+ emailPreview?: string;
4788
4945
  }
4789
- interface GetRefundabilityStatusRequest {
4946
+ interface PreviewCancelRefundEmailRequest {
4790
4947
  /**
4791
- * Order ID.
4792
4948
  * @minLength 1
4793
4949
  * @maxLength 100
4794
4950
  */
4795
- ecomOrderId: string;
4796
- }
4797
- interface GetRefundabilityStatusResponse {
4951
+ orderId?: string;
4798
4952
  /**
4799
- * Refundability details.
4800
- * @maxSize 300
4953
+ * Personal note added to the email (optional)
4954
+ * @minLength 1
4955
+ * @maxLength 1000
4801
4956
  */
4802
- refundabilities?: Refundability[];
4957
+ customMessage?: string | null;
4958
+ /** Refund amount */
4959
+ refundAmount?: Price;
4803
4960
  /**
4804
- * Whether the order supports refunding per item.
4805
- * @deprecated
4961
+ * Refund ID. (Optional)
4962
+ * @format GUID
4806
4963
  */
4807
- refundablePerItem?: boolean;
4964
+ refundId?: string | null;
4808
4965
  }
4809
- interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
4810
- /** Reason why payment is not refundable. */
4811
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4812
- /** Reason why payment is only refundable manually. */
4813
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4814
- /** Payment ID. */
4815
- paymentId?: string;
4816
- /** Payment refundability status. */
4817
- refundabilityStatus?: RefundableStatusWithLiterals;
4818
- /** Link to payment provider dashboard. */
4819
- providerLink?: string | null;
4966
+ interface PreviewCancelRefundEmailResponse {
4967
+ emailPreview?: string;
4820
4968
  }
4821
- /** @oneof */
4822
- interface RefundabilityAdditionalRefundabilityInfoOneOf {
4823
- /** Reason why payment is not refundable. */
4824
- nonRefundableReason?: NonRefundableReasonWithLiterals;
4825
- /** Reason why payment is only refundable manually. */
4826
- manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
4969
+ interface PreviewBuyerPaymentsReceivedEmailRequest {
4827
4970
  }
4828
- declare enum RefundableStatus {
4829
- NOT_REFUNDABLE = "NOT_REFUNDABLE",
4830
- MANUAL = "MANUAL",
4831
- REFUNDABLE = "REFUNDABLE"
4971
+ interface PreviewBuyerPaymentsReceivedEmailResponse {
4972
+ emailPreview?: string;
4832
4973
  }
4833
- /** @enumType */
4834
- type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
4835
- declare enum NonRefundableReason {
4836
- NONE = "NONE",
4837
- ALREADY_REFUNDED = "ALREADY_REFUNDED",
4838
- PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
4839
- INTERNAL_ERROR = "INTERNAL_ERROR",
4840
- NOT_PAID = "NOT_PAID",
4841
- ACCESS_DENIED = "ACCESS_DENIED",
4842
- ZERO_PRICE = "ZERO_PRICE",
4843
- DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
4844
- PENDING_REFUND = "PENDING_REFUND",
4845
- FORBIDDEN = "FORBIDDEN",
4846
- TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
4847
- ORDER_IS_PENDING = "ORDER_IS_PENDING",
4848
- ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
4974
+ interface PreviewBuyerConfirmationEmailRequest {
4849
4975
  }
4850
- /** @enumType */
4851
- 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';
4852
- declare enum ManuallyRefundableReason {
4853
- EXPIRED = "EXPIRED",
4854
- NOT_SUPPORTED = "NOT_SUPPORTED",
4855
- OFFLINE = "OFFLINE",
4856
- REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
4976
+ interface PreviewBuyerConfirmationEmailResponse {
4977
+ emailPreview?: string;
4857
4978
  }
4858
- /** @enumType */
4859
- type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
4860
- interface CreatePaymentGatewayOrderRequest {
4861
- /**
4862
- * Ecom order ID.
4863
- * @minLength 1
4864
- * @maxLength 100
4865
- */
4866
- ecomOrderId: string;
4867
- /** Information about the user who initiated the payment. */
4868
- chargedBy?: ChargedBy;
4869
- /**
4870
- * Whether to delay capture of the payment.
4871
- *
4872
- * Default: false
4873
- * @internal
4874
- */
4875
- delayedCapture?: boolean;
4979
+ interface PreviewBuyerPickupConfirmationEmailRequest {
4876
4980
  }
4877
- interface ChargedBy {
4878
- /**
4879
- * ID - id of the user who initiated the payment
4880
- * @format GUID
4881
- */
4882
- _id?: string;
4883
- /**
4884
- * Full name - name of the user who initiated the payment
4885
- * @minLength 1
4886
- * @maxLength 200
4887
- */
4888
- fullName?: string | null;
4981
+ interface PreviewBuyerPickupConfirmationEmailResponse {
4982
+ emailPreview?: string;
4889
4983
  }
4890
- interface CreatePaymentGatewayOrderResponse {
4891
- /** ID of the order created in the payment gateway */
4892
- paymentGatewayOrderId?: string;
4984
+ interface PreviewShippingConfirmationEmailRequest {
4893
4985
  }
4894
- interface ChargeMembershipsRequest {
4986
+ interface PreviewShippingConfirmationEmailResponse {
4987
+ emailPreview?: string;
4988
+ }
4989
+ interface PreviewResendDownloadLinksEmailRequest {
4990
+ }
4991
+ interface PreviewResendDownloadLinksEmailResponse {
4992
+ emailPreview?: string;
4993
+ }
4994
+ interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
4995
+ /** Emitted on a meta site creation. */
4996
+ siteCreated?: SiteCreated;
4997
+ /** Emitted on a meta site transfer completion. */
4998
+ siteTransferred?: SiteTransferred;
4999
+ /** Emitted on a meta site deletion. */
5000
+ siteDeleted?: SiteDeleted;
5001
+ /** Emitted on a meta site restoration. */
5002
+ siteUndeleted?: SiteUndeleted;
5003
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5004
+ sitePublished?: SitePublished;
5005
+ /** Emitted on a meta site unpublish. */
5006
+ siteUnpublished?: SiteUnpublished;
5007
+ /** Emitted when meta site is marked as template. */
5008
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5009
+ /** Emitted when meta site is marked as a WixSite. */
5010
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5011
+ /** Emitted when an application is provisioned (installed). */
5012
+ serviceProvisioned?: ServiceProvisioned;
5013
+ /** Emitted when an application is removed (uninstalled). */
5014
+ serviceRemoved?: ServiceRemoved;
5015
+ /** Emitted when meta site name (URL slug) is changed. */
5016
+ siteRenamedPayload?: SiteRenamed;
5017
+ /** Emitted when meta site was permanently deleted. */
5018
+ hardDeleted?: SiteHardDeleted;
5019
+ /** Emitted on a namespace change. */
5020
+ namespaceChanged?: NamespaceChanged;
5021
+ /** Emitted when Studio is attached. */
5022
+ studioAssigned?: StudioAssigned;
5023
+ /** Emitted when Studio is detached. */
5024
+ studioUnassigned?: StudioUnassigned;
4895
5025
  /**
4896
- * Order ID.
4897
- * @minLength 1
4898
- * @maxLength 100
5026
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5027
+ * the actual URL.
5028
+ *
5029
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5030
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4899
5031
  */
4900
- ecomOrderId: string;
5032
+ urlChanged?: SiteUrlChanged;
5033
+ /** Site is marked as PurgedExternally */
5034
+ sitePurgedExternally?: SitePurgedExternally;
5035
+ /** Emitted when Odeditor is attached. */
5036
+ odeditorAssigned?: OdeditorAssigned;
5037
+ /** Emitted when Odeditor is detached. */
5038
+ odeditorUnassigned?: OdeditorUnassigned;
5039
+ /** Emitted when Picasso is attached. */
5040
+ picassoAssigned?: PicassoAssigned;
5041
+ /** Emitted when Picasso is detached. */
5042
+ picassoUnassigned?: PicassoUnassigned;
5043
+ /** Emitted when Wixel is attached. */
5044
+ wixelAssigned?: WixelAssigned;
5045
+ /** Emitted when Wixel is detached. */
5046
+ wixelUnassigned?: WixelUnassigned;
5047
+ /** Emitted when StudioTwo is attached. */
5048
+ studioTwoAssigned?: StudioTwoAssigned;
5049
+ /** Emitted when StudioTwo is detached. */
5050
+ studioTwoUnassigned?: StudioTwoUnassigned;
5051
+ /** Emitted when media from user domain is enabled. */
5052
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5053
+ /** Emitted when media from user domain is disabled. */
5054
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5055
+ /** Emitted when Editorless is attached. */
5056
+ editorlessAssigned?: EditorlessAssigned;
5057
+ /** Emitted when Editorless is detached. */
5058
+ editorlessUnassigned?: EditorlessUnassigned;
4901
5059
  /**
4902
- * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
4903
- * but a user which is using the membership on behalf of the a member
5060
+ * A meta site id.
4904
5061
  * @format GUID
4905
5062
  */
4906
- memberId: string;
5063
+ metaSiteId?: string;
5064
+ /** A meta site version. Monotonically increasing. */
5065
+ version?: string;
5066
+ /** A timestamp of the event. */
5067
+ timestamp?: string;
4907
5068
  /**
4908
- * List of items to be paid by memberships
4909
- * @minSize 1
4910
- * @maxSize 300
5069
+ * TODO(meta-site): Change validation once validations are disabled for consumers
5070
+ * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
5071
+ * @maxSize 4000
4911
5072
  */
4912
- membershipCharges?: MembershipChargeItem[];
5073
+ assets?: Asset[];
4913
5074
  }
4914
- interface MembershipChargeItem {
4915
- /**
4916
- * The id of used membership
4917
- * @minLength 1
4918
- * @maxLength 100
4919
- */
4920
- membershipId?: string;
5075
+ /** @oneof */
5076
+ interface MetaSiteSpecialEventPayloadOneOf {
5077
+ /** Emitted on a meta site creation. */
5078
+ siteCreated?: SiteCreated;
5079
+ /** Emitted on a meta site transfer completion. */
5080
+ siteTransferred?: SiteTransferred;
5081
+ /** Emitted on a meta site deletion. */
5082
+ siteDeleted?: SiteDeleted;
5083
+ /** Emitted on a meta site restoration. */
5084
+ siteUndeleted?: SiteUndeleted;
5085
+ /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
5086
+ sitePublished?: SitePublished;
5087
+ /** Emitted on a meta site unpublish. */
5088
+ siteUnpublished?: SiteUnpublished;
5089
+ /** Emitted when meta site is marked as template. */
5090
+ siteMarkedAsTemplate?: SiteMarkedAsTemplate;
5091
+ /** Emitted when meta site is marked as a WixSite. */
5092
+ siteMarkedAsWixSite?: SiteMarkedAsWixSite;
5093
+ /** Emitted when an application is provisioned (installed). */
5094
+ serviceProvisioned?: ServiceProvisioned;
5095
+ /** Emitted when an application is removed (uninstalled). */
5096
+ serviceRemoved?: ServiceRemoved;
5097
+ /** Emitted when meta site name (URL slug) is changed. */
5098
+ siteRenamedPayload?: SiteRenamed;
5099
+ /** Emitted when meta site was permanently deleted. */
5100
+ hardDeleted?: SiteHardDeleted;
5101
+ /** Emitted on a namespace change. */
5102
+ namespaceChanged?: NamespaceChanged;
5103
+ /** Emitted when Studio is attached. */
5104
+ studioAssigned?: StudioAssigned;
5105
+ /** Emitted when Studio is detached. */
5106
+ studioUnassigned?: StudioUnassigned;
4921
5107
  /**
4922
- * ID of the application providing this payment option
4923
- * @format GUID
5108
+ * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
5109
+ * the actual URL.
5110
+ *
5111
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
5112
+ * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
4924
5113
  */
4925
- appId?: string;
4926
- /** The name of used membership */
4927
- membershipName?: MembershipName;
4928
- /** Additional data about this membership */
4929
- membershipAdditionalData?: Record<string, any> | null;
4930
- /** Catalog and item reference info. */
4931
- catalogReference?: CatalogReference;
4932
- /** Properties of the service. When relevant, contains information such as date and number of participants. */
4933
- serviceProperties?: ServiceProperties;
5114
+ urlChanged?: SiteUrlChanged;
5115
+ /** Site is marked as PurgedExternally */
5116
+ sitePurgedExternally?: SitePurgedExternally;
5117
+ /** Emitted when Odeditor is attached. */
5118
+ odeditorAssigned?: OdeditorAssigned;
5119
+ /** Emitted when Odeditor is detached. */
5120
+ odeditorUnassigned?: OdeditorUnassigned;
5121
+ /** Emitted when Picasso is attached. */
5122
+ picassoAssigned?: PicassoAssigned;
5123
+ /** Emitted when Picasso is detached. */
5124
+ picassoUnassigned?: PicassoUnassigned;
5125
+ /** Emitted when Wixel is attached. */
5126
+ wixelAssigned?: WixelAssigned;
5127
+ /** Emitted when Wixel is detached. */
5128
+ wixelUnassigned?: WixelUnassigned;
5129
+ /** Emitted when StudioTwo is attached. */
5130
+ studioTwoAssigned?: StudioTwoAssigned;
5131
+ /** Emitted when StudioTwo is detached. */
5132
+ studioTwoUnassigned?: StudioTwoUnassigned;
5133
+ /** Emitted when media from user domain is enabled. */
5134
+ userDomainMediaEnabled?: UserDomainMediaEnabled;
5135
+ /** Emitted when media from user domain is disabled. */
5136
+ userDomainMediaDisabled?: UserDomainMediaDisabled;
5137
+ /** Emitted when Editorless is attached. */
5138
+ editorlessAssigned?: EditorlessAssigned;
5139
+ /** Emitted when Editorless is detached. */
5140
+ editorlessUnassigned?: EditorlessUnassigned;
5141
+ }
5142
+ interface Asset {
4934
5143
  /**
4935
- * Usually would be the same as catalogReference.catalogItemId
4936
- * For cases when these are not the same, this field would return the actual id of the item in the catalog
4937
- * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
4938
- * @minLength 1
5144
+ * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
4939
5145
  * @maxLength 36
4940
5146
  */
4941
- rootCatalogItemId?: string | null;
5147
+ appDefId?: string;
4942
5148
  /**
4943
- * line item id of Checkout/Order line item
4944
- * @minLength 1
4945
- * @maxLength 100
5149
+ * An instance id. For legacy reasons may be UUID or a string.
5150
+ * @maxLength 200
4946
5151
  */
4947
- lineItemId?: string;
5152
+ instanceId?: string;
5153
+ /** An application state. */
5154
+ state?: StateWithLiterals;
4948
5155
  }
4949
- interface MembershipName {
5156
+ declare enum State {
5157
+ UNKNOWN = "UNKNOWN",
5158
+ ENABLED = "ENABLED",
5159
+ DISABLED = "DISABLED",
5160
+ PENDING = "PENDING",
5161
+ DEMO = "DEMO"
5162
+ }
5163
+ /** @enumType */
5164
+ type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
5165
+ interface SiteCreated {
4950
5166
  /**
4951
- * Membership name in the site's original language.
4952
- * @maxLength 100
5167
+ * A template identifier (empty if not created from a template).
5168
+ * @maxLength 36
4953
5169
  */
4954
- original?: string;
5170
+ originTemplateId?: string;
4955
5171
  /**
4956
- * Membership name translated into the buyer's language.
4957
- *
4958
- * Default: The value of `original`
4959
- * @maxLength 100
5172
+ * An account id of the owner.
5173
+ * @format GUID
4960
5174
  */
4961
- translated?: string | null;
4962
- }
4963
- interface ChargeMembershipsResponse {
4964
- }
4965
- interface TriggerRefundRequest {
5175
+ ownerId?: string;
5176
+ /** A context in which meta site was created. */
5177
+ context?: SiteCreatedContextWithLiterals;
4966
5178
  /**
4967
- * The order this refund related to
4968
- * @minLength 1
4969
- * @maxLength 100
5179
+ * A meta site id from which this site was created.
5180
+ *
5181
+ * In case of a creation from a template it's a template id.
5182
+ * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
5183
+ * @format GUID
4970
5184
  */
4971
- ecomOrderId: string;
5185
+ originMetaSiteId?: string | null;
4972
5186
  /**
4973
- * Refund operations information
4974
- * @minSize 1
4975
- * @maxSize 1
5187
+ * A meta site name (URL slug).
5188
+ * @maxLength 20
4976
5189
  */
4977
- payments: PaymentRefund[];
4978
- /** Business model of a refund */
4979
- details?: RefundDetails;
4980
- /** Side effect details related to refund */
4981
- sideEffects?: RefundSideEffects;
5190
+ siteName?: string;
5191
+ /** A namespace. */
5192
+ namespace?: NamespaceWithLiterals;
4982
5193
  }
4983
- interface PaymentRefund {
4984
- /**
4985
- * Specific payment within the order to refund
4986
- * @format GUID
5194
+ declare enum SiteCreatedContext {
5195
+ /** A valid option, we don't expose all reasons why site might be created. */
5196
+ OTHER = "OTHER",
5197
+ /** A meta site was created from template. */
5198
+ FROM_TEMPLATE = "FROM_TEMPLATE",
5199
+ /** A meta site was created by copying of the transfferred meta site. */
5200
+ DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
5201
+ /** A copy of existing meta site. */
5202
+ DUPLICATE = "DUPLICATE",
5203
+ /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
5204
+ OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
5205
+ /** deprecated A meta site was created for Flash editor. */
5206
+ FLASH = "FLASH"
5207
+ }
5208
+ /** @enumType */
5209
+ type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
5210
+ declare enum Namespace {
5211
+ UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
5212
+ /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
5213
+ WIX = "WIX",
5214
+ /** 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. */
5215
+ SHOUT_OUT = "SHOUT_OUT",
5216
+ /** 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. */
5217
+ ALBUMS = "ALBUMS",
5218
+ /** 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. */
5219
+ WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
5220
+ /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5221
+ HOTELS = "HOTELS",
5222
+ /** 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. */
5223
+ CLUBS = "CLUBS",
5224
+ /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
5225
+ ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
5226
+ /**
5227
+ * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
5228
+ * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
4987
5229
  */
4988
- paymentId?: string;
4989
- /** Refund amount. Not relevant for membership and gift card refunds. */
4990
- amount?: Price;
5230
+ DEV_SITE = "DEV_SITE",
5231
+ /** 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. */
5232
+ LOGOS = "LOGOS",
5233
+ /** 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. */
5234
+ VIDEO_MAKER = "VIDEO_MAKER",
5235
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5236
+ PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
5237
+ /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
5238
+ DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
4991
5239
  /**
4992
- * Whether refund is made externally and manually (on the payment provider's side)
4993
- * 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.
4994
- * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
5240
+ * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
5241
+ *
5242
+ * Meta site with this namespace will *not* be shown in a user's site list by default.
4995
5243
  */
4996
- externalRefund?: boolean;
5244
+ HTML_DRAFT = "HTML_DRAFT",
4997
5245
  /**
4998
- * Gateway refund id. When param is present, new refund is not created.
4999
- * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
5000
- * and all side effects from request will be executed.
5001
- * @internal
5002
- * @minLength 1
5003
- * @maxLength 100
5246
+ * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
5247
+ * Will be accessible from Site List and will not have a website app.
5248
+ * Once the user attaches a site, the site will become a regular wixsite.
5004
5249
  */
5005
- gatewayRefundId?: string | null;
5006
- }
5007
- /** Business model of a refund request */
5008
- interface RefundDetails {
5250
+ SITELESS_BUSINESS = "SITELESS_BUSINESS",
5251
+ /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
5252
+ CREATOR_ECONOMY = "CREATOR_ECONOMY",
5253
+ /** It is to be used in the Business First efforts. */
5254
+ DASHBOARD_FIRST = "DASHBOARD_FIRST",
5255
+ /** Bookings business flow with no site. */
5256
+ ANYWHERE = "ANYWHERE",
5257
+ /** Namespace for Headless Backoffice with no editor */
5258
+ HEADLESS = "HEADLESS",
5009
5259
  /**
5010
- * Order line item IDs and quantities that were refunded.
5011
- * @maxSize 300
5260
+ * Namespace for master site that will exist in parent account that will be referenced by subaccounts
5261
+ * The site will be used for account level CSM feature for enterprise
5012
5262
  */
5013
- items?: RefundItem[];
5014
- /** Whether the shipping fee was also refunded. */
5015
- shippingIncluded?: boolean;
5263
+ ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
5264
+ /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
5265
+ RISE = "RISE",
5016
5266
  /**
5017
- * Reason for the refund, provided by customer (optional).
5018
- * @maxLength 200
5267
+ * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
5268
+ * There's a blank site behind the scene but it's blank).
5269
+ * The Mobile company will be the owner of this namespace.
5019
5270
  */
5020
- reason?: string | null;
5271
+ BRANDED_FIRST = "BRANDED_FIRST",
5272
+ /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
5273
+ NOWNIA = "NOWNIA",
5021
5274
  /**
5022
- * Line items that were refunded.
5023
- * @maxSize 300
5275
+ * UGC Templates are templates that are created by users for personal use and to sale to other users.
5276
+ * The Partners company owns this namespace.
5024
5277
  */
5025
- lineItems?: LineItemRefund[];
5278
+ UGC_TEMPLATE = "UGC_TEMPLATE",
5279
+ /** Codux Headless Sites */
5280
+ CODUX = "CODUX",
5281
+ /** Bobb - AI Design Creator. */
5282
+ MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
5026
5283
  /**
5027
- * Additional fees that were refunded.
5028
- * @maxSize 100
5284
+ * Shared Blog Site is a unique single site across Enterprise account,
5285
+ * This site will hold all Blog posts related to the Marketing product.
5029
5286
  */
5030
- additionalFees?: AdditionalFeeRefund[];
5031
- /** Shipping amount that was refunded. */
5032
- shipping?: ShippingRefund;
5033
- }
5034
- interface RefundItem {
5287
+ SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
5288
+ /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5289
+ STANDALONE_FORMS = "STANDALONE_FORMS",
5290
+ /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
5291
+ STANDALONE_EVENTS = "STANDALONE_EVENTS",
5292
+ /** MIMIR - Siteless account for MIMIR Ai Job runner. */
5293
+ MIMIR = "MIMIR",
5294
+ /** Wix Twins platform. */
5295
+ TWINS = "TWINS",
5296
+ /** Wix Nano. */
5297
+ NANO = "NANO",
5298
+ /** Base44 headless sites. */
5299
+ BASE44 = "BASE44",
5300
+ /** Wix Channels Sites */
5301
+ CHANNELS = "CHANNELS",
5302
+ /** Nautilus platform. */
5303
+ NAUTILUS = "NAUTILUS",
5035
5304
  /**
5036
- * Line item ID the refunded line item.
5037
- * @format GUID
5305
+ * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
5306
+ * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
5038
5307
  */
5039
- lineItemId?: string;
5308
+ SYMPHONY = "SYMPHONY",
5309
+ /** Nautilus platform app. */
5310
+ NAUTILUS_APPS = "NAUTILUS_APPS",
5040
5311
  /**
5041
- * Line item quantity refunded.
5042
- * @min 1
5043
- * @max 100000
5312
+ * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
5313
+ * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
5044
5314
  */
5045
- quantity?: number;
5046
- }
5047
- interface LineItemRefund {
5315
+ VIBU = "VIBU",
5048
5316
  /**
5049
- * Line item ID.
5050
- * @format GUID
5051
- * @immutable
5317
+ * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
5318
+ * (an Enterprise account may have several), holding that BrandKit's brand definition
5319
+ * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
5320
+ * MetaSites with this namespace will *not* be shown in a user's site list by default.
5052
5321
  */
5053
- lineItemId?: string;
5322
+ ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
5054
5323
  /**
5055
- * Refund quantity.
5056
- * @min 1
5057
- * @max 100000
5058
- * @immutable
5324
+ * Dev-center development sites (com.wixpress.devcenter.dsm).
5325
+ * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
5059
5326
  */
5060
- quantity?: number;
5327
+ DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
5061
5328
  }
5062
- interface AdditionalFeeRefund {
5329
+ /** @enumType */
5330
+ 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';
5331
+ /** Site transferred to another user. */
5332
+ interface SiteTransferred {
5063
5333
  /**
5064
- * Additional fee ID.
5334
+ * A previous owner id (user that transfers meta site).
5065
5335
  * @format GUID
5066
- * @immutable
5067
- */
5068
- additionalFeeId?: string;
5069
- /**
5070
- * Refund amount.
5071
- * @immutable
5072
5336
  */
5073
- amount?: Price;
5074
- }
5075
- interface ShippingRefund {
5337
+ oldOwnerId?: string;
5076
5338
  /**
5077
- * Refund amount.
5078
- * @immutable
5339
+ * A new owner id (user that accepts meta site).
5340
+ * @format GUID
5079
5341
  */
5080
- amount?: Price;
5342
+ newOwnerId?: string;
5081
5343
  }
5082
- interface RefundSideEffects {
5083
- /** Inventory restock details as part of this refund. */
5084
- restockInfo?: RestockInfo;
5085
- /** Whether to send a refund confirmation email to the customer. */
5086
- sendOrderRefundedEmail?: boolean;
5087
- /**
5088
- * Custom message added to the refund confirmation email.
5089
- * @minLength 1
5090
- * @maxLength 1000
5091
- */
5092
- customMessage?: string | null;
5344
+ /** Soft deletion of the meta site. Could be restored. */
5345
+ interface SiteDeleted {
5346
+ /** A deletion context. */
5347
+ deleteContext?: DeleteContext;
5093
5348
  }
5094
- interface RestockInfo {
5095
- /** Restock type. */
5096
- type?: RestockTypeWithLiterals;
5349
+ interface DeleteContext {
5350
+ /** When the meta site was deleted. */
5351
+ dateDeleted?: Date | null;
5352
+ /** A status. */
5353
+ deleteStatus?: DeleteStatusWithLiterals;
5097
5354
  /**
5098
- * Deprecated, use items instead
5099
- * @internal
5100
- * @maxSize 300
5101
- * @deprecated
5355
+ * A reason (flow).
5356
+ * @maxLength 255
5102
5357
  */
5103
- lineItemIds?: string[];
5358
+ deleteOrigin?: string;
5104
5359
  /**
5105
- * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
5106
- * @maxSize 300
5360
+ * A service that deleted it.
5361
+ * @maxLength 255
5107
5362
  */
5108
- items?: RestockItem[];
5363
+ initiatorId?: string | null;
5109
5364
  }
5110
- declare enum RestockType {
5111
- NO_ITEMS = "NO_ITEMS",
5112
- ALL_ITEMS = "ALL_ITEMS",
5113
- SOME_ITEMS = "SOME_ITEMS"
5365
+ declare enum DeleteStatus {
5366
+ UNKNOWN = "UNKNOWN",
5367
+ TRASH = "TRASH",
5368
+ DELETED = "DELETED",
5369
+ PENDING_PURGE = "PENDING_PURGE",
5370
+ PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
5114
5371
  }
5115
5372
  /** @enumType */
5116
- type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
5117
- interface RestockItem {
5118
- /**
5119
- * ID of the line item being restocked.
5120
- * @format GUID
5121
- */
5122
- lineItemId?: string;
5123
- /**
5124
- * Line item quantity being restocked.
5125
- * @min 1
5126
- * @max 100000
5127
- */
5128
- quantity?: number;
5129
- /**
5130
- * Per-location breakdown of restock quantities.
5131
- * @internal
5132
- * @maxSize 5
5133
- */
5134
- restockLocations?: RestockLocation[];
5373
+ type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
5374
+ /** Restoration of the meta site. */
5375
+ interface SiteUndeleted {
5135
5376
  }
5136
- interface TriggerRefundResponse {
5137
- /** All order's transactions after the refunds were added */
5138
- orderTransactions?: OrderTransactions;
5139
- /** Created refund ID */
5140
- refundId?: string | null;
5141
- /** Payment ID's that the refund execution had failed for */
5142
- failedPaymentIds?: ItemMetadata[];
5377
+ /** First publish of a meta site. Or subsequent publish after unpublish. */
5378
+ interface SitePublished {
5143
5379
  }
5144
- /**
5145
- * A record of all payments and refunds associated with an order.
5146
- *
5147
- * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
5148
- */
5149
- interface OrderTransactions {
5150
- /**
5151
- * Order ID.
5152
- * @format GUID
5153
- */
5154
- orderId?: string;
5155
- /**
5156
- * Record of payments made to the merchant.
5157
- * @maxSize 100
5158
- */
5159
- payments?: Payment[];
5380
+ interface SiteUnpublished {
5160
5381
  /**
5161
- * Record of refunds made to the buyer.
5162
- * @maxSize 300
5382
+ * A list of URLs previously associated with the meta site.
5383
+ * @maxLength 4000
5384
+ * @maxSize 10000
5163
5385
  */
5164
- refunds?: Refund[];
5386
+ urls?: string[];
5165
5387
  }
5166
- interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
5167
- /** Regular payment details. */
5168
- regularPaymentDetails?: RegularPaymentDetails;
5169
- /** Gift card payment details. */
5170
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5171
- /** Membership payment details. */
5172
- membershipPaymentDetails?: MembershipPaymentDetails;
5388
+ interface SiteMarkedAsTemplate {
5389
+ }
5390
+ interface SiteMarkedAsWixSite {
5391
+ }
5392
+ /**
5393
+ * Represents a service provisioned a site.
5394
+ *
5395
+ * Note on `origin_instance_id`:
5396
+ * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
5397
+ * This is because of the following scenario:
5398
+ *
5399
+ * Imagine you have a template where a third-party application (TPA) includes some stub data,
5400
+ * such as a product catalog. When you create a site from this template, you inherit this
5401
+ * default product catalog. However, if the template's product catalog is modified,
5402
+ * your site will retain the catalog as it was at the time of site creation. This ensures that
5403
+ * your site remains consistent with what you initially received and does not include any
5404
+ * changes made to the original template afterward.
5405
+ * To ensure this, the TPA on the template gets a new instance_id.
5406
+ */
5407
+ interface ServiceProvisioned {
5173
5408
  /**
5174
- * Receipt created by Wix
5175
- * @internal
5409
+ * Either UUID or EmbeddedServiceType.
5410
+ * @maxLength 36
5176
5411
  */
5177
- wixReceipt?: WixReceiptInfo;
5412
+ appDefId?: string;
5178
5413
  /**
5179
- * Receipt created by an external system.
5180
- * @internal
5414
+ * Not only UUID. Something here could be something weird.
5415
+ * @maxLength 36
5181
5416
  */
5182
- externalReceipt?: ExternalReceiptInfo;
5183
- /** @internal */
5184
- canceled?: CanceledStatusDetails;
5185
- /** @internal */
5186
- declined?: DeclinedStatusDetails;
5187
- /** @internal */
5188
- voided?: VoidedStatusDetails;
5417
+ instanceId?: string;
5189
5418
  /**
5190
- * Payment ID.
5191
- * @format GUID
5192
- * @readonly
5419
+ * An instance id from which this instance is originated.
5420
+ * @maxLength 36
5193
5421
  */
5194
- _id?: string | null;
5195
- /** 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. */
5196
- _createdDate?: Date | null;
5422
+ originInstanceId?: string;
5197
5423
  /**
5198
- * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5199
- * @readonly
5424
+ * A version.
5425
+ * @maxLength 500
5200
5426
  */
5201
- _updatedDate?: Date | null;
5202
- /** Payment amount. */
5203
- amount?: Price;
5427
+ version?: string | null;
5204
5428
  /**
5205
- * Whether refunds for this payment are disabled.
5206
- * + `true`: This payment is not refundable.
5207
- * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5429
+ * The origin meta site id
5430
+ * @format GUID
5208
5431
  */
5209
- refundDisabled?: boolean;
5432
+ originMetaSiteId?: string | null;
5433
+ }
5434
+ interface ServiceRemoved {
5210
5435
  /**
5211
- * Whether receipt generation is allowed for this payment.
5212
- * + `true`: This payment supports receipt generation.
5213
- * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
5214
- * @readonly
5436
+ * Either UUID or EmbeddedServiceType.
5437
+ * @maxLength 36
5215
5438
  */
5216
- supportReceiptGeneration?: boolean;
5217
- /** Details about cash rounding applied to this payment, when relevant. */
5218
- cashRounding?: CashRoundingDetails;
5439
+ appDefId?: string;
5219
5440
  /**
5220
- * Overall payment status.
5221
- *
5222
- * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5441
+ * Not only UUID. Something here could be something weird.
5442
+ * @maxLength 36
5223
5443
  */
5224
- status?: PaymentStatusWithLiterals;
5444
+ instanceId?: string;
5225
5445
  /**
5226
- * Detailed payment status information including gateway reason codes and status-specific details.
5227
- * @internal
5446
+ * A version.
5447
+ * @maxLength 500
5228
5448
  */
5229
- paymentStatusDetails?: PaymentStatusDetails;
5449
+ version?: string | null;
5450
+ }
5451
+ /** Rename of the site. Meaning, free public url has been changed as well. */
5452
+ interface SiteRenamed {
5230
5453
  /**
5231
- * Location where the payment was processed.
5232
- * @internal
5233
- * @format GUID
5234
- * @immutable
5454
+ * A new meta site name (URL slug).
5455
+ * @maxLength 20
5235
5456
  */
5236
- locationId?: string | null;
5457
+ newSiteName?: string;
5237
5458
  /**
5238
- * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
5239
- * @format GUID
5459
+ * A previous meta site name (URL slug).
5460
+ * @maxLength 255
5240
5461
  */
5241
- chargeCorrelationId?: string | null;
5462
+ oldSiteName?: string;
5242
5463
  }
5243
- /** @oneof */
5244
- interface PaymentPaymentDetailsOneOf {
5245
- /** Regular payment details. */
5246
- regularPaymentDetails?: RegularPaymentDetails;
5247
- /** Gift card payment details. */
5248
- giftcardPaymentDetails?: GiftCardPaymentDetails;
5249
- /** Membership payment details. */
5250
- membershipPaymentDetails?: MembershipPaymentDetails;
5464
+ /**
5465
+ * Hard deletion of the meta site.
5466
+ *
5467
+ * Could not be restored. Therefore it's desirable to cleanup data.
5468
+ */
5469
+ interface SiteHardDeleted {
5470
+ /** A deletion context. */
5471
+ deleteContext?: DeleteContext;
5251
5472
  }
5252
- /** @oneof */
5253
- interface PaymentReceiptInfoOneOf {
5254
- /**
5255
- * Receipt created by Wix
5256
- * @internal
5257
- */
5258
- wixReceipt?: WixReceiptInfo;
5473
+ interface NamespaceChanged {
5474
+ /** A previous namespace. */
5475
+ oldNamespace?: NamespaceWithLiterals;
5476
+ /** A new namespace. */
5477
+ newNamespace?: NamespaceWithLiterals;
5478
+ }
5479
+ /** Assigned Studio editor */
5480
+ interface StudioAssigned {
5481
+ }
5482
+ /** Unassigned Studio editor */
5483
+ interface StudioUnassigned {
5484
+ }
5485
+ /**
5486
+ * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
5487
+ *
5488
+ * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
5489
+ * with sites and its urls, you need to listen to another topic/event. Read about it:
5490
+ *
5491
+ * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
5492
+ */
5493
+ interface SiteUrlChanged {
5494
+ }
5495
+ /**
5496
+ * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
5497
+ * Consumed by other teams to remove relevant data.
5498
+ */
5499
+ interface SitePurgedExternally {
5259
5500
  /**
5260
- * Receipt created by an external system.
5261
- * @internal
5501
+ * @maxLength 2048
5502
+ * @maxSize 100
5503
+ * @deprecated
5504
+ * @targetRemovalDate 2025-04-15
5262
5505
  */
5263
- externalReceipt?: ExternalReceiptInfo;
5506
+ appDefId?: string[];
5264
5507
  }
5265
- /** @oneof */
5266
- interface PaymentStatusDetailsOneOf {
5267
- /** @internal */
5268
- canceled?: CanceledStatusDetails;
5269
- /** @internal */
5270
- declined?: DeclinedStatusDetails;
5271
- /** @internal */
5272
- voided?: VoidedStatusDetails;
5508
+ /** Assigned Odeditor */
5509
+ interface OdeditorAssigned {
5273
5510
  }
5274
- interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
5275
- /** Credit card details. */
5276
- creditCardDetails?: CreditCardPaymentMethodDetails;
5511
+ /** Unassigned Odeditor */
5512
+ interface OdeditorUnassigned {
5513
+ }
5514
+ /** Assigned Picasso editor */
5515
+ interface PicassoAssigned {
5516
+ }
5517
+ /** Unassigned Picasso */
5518
+ interface PicassoUnassigned {
5519
+ }
5520
+ /** Assigned Wixel */
5521
+ interface WixelAssigned {
5522
+ }
5523
+ /** Unassigned Wixel */
5524
+ interface WixelUnassigned {
5525
+ }
5526
+ /** Assigned StudioTwo */
5527
+ interface StudioTwoAssigned {
5528
+ }
5529
+ /** Unassigned StudioTwo */
5530
+ interface StudioTwoUnassigned {
5531
+ }
5532
+ /** Media from user domain is enabled. */
5533
+ interface UserDomainMediaEnabled {
5534
+ }
5535
+ /** Media from user domain is disabled. */
5536
+ interface UserDomainMediaDisabled {
5537
+ }
5538
+ /** Assigned Editorless */
5539
+ interface EditorlessAssigned {
5540
+ }
5541
+ /** Unassigned Editorless */
5542
+ interface EditorlessUnassigned {
5543
+ }
5544
+ interface HasCustomEmailConfigurationsRequest {
5545
+ }
5546
+ interface HasCustomEmailConfigurationsResponse {
5547
+ hasCustomConfigurations?: boolean;
5548
+ }
5549
+ interface AddToAutomationMigrationPopulationRequest {
5550
+ /** When true, sends custom email configurations to automation system via email */
5551
+ sendCustomEmailConfigs?: boolean;
5552
+ /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
5553
+ origin?: OriginWithLiterals;
5554
+ }
5555
+ declare enum Origin {
5556
+ OPT_IN = "OPT_IN",
5557
+ MIGRATION = "MIGRATION"
5558
+ }
5559
+ /** @enumType */
5560
+ type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
5561
+ interface AddToAutomationMigrationPopulationResponse {
5562
+ success?: boolean;
5563
+ }
5564
+ interface IsInAutomationMigrationPopulationRequest {
5565
+ }
5566
+ interface IsInAutomationMigrationPopulationResponse {
5567
+ inPopulation?: boolean;
5568
+ }
5569
+ interface PreparePaymentCollectionRequest {
5277
5570
  /**
5278
- * Wix Payments order ID.
5571
+ * Ecom order ID.
5572
+ * @minLength 1
5279
5573
  * @maxLength 100
5280
5574
  */
5281
- paymentOrderId?: string | null;
5575
+ ecomOrderId: string;
5576
+ /** Amount to collect */
5577
+ amount: Price;
5282
5578
  /**
5283
- * Payment gateway's transaction ID.
5284
- * This field is only returned when the value of `offline_payment` is `false`.
5285
- * @maxLength 100
5579
+ * Optional parameter. When present, payment collection will be performed using given payment gateway order.
5580
+ * Existing payment gateway order will be updated with a new amount.
5581
+ * When parameter is absent, new payment gateway order will be created and used for payment collection.
5286
5582
  */
5287
- gatewayTransactionId?: string | null;
5583
+ paymentGatewayOrderId?: string | null;
5288
5584
  /**
5289
- * Payment method.
5290
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5291
- * Non-exhaustive list of supported values:
5292
- * + `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`
5293
- * @maxLength 150
5294
- * @deprecated Payment method.
5295
- * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
5296
- * Non-exhaustive list of supported values:
5297
- * + `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`
5298
- * @replacedBy payment_method_name
5299
- * @targetRemovalDate 2026-07-01
5585
+ * Whether to delay capture of the payment.
5586
+ * Default: false
5587
+ * @deprecated Whether to delay capture of the payment.
5588
+ * Default: false
5589
+ * @replacedBy delayed_capture_settings.scheduled_action
5590
+ * @targetRemovalDate 2024-09-30
5300
5591
  */
5301
- paymentMethod?: string | null;
5592
+ delayedCapture?: boolean;
5302
5593
  /**
5303
- * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
5304
- * @maxLength 100
5594
+ * Specifies whether payment collection is initiated by Merchant or User of User
5595
+ * Default: `true`
5596
+ * @internal
5305
5597
  */
5306
- providerTransactionId?: string | null;
5307
- /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
5308
- offlinePayment?: boolean;
5598
+ merchantInitiated?: boolean | null;
5309
5599
  /**
5310
- * Payment status.
5311
- * @deprecated Payment status.
5312
- * @replacedBy payment.status
5313
- * @targetRemovalDate 2026-11-01
5600
+ * Redirect urls which are used to return buyer to third party system.
5601
+ * @internal
5314
5602
  */
5315
- status?: TransactionStatusWithLiterals;
5316
- /** Whether there is a payment agreement that allows for future charges. */
5317
- savedPaymentMethod?: boolean;
5318
- /** Authorization details. */
5319
- authorizationDetails?: AuthorizationDetails;
5603
+ redirectUrls?: RedirectUrls;
5604
+ /** Delayed capture payment settings */
5605
+ delayedCaptureSettings?: DelayedCaptureSettings;
5606
+ }
5607
+ interface RedirectUrls {
5320
5608
  /**
5321
- * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
5322
- * @internal
5323
- * @maxLength 300
5609
+ * URL to redirect buyer in case of approved (successful) transaction
5610
+ * @format WEB_URL
5324
5611
  */
5325
- paymentProvider?: string | null;
5612
+ successUrl?: string | null;
5326
5613
  /**
5327
- * Record of chargebacks made by the buyer.
5328
- * @maxSize 6
5614
+ * URL to redirect buyer in case of buyer canceled the transaction
5615
+ * @format WEB_URL
5329
5616
  */
5330
- chargebacks?: Chargeback[];
5617
+ cancelUrl?: string | null;
5331
5618
  /**
5332
- * Payment method ID.
5333
- * @internal
5334
- * @maxLength 36
5619
+ * URL to redirect buyer in case of failed/rejected transaction
5620
+ * @format WEB_URL
5335
5621
  */
5336
- paymentMethodId?: string | null;
5337
- /** Platform fee amount associated with this payment. */
5338
- platformFee?: Price;
5622
+ errorUrl?: string | null;
5339
5623
  /**
5340
- * Payment method with buyer and optional owner translations.
5341
- * Non-exhaustive list of supported values:
5342
- * + `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`
5624
+ * URL to redirect buyer in case of pending transaction (that might take some time to process)
5625
+ * @format WEB_URL
5343
5626
  */
5344
- paymentMethodName?: PaymentMethodName;
5627
+ pendingUrl?: string | null;
5345
5628
  }
5346
- /** @oneof */
5347
- interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
5348
- /** Credit card details. */
5349
- creditCardDetails?: CreditCardPaymentMethodDetails;
5629
+ interface DelayedCaptureSettings {
5630
+ /** Specifies the automatic action (void/capture) for authorized transaction after the specified duration */
5631
+ scheduledAction?: ScheduledActionWithLiterals;
5632
+ /** Delay duration before execution. Optional - if not set, providers default period will be used */
5633
+ delayDuration?: Duration;
5350
5634
  }
5351
- declare enum TransactionStatus {
5352
- UNDEFINED = "UNDEFINED",
5353
- APPROVED = "APPROVED",
5354
- PENDING = "PENDING",
5355
- PENDING_MERCHANT = "PENDING_MERCHANT",
5356
- CANCELED = "CANCELED",
5357
- DECLINED = "DECLINED",
5358
- REFUNDED = "REFUNDED",
5359
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5360
- AUTHORIZED = "AUTHORIZED",
5361
- VOIDED = "VOIDED"
5635
+ declare enum ScheduledAction {
5636
+ /** Whether payment will be auto-voided when duration passes */
5637
+ VOID = "VOID",
5638
+ /** Whether payment will be auto-captured when duration passes */
5639
+ CAPTURE = "CAPTURE"
5362
5640
  }
5363
5641
  /** @enumType */
5364
- type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5365
- interface CreditCardPaymentMethodDetails {
5642
+ type ScheduledActionWithLiterals = ScheduledAction | 'VOID' | 'CAPTURE';
5643
+ interface Duration {
5366
5644
  /**
5367
- * The last 4 digits of the card number.
5368
- * @maxLength 4
5645
+ * Amount of units. For example, 30 MINUTES, 1 HOURS, 7 DAYS, etc
5646
+ * @min 1
5369
5647
  */
5370
- lastFourDigits?: string | null;
5648
+ count?: number;
5649
+ /** Duration unit: MINUTES, HOURS and DAYS */
5650
+ unit?: DurationUnitWithLiterals;
5651
+ }
5652
+ declare enum DurationUnit {
5653
+ MINUTES = "MINUTES",
5654
+ HOURS = "HOURS",
5655
+ DAYS = "DAYS"
5656
+ }
5657
+ /** @enumType */
5658
+ type DurationUnitWithLiterals = DurationUnit | 'MINUTES' | 'HOURS' | 'DAYS';
5659
+ interface PreparePaymentCollectionResponse {
5660
+ /** Payment gateway order id which is associated with given payment */
5661
+ paymentGatewayOrderId?: string;
5662
+ }
5663
+ interface GetPaymentCollectabilityStatusRequest {
5371
5664
  /**
5372
- * Card issuer's brand.
5665
+ * Ecom order ID.
5666
+ * @minLength 1
5373
5667
  * @maxLength 100
5374
5668
  */
5375
- brand?: string | null;
5669
+ ecomOrderId: string;
5376
5670
  }
5377
- interface AuthorizationDetails {
5671
+ interface GetPaymentCollectabilityStatusResponse {
5672
+ /** Payment collectability status */
5673
+ status?: PaymentCollectabilityStatusWithLiterals;
5674
+ /** Collectable order amount */
5675
+ amount?: Price;
5378
5676
  /**
5379
- * Whether the authorized payment is of a delayed capture.
5380
- * @readonly
5677
+ * Whether authorization supported
5678
+ * @internal
5381
5679
  */
5382
- delayedCapture?: boolean;
5383
- /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5384
- authorizedDate?: Date | null;
5680
+ authorizationSupported?: boolean;
5385
5681
  /**
5386
- * List of captures associated with payment
5387
- * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
5388
- * @maxSize 1
5682
+ * Whether custom amount is supported for payment collection
5683
+ * @internal
5389
5684
  */
5390
- captures?: AuthorizationCapture[];
5391
- /** Void associated with payment */
5392
- void?: AuthorizationVoid;
5393
- /** Scheduled action for this transaction */
5394
- scheduledAction?: V1ScheduledAction;
5685
+ customAmountSupported?: boolean;
5395
5686
  }
5396
- interface AuthorizationCapture {
5687
+ declare enum PaymentCollectabilityStatus {
5688
+ UNKNOWN = "UNKNOWN",
5689
+ COLLECTABLE = "COLLECTABLE",
5690
+ NONCOLLECTABLE_ORDER_IS_CANCELLED = "NONCOLLECTABLE_ORDER_IS_CANCELLED",
5691
+ NONCOLLECTABLE_ORDER_IS_PAID = "NONCOLLECTABLE_ORDER_IS_PAID",
5692
+ NONCOLLECTABLE_MISSING_PAYMENT_METHOD = "NONCOLLECTABLE_MISSING_PAYMENT_METHOD",
5693
+ NONCOLLECTABLE_ORDER_IS_PENDING = "NONCOLLECTABLE_ORDER_IS_PENDING",
5694
+ NONCOLLECTABLE_ORDER_IS_REJECTED = "NONCOLLECTABLE_ORDER_IS_REJECTED",
5695
+ NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS = "NONCOLLECTABLE_ORDER_HAS_SUBSCRIPTIONS",
5696
+ NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS = "NONCOLLECTABLE_ORDER_HAS_CHARGEBACKS",
5697
+ NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED = "NONCOLLECTABLE_SUBSCRIPTION_CYCLE_ALREADY_PASSED",
5698
+ NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION = "NONCOLLECTABLE_ORDER_HAS_UNSUPPORTED_SUBSCRIPTION",
5699
+ NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED = "NONCOLLECTABLE_CUSTOM_AMOUNT_NOT_SUPPORTED",
5700
+ NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST = "NONCOLLECTABLE_SUBSCRIPTION_START_DATE_IN_PAST"
5701
+ }
5702
+ /** @enumType */
5703
+ 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';
5704
+ interface RecordManuallyCollectedPaymentRequest {
5397
5705
  /**
5398
- * Capture ID.
5399
- * @format GUID
5400
- * @readonly
5706
+ * Order ID.
5707
+ * @minLength 1
5708
+ * @maxLength 100
5401
5709
  */
5402
- _id?: string | null;
5403
- /** Status of this capture action */
5404
- status?: AuthorizationCaptureStatusWithLiterals;
5710
+ orderId: string;
5711
+ /** Amount to be recorded as approved manual payment for given order */
5712
+ amount: Price;
5405
5713
  /**
5406
- * Amount of this capture
5407
- * @immutable
5714
+ * Payment method name provided by user.
5715
+ *
5716
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5717
+ * @internal
5408
5718
  */
5409
- amount?: Price;
5410
- /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5411
- _createdDate?: Date | null;
5412
- /** In case of status is FAILED may contain failure details */
5413
- failureDetails?: AuthorizationActionFailureDetails;
5414
- }
5415
- declare enum AuthorizationCaptureStatus {
5416
- /** Capture operation still in progress. */
5417
- PENDING = "PENDING",
5418
- /** Capture operation succeeded. */
5419
- SUCCEEDED = "SUCCEEDED",
5420
- /** Capture operation failed. */
5421
- FAILED = "FAILED"
5422
- }
5423
- /** @enumType */
5424
- type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5425
- interface AuthorizationActionFailureDetails {
5426
- /** @maxLength 100 */
5427
- failureCode?: string;
5719
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5428
5720
  }
5429
- interface AuthorizationVoid {
5430
- /** Status of this void action */
5431
- status?: AuthorizationVoidStatusWithLiterals;
5432
- /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
5433
- voidedDate?: Date | null;
5434
- /** In case of status is FAILED may contain failure details */
5435
- failureDetails?: AuthorizationActionFailureDetails;
5436
- /** Reason of void action */
5437
- reason?: ReasonWithLiterals;
5721
+ /**
5722
+ * User-defined payment method name.
5723
+ * Allows specifying either a predefined type or a custom name.
5724
+ */
5725
+ interface UserDefinedPaymentMethodName extends UserDefinedPaymentMethodNameKindOneOf {
5726
+ /** Predefined payment method. */
5727
+ predefined?: PredefinedPaymentMethodWithLiterals;
5728
+ /**
5729
+ * Custom payment method name provided by user.
5730
+ *
5731
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5732
+ * @minLength 1
5733
+ * @maxLength 150
5734
+ */
5735
+ custom?: string | null;
5438
5736
  }
5439
- declare enum AuthorizationVoidStatus {
5440
- /** Void operation still in progress. */
5441
- PENDING = "PENDING",
5442
- /** Void operation succeeded. */
5443
- SUCCEEDED = "SUCCEEDED",
5444
- /** Void operation failed. */
5445
- FAILED = "FAILED"
5737
+ /** @oneof */
5738
+ interface UserDefinedPaymentMethodNameKindOneOf {
5739
+ /** Predefined payment method. */
5740
+ predefined?: PredefinedPaymentMethodWithLiterals;
5741
+ /**
5742
+ * Custom payment method name provided by user.
5743
+ *
5744
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5745
+ * @minLength 1
5746
+ * @maxLength 150
5747
+ */
5748
+ custom?: string | null;
5446
5749
  }
5447
- /** @enumType */
5448
- type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
5449
- /** Reason the authorization was voided. */
5450
- declare enum Reason {
5451
- /** Authorization was voided by user. */
5452
- MANUAL = "MANUAL",
5453
- /** Authorization passed execution date. */
5454
- SCHEDULED = "SCHEDULED"
5750
+ /** Predefined payment method types for offline/manual payments. */
5751
+ declare enum PredefinedPaymentMethod {
5752
+ /** Cash payment. */
5753
+ CASH = "CASH",
5754
+ /** Bank transfer. */
5755
+ BANK_TRANSFER = "BANK_TRANSFER",
5756
+ /** Payment by check. */
5757
+ CHECK = "CHECK"
5455
5758
  }
5456
5759
  /** @enumType */
5457
- type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
5458
- interface V1ScheduledAction {
5459
- /** Type of the action. */
5460
- actionType?: ActionTypeWithLiterals;
5461
- /** The date and time of the action. */
5462
- executionDate?: Date | null;
5463
- }
5464
- declare enum ActionType {
5465
- VOID = "VOID",
5466
- CAPTURE = "CAPTURE"
5760
+ type PredefinedPaymentMethodWithLiterals = PredefinedPaymentMethod | 'CASH' | 'BANK_TRANSFER' | 'CHECK';
5761
+ interface RecordManuallyCollectedPaymentResponse {
5467
5762
  }
5468
- /** @enumType */
5469
- type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
5470
- interface Chargeback {
5471
- /**
5472
- * Chargeback ID.
5473
- * @format GUID
5474
- * @readonly
5475
- * @immutable
5476
- */
5477
- _id?: string;
5763
+ interface MarkOrderAsPaidRequest {
5478
5764
  /**
5479
- * 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.
5480
- * @readonly
5481
- * @immutable
5765
+ * Ecom order ID.
5766
+ * @minLength 1
5767
+ * @maxLength 100
5482
5768
  */
5483
- _createdDate?: Date | null;
5769
+ ecomOrderId: string;
5484
5770
  /**
5485
- * 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.
5486
- * @readonly
5771
+ * Payment method name provided by user.
5772
+ *
5773
+ * For example, `"Wire transfer"`, `"Money order"`, `"Venmo"` or any other custom name.
5774
+ * @internal
5487
5775
  */
5488
- _updatedDate?: Date | null;
5776
+ userDefinedPaymentMethodName?: UserDefinedPaymentMethodName;
5777
+ }
5778
+ interface MarkOrderAsPaidResponse {
5779
+ /** Updated order. */
5780
+ order?: Order;
5781
+ }
5782
+ interface BulkMarkOrdersAsPaidRequest {
5489
5783
  /**
5490
- * Amount.
5491
- * @readonly
5492
- * @immutable
5784
+ * IDs of orders to mark as paid.
5785
+ * @minSize 1
5786
+ * @maxSize 100
5787
+ * @minLength 1
5788
+ * @maxLength 100
5493
5789
  */
5494
- amount?: Price;
5790
+ ecomOrderIds: string[];
5791
+ }
5792
+ interface BulkMarkOrdersAsPaidResponse {
5495
5793
  /**
5496
- * Reversal amount. Present only when status is REVERSED.
5497
- * @readonly
5794
+ * Items updated by the bulk action.
5795
+ * The Order entity within the results optimistically changes its payment status to paid, however this process is async.
5498
5796
  */
5499
- reversalAmount?: Price;
5797
+ results?: BulkOrderResult[];
5798
+ /** Bulk action metadata. */
5799
+ bulkActionMetadata?: BulkActionMetadata;
5800
+ }
5801
+ interface BulkOrderResult {
5802
+ /** Item metadata. */
5803
+ itemMetadata?: ItemMetadata;
5500
5804
  /**
5501
- * Status.
5805
+ * Updated order.
5502
5806
  *
5503
- * Default: `"APPROVED"`.
5504
- */
5505
- status?: ChargebackStatusWithLiterals;
5506
- /**
5507
- * External chargeback ID.
5508
- * @format GUID
5509
- * @readonly
5510
- * @immutable
5807
+ * Returned when `returnFullEntity = true`.
5511
5808
  */
5512
- externalId?: string | null;
5809
+ item?: Order;
5513
5810
  }
5514
- declare enum ChargebackStatus {
5515
- /** Chargeback was approved. */
5516
- APPROVED = "APPROVED",
5517
- /** Chargeback was reversed. */
5518
- REVERSED = "REVERSED"
5811
+ interface ItemMetadata {
5812
+ /** Item ID. Should always be available, unless it's impossible (for example, when failing to create an item). */
5813
+ _id?: string | null;
5814
+ /** Index of the item within the request array. Allows for correlation between request and response items. */
5815
+ originalIndex?: number;
5816
+ /** Whether the requested action was successful for this item. When `false`, the `error` field is populated. */
5817
+ success?: boolean;
5818
+ /** Details about the error in case of failure. */
5819
+ error?: ApplicationError;
5519
5820
  }
5520
- /** @enumType */
5521
- type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
5522
- interface PaymentMethodName {
5821
+ interface ApplicationError {
5822
+ /** Error code. */
5823
+ code?: string;
5824
+ /** Description of the error. */
5825
+ description?: string;
5826
+ /** Data related to the error. */
5827
+ data?: Record<string, any> | null;
5828
+ }
5829
+ interface BulkActionMetadata {
5830
+ /** Number of items that were successfully processed. */
5831
+ totalSuccesses?: number;
5832
+ /** Number of items that couldn't be processed. */
5833
+ totalFailures?: number;
5834
+ /** Number of failures without details because detailed failure threshold was exceeded. */
5835
+ undetailedFailures?: number;
5836
+ }
5837
+ interface GetRefundabilityStatusRequest {
5523
5838
  /**
5524
- * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
5525
- * @maxLength 150
5839
+ * Order ID.
5840
+ * @minLength 1
5841
+ * @maxLength 100
5526
5842
  */
5527
- buyerLanguageName?: string | null;
5843
+ ecomOrderId: string;
5844
+ }
5845
+ interface GetRefundabilityStatusResponse {
5528
5846
  /**
5529
- * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
5530
- *
5531
- * When no site-language name is stored, holds the same value as `buyerLanguageName`.
5532
- * @maxLength 150
5847
+ * Refundability details.
5848
+ * @maxSize 300
5533
5849
  */
5534
- siteLanguageName?: string | null;
5850
+ refundabilities?: Refundability[];
5535
5851
  /**
5536
- * User-provided payment method name.
5537
- *
5538
- * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
5852
+ * Whether the order supports refunding per item.
5853
+ * @deprecated
5539
5854
  */
5540
- userDefinedName?: UserDefinedPaymentMethodName;
5855
+ refundablePerItem?: boolean;
5541
5856
  }
5542
- interface GiftCardPaymentDetails {
5857
+ interface Refundability extends RefundabilityAdditionalRefundabilityInfoOneOf {
5858
+ /** Reason why payment is not refundable. */
5859
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5860
+ /** Reason why payment is only refundable manually. */
5861
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5862
+ /** Payment ID. */
5863
+ paymentId?: string;
5864
+ /** Payment refundability status. */
5865
+ refundabilityStatus?: RefundableStatusWithLiterals;
5866
+ /** Link to payment provider dashboard. */
5867
+ providerLink?: string | null;
5868
+ }
5869
+ /** @oneof */
5870
+ interface RefundabilityAdditionalRefundabilityInfoOneOf {
5871
+ /** Reason why payment is not refundable. */
5872
+ nonRefundableReason?: NonRefundableReasonWithLiterals;
5873
+ /** Reason why payment is only refundable manually. */
5874
+ manuallyRefundableReason?: ManuallyRefundableReasonWithLiterals;
5875
+ }
5876
+ declare enum RefundableStatus {
5877
+ NOT_REFUNDABLE = "NOT_REFUNDABLE",
5878
+ MANUAL = "MANUAL",
5879
+ REFUNDABLE = "REFUNDABLE"
5880
+ }
5881
+ /** @enumType */
5882
+ type RefundableStatusWithLiterals = RefundableStatus | 'NOT_REFUNDABLE' | 'MANUAL' | 'REFUNDABLE';
5883
+ declare enum NonRefundableReason {
5884
+ NONE = "NONE",
5885
+ ALREADY_REFUNDED = "ALREADY_REFUNDED",
5886
+ PROVIDER_IS_DOWN = "PROVIDER_IS_DOWN",
5887
+ INTERNAL_ERROR = "INTERNAL_ERROR",
5888
+ NOT_PAID = "NOT_PAID",
5889
+ ACCESS_DENIED = "ACCESS_DENIED",
5890
+ ZERO_PRICE = "ZERO_PRICE",
5891
+ DISABLED_BY_PROVIDER = "DISABLED_BY_PROVIDER",
5892
+ PENDING_REFUND = "PENDING_REFUND",
5893
+ FORBIDDEN = "FORBIDDEN",
5894
+ TRANSACTION_NOT_FOUND = "TRANSACTION_NOT_FOUND",
5895
+ ORDER_IS_PENDING = "ORDER_IS_PENDING",
5896
+ ORDER_IS_REJECTED = "ORDER_IS_REJECTED"
5897
+ }
5898
+ /** @enumType */
5899
+ 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';
5900
+ declare enum ManuallyRefundableReason {
5901
+ EXPIRED = "EXPIRED",
5902
+ NOT_SUPPORTED = "NOT_SUPPORTED",
5903
+ OFFLINE = "OFFLINE",
5904
+ REQUIRES_CARD_READER = "REQUIRES_CARD_READER"
5905
+ }
5906
+ /** @enumType */
5907
+ type ManuallyRefundableReasonWithLiterals = ManuallyRefundableReason | 'EXPIRED' | 'NOT_SUPPORTED' | 'OFFLINE' | 'REQUIRES_CARD_READER';
5908
+ interface CreatePaymentGatewayOrderRequest {
5543
5909
  /**
5544
- * Gift card payment ID.
5910
+ * Ecom order ID.
5911
+ * @minLength 1
5545
5912
  * @maxLength 100
5546
5913
  */
5547
- giftCardPaymentId?: string;
5914
+ ecomOrderId: string;
5915
+ /** Information about the user who initiated the payment. */
5916
+ chargedBy?: ChargedBy;
5548
5917
  /**
5549
- * Gift card ID.
5918
+ * Whether to delay capture of the payment.
5919
+ *
5920
+ * Default: false
5550
5921
  * @internal
5551
- * @deprecated
5552
5922
  */
5553
- giftCardId?: string;
5923
+ delayedCapture?: boolean;
5924
+ }
5925
+ interface ChargedBy {
5554
5926
  /**
5555
- * ID of the app that created the gift card.
5927
+ * ID - id of the user who initiated the payment
5556
5928
  * @format GUID
5557
5929
  */
5558
- appId?: string;
5930
+ _id?: string;
5559
5931
  /**
5560
- * Whether the gift card is voided.
5561
- * @readonly
5562
- * @deprecated Whether the gift card is voided.
5563
- * @replacedBy payment.status
5564
- * @targetRemovalDate 2026-11-01
5932
+ * Full name - name of the user who initiated the payment
5933
+ * @minLength 1
5934
+ * @maxLength 200
5565
5935
  */
5566
- voided?: boolean;
5936
+ fullName?: string | null;
5937
+ }
5938
+ interface CreatePaymentGatewayOrderResponse {
5939
+ /** ID of the order created in the payment gateway */
5940
+ paymentGatewayOrderId?: string;
5941
+ }
5942
+ interface ChargeMembershipsRequest {
5943
+ /**
5944
+ * Order ID.
5945
+ * @minLength 1
5946
+ * @maxLength 100
5947
+ */
5948
+ ecomOrderId: string;
5949
+ /**
5950
+ * The member id. Do not attempt to get it from the request context, since in some cases the caller is not a member
5951
+ * but a user which is using the membership on behalf of the a member
5952
+ * @format GUID
5953
+ */
5954
+ memberId: string;
5567
5955
  /**
5568
- * Gift card code with all but the last four characters masked. For example, `************QXY1`.
5569
- * @maxLength 30
5570
- * @immutable
5956
+ * List of items to be paid by memberships
5957
+ * @minSize 1
5958
+ * @maxSize 300
5571
5959
  */
5572
- obfuscatedCode?: string | null;
5960
+ membershipCharges?: MembershipChargeItem[];
5573
5961
  }
5574
- interface MembershipPaymentDetails {
5962
+ interface MembershipChargeItem {
5575
5963
  /**
5576
- * Membership ID.
5577
- * @maxLength 200
5964
+ * The id of used membership
5965
+ * @minLength 1
5966
+ * @maxLength 100
5578
5967
  */
5579
5968
  membershipId?: string;
5580
5969
  /**
5581
- * ID of the line item this membership applies to.
5582
- * @minLength 1
5583
- * @maxLength 100
5970
+ * ID of the application providing this payment option
5971
+ * @format GUID
5584
5972
  */
5585
- lineItemId?: string;
5973
+ appId?: string;
5974
+ /** The name of used membership */
5975
+ membershipName?: MembershipName;
5976
+ /** Additional data about this membership */
5977
+ membershipAdditionalData?: Record<string, any> | null;
5978
+ /** Catalog and item reference info. */
5979
+ catalogReference?: CatalogReference;
5980
+ /** Properties of the service. When relevant, contains information such as date and number of participants. */
5981
+ serviceProperties?: ServiceProperties;
5586
5982
  /**
5587
- * Payment status.
5588
- * @deprecated Payment status.
5589
- * @replacedBy payment.status
5590
- * @targetRemovalDate 2026-11-01
5983
+ * Usually would be the same as catalogReference.catalogItemId
5984
+ * For cases when these are not the same, this field would return the actual id of the item in the catalog
5985
+ * For example, for Wix bookings, catalogReference.catalogItemId is the booking id, and this value is being set to be the service id
5986
+ * @minLength 1
5987
+ * @maxLength 36
5591
5988
  */
5592
- status?: MembershipPaymentStatusWithLiterals;
5593
- /** Membership name. */
5594
- name?: MembershipName;
5989
+ rootCatalogItemId?: string | null;
5595
5990
  /**
5596
- * The transaction ID in the membership system. Can be used to void the transaction.
5991
+ * line item id of Checkout/Order line item
5597
5992
  * @minLength 1
5598
5993
  * @maxLength 100
5599
5994
  */
5600
- externalTransactionId?: string | null;
5995
+ lineItemId?: string;
5996
+ }
5997
+ interface MembershipName {
5601
5998
  /**
5602
- * Whether the membership is voided.
5603
- * @readonly
5604
- * @deprecated Whether the membership is voided.
5605
- * @replacedBy payment.status
5606
- * @targetRemovalDate 2026-11-01
5999
+ * Membership name in the site's original language.
6000
+ * @maxLength 100
5607
6001
  */
5608
- voided?: boolean;
6002
+ original?: string;
5609
6003
  /**
5610
- * ID of the application providing this payment option.
5611
- * @format GUID
6004
+ * Membership name translated into the buyer's language.
6005
+ *
6006
+ * Default: The value of `original`
6007
+ * @maxLength 100
5612
6008
  */
5613
- providerAppId?: string;
5614
- /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
5615
- futureMembership?: FutureMembershipDetails;
6009
+ translated?: string | null;
5616
6010
  }
5617
- declare enum MembershipPaymentStatus {
5618
- /** Payment was charged. */
5619
- CHARGED = "CHARGED",
5620
- /** The attempt to charge the payment failed, for example, due to lack of credits. */
5621
- CHARGE_FAILED = "CHARGE_FAILED",
5622
- /** Payment is pending. */
5623
- CHARGE_PENDING = "CHARGE_PENDING",
5624
- /** Payment was voided. */
5625
- VOIDED = "VOIDED"
6011
+ interface ChargeMembershipsResponse {
5626
6012
  }
5627
- /** @enumType */
5628
- type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
5629
- interface FutureMembershipDetails {
6013
+ interface TriggerRefundRequest {
5630
6014
  /**
5631
- * ID of the plan line item in the order from which the membership will be created.
5632
- * @format GUID
6015
+ * The order this refund related to
6016
+ * @minLength 1
6017
+ * @maxLength 100
5633
6018
  */
5634
- lineItemId?: string;
6019
+ ecomOrderId: string;
5635
6020
  /**
5636
- * ID of the benefit the future membership will grant.
5637
- * @maxLength 200
6021
+ * Refund operations information
6022
+ * @minSize 1
6023
+ * @maxSize 1
5638
6024
  */
5639
- benefitId?: string;
6025
+ payments: PaymentRefund[];
6026
+ /** Business model of a refund */
6027
+ details?: RefundDetails;
6028
+ /** Side effect details related to refund */
6029
+ sideEffects?: RefundSideEffects;
5640
6030
  }
5641
- interface WixReceiptInfo {
6031
+ interface PaymentRefund {
5642
6032
  /**
5643
- * Receipt ID
6033
+ * Specific payment within the order to refund
5644
6034
  * @format GUID
5645
6035
  */
5646
- receiptId?: string;
6036
+ paymentId?: string;
6037
+ /** Refund amount. Not relevant for membership and gift card refunds. */
6038
+ amount?: Price;
5647
6039
  /**
5648
- * Display number of receipt
6040
+ * Whether refund is made externally and manually (on the payment provider's side)
6041
+ * 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.
6042
+ * When true, the payment will only be *marked* as refunded, and no actual refund will be performed.
6043
+ */
6044
+ externalRefund?: boolean;
6045
+ /**
6046
+ * Gateway refund id. When param is present, new refund is not created.
6047
+ * Instead if order has a refund transaction with given gateway refund id, this refund will be updated with details from request,
6048
+ * and all side effects from request will be executed.
6049
+ * @internal
5649
6050
  * @minLength 1
5650
- * @maxLength 40
6051
+ * @maxLength 100
5651
6052
  */
5652
- displayNumber?: string | null;
6053
+ gatewayRefundId?: string | null;
5653
6054
  }
5654
- interface ExternalReceiptInfo {
6055
+ interface RefundSideEffects {
6056
+ /** Inventory restock details as part of this refund. */
6057
+ restockInfo?: RestockInfo;
6058
+ /** Whether to send a refund confirmation email to the customer. */
6059
+ sendOrderRefundedEmail?: boolean;
5655
6060
  /**
5656
- * External receipt ID
5657
- * @maxLength 100
6061
+ * Custom message added to the refund confirmation email.
6062
+ * @minLength 1
6063
+ * @maxLength 1000
5658
6064
  */
5659
- receiptId?: string | null;
6065
+ customMessage?: string | null;
6066
+ }
6067
+ interface RestockInfo {
6068
+ /** Restock type. */
6069
+ type?: RestockTypeWithLiterals;
5660
6070
  /**
5661
- * ID of the app providing the receipt
5662
- * @format GUID
6071
+ * Deprecated, use items instead
6072
+ * @internal
6073
+ * @maxSize 300
6074
+ * @deprecated
5663
6075
  */
5664
- appId?: string | null;
6076
+ lineItemIds?: string[];
5665
6077
  /**
5666
- * Display number of receipt
5667
- * @minLength 1
5668
- * @maxLength 40
6078
+ * Restocked line items and quantities. Only relevant for `{"type": "SOME_ITEMS"}`.
6079
+ * @maxSize 300
5669
6080
  */
5670
- displayNumber?: string | null;
6081
+ items?: RestockItem[];
5671
6082
  }
5672
- interface CashRoundingDetails {
6083
+ declare enum RestockType {
6084
+ NO_ITEMS = "NO_ITEMS",
6085
+ ALL_ITEMS = "ALL_ITEMS",
6086
+ SOME_ITEMS = "SOME_ITEMS"
6087
+ }
6088
+ /** @enumType */
6089
+ type RestockTypeWithLiterals = RestockType | 'NO_ITEMS' | 'ALL_ITEMS' | 'SOME_ITEMS';
6090
+ interface RestockItem {
5673
6091
  /**
5674
- * Payment amount before cash rounding was applied.
5675
- * When provided, balance and status calculations use this value instead of `amount`
5676
- * to prevent false overpayment or underpayment due to rounding.
6092
+ * ID of the line item being restocked.
6093
+ * @format GUID
5677
6094
  */
5678
- unroundedAmount?: Price;
6095
+ lineItemId?: string;
5679
6096
  /**
5680
- * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
5681
- * A positive value indicates the price was rounded up; a negative value indicates a round-down.
5682
- * @readonly
6097
+ * Line item quantity being restocked.
6098
+ * @min 1
6099
+ * @max 100000
5683
6100
  */
5684
- roundingAdjustment?: CashRounding;
5685
- }
5686
- declare enum PaymentStatus {
5687
- /** Payment was charged successfully. */
5688
- APPROVED = "APPROVED",
5689
- /** Payment is being processed and hasn't been confirmed yet. */
5690
- PENDING = "PENDING",
5691
- /** 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. */
5692
- PENDING_MERCHANT = "PENDING_MERCHANT",
5693
- /** Payment was canceled before it was charged. */
5694
- CANCELED = "CANCELED",
5695
- /** Payment was declined by the payment provider. */
5696
- DECLINED = "DECLINED",
5697
- /** Payment was fully refunded. */
5698
- REFUNDED = "REFUNDED",
5699
- /** Part of the payment amount was refunded. */
5700
- PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
5701
- /** 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. */
5702
- AUTHORIZED = "AUTHORIZED",
6101
+ quantity?: number;
5703
6102
  /**
5704
- * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
5705
- *
5706
- * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6103
+ * Per-location breakdown of restock quantities.
6104
+ * @internal
6105
+ * @maxSize 5
5707
6106
  */
5708
- VOIDED = "VOIDED"
5709
- }
5710
- /** @enumType */
5711
- type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
5712
- interface CanceledStatusDetails {
5713
- reason?: CanceledReasonWithLiterals;
5714
- }
5715
- declare enum CanceledReason {
5716
- /** Other payment with the same chargeCorrelationId failed before current payment started. */
5717
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
5718
- /** Payment was not completed by user and expired. */
5719
- EXPIRED = "EXPIRED"
5720
- }
5721
- /** @enumType */
5722
- type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
5723
- interface DeclinedStatusDetails {
5724
- reason?: DeclinedReasonWithLiterals;
5725
- }
5726
- declare enum DeclinedReason {
5727
- /** Corresponding charge failed. */
5728
- CHARGE_FAILED = "CHARGE_FAILED",
5729
- /** Payment details expired. */
5730
- EXPIRED = "EXPIRED",
5731
- /** Insufficient funds. */
5732
- INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
5733
- /** Gift card was disabled before charge was attempted. */
5734
- GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6107
+ restockLocations?: RestockLocation[];
5735
6108
  }
5736
- /** @enumType */
5737
- type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
5738
- interface VoidedStatusDetails {
5739
- reason?: VoidedReasonWithLiterals;
6109
+ interface TriggerRefundResponse {
6110
+ /** All order's transactions after the refunds were added */
6111
+ orderTransactions?: OrderTransactions;
6112
+ /** Created refund ID */
6113
+ refundId?: string | null;
6114
+ /** Payment ID's that the refund execution had failed for */
6115
+ failedPaymentIds?: ItemMetadata[];
5740
6116
  }
5741
- declare enum VoidedReason {
5742
- /** Payment was voided by merchant request. */
5743
- MERCHANT_REQUEST = "MERCHANT_REQUEST",
5744
- /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
5745
- OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6117
+ /**
6118
+ * A record of all payments and refunds associated with an order.
6119
+ *
6120
+ * Use order transactions to track payment status, add payment records, process refunds, and monitor chargebacks.
6121
+ */
6122
+ interface OrderTransactions {
6123
+ /**
6124
+ * Order ID.
6125
+ * @format GUID
6126
+ */
6127
+ orderId?: string;
6128
+ /**
6129
+ * Record of payments made to the merchant.
6130
+ * @maxSize 100
6131
+ */
6132
+ payments?: Payment[];
6133
+ /**
6134
+ * Record of refunds made to the buyer.
6135
+ * @maxSize 300
6136
+ */
6137
+ refunds?: Refund[];
5746
6138
  }
5747
- /** @enumType */
5748
- type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
5749
- interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
5750
- /** @internal */
5751
- canceled?: CanceledStatusDetails;
5752
- /** @internal */
5753
- declined?: DeclinedStatusDetails;
5754
- /** @internal */
5755
- voided?: VoidedStatusDetails;
6139
+ interface Payment extends PaymentPaymentDetailsOneOf, PaymentReceiptInfoOneOf, PaymentStatusDetailsOneOf {
6140
+ /** Regular payment details. */
6141
+ regularPaymentDetails?: RegularPaymentDetails;
6142
+ /** Gift card payment details. */
6143
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6144
+ /** Membership payment details. */
6145
+ membershipPaymentDetails?: MembershipPaymentDetails;
5756
6146
  /**
5757
- * Reason code from the payment gateway.
6147
+ * Receipt created by Wix
5758
6148
  * @internal
5759
- * @minLength 1
5760
- * @maxLength 10
5761
6149
  */
5762
- paymentGatewayReasonCode?: string | null;
5763
- }
5764
- /** @oneof */
5765
- interface PaymentStatusDetailsStatusDetailsOneOf {
6150
+ wixReceipt?: WixReceiptInfo;
6151
+ /**
6152
+ * Receipt created by an external system.
6153
+ * @internal
6154
+ */
6155
+ externalReceipt?: ExternalReceiptInfo;
5766
6156
  /** @internal */
5767
6157
  canceled?: CanceledStatusDetails;
5768
6158
  /** @internal */
5769
6159
  declined?: DeclinedStatusDetails;
5770
6160
  /** @internal */
5771
6161
  voided?: VoidedStatusDetails;
5772
- }
5773
- interface Refund {
5774
6162
  /**
5775
- * Refund ID.
6163
+ * Payment ID.
5776
6164
  * @format GUID
5777
6165
  * @readonly
5778
6166
  */
5779
- _id?: string;
5780
- /**
5781
- * List of transactions.
5782
- * @maxSize 50
5783
- */
5784
- transactions?: RefundTransaction[];
5785
- /** Refund business details. */
5786
- details?: RefundDetails;
5787
- /**
5788
- * 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.
5789
- * @readonly
5790
- * @immutable
5791
- */
6167
+ _id?: string | null;
6168
+ /** 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. */
5792
6169
  _createdDate?: Date | null;
5793
6170
  /**
5794
- * Aggregated refund summary.
5795
- * @readonly
5796
- */
5797
- summary?: AggregatedRefundSummary;
5798
- /**
5799
- * ID of the app that initiated this refund.
5800
- * @format GUID
6171
+ * Date and time the payment was last updated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format.
5801
6172
  * @readonly
5802
- * @immutable
5803
6173
  */
5804
- requestingServiceAppId?: string | null;
5805
- }
5806
- interface RefundTransaction {
6174
+ _updatedDate?: Date | null;
6175
+ /** Payment amount. */
6176
+ amount?: Price;
5807
6177
  /**
5808
- * ID of the payment associated with this refund.
5809
- * @format GUID
5810
- * @immutable
6178
+ * Whether refunds for this payment are disabled.
6179
+ * + `true`: This payment is not refundable.
6180
+ * + `false`: This payment may be refunded. However, this ultimately depends on the payment provider.
5811
6181
  */
5812
- paymentId?: string;
6182
+ refundDisabled?: boolean;
5813
6183
  /**
5814
- * Refund amount.
5815
- * @immutable
6184
+ * Whether receipt generation is allowed for this payment.
6185
+ * + `true`: This payment supports receipt generation.
6186
+ * + `false`: This payment doesn't support receipt generation, or a receipt was already generated.
6187
+ * @readonly
5816
6188
  */
5817
- amount?: Price;
5818
- /** Refund status. */
5819
- refundStatus?: RefundStatusWithLiterals;
5820
- /** Optional details of current refund status. */
5821
- refundStatusInfo?: RefundStatusInfo;
6189
+ supportReceiptGeneration?: boolean;
6190
+ /** Details about cash rounding applied to this payment, when relevant. */
6191
+ cashRounding?: CashRoundingDetails;
5822
6192
  /**
5823
- * Payment gateway's refund ID.
5824
- * This field is only returned when the value of `external_refund` is `false`.
5825
- * @format GUID
6193
+ * Overall payment status.
6194
+ *
6195
+ * Gift card and membership payments support only `APPROVED`, `PENDING`, `CANCELED`, `DECLINED`, and `VOIDED`. The remaining values apply to regular payments.
5826
6196
  */
5827
- gatewayRefundId?: string | null;
5828
- /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
5829
- providerRefundId?: string | null;
6197
+ status?: PaymentStatusWithLiterals;
5830
6198
  /**
5831
- * Whether refund was made externally and manually on the payment provider's side.
5832
- * @immutable
6199
+ * Detailed payment status information including gateway reason codes and status-specific details.
6200
+ * @internal
5833
6201
  */
5834
- externalRefund?: boolean;
6202
+ paymentStatusDetails?: PaymentStatusDetails;
5835
6203
  /**
5836
- * Location where the refund was processed.
6204
+ * Location where the payment was processed.
5837
6205
  * @internal
5838
6206
  * @format GUID
5839
6207
  * @immutable
5840
6208
  */
5841
6209
  locationId?: string | null;
5842
- }
5843
- /** Refund transaction status. */
5844
- declare enum RefundStatus {
5845
- /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
5846
- PENDING = "PENDING",
5847
- /** Refund transaction succeeded. */
5848
- SUCCEEDED = "SUCCEEDED",
5849
- /** Refund transaction failed. */
5850
- FAILED = "FAILED",
5851
- /** Refund request acknowledged, and will be executed soon. */
5852
- SCHEDULED = "SCHEDULED",
5853
- /** Refund was initiated on payment provider side. */
5854
- STARTED = "STARTED"
5855
- }
5856
- /** @enumType */
5857
- type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
5858
- interface RefundStatusInfo {
5859
- /**
5860
- * Reason code for the refund's current status.
5861
- *
5862
- * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
5863
- * @minLength 1
5864
- * @maxLength 10
5865
- */
5866
- paymentGatewayReasonCode?: string | null;
5867
6210
  /**
5868
- * Free text explanation of current refund status.
5869
- * @minLength 1
5870
- * @maxLength 1000
6211
+ * ID linking this payment to the charge request that created it. Matches the `idempotencyKey` sent in the Charge Order request.
6212
+ * @format GUID
5871
6213
  */
5872
- description?: string | null;
6214
+ chargeCorrelationId?: string | null;
5873
6215
  }
5874
- interface AggregatedRefundSummary {
5875
- /** Total amount requested for refund. */
5876
- requestedRefund?: Price;
5877
- /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
5878
- pendingRefund?: Price;
5879
- /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
5880
- refunded?: Price;
5881
- /** Failed refund amount - the portion of `requestedRefund` that failed. */
5882
- failedRefundAmount?: Price;
5883
- /** Whether at least one refund transaction is still in `"PENDING"` status. */
5884
- pending?: boolean;
5885
- /** Breakdown of refunded items. Available only after refund is complete. */
5886
- breakdown?: RefundItemsBreakdown;
6216
+ /** @oneof */
6217
+ interface PaymentPaymentDetailsOneOf {
6218
+ /** Regular payment details. */
6219
+ regularPaymentDetails?: RegularPaymentDetails;
6220
+ /** Gift card payment details. */
6221
+ giftcardPaymentDetails?: GiftCardPaymentDetails;
6222
+ /** Membership payment details. */
6223
+ membershipPaymentDetails?: MembershipPaymentDetails;
5887
6224
  }
5888
- interface RefundItemsBreakdown {
6225
+ /** @oneof */
6226
+ interface PaymentReceiptInfoOneOf {
5889
6227
  /**
5890
- * Refunded line items and the amount refunded for each.
5891
- * @maxSize 300
6228
+ * Receipt created by Wix
6229
+ * @internal
5892
6230
  */
5893
- lineItems?: LineItemRefundSummary[];
5894
- }
5895
- interface LineItemRefundSummary {
6231
+ wixReceipt?: WixReceiptInfo;
5896
6232
  /**
5897
- * ID of the refunded line item.
5898
- * @format GUID
6233
+ * Receipt created by an external system.
6234
+ * @internal
5899
6235
  */
5900
- lineItemId?: string;
5901
- /** Total refunded amount for the line item. */
5902
- totalRefundedAmount?: Price;
6236
+ externalReceipt?: ExternalReceiptInfo;
5903
6237
  }
5904
- interface CalculateRefundRequest {
6238
+ /** @oneof */
6239
+ interface PaymentStatusDetailsOneOf {
6240
+ /** @internal */
6241
+ canceled?: CanceledStatusDetails;
6242
+ /** @internal */
6243
+ declined?: DeclinedStatusDetails;
6244
+ /** @internal */
6245
+ voided?: VoidedStatusDetails;
6246
+ }
6247
+ interface RegularPaymentDetails extends RegularPaymentDetailsPaymentMethodDetailsOneOf {
6248
+ /** Credit card details. */
6249
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5905
6250
  /**
5906
- * Order ID
5907
- * @minLength 1
6251
+ * Wix Payments order ID.
5908
6252
  * @maxLength 100
5909
6253
  */
5910
- ecomOrderId?: string;
6254
+ paymentOrderId?: string | null;
5911
6255
  /**
5912
- * Refunded line items and quantity
5913
- * @maxSize 300
6256
+ * Payment gateway's transaction ID.
6257
+ * This field is only returned when the value of `offline_payment` is `false`.
6258
+ * @maxLength 100
5914
6259
  */
5915
- refundItems?: CalculateRefundItemRequest[];
5916
- /** Should include shipping in refund calculation */
5917
- refundShipping?: boolean;
5918
- }
5919
- interface CalculateRefundItemRequest {
6260
+ gatewayTransactionId?: string | null;
5920
6261
  /**
5921
- * ID of the line item being refunded
5922
- * @format GUID
6262
+ * Payment method.
6263
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6264
+ * Non-exhaustive list of supported values:
6265
+ * + `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`
6266
+ * @maxLength 150
6267
+ * @deprecated Payment method.
6268
+ * Deprecated. Use `paymentMethodName.buyerLanguageName` instead.
6269
+ * Non-exhaustive list of supported values:
6270
+ * + `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`
6271
+ * @replacedBy payment_method_name
6272
+ * @targetRemovalDate 2026-07-01
5923
6273
  */
5924
- _id?: string;
6274
+ paymentMethod?: string | null;
5925
6275
  /**
5926
- * How much of that line item is being refunded
5927
- * @min 1
5928
- * @max 100000
6276
+ * Transaction ID in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for offline payments.
6277
+ * @maxLength 100
5929
6278
  */
5930
- quantity?: number;
5931
- }
5932
- interface CalculateRefundResponse {
5933
- /** Total refundable amount */
5934
- total?: Price;
5935
- /** Tax cost of the order */
5936
- tax?: Price;
5937
- /** Discount given for this order */
5938
- discount?: Price;
5939
- /** Total cost of the order (without tax) */
5940
- subtotal?: Price;
5941
- /** Total shipping cost for order */
5942
- shipping?: Price;
5943
- /** Previous refund given on that order */
5944
- previouslyRefundedAmount?: Price;
6279
+ providerTransactionId?: string | null;
6280
+ /** Whether the payment was made offline. For example, when using cash or when marked as paid in the Business Manager. */
6281
+ offlinePayment?: boolean;
5945
6282
  /**
5946
- * The refundable items of that order
5947
- * @maxSize 300
6283
+ * Payment status.
6284
+ * @deprecated Payment status.
6285
+ * @replacedBy payment.status
6286
+ * @targetRemovalDate 2026-11-01
5948
6287
  */
5949
- items?: CalculateRefundItemResponse[];
5950
- }
5951
- interface CalculateRefundItemResponse {
6288
+ status?: TransactionStatusWithLiterals;
6289
+ /** Whether there is a payment agreement that allows for future charges. */
6290
+ savedPaymentMethod?: boolean;
6291
+ /** Authorization details. */
6292
+ authorizationDetails?: AuthorizationDetails;
5952
6293
  /**
5953
- * Line item ID
5954
- * @format GUID
6294
+ * Payment service provider display name. Non-exhaustive list of supported values: Wix Payments, PayPal, Square, Stripe, etc.
6295
+ * @internal
6296
+ * @maxLength 300
5955
6297
  */
5956
- _id?: string;
5957
- /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
5958
- price?: Price;
5959
- }
5960
- interface VoidAuthorizedPaymentsRequest {
6298
+ paymentProvider?: string | null;
5961
6299
  /**
5962
- * Wix eCommerce order ID
5963
- * @minLength 1
5964
- * @maxLength 100
6300
+ * Record of chargebacks made by the buyer.
6301
+ * @maxSize 6
5965
6302
  */
5966
- ecomOrderId: string;
6303
+ chargebacks?: Chargeback[];
5967
6304
  /**
5968
- * Payment IDs
5969
- * @minSize 1
5970
- * @maxSize 100
5971
- * @format GUID
6305
+ * Payment method ID.
6306
+ * @internal
6307
+ * @maxLength 36
5972
6308
  */
5973
- paymentIds: string[];
6309
+ paymentMethodId?: string | null;
6310
+ /** Platform fee amount associated with this payment. */
6311
+ platformFee?: Price;
6312
+ /**
6313
+ * Payment method with buyer and optional owner translations.
6314
+ * Non-exhaustive list of supported values:
6315
+ * + `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`
6316
+ */
6317
+ paymentMethodName?: PaymentMethodName;
5974
6318
  }
5975
- interface VoidAuthorizedPaymentsResponse {
5976
- /** All order's transactions after the void was triggered */
5977
- orderTransactions?: OrderTransactions;
6319
+ /** @oneof */
6320
+ interface RegularPaymentDetailsPaymentMethodDetailsOneOf {
6321
+ /** Credit card details. */
6322
+ creditCardDetails?: CreditCardPaymentMethodDetails;
5978
6323
  }
5979
- interface CaptureAuthorizedPaymentsRequest {
6324
+ declare enum TransactionStatus {
6325
+ UNDEFINED = "UNDEFINED",
6326
+ APPROVED = "APPROVED",
6327
+ PENDING = "PENDING",
6328
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6329
+ CANCELED = "CANCELED",
6330
+ DECLINED = "DECLINED",
6331
+ REFUNDED = "REFUNDED",
6332
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6333
+ AUTHORIZED = "AUTHORIZED",
6334
+ VOIDED = "VOIDED"
6335
+ }
6336
+ /** @enumType */
6337
+ type TransactionStatusWithLiterals = TransactionStatus | 'UNDEFINED' | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6338
+ interface CreditCardPaymentMethodDetails {
5980
6339
  /**
5981
- * Wix eCommerce order ID
5982
- * @minLength 1
5983
- * @maxLength 100
6340
+ * The last 4 digits of the card number.
6341
+ * @maxLength 4
5984
6342
  */
5985
- ecomOrderId: string;
6343
+ lastFourDigits?: string | null;
5986
6344
  /**
5987
- * Capture payments information
5988
- * @minSize 1
5989
- * @maxSize 100
6345
+ * Card issuer's brand.
6346
+ * @maxLength 100
5990
6347
  */
5991
- payments: PaymentCapture[];
6348
+ brand?: string | null;
5992
6349
  }
5993
- interface PaymentCapture {
6350
+ interface AuthorizationDetails {
5994
6351
  /**
5995
- * Payment ID
5996
- * @format GUID
6352
+ * Whether the authorized payment is of a delayed capture.
6353
+ * @readonly
5997
6354
  */
5998
- paymentId?: string | null;
6355
+ delayedCapture?: boolean;
6356
+ /** Date and time the payment was authorized in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6357
+ authorizedDate?: Date | null;
5999
6358
  /**
6000
- * Capture amount.
6001
- * If not provided - full authorized amount will be captured.
6359
+ * List of captures associated with payment
6360
+ * In case of failed it can be replaced with new one with PENDING or SUCCESS statuses
6361
+ * @maxSize 1
6002
6362
  */
6003
- amount?: Price;
6004
- }
6005
- interface CaptureAuthorizedPaymentsResponse {
6006
- /** All order's transactions after the capture was triggered */
6007
- orderTransactions?: OrderTransactions;
6363
+ captures?: AuthorizationCapture[];
6364
+ /** Void associated with payment */
6365
+ void?: AuthorizationVoid;
6366
+ /** Scheduled action for this transaction */
6367
+ scheduledAction?: V1ScheduledAction;
6008
6368
  }
6009
- interface ChargeSavedPaymentMethodRequest {
6369
+ interface AuthorizationCapture {
6010
6370
  /**
6011
- * Ecom Order ID.
6012
- * @minLength 1
6013
- * @maxLength 100
6371
+ * Capture ID.
6372
+ * @format GUID
6373
+ * @readonly
6374
+ */
6375
+ _id?: string | null;
6376
+ /** Status of this capture action */
6377
+ status?: AuthorizationCaptureStatusWithLiterals;
6378
+ /**
6379
+ * Amount of this capture
6380
+ * @immutable
6014
6381
  */
6015
- ecomOrderId?: string;
6016
- /** Amount to be charged */
6017
6382
  amount?: Price;
6383
+ /** Date and time the capture was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6384
+ _createdDate?: Date | null;
6385
+ /** In case of status is FAILED may contain failure details */
6386
+ failureDetails?: AuthorizationActionFailureDetails;
6018
6387
  }
6019
- interface ChargeSavedPaymentMethodResponse {
6020
- /** Payment gateway's order ID (e.g Wix Payments) */
6021
- paymentGatewayOrderId?: string;
6388
+ declare enum AuthorizationCaptureStatus {
6389
+ /** Capture operation still in progress. */
6390
+ PENDING = "PENDING",
6391
+ /** Capture operation succeeded. */
6392
+ SUCCEEDED = "SUCCEEDED",
6393
+ /** Capture operation failed. */
6394
+ FAILED = "FAILED"
6022
6395
  }
6023
- interface SendBuyerConfirmationEmailRequest {
6024
- /** @format GUID */
6025
- orderId?: string;
6396
+ /** @enumType */
6397
+ type AuthorizationCaptureStatusWithLiterals = AuthorizationCaptureStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6398
+ interface AuthorizationActionFailureDetails {
6399
+ /** @maxLength 100 */
6400
+ failureCode?: string;
6026
6401
  }
6027
- interface SendBuyerConfirmationEmailResponse {
6402
+ interface AuthorizationVoid {
6403
+ /** Status of this void action */
6404
+ status?: AuthorizationVoidStatusWithLiterals;
6405
+ /** Date and time the void was initiated in [ISO-8601](https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations) format. */
6406
+ voidedDate?: Date | null;
6407
+ /** In case of status is FAILED may contain failure details */
6408
+ failureDetails?: AuthorizationActionFailureDetails;
6409
+ /** Reason of void action */
6410
+ reason?: ReasonWithLiterals;
6028
6411
  }
6029
- interface SendBuyerPaymentsReceivedEmailRequest {
6030
- /**
6031
- * @minLength 1
6032
- * @maxLength 100
6033
- */
6034
- orderId?: string;
6412
+ declare enum AuthorizationVoidStatus {
6413
+ /** Void operation still in progress. */
6414
+ PENDING = "PENDING",
6415
+ /** Void operation succeeded. */
6416
+ SUCCEEDED = "SUCCEEDED",
6417
+ /** Void operation failed. */
6418
+ FAILED = "FAILED"
6035
6419
  }
6036
- interface SendBuyerPaymentsReceivedEmailResponse {
6420
+ /** @enumType */
6421
+ type AuthorizationVoidStatusWithLiterals = AuthorizationVoidStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED';
6422
+ /** Reason the authorization was voided. */
6423
+ declare enum Reason {
6424
+ /** Authorization was voided by user. */
6425
+ MANUAL = "MANUAL",
6426
+ /** Authorization passed execution date. */
6427
+ SCHEDULED = "SCHEDULED"
6037
6428
  }
6038
- interface SendBuyerPickupConfirmationEmailRequest {
6039
- /**
6040
- * @minLength 1
6041
- * @maxLength 100
6042
- */
6043
- orderId?: string;
6429
+ /** @enumType */
6430
+ type ReasonWithLiterals = Reason | 'MANUAL' | 'SCHEDULED';
6431
+ interface V1ScheduledAction {
6432
+ /** Type of the action. */
6433
+ actionType?: ActionTypeWithLiterals;
6434
+ /** The date and time of the action. */
6435
+ executionDate?: Date | null;
6044
6436
  }
6045
- interface SendBuyerPickupConfirmationEmailResponse {
6437
+ declare enum ActionType {
6438
+ VOID = "VOID",
6439
+ CAPTURE = "CAPTURE"
6046
6440
  }
6047
- interface BulkSendBuyerPickupConfirmationEmailsRequest {
6441
+ /** @enumType */
6442
+ type ActionTypeWithLiterals = ActionType | 'VOID' | 'CAPTURE';
6443
+ interface Chargeback {
6048
6444
  /**
6049
- * IDs of orders to send pickup emails for.
6050
- * @minSize 1
6051
- * @maxSize 300
6445
+ * Chargeback ID.
6446
+ * @format GUID
6447
+ * @readonly
6448
+ * @immutable
6052
6449
  */
6053
- orderIds?: string[];
6054
- }
6055
- interface BulkSendBuyerPickupConfirmationEmailsResponse {
6056
- }
6057
- interface SendBuyerShippingConfirmationEmailRequest {
6450
+ _id?: string;
6058
6451
  /**
6059
- * @minLength 1
6060
- * @maxLength 100
6452
+ * 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.
6453
+ * @readonly
6454
+ * @immutable
6061
6455
  */
6062
- orderId?: string;
6063
- }
6064
- interface SendBuyerShippingConfirmationEmailResponse {
6065
- }
6066
- interface BulkSendBuyerShippingConfirmationEmailsRequest {
6456
+ _createdDate?: Date | null;
6067
6457
  /**
6068
- * IDs of orders to send pickup emails for.
6069
- * @minSize 1
6070
- * @maxSize 300
6458
+ * 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.
6459
+ * @readonly
6071
6460
  */
6072
- orderIds?: string[];
6073
- }
6074
- interface BulkSendBuyerShippingConfirmationEmailsResponse {
6075
- }
6076
- interface SendMerchantOrderReceivedNotificationRequest {
6461
+ _updatedDate?: Date | null;
6077
6462
  /**
6078
- * @minLength 1
6079
- * @maxLength 100
6463
+ * Amount.
6464
+ * @readonly
6465
+ * @immutable
6080
6466
  */
6081
- orderId?: string;
6082
- }
6083
- interface SendMerchantOrderReceivedNotificationResponse {
6084
- }
6085
- interface SendCancelRefundEmailRequest {
6467
+ amount?: Price;
6086
6468
  /**
6087
- * The ID of order that is canceled/refunded
6088
- * @minLength 1
6089
- * @maxLength 100
6469
+ * Reversal amount. Present only when status is REVERSED.
6470
+ * @readonly
6090
6471
  */
6091
- orderId?: string;
6472
+ reversalAmount?: Price;
6092
6473
  /**
6093
- * Personal note added to the email (optional)
6094
- * @minLength 1
6095
- * @maxLength 1000
6474
+ * Status.
6475
+ *
6476
+ * Default: `"APPROVED"`.
6096
6477
  */
6097
- customMessage?: string | null;
6098
- /** Refund amount */
6099
- refundAmount?: Price;
6478
+ status?: ChargebackStatusWithLiterals;
6100
6479
  /**
6101
- * Refund ID. (Optional)
6480
+ * External chargeback ID.
6102
6481
  * @format GUID
6482
+ * @readonly
6483
+ * @immutable
6103
6484
  */
6104
- refundId?: string | null;
6485
+ externalId?: string | null;
6105
6486
  }
6106
- interface SendCancelRefundEmailResponse {
6487
+ declare enum ChargebackStatus {
6488
+ /** Chargeback was approved. */
6489
+ APPROVED = "APPROVED",
6490
+ /** Chargeback was reversed. */
6491
+ REVERSED = "REVERSED"
6107
6492
  }
6108
- interface SendRefundEmailRequest {
6109
- /**
6110
- * The ID of order that is refunded
6111
- * @format GUID
6112
- */
6113
- orderId?: string;
6493
+ /** @enumType */
6494
+ type ChargebackStatusWithLiterals = ChargebackStatus | 'APPROVED' | 'REVERSED';
6495
+ interface PaymentMethodName {
6114
6496
  /**
6115
- * Refund ID
6116
- * @format GUID
6497
+ * Payment method name in the buyer's language. For example, `"Credit/Debit Cards"`.
6498
+ * @maxLength 150
6117
6499
  */
6118
- refundId?: string;
6500
+ buyerLanguageName?: string | null;
6119
6501
  /**
6120
- * Personal note added to the email (optional)
6121
- * @minLength 1
6122
- * @maxLength 1000
6502
+ * Payment method name in the site's language. For example, `"Credit/Debit Cards"`.
6503
+ *
6504
+ * When no site-language name is stored, holds the same value as `buyerLanguageName`.
6505
+ * @maxLength 150
6123
6506
  */
6124
- customMessage?: string | null;
6125
- }
6126
- interface SendRefundEmailResponse {
6127
- }
6128
- interface SendFulfillmentEmailRequest {
6129
- /** @format GUID */
6130
- orderId?: string;
6131
- /** @format GUID */
6132
- fulfillerId?: string;
6133
- }
6134
- interface SendFulfillmentEmailResponse {
6135
- }
6136
- interface SendMerchantOrderReceivedPushRequest {
6507
+ siteLanguageName?: string | null;
6137
6508
  /**
6138
- * @minLength 1
6139
- * @maxLength 100
6509
+ * User-provided payment method name.
6510
+ *
6511
+ * When set, takes precedence over `buyerLanguageName` and `siteLanguageName`.
6140
6512
  */
6141
- orderId?: string;
6142
- }
6143
- interface SendMerchantOrderReceivedPushResponse {
6144
- }
6145
- interface PreviewEmailByTypeRequest {
6146
- emailType?: PreviewEmailTypeWithLiterals;
6147
- }
6148
- declare enum PreviewEmailType {
6149
- ORDER_PLACED = "ORDER_PLACED",
6150
- DOWNLOAD_LINKS = "DOWNLOAD_LINKS",
6151
- ORDER_SHIPPED = "ORDER_SHIPPED",
6152
- ORDER_READY_FOR_PICKUP = "ORDER_READY_FOR_PICKUP"
6153
- }
6154
- /** @enumType */
6155
- type PreviewEmailTypeWithLiterals = PreviewEmailType | 'ORDER_PLACED' | 'DOWNLOAD_LINKS' | 'ORDER_SHIPPED' | 'ORDER_READY_FOR_PICKUP';
6156
- interface PreviewEmailByTypeResponse {
6157
- emailPreview?: string;
6513
+ userDefinedName?: UserDefinedPaymentMethodName;
6158
6514
  }
6159
- interface PreviewRefundEmailRequest {
6515
+ interface GiftCardPaymentDetails {
6160
6516
  /**
6161
- * @minLength 1
6517
+ * Gift card payment ID.
6162
6518
  * @maxLength 100
6163
6519
  */
6164
- orderId?: string;
6165
- /** Refund amount */
6166
- refundAmount?: Price;
6167
- /** Refund business details */
6168
- details?: RefundDetails;
6520
+ giftCardPaymentId?: string;
6169
6521
  /**
6170
- * Personal note added to the email (optional)
6171
- * @minLength 1
6172
- * @maxLength 1000
6522
+ * Gift card ID.
6523
+ * @internal
6524
+ * @deprecated
6173
6525
  */
6174
- customMessage?: string | null;
6526
+ giftCardId?: string;
6175
6527
  /**
6176
- * Refund ID. (Optional)
6528
+ * ID of the app that created the gift card.
6177
6529
  * @format GUID
6178
6530
  */
6179
- refundId?: string | null;
6180
- }
6181
- interface PreviewRefundEmailResponse {
6182
- emailPreview?: string;
6183
- }
6184
- interface PreviewCancelEmailRequest {
6531
+ appId?: string;
6185
6532
  /**
6186
- * @minLength 1
6187
- * @maxLength 100
6533
+ * Whether the gift card is voided.
6534
+ * @readonly
6535
+ * @deprecated Whether the gift card is voided.
6536
+ * @replacedBy payment.status
6537
+ * @targetRemovalDate 2026-11-01
6188
6538
  */
6189
- orderId?: string;
6539
+ voided?: boolean;
6190
6540
  /**
6191
- * Personal note added to the email (optional)
6192
- * @minLength 1
6193
- * @maxLength 1000
6541
+ * Gift card code with all but the last four characters masked. For example, `************QXY1`.
6542
+ * @maxLength 30
6543
+ * @immutable
6194
6544
  */
6195
- customMessage?: string | null;
6196
- }
6197
- interface PreviewCancelEmailResponse {
6198
- emailPreview?: string;
6545
+ obfuscatedCode?: string | null;
6199
6546
  }
6200
- interface PreviewCancelRefundEmailRequest {
6547
+ interface MembershipPaymentDetails {
6548
+ /**
6549
+ * Membership ID.
6550
+ * @maxLength 200
6551
+ */
6552
+ membershipId?: string;
6201
6553
  /**
6554
+ * ID of the line item this membership applies to.
6202
6555
  * @minLength 1
6203
6556
  * @maxLength 100
6204
6557
  */
6205
- orderId?: string;
6558
+ lineItemId?: string;
6206
6559
  /**
6207
- * Personal note added to the email (optional)
6208
- * @minLength 1
6209
- * @maxLength 1000
6560
+ * Payment status.
6561
+ * @deprecated Payment status.
6562
+ * @replacedBy payment.status
6563
+ * @targetRemovalDate 2026-11-01
6210
6564
  */
6211
- customMessage?: string | null;
6212
- /** Refund amount */
6213
- refundAmount?: Price;
6565
+ status?: MembershipPaymentStatusWithLiterals;
6566
+ /** Membership name. */
6567
+ name?: MembershipName;
6214
6568
  /**
6215
- * Refund ID. (Optional)
6216
- * @format GUID
6569
+ * The transaction ID in the membership system. Can be used to void the transaction.
6570
+ * @minLength 1
6571
+ * @maxLength 100
6217
6572
  */
6218
- refundId?: string | null;
6219
- }
6220
- interface PreviewCancelRefundEmailResponse {
6221
- emailPreview?: string;
6222
- }
6223
- interface PreviewBuyerPaymentsReceivedEmailRequest {
6224
- }
6225
- interface PreviewBuyerPaymentsReceivedEmailResponse {
6226
- emailPreview?: string;
6227
- }
6228
- interface PreviewBuyerConfirmationEmailRequest {
6229
- }
6230
- interface PreviewBuyerConfirmationEmailResponse {
6231
- emailPreview?: string;
6232
- }
6233
- interface PreviewBuyerPickupConfirmationEmailRequest {
6234
- }
6235
- interface PreviewBuyerPickupConfirmationEmailResponse {
6236
- emailPreview?: string;
6237
- }
6238
- interface PreviewShippingConfirmationEmailRequest {
6239
- }
6240
- interface PreviewShippingConfirmationEmailResponse {
6241
- emailPreview?: string;
6242
- }
6243
- interface PreviewResendDownloadLinksEmailRequest {
6244
- }
6245
- interface PreviewResendDownloadLinksEmailResponse {
6246
- emailPreview?: string;
6247
- }
6248
- interface MetaSiteSpecialEvent extends MetaSiteSpecialEventPayloadOneOf {
6249
- /** Emitted on a meta site creation. */
6250
- siteCreated?: SiteCreated;
6251
- /** Emitted on a meta site transfer completion. */
6252
- siteTransferred?: SiteTransferred;
6253
- /** Emitted on a meta site deletion. */
6254
- siteDeleted?: SiteDeleted;
6255
- /** Emitted on a meta site restoration. */
6256
- siteUndeleted?: SiteUndeleted;
6257
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6258
- sitePublished?: SitePublished;
6259
- /** Emitted on a meta site unpublish. */
6260
- siteUnpublished?: SiteUnpublished;
6261
- /** Emitted when meta site is marked as template. */
6262
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6263
- /** Emitted when meta site is marked as a WixSite. */
6264
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6265
- /** Emitted when an application is provisioned (installed). */
6266
- serviceProvisioned?: ServiceProvisioned;
6267
- /** Emitted when an application is removed (uninstalled). */
6268
- serviceRemoved?: ServiceRemoved;
6269
- /** Emitted when meta site name (URL slug) is changed. */
6270
- siteRenamedPayload?: SiteRenamed;
6271
- /** Emitted when meta site was permanently deleted. */
6272
- hardDeleted?: SiteHardDeleted;
6273
- /** Emitted on a namespace change. */
6274
- namespaceChanged?: NamespaceChanged;
6275
- /** Emitted when Studio is attached. */
6276
- studioAssigned?: StudioAssigned;
6277
- /** Emitted when Studio is detached. */
6278
- studioUnassigned?: StudioUnassigned;
6573
+ externalTransactionId?: string | null;
6279
6574
  /**
6280
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6281
- * the actual URL.
6282
- *
6283
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6284
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6575
+ * Whether the membership is voided.
6576
+ * @readonly
6577
+ * @deprecated Whether the membership is voided.
6578
+ * @replacedBy payment.status
6579
+ * @targetRemovalDate 2026-11-01
6285
6580
  */
6286
- urlChanged?: SiteUrlChanged;
6287
- /** Site is marked as PurgedExternally */
6288
- sitePurgedExternally?: SitePurgedExternally;
6289
- /** Emitted when Odeditor is attached. */
6290
- odeditorAssigned?: OdeditorAssigned;
6291
- /** Emitted when Odeditor is detached. */
6292
- odeditorUnassigned?: OdeditorUnassigned;
6293
- /** Emitted when Picasso is attached. */
6294
- picassoAssigned?: PicassoAssigned;
6295
- /** Emitted when Picasso is detached. */
6296
- picassoUnassigned?: PicassoUnassigned;
6297
- /** Emitted when Wixel is attached. */
6298
- wixelAssigned?: WixelAssigned;
6299
- /** Emitted when Wixel is detached. */
6300
- wixelUnassigned?: WixelUnassigned;
6301
- /** Emitted when StudioTwo is attached. */
6302
- studioTwoAssigned?: StudioTwoAssigned;
6303
- /** Emitted when StudioTwo is detached. */
6304
- studioTwoUnassigned?: StudioTwoUnassigned;
6305
- /** Emitted when media from user domain is enabled. */
6306
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6307
- /** Emitted when media from user domain is disabled. */
6308
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6309
- /** Emitted when Editorless is attached. */
6310
- editorlessAssigned?: EditorlessAssigned;
6311
- /** Emitted when Editorless is detached. */
6312
- editorlessUnassigned?: EditorlessUnassigned;
6581
+ voided?: boolean;
6313
6582
  /**
6314
- * A meta site id.
6583
+ * ID of the application providing this payment option.
6315
6584
  * @format GUID
6316
6585
  */
6317
- metaSiteId?: string;
6318
- /** A meta site version. Monotonically increasing. */
6319
- version?: string;
6320
- /** A timestamp of the event. */
6321
- timestamp?: string;
6586
+ providerAppId?: string;
6587
+ /** Details of a membership that does not yet exist, allowing the payment to be held before the membership is created. */
6588
+ futureMembership?: FutureMembershipDetails;
6589
+ }
6590
+ declare enum MembershipPaymentStatus {
6591
+ /** Payment was charged. */
6592
+ CHARGED = "CHARGED",
6593
+ /** The attempt to charge the payment failed, for example, due to lack of credits. */
6594
+ CHARGE_FAILED = "CHARGE_FAILED",
6595
+ /** Payment is pending. */
6596
+ CHARGE_PENDING = "CHARGE_PENDING",
6597
+ /** Payment was voided. */
6598
+ VOIDED = "VOIDED"
6599
+ }
6600
+ /** @enumType */
6601
+ type MembershipPaymentStatusWithLiterals = MembershipPaymentStatus | 'CHARGED' | 'CHARGE_FAILED' | 'CHARGE_PENDING' | 'VOIDED';
6602
+ interface FutureMembershipDetails {
6322
6603
  /**
6323
- * TODO(meta-site): Change validation once validations are disabled for consumers
6324
- * More context: https://wix.slack.com/archives/C0UHEBPFT/p1720957844413149 and https://wix.slack.com/archives/CFWKX325T/p1728892152855659
6325
- * @maxSize 4000
6604
+ * ID of the plan line item in the order from which the membership will be created.
6605
+ * @format GUID
6326
6606
  */
6327
- assets?: Asset[];
6328
- }
6329
- /** @oneof */
6330
- interface MetaSiteSpecialEventPayloadOneOf {
6331
- /** Emitted on a meta site creation. */
6332
- siteCreated?: SiteCreated;
6333
- /** Emitted on a meta site transfer completion. */
6334
- siteTransferred?: SiteTransferred;
6335
- /** Emitted on a meta site deletion. */
6336
- siteDeleted?: SiteDeleted;
6337
- /** Emitted on a meta site restoration. */
6338
- siteUndeleted?: SiteUndeleted;
6339
- /** Emitted on the first* publish of the meta site (* switching from unpublished to published state). */
6340
- sitePublished?: SitePublished;
6341
- /** Emitted on a meta site unpublish. */
6342
- siteUnpublished?: SiteUnpublished;
6343
- /** Emitted when meta site is marked as template. */
6344
- siteMarkedAsTemplate?: SiteMarkedAsTemplate;
6345
- /** Emitted when meta site is marked as a WixSite. */
6346
- siteMarkedAsWixSite?: SiteMarkedAsWixSite;
6347
- /** Emitted when an application is provisioned (installed). */
6348
- serviceProvisioned?: ServiceProvisioned;
6349
- /** Emitted when an application is removed (uninstalled). */
6350
- serviceRemoved?: ServiceRemoved;
6351
- /** Emitted when meta site name (URL slug) is changed. */
6352
- siteRenamedPayload?: SiteRenamed;
6353
- /** Emitted when meta site was permanently deleted. */
6354
- hardDeleted?: SiteHardDeleted;
6355
- /** Emitted on a namespace change. */
6356
- namespaceChanged?: NamespaceChanged;
6357
- /** Emitted when Studio is attached. */
6358
- studioAssigned?: StudioAssigned;
6359
- /** Emitted when Studio is detached. */
6360
- studioUnassigned?: StudioUnassigned;
6607
+ lineItemId?: string;
6361
6608
  /**
6362
- * Emitted when one of the URLs is changed. After this event you may call `urls-server` to fetch
6363
- * the actual URL.
6364
- *
6365
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1732520791210559?thread_ts=1732027914.294059&cid=C0UHEBPFT
6366
- * See: https://wix.slack.com/archives/C0UHEBPFT/p1744115197619459
6609
+ * ID of the benefit the future membership will grant.
6610
+ * @maxLength 200
6367
6611
  */
6368
- urlChanged?: SiteUrlChanged;
6369
- /** Site is marked as PurgedExternally */
6370
- sitePurgedExternally?: SitePurgedExternally;
6371
- /** Emitted when Odeditor is attached. */
6372
- odeditorAssigned?: OdeditorAssigned;
6373
- /** Emitted when Odeditor is detached. */
6374
- odeditorUnassigned?: OdeditorUnassigned;
6375
- /** Emitted when Picasso is attached. */
6376
- picassoAssigned?: PicassoAssigned;
6377
- /** Emitted when Picasso is detached. */
6378
- picassoUnassigned?: PicassoUnassigned;
6379
- /** Emitted when Wixel is attached. */
6380
- wixelAssigned?: WixelAssigned;
6381
- /** Emitted when Wixel is detached. */
6382
- wixelUnassigned?: WixelUnassigned;
6383
- /** Emitted when StudioTwo is attached. */
6384
- studioTwoAssigned?: StudioTwoAssigned;
6385
- /** Emitted when StudioTwo is detached. */
6386
- studioTwoUnassigned?: StudioTwoUnassigned;
6387
- /** Emitted when media from user domain is enabled. */
6388
- userDomainMediaEnabled?: UserDomainMediaEnabled;
6389
- /** Emitted when media from user domain is disabled. */
6390
- userDomainMediaDisabled?: UserDomainMediaDisabled;
6391
- /** Emitted when Editorless is attached. */
6392
- editorlessAssigned?: EditorlessAssigned;
6393
- /** Emitted when Editorless is detached. */
6394
- editorlessUnassigned?: EditorlessUnassigned;
6612
+ benefitId?: string;
6395
6613
  }
6396
- interface Asset {
6614
+ interface WixReceiptInfo {
6397
6615
  /**
6398
- * An application definition id (app_id in dev-center). For legacy reasons may be UUID or a string (from Java Enum).
6399
- * @maxLength 36
6616
+ * Receipt ID
6617
+ * @format GUID
6400
6618
  */
6401
- appDefId?: string;
6619
+ receiptId?: string;
6402
6620
  /**
6403
- * An instance id. For legacy reasons may be UUID or a string.
6404
- * @maxLength 200
6621
+ * Display number of receipt
6622
+ * @minLength 1
6623
+ * @maxLength 40
6405
6624
  */
6406
- instanceId?: string;
6407
- /** An application state. */
6408
- state?: StateWithLiterals;
6409
- }
6410
- declare enum State {
6411
- UNKNOWN = "UNKNOWN",
6412
- ENABLED = "ENABLED",
6413
- DISABLED = "DISABLED",
6414
- PENDING = "PENDING",
6415
- DEMO = "DEMO"
6625
+ displayNumber?: string | null;
6416
6626
  }
6417
- /** @enumType */
6418
- type StateWithLiterals = State | 'UNKNOWN' | 'ENABLED' | 'DISABLED' | 'PENDING' | 'DEMO';
6419
- interface SiteCreated {
6627
+ interface ExternalReceiptInfo {
6420
6628
  /**
6421
- * A template identifier (empty if not created from a template).
6422
- * @maxLength 36
6629
+ * External receipt ID
6630
+ * @maxLength 100
6423
6631
  */
6424
- originTemplateId?: string;
6632
+ receiptId?: string | null;
6425
6633
  /**
6426
- * An account id of the owner.
6634
+ * ID of the app providing the receipt
6427
6635
  * @format GUID
6428
6636
  */
6429
- ownerId?: string;
6430
- /** A context in which meta site was created. */
6431
- context?: SiteCreatedContextWithLiterals;
6637
+ appId?: string | null;
6432
6638
  /**
6433
- * A meta site id from which this site was created.
6434
- *
6435
- * In case of a creation from a template it's a template id.
6436
- * In case of a site duplication ("Save As" in dashboard or duplicate in UM) it's an id of a source site.
6437
- * @format GUID
6639
+ * Display number of receipt
6640
+ * @minLength 1
6641
+ * @maxLength 40
6438
6642
  */
6439
- originMetaSiteId?: string | null;
6643
+ displayNumber?: string | null;
6644
+ }
6645
+ interface CashRoundingDetails {
6440
6646
  /**
6441
- * A meta site name (URL slug).
6442
- * @maxLength 20
6647
+ * Payment amount before cash rounding was applied.
6648
+ * When provided, balance and status calculations use this value instead of `amount`
6649
+ * to prevent false overpayment or underpayment due to rounding.
6443
6650
  */
6444
- siteName?: string;
6445
- /** A namespace. */
6446
- namespace?: NamespaceWithLiterals;
6447
- }
6448
- declare enum SiteCreatedContext {
6449
- /** A valid option, we don't expose all reasons why site might be created. */
6450
- OTHER = "OTHER",
6451
- /** A meta site was created from template. */
6452
- FROM_TEMPLATE = "FROM_TEMPLATE",
6453
- /** A meta site was created by copying of the transfferred meta site. */
6454
- DUPLICATE_BY_SITE_TRANSFER = "DUPLICATE_BY_SITE_TRANSFER",
6455
- /** A copy of existing meta site. */
6456
- DUPLICATE = "DUPLICATE",
6457
- /** A meta site was created as a transfferred site (copy of the original), old flow, should die soon. */
6458
- OLD_SITE_TRANSFER = "OLD_SITE_TRANSFER",
6459
- /** deprecated A meta site was created for Flash editor. */
6460
- FLASH = "FLASH"
6461
- }
6462
- /** @enumType */
6463
- type SiteCreatedContextWithLiterals = SiteCreatedContext | 'OTHER' | 'FROM_TEMPLATE' | 'DUPLICATE_BY_SITE_TRANSFER' | 'DUPLICATE' | 'OLD_SITE_TRANSFER' | 'FLASH';
6464
- declare enum Namespace {
6465
- UNKNOWN_NAMESPACE = "UNKNOWN_NAMESPACE",
6466
- /** Default namespace for UGC sites. MetaSites with this namespace will be shown in a user's site list by default. */
6467
- WIX = "WIX",
6468
- /** 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. */
6469
- SHOUT_OUT = "SHOUT_OUT",
6470
- /** 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. */
6471
- ALBUMS = "ALBUMS",
6472
- /** 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. */
6473
- WIX_STORES_TEST_DRIVE = "WIX_STORES_TEST_DRIVE",
6474
- /** Hotels standalone (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6475
- HOTELS = "HOTELS",
6476
- /** 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. */
6477
- CLUBS = "CLUBS",
6478
- /** A partially created ADI website. MetaSites with this namespace will *not* be shown in a user's site list by default. */
6479
- ONBOARDING_DRAFT = "ONBOARDING_DRAFT",
6651
+ unroundedAmount?: Price;
6480
6652
  /**
6481
- * AppBuilder for AppStudio / shmite (c). MetaSites with this namespace will *not* be shown in a user's site list by default.
6482
- * Not the dev-center dev site (see Flag.DEV_CENTER_DEV_SITE_FLAG).
6653
+ * The difference between 'amount' and 'unroundedAmount' (amount minus unroundedAmount).
6654
+ * A positive value indicates the price was rounded up; a negative value indicates a round-down.
6655
+ * @readonly
6483
6656
  */
6484
- DEV_SITE = "DEV_SITE",
6485
- /** 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. */
6486
- LOGOS = "LOGOS",
6487
- /** 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. */
6488
- VIDEO_MAKER = "VIDEO_MAKER",
6489
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6490
- PARTNER_DASHBOARD = "PARTNER_DASHBOARD",
6491
- /** MetaSites with this namespace will *not* be shown in a user's site list by default. */
6492
- DEV_CENTER_COMPANY = "DEV_CENTER_COMPANY",
6657
+ roundingAdjustment?: CashRounding;
6658
+ }
6659
+ declare enum PaymentStatus {
6660
+ /** Payment was charged successfully. */
6661
+ APPROVED = "APPROVED",
6662
+ /** Payment is being processed and hasn't been confirmed yet. */
6663
+ PENDING = "PENDING",
6664
+ /** 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. */
6665
+ PENDING_MERCHANT = "PENDING_MERCHANT",
6666
+ /** Payment was canceled before it was charged. */
6667
+ CANCELED = "CANCELED",
6668
+ /** Payment was declined by the payment provider. */
6669
+ DECLINED = "DECLINED",
6670
+ /** Payment was fully refunded. */
6671
+ REFUNDED = "REFUNDED",
6672
+ /** Part of the payment amount was refunded. */
6673
+ PARTIALLY_REFUNDED = "PARTIALLY_REFUNDED",
6674
+ /** 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. */
6675
+ AUTHORIZED = "AUTHORIZED",
6493
6676
  /**
6494
- * A draft created by HTML editor on open. Upon "first save" it will be moved to be of WIX domain.
6677
+ * Payment was voided, releasing whatever it held or consumed: an authorization on the buyer's payment method, a gift card balance, or membership credits.
6495
6678
  *
6496
- * Meta site with this namespace will *not* be shown in a user's site list by default.
6679
+ * Gift card and membership payments don't support partial refunds, so a full refund of one is reported as `VOIDED` rather than `REFUNDED`.
6497
6680
  */
6498
- HTML_DRAFT = "HTML_DRAFT",
6681
+ VOIDED = "VOIDED"
6682
+ }
6683
+ /** @enumType */
6684
+ type PaymentStatusWithLiterals = PaymentStatus | 'APPROVED' | 'PENDING' | 'PENDING_MERCHANT' | 'CANCELED' | 'DECLINED' | 'REFUNDED' | 'PARTIALLY_REFUNDED' | 'AUTHORIZED' | 'VOIDED';
6685
+ interface CanceledStatusDetails {
6686
+ reason?: CanceledReasonWithLiterals;
6687
+ }
6688
+ declare enum CanceledReason {
6689
+ /** Other payment with the same chargeCorrelationId failed before current payment started. */
6690
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE",
6691
+ /** Payment was not completed by user and expired. */
6692
+ EXPIRED = "EXPIRED"
6693
+ }
6694
+ /** @enumType */
6695
+ type CanceledReasonWithLiterals = CanceledReason | 'OTHER_PAYMENT_FAILURE' | 'EXPIRED';
6696
+ interface DeclinedStatusDetails {
6697
+ reason?: DeclinedReasonWithLiterals;
6698
+ }
6699
+ declare enum DeclinedReason {
6700
+ /** Corresponding charge failed. */
6701
+ CHARGE_FAILED = "CHARGE_FAILED",
6702
+ /** Payment details expired. */
6703
+ EXPIRED = "EXPIRED",
6704
+ /** Insufficient funds. */
6705
+ INSUFFICIENT_FUNDS = "INSUFFICIENT_FUNDS",
6706
+ /** Gift card was disabled before charge was attempted. */
6707
+ GIFT_CARD_DISABLED = "GIFT_CARD_DISABLED"
6708
+ }
6709
+ /** @enumType */
6710
+ type DeclinedReasonWithLiterals = DeclinedReason | 'CHARGE_FAILED' | 'EXPIRED' | 'INSUFFICIENT_FUNDS' | 'GIFT_CARD_DISABLED';
6711
+ interface VoidedStatusDetails {
6712
+ reason?: VoidedReasonWithLiterals;
6713
+ }
6714
+ declare enum VoidedReason {
6715
+ /** Payment was voided by merchant request. */
6716
+ MERCHANT_REQUEST = "MERCHANT_REQUEST",
6717
+ /** Other payment with the same chargeCorrelationId failed and caused rollback of all payments with same chargeCorrelationId. */
6718
+ OTHER_PAYMENT_FAILURE = "OTHER_PAYMENT_FAILURE"
6719
+ }
6720
+ /** @enumType */
6721
+ type VoidedReasonWithLiterals = VoidedReason | 'MERCHANT_REQUEST' | 'OTHER_PAYMENT_FAILURE';
6722
+ interface PaymentStatusDetails extends PaymentStatusDetailsStatusDetailsOneOf {
6723
+ /** @internal */
6724
+ canceled?: CanceledStatusDetails;
6725
+ /** @internal */
6726
+ declined?: DeclinedStatusDetails;
6727
+ /** @internal */
6728
+ voided?: VoidedStatusDetails;
6499
6729
  /**
6500
- * the user-journey for Fitness users who want to start from managing their business instead of designing their website.
6501
- * Will be accessible from Site List and will not have a website app.
6502
- * Once the user attaches a site, the site will become a regular wixsite.
6730
+ * Reason code from the payment gateway.
6731
+ * @internal
6732
+ * @minLength 1
6733
+ * @maxLength 10
6503
6734
  */
6504
- SITELESS_BUSINESS = "SITELESS_BUSINESS",
6505
- /** Belongs to "strategic products" company. Supports new product in the creator's economy space. */
6506
- CREATOR_ECONOMY = "CREATOR_ECONOMY",
6507
- /** It is to be used in the Business First efforts. */
6508
- DASHBOARD_FIRST = "DASHBOARD_FIRST",
6509
- /** Bookings business flow with no site. */
6510
- ANYWHERE = "ANYWHERE",
6511
- /** Namespace for Headless Backoffice with no editor */
6512
- HEADLESS = "HEADLESS",
6735
+ paymentGatewayReasonCode?: string | null;
6736
+ }
6737
+ /** @oneof */
6738
+ interface PaymentStatusDetailsStatusDetailsOneOf {
6739
+ /** @internal */
6740
+ canceled?: CanceledStatusDetails;
6741
+ /** @internal */
6742
+ declined?: DeclinedStatusDetails;
6743
+ /** @internal */
6744
+ voided?: VoidedStatusDetails;
6745
+ }
6746
+ interface Refund {
6513
6747
  /**
6514
- * Namespace for master site that will exist in parent account that will be referenced by subaccounts
6515
- * The site will be used for account level CSM feature for enterprise
6748
+ * Refund ID.
6749
+ * @format GUID
6750
+ * @readonly
6516
6751
  */
6517
- ACCOUNT_MASTER_CMS = "ACCOUNT_MASTER_CMS",
6518
- /** Rise.ai Siteless account management for Gift Cards and Store Credit. */
6519
- RISE = "RISE",
6752
+ _id?: string;
6520
6753
  /**
6521
- * As part of the branded app new funnel, users now can create a meta site that will be branded app first.
6522
- * There's a blank site behind the scene but it's blank).
6523
- * The Mobile company will be the owner of this namespace.
6754
+ * List of transactions.
6755
+ * @maxSize 50
6524
6756
  */
6525
- BRANDED_FIRST = "BRANDED_FIRST",
6526
- /** Nownia.com Siteless account management for Ai Scheduling Assistant. */
6527
- NOWNIA = "NOWNIA",
6757
+ transactions?: RefundTransaction[];
6758
+ /** Refund business details. */
6759
+ details?: RefundDetails;
6528
6760
  /**
6529
- * UGC Templates are templates that are created by users for personal use and to sale to other users.
6530
- * The Partners company owns this namespace.
6761
+ * 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.
6762
+ * @readonly
6763
+ * @immutable
6531
6764
  */
6532
- UGC_TEMPLATE = "UGC_TEMPLATE",
6533
- /** Codux Headless Sites */
6534
- CODUX = "CODUX",
6535
- /** Bobb - AI Design Creator. */
6536
- MEDIA_DESIGN_CREATOR = "MEDIA_DESIGN_CREATOR",
6765
+ _createdDate?: Date | null;
6537
6766
  /**
6538
- * Shared Blog Site is a unique single site across Enterprise account,
6539
- * This site will hold all Blog posts related to the Marketing product.
6767
+ * Aggregated refund summary.
6768
+ * @readonly
6540
6769
  */
6541
- SHARED_BLOG_ENTERPRISE = "SHARED_BLOG_ENTERPRISE",
6542
- /** Standalone forms (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6543
- STANDALONE_FORMS = "STANDALONE_FORMS",
6544
- /** Standalone events (siteless). MetaSites with this namespace will *not* be shown in a user's site list by default. */
6545
- STANDALONE_EVENTS = "STANDALONE_EVENTS",
6546
- /** MIMIR - Siteless account for MIMIR Ai Job runner. */
6547
- MIMIR = "MIMIR",
6548
- /** Wix Twins platform. */
6549
- TWINS = "TWINS",
6550
- /** Wix Nano. */
6551
- NANO = "NANO",
6552
- /** Base44 headless sites. */
6553
- BASE44 = "BASE44",
6554
- /** Wix Channels Sites */
6555
- CHANNELS = "CHANNELS",
6556
- /** Nautilus platform. */
6557
- NAUTILUS = "NAUTILUS",
6770
+ summary?: AggregatedRefundSummary;
6558
6771
  /**
6559
- * Symphony — a siteless site representing a project within Symphony (the evolution of Orion).
6560
- * Holds project data, conversations, assets, and manages collaborators / shared team members for the project.
6772
+ * ID of the app that initiated this refund.
6773
+ * @format GUID
6774
+ * @readonly
6775
+ * @immutable
6561
6776
  */
6562
- SYMPHONY = "SYMPHONY",
6563
- /** Nautilus platform app. */
6564
- NAUTILUS_APPS = "NAUTILUS_APPS",
6777
+ requestingServiceAppId?: string | null;
6778
+ }
6779
+ interface RefundTransaction {
6565
6780
  /**
6566
- * Vibu — a siteless site representing a project built with Vibu (the AI app builder).
6567
- * Holds the project's generated code, conversations, assets, and manages collaborators for the project.
6781
+ * ID of the payment associated with this refund.
6782
+ * @format GUID
6783
+ * @immutable
6568
6784
  */
6569
- VIBU = "VIBU",
6785
+ paymentId?: string;
6570
6786
  /**
6571
- * Ghost site for the BrandKit multi-site platform. Each ghost backs a single BrandKit
6572
- * (an Enterprise account may have several), holding that BrandKit's brand definition
6573
- * (theme, typography, assets) which is rolled out to the BrandKit's connected sites.
6574
- * MetaSites with this namespace will *not* be shown in a user's site list by default.
6787
+ * Refund amount.
6788
+ * @immutable
6575
6789
  */
6576
- ENTERPRISE_BRAND_KIT = "ENTERPRISE_BRAND_KIT",
6790
+ amount?: Price;
6791
+ /** Refund status. */
6792
+ refundStatus?: RefundStatusWithLiterals;
6793
+ /** Optional details of current refund status. */
6794
+ refundStatusInfo?: RefundStatusInfo;
6577
6795
  /**
6578
- * Dev-center development sites (com.wixpress.devcenter.dsm).
6579
- * DEPRECATED: replaced by Flag.DEV_CENTER_DEV_SITE_FLAG (a dev site is orthogonal to the namespace). Do not use for new sites.
6796
+ * Payment gateway's refund ID.
6797
+ * This field is only returned when the value of `external_refund` is `false`.
6798
+ * @format GUID
6580
6799
  */
6581
- DEV_CENTER_DEV_SITE = "DEV_CENTER_DEV_SITE"
6582
- }
6583
- /** @enumType */
6584
- 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';
6585
- /** Site transferred to another user. */
6586
- interface SiteTransferred {
6800
+ gatewayRefundId?: string | null;
6801
+ /** ID of the refund in the payment provider's system. For example, at PayPal, Square, Stripe, etc. Not returned for external refunds. */
6802
+ providerRefundId?: string | null;
6587
6803
  /**
6588
- * A previous owner id (user that transfers meta site).
6589
- * @format GUID
6804
+ * Whether refund was made externally and manually on the payment provider's side.
6805
+ * @immutable
6590
6806
  */
6591
- oldOwnerId?: string;
6807
+ externalRefund?: boolean;
6592
6808
  /**
6593
- * A new owner id (user that accepts meta site).
6809
+ * Location where the refund was processed.
6810
+ * @internal
6594
6811
  * @format GUID
6812
+ * @immutable
6595
6813
  */
6596
- newOwnerId?: string;
6814
+ locationId?: string | null;
6597
6815
  }
6598
- /** Soft deletion of the meta site. Could be restored. */
6599
- interface SiteDeleted {
6600
- /** A deletion context. */
6601
- deleteContext?: DeleteContext;
6816
+ /** Refund transaction status. */
6817
+ declare enum RefundStatus {
6818
+ /** Refund was initiated on payment provider side. PENDING status was assigned by provider. */
6819
+ PENDING = "PENDING",
6820
+ /** Refund transaction succeeded. */
6821
+ SUCCEEDED = "SUCCEEDED",
6822
+ /** Refund transaction failed. */
6823
+ FAILED = "FAILED",
6824
+ /** Refund request acknowledged, and will be executed soon. */
6825
+ SCHEDULED = "SCHEDULED",
6826
+ /** Refund was initiated on payment provider side. */
6827
+ STARTED = "STARTED"
6602
6828
  }
6603
- interface DeleteContext {
6604
- /** When the meta site was deleted. */
6605
- dateDeleted?: Date | null;
6606
- /** A status. */
6607
- deleteStatus?: DeleteStatusWithLiterals;
6608
- /**
6609
- * A reason (flow).
6610
- * @maxLength 255
6611
- */
6612
- deleteOrigin?: string;
6829
+ /** @enumType */
6830
+ type RefundStatusWithLiterals = RefundStatus | 'PENDING' | 'SUCCEEDED' | 'FAILED' | 'SCHEDULED' | 'STARTED';
6831
+ interface RefundStatusInfo {
6613
6832
  /**
6614
- * A service that deleted it.
6615
- * @maxLength 255
6833
+ * Reason code for the refund's current status.
6834
+ *
6835
+ * Learn more about [reason codes](https://dev.wix.com/docs/rest/business-management/payments/service-plugins/payment-service-provider-service-plugin/reason-codes).
6836
+ * @minLength 1
6837
+ * @maxLength 10
6616
6838
  */
6617
- initiatorId?: string | null;
6618
- }
6619
- declare enum DeleteStatus {
6620
- UNKNOWN = "UNKNOWN",
6621
- TRASH = "TRASH",
6622
- DELETED = "DELETED",
6623
- PENDING_PURGE = "PENDING_PURGE",
6624
- PURGED_EXTERNALLY = "PURGED_EXTERNALLY"
6625
- }
6626
- /** @enumType */
6627
- type DeleteStatusWithLiterals = DeleteStatus | 'UNKNOWN' | 'TRASH' | 'DELETED' | 'PENDING_PURGE' | 'PURGED_EXTERNALLY';
6628
- /** Restoration of the meta site. */
6629
- interface SiteUndeleted {
6630
- }
6631
- /** First publish of a meta site. Or subsequent publish after unpublish. */
6632
- interface SitePublished {
6633
- }
6634
- interface SiteUnpublished {
6839
+ paymentGatewayReasonCode?: string | null;
6635
6840
  /**
6636
- * A list of URLs previously associated with the meta site.
6637
- * @maxLength 4000
6638
- * @maxSize 10000
6841
+ * Free text explanation of current refund status.
6842
+ * @minLength 1
6843
+ * @maxLength 1000
6639
6844
  */
6640
- urls?: string[];
6641
- }
6642
- interface SiteMarkedAsTemplate {
6845
+ description?: string | null;
6643
6846
  }
6644
- interface SiteMarkedAsWixSite {
6847
+ interface AggregatedRefundSummary {
6848
+ /** Total amount requested for refund. */
6849
+ requestedRefund?: Price;
6850
+ /** Pending refund amount - the portion of `requestedRefund` that is still pending. */
6851
+ pendingRefund?: Price;
6852
+ /** Refunded amount - the portion of `requestedRefund` that refunded successfully. */
6853
+ refunded?: Price;
6854
+ /** Failed refund amount - the portion of `requestedRefund` that failed. */
6855
+ failedRefundAmount?: Price;
6856
+ /** Whether at least one refund transaction is still in `"PENDING"` status. */
6857
+ pending?: boolean;
6858
+ /** Breakdown of refunded items. Available only after refund is complete. */
6859
+ breakdown?: RefundItemsBreakdown;
6645
6860
  }
6646
- /**
6647
- * Represents a service provisioned a site.
6648
- *
6649
- * Note on `origin_instance_id`:
6650
- * There is no guarantee that you will be able to find a meta site using `origin_instance_id`.
6651
- * This is because of the following scenario:
6652
- *
6653
- * Imagine you have a template where a third-party application (TPA) includes some stub data,
6654
- * such as a product catalog. When you create a site from this template, you inherit this
6655
- * default product catalog. However, if the template's product catalog is modified,
6656
- * your site will retain the catalog as it was at the time of site creation. This ensures that
6657
- * your site remains consistent with what you initially received and does not include any
6658
- * changes made to the original template afterward.
6659
- * To ensure this, the TPA on the template gets a new instance_id.
6660
- */
6661
- interface ServiceProvisioned {
6861
+ interface RefundItemsBreakdown {
6662
6862
  /**
6663
- * Either UUID or EmbeddedServiceType.
6664
- * @maxLength 36
6863
+ * Refunded line items and the amount refunded for each.
6864
+ * @maxSize 300
6665
6865
  */
6666
- appDefId?: string;
6866
+ lineItems?: LineItemRefundSummary[];
6867
+ }
6868
+ interface LineItemRefundSummary {
6667
6869
  /**
6668
- * Not only UUID. Something here could be something weird.
6669
- * @maxLength 36
6870
+ * ID of the refunded line item.
6871
+ * @format GUID
6670
6872
  */
6671
- instanceId?: string;
6873
+ lineItemId?: string;
6874
+ /** Total refunded amount for the line item. */
6875
+ totalRefundedAmount?: Price;
6876
+ }
6877
+ interface CalculateRefundRequest {
6672
6878
  /**
6673
- * An instance id from which this instance is originated.
6674
- * @maxLength 36
6879
+ * Order ID
6880
+ * @minLength 1
6881
+ * @maxLength 100
6675
6882
  */
6676
- originInstanceId?: string;
6883
+ ecomOrderId?: string;
6677
6884
  /**
6678
- * A version.
6679
- * @maxLength 500
6885
+ * Refunded line items and quantity
6886
+ * @maxSize 300
6680
6887
  */
6681
- version?: string | null;
6888
+ refundItems?: CalculateRefundItemRequest[];
6889
+ /** Should include shipping in refund calculation */
6890
+ refundShipping?: boolean;
6891
+ }
6892
+ interface CalculateRefundItemRequest {
6682
6893
  /**
6683
- * The origin meta site id
6894
+ * ID of the line item being refunded
6684
6895
  * @format GUID
6685
6896
  */
6686
- originMetaSiteId?: string | null;
6687
- }
6688
- interface ServiceRemoved {
6897
+ _id?: string;
6689
6898
  /**
6690
- * Either UUID or EmbeddedServiceType.
6691
- * @maxLength 36
6899
+ * How much of that line item is being refunded
6900
+ * @min 1
6901
+ * @max 100000
6692
6902
  */
6693
- appDefId?: string;
6903
+ quantity?: number;
6904
+ }
6905
+ interface CalculateRefundResponse {
6906
+ /** Total refundable amount */
6907
+ total?: Price;
6908
+ /** Tax cost of the order */
6909
+ tax?: Price;
6910
+ /** Discount given for this order */
6911
+ discount?: Price;
6912
+ /** Total cost of the order (without tax) */
6913
+ subtotal?: Price;
6914
+ /** Total shipping cost for order */
6915
+ shipping?: Price;
6916
+ /** Previous refund given on that order */
6917
+ previouslyRefundedAmount?: Price;
6694
6918
  /**
6695
- * Not only UUID. Something here could be something weird.
6696
- * @maxLength 36
6919
+ * The refundable items of that order
6920
+ * @maxSize 300
6697
6921
  */
6698
- instanceId?: string;
6922
+ items?: CalculateRefundItemResponse[];
6923
+ }
6924
+ interface CalculateRefundItemResponse {
6699
6925
  /**
6700
- * A version.
6701
- * @maxLength 500
6926
+ * Line item ID
6927
+ * @format GUID
6702
6928
  */
6703
- version?: string | null;
6929
+ _id?: string;
6930
+ /** Refundable amount for requested quantity of items (price of requested quantity of items without tax and discount) */
6931
+ price?: Price;
6704
6932
  }
6705
- /** Rename of the site. Meaning, free public url has been changed as well. */
6706
- interface SiteRenamed {
6933
+ interface VoidAuthorizedPaymentsRequest {
6707
6934
  /**
6708
- * A new meta site name (URL slug).
6709
- * @maxLength 20
6935
+ * Wix eCommerce order ID
6936
+ * @minLength 1
6937
+ * @maxLength 100
6710
6938
  */
6711
- newSiteName?: string;
6939
+ ecomOrderId: string;
6712
6940
  /**
6713
- * A previous meta site name (URL slug).
6714
- * @maxLength 255
6941
+ * Payment IDs
6942
+ * @minSize 1
6943
+ * @maxSize 100
6944
+ * @format GUID
6715
6945
  */
6716
- oldSiteName?: string;
6717
- }
6718
- /**
6719
- * Hard deletion of the meta site.
6720
- *
6721
- * Could not be restored. Therefore it's desirable to cleanup data.
6722
- */
6723
- interface SiteHardDeleted {
6724
- /** A deletion context. */
6725
- deleteContext?: DeleteContext;
6726
- }
6727
- interface NamespaceChanged {
6728
- /** A previous namespace. */
6729
- oldNamespace?: NamespaceWithLiterals;
6730
- /** A new namespace. */
6731
- newNamespace?: NamespaceWithLiterals;
6732
- }
6733
- /** Assigned Studio editor */
6734
- interface StudioAssigned {
6735
- }
6736
- /** Unassigned Studio editor */
6737
- interface StudioUnassigned {
6946
+ paymentIds: string[];
6738
6947
  }
6739
- /**
6740
- * Fired in case site URLs were changed in any way: new secondary domain, published, account slug rename, site rename etc.
6741
- *
6742
- * This is an internal event, it's not propagated in special events, because it's non-actionable. If you need to keep up
6743
- * with sites and its urls, you need to listen to another topic/event. Read about it:
6744
- *
6745
- * https://bo.wix.com/wix-docs/rest/meta-site/meta-site---urls-service
6746
- */
6747
- interface SiteUrlChanged {
6948
+ interface VoidAuthorizedPaymentsResponse {
6949
+ /** All order's transactions after the void was triggered */
6950
+ orderTransactions?: OrderTransactions;
6748
6951
  }
6749
- /**
6750
- * Used at the end of the deletion flow for both draft sites and when a user deletes a site.
6751
- * Consumed by other teams to remove relevant data.
6752
- */
6753
- interface SitePurgedExternally {
6952
+ interface CaptureAuthorizedPaymentsRequest {
6754
6953
  /**
6755
- * @maxLength 2048
6954
+ * Wix eCommerce order ID
6955
+ * @minLength 1
6956
+ * @maxLength 100
6957
+ */
6958
+ ecomOrderId: string;
6959
+ /**
6960
+ * Capture payments information
6961
+ * @minSize 1
6756
6962
  * @maxSize 100
6757
- * @deprecated
6758
- * @targetRemovalDate 2025-04-15
6759
6963
  */
6760
- appDefId?: string[];
6761
- }
6762
- /** Assigned Odeditor */
6763
- interface OdeditorAssigned {
6764
- }
6765
- /** Unassigned Odeditor */
6766
- interface OdeditorUnassigned {
6767
- }
6768
- /** Assigned Picasso editor */
6769
- interface PicassoAssigned {
6770
- }
6771
- /** Unassigned Picasso */
6772
- interface PicassoUnassigned {
6773
- }
6774
- /** Assigned Wixel */
6775
- interface WixelAssigned {
6776
- }
6777
- /** Unassigned Wixel */
6778
- interface WixelUnassigned {
6779
- }
6780
- /** Assigned StudioTwo */
6781
- interface StudioTwoAssigned {
6782
- }
6783
- /** Unassigned StudioTwo */
6784
- interface StudioTwoUnassigned {
6785
- }
6786
- /** Media from user domain is enabled. */
6787
- interface UserDomainMediaEnabled {
6788
- }
6789
- /** Media from user domain is disabled. */
6790
- interface UserDomainMediaDisabled {
6791
- }
6792
- /** Assigned Editorless */
6793
- interface EditorlessAssigned {
6794
- }
6795
- /** Unassigned Editorless */
6796
- interface EditorlessUnassigned {
6964
+ payments: PaymentCapture[];
6797
6965
  }
6798
- interface HasCustomEmailConfigurationsRequest {
6966
+ interface PaymentCapture {
6967
+ /**
6968
+ * Payment ID
6969
+ * @format GUID
6970
+ */
6971
+ paymentId?: string | null;
6972
+ /**
6973
+ * Capture amount.
6974
+ * If not provided - full authorized amount will be captured.
6975
+ */
6976
+ amount?: Price;
6799
6977
  }
6800
- interface HasCustomEmailConfigurationsResponse {
6801
- hasCustomConfigurations?: boolean;
6978
+ interface CaptureAuthorizedPaymentsResponse {
6979
+ /** All order's transactions after the capture was triggered */
6980
+ orderTransactions?: OrderTransactions;
6802
6981
  }
6803
- interface AddToAutomationMigrationPopulationRequest {
6804
- /** When true, sends custom email configurations to automation system via email */
6805
- sendCustomEmailConfigs?: boolean;
6806
- /** Origin of the migration request. Defaults to OPT_IN when UNKNOWN_ORIGIN. */
6807
- origin?: OriginWithLiterals;
6982
+ interface ChargeSavedPaymentMethodRequest {
6983
+ /**
6984
+ * Ecom Order ID.
6985
+ * @minLength 1
6986
+ * @maxLength 100
6987
+ */
6988
+ ecomOrderId?: string;
6989
+ /** Amount to be charged */
6990
+ amount?: Price;
6808
6991
  }
6809
- declare enum Origin {
6810
- OPT_IN = "OPT_IN",
6811
- MIGRATION = "MIGRATION"
6992
+ interface ChargeSavedPaymentMethodResponse {
6993
+ /** Payment gateway's order ID (e.g Wix Payments) */
6994
+ paymentGatewayOrderId?: string;
6812
6995
  }
6813
- /** @enumType */
6814
- type OriginWithLiterals = Origin | 'OPT_IN' | 'MIGRATION';
6815
- interface AddToAutomationMigrationPopulationResponse {
6816
- success?: boolean;
6996
+ interface V1TriggerReindexRequest {
6997
+ /** @format GUID */
6998
+ metasiteId?: string;
6999
+ /**
7000
+ * @minLength 1
7001
+ * @maxLength 100
7002
+ * @maxSize 100
7003
+ */
7004
+ orderIds?: string[];
6817
7005
  }
6818
- interface IsInAutomationMigrationPopulationRequest {
7006
+ interface V1TriggerReindexResponse {
6819
7007
  }
6820
- interface IsInAutomationMigrationPopulationResponse {
6821
- inPopulation?: boolean;
7008
+ interface V1TriggerReindexOrderRequest {
7009
+ /** @format GUID */
7010
+ metasiteId?: string;
7011
+ /**
7012
+ * @minLength 1
7013
+ * @maxLength 100
7014
+ */
7015
+ orderId?: string;
6822
7016
  }
6823
7017
  interface DiffmatokyPayload {
6824
7018
  left?: string;
@@ -9969,6 +10163,13 @@ interface UpdateOrder {
9969
10163
  * @immutable
9970
10164
  */
9971
10165
  taxIncludedInPrices?: boolean;
10166
+ /**
10167
+ * 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.
10168
+ * @internal
10169
+ * @readonly
10170
+ * @immutable
10171
+ */
10172
+ crossBorderRepricing?: CrossBorderRepricing;
9972
10173
  /**
9973
10174
  * Site language in which original values are shown.
9974
10175
  * @readonly
@@ -10447,6 +10648,12 @@ interface UpdateOrderLineItem {
10447
10648
  * @readonly
10448
10649
  */
10449
10650
  serviceProperties?: ServiceProperties;
10651
+ /**
10652
+ * 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.
10653
+ * @internal
10654
+ * @readonly
10655
+ */
10656
+ crossBorderAdjustment?: CrossBorderPriceAdjustment;
10450
10657
  }
10451
10658
  /**
10452
10659
  * Adds a merchant comment to an order.
@@ -10640,4 +10847,4 @@ interface BulkUpdateOrderTagsOptions {
10640
10847
  unassignTags?: TagsTags;
10641
10848
  }
10642
10849
 
10643
- export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, MembershipPaymentStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, LineItemQuantityChangeType as aA, ActivityType as aB, OrderActivityTypeEnumActivityType as aC, AttributionSource as aD, ChannelType as aE, AdditionalFeeSource as aF, OrderActionType as aG, SpecificItemsCouponBehavior as aH, ChargeType as aI, VersioningMode as aJ, DeltaPaymentOptionType as aK, InventoryAction as aL, WebhookIdentityType as aM, ScheduledAction as aN, DurationUnit as aO, PaymentCollectabilityStatus as aP, PredefinedPaymentMethod as aQ, RefundableStatus as aR, NonRefundableReason as aS, ManuallyRefundableReason as aT, RestockType as aU, TransactionStatus as aV, AuthorizationCaptureStatus as aW, AuthorizationVoidStatus as aX, Reason as aY, ActionType as aZ, ChargebackStatus as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, PaymentStatusEnumPaymentStatus as as, FulfillmentStatus as at, WeightUnit as au, VatType as av, PickupMethod as aw, OrderStatus as ax, DiscountType as ay, DiscountReason as az, type SetOrderNumberCounterResponse as b, type AddressWithContact as b$, PaymentStatus as b0, CanceledReason as b1, DeclinedReason as b2, VoidedReason as b3, RefundStatus as b4, PreviewEmailType as b5, State as b6, SiteCreatedContext as b7, Namespace as b8, DeleteStatus as b9, type LineItemTaxInfo as bA, type LineItemTaxBreakdown as bB, type DigitalFile as bC, type SubscriptionInfo as bD, type SubscriptionTitle as bE, type SubscriptionDescription as bF, type SubscriptionSettings as bG, type FreeTrialPeriod as bH, type BillingSettings as bI, type BillingAdjustment as bJ, type BillingAdjustmentPriceSummary as bK, type CyclePriceOverride as bL, type PriceDescription as bM, type LocationAndQuantity as bN, type TaxableAddress as bO, type TaxableAddressTaxableAddressDataOneOf as bP, type DecimalQuantity as bQ, type DecimalQuantityUnitOneOf as bR, type TranslatableString as bS, type ExtendedFields as bT, type ModifierGroup as bU, type ItemModifier as bV, type ServiceProperties as bW, type BuyerInfo as bX, type BuyerInfoIdOneOf as bY, type CurrencyConversionDetails as bZ, type PriceSummary as b_, Origin as ba, SortOrder as bb, OrderApprovalStrategy as bc, Placement as bd, SubdivisionType as be, SourceType as bf, CustomFieldGroup as bg, ValueType as bh, DepositType as bi, InvoiceStatus as bj, type OrderLineItem as bk, type ProductName as bl, type CatalogReference as bm, type DescriptionLine as bn, type DescriptionLineValueOneOf as bo, type DescriptionLineDescriptionLineValueOneOf as bp, type DescriptionLineName as bq, type PlainTextValue as br, type Color as bs, type FocalPoint as bt, type PhysicalProperties as bu, type Dimensions as bv, type ItemType as bw, type ItemTypeItemTypeDataOneOf as bx, type RestockLocation as by, type ItemTaxFullDetails as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedAsStoreCredit as c$, type Address as c0, type StreetAddress as c1, type AddressLocation as c2, type FullAddressContactDetails as c3, type VatId as c4, type V1ShippingInformation as c5, type DeliveryLogistics as c6, type DeliveryLogisticsAddressOneOf as c7, type PickupDetails as c8, type PickupAddress as c9, type OrderChangeValueOneOf as cA, type LineItemChanges as cB, type LineItemQuantityChange as cC, type LineItemPriceChange as cD, type LineItemProductNameChange as cE, type LineItemDescriptionLineChange as cF, type LineItemModifiersChange as cG, type ManagedLineItem as cH, type ManagedDiscount as cI, type TranslatedValue as cJ, type LineItemAmount as cK, type ManagedAdditionalFee as cL, type TotalPriceChange as cM, type ShippingInformationChange as cN, type ShippingInformation as cO, type SavedPaymentMethod as cP, type AuthorizedPaymentCreated as cQ, type AuthorizedPaymentCaptured as cR, type AuthorizedPaymentVoided as cS, type RefundInitiated as cT, type RefundedPayment as cU, type RefundedPaymentKindOneOf as cV, type RegularPaymentRefund as cW, type GiftCardPaymentRefund as cX, type MembershipPaymentRefund as cY, type PaymentRefunded as cZ, type PaymentRefundFailed as c_, type DeliveryTimeSlot as ca, type ShippingPrice as cb, type ShippingRegion as cc, type TaxSummary as cd, type OrderTaxInfo as ce, type OrderTaxBreakdown as cf, type AppliedDiscount as cg, type AppliedDiscountDiscountSourceOneOf as ch, type Coupon as ci, type MerchantDiscount as cj, type MerchantDiscountMerchantDiscountReasonOneOf as ck, type DiscountRule as cl, type DiscountRuleName as cm, type LineItemDiscount as cn, type ItemCombination as co, type ItemCombinationLineItem as cp, type Activity as cq, type ActivityContentOneOf as cr, type CustomActivity as cs, type MerchantComment as ct, type OrderRefunded as cu, type OrderCreatedFromExchange as cv, type NewExchangeOrderCreated as cw, type LineItemExchangeData as cx, type DraftOrderChangesApplied as cy, type OrderChange as cz, type PreparePaymentCollectionOptions as d, type ItemChangedDetails as d$, type PaymentPending as d0, type PaymentPendingPaymentDetailsOneOf as d1, type RegularPayment as d2, type RegularPaymentPaymentMethodDetailsOneOf as d3, type CreditCardDetails as d4, type PaymentCanceled as d5, type PaymentCanceledPaymentDetailsOneOf as d6, type PaymentDeclined as d7, type PaymentDeclinedPaymentDetailsOneOf as d8, type ReceiptCreated as d9, type FormIdentifier as dA, type PlatformFeeSummary as dB, type PlatformFee as dC, type UpdateInternalDocumentsEvent as dD, type UpdateInternalDocumentsEventOperationOneOf as dE, type InternalDocument as dF, type InternalDocumentUpdateOperation as dG, type DeleteByIdsOperation as dH, type DeleteByFilterOperation as dI, type InternalDocumentUpdateByFilterOperation as dJ, type InternalUpdateExistingOperation as dK, type VersionedDocumentUpdateOperation as dL, type VersionedDeleteByIdsOperation as dM, type VersionedDocumentId as dN, type OrderApproved as dO, type OrdersExperiments as dP, type OrderRejectedEventOrderRejected as dQ, type OrderItemsRestocked as dR, type V1RestockItem as dS, type OrderImported as dT, type ImportedOrderDeleted as dU, type PaymentStatusUpdated as dV, type FulfillmentStatusUpdated as dW, type OrderCanceledEventOrderCanceled as dX, type OrderDeltasCommitted as dY, type CommittedDiffs as dZ, type CommittedDiffsShippingUpdateInfoOneOf as d_, type ReceiptCreatedReceiptInfoOneOf as da, type WixReceipt as db, type ExternalReceipt as dc, type ReceiptSent as dd, type ReceiptSentReceiptInfoOneOf as de, type ChargebackCreated as df, type ChargebackReversed as dg, type CreatedBy as dh, type CreatedByStringOneOf as di, type ChannelInfo as dj, type CustomField as dk, type BalanceSummary as dl, type Balance as dm, type CashRounding as dn, type AdditionalFee as dp, type FulfillmentStatusesAggregate as dq, type Tags as dr, type TagList as ds, type Location as dt, type OrderSettings as du, type OrderSettingsAllowedActionsOneOf as dv, type OrderSettingsEditableByOneOf as dw, type CustomAllowedActions as dx, type OwnerApps as dy, type FormInfo as dz, type PreparePaymentCollectionResponse as e, type RestockItem as e$, type OrderLineItemChangedDetails as e0, type DecimalQuantityUpdate as e1, type LineItemDelta as e2, type LineItemDeltaDeltaOneOf as e3, type AppliedDiscountDelta as e4, type AppliedDiscountDeltaDeltaOneOf as e5, type AdditionalFeeDelta as e6, type AdditionalFeeDeltaDeltaOneOf as e7, type DraftOrderCommitSettings as e8, type InventoryUpdateDetails as e9, type RecordManuallyCollectedPaymentRequest as eA, type UserDefinedPaymentMethodName as eB, type UserDefinedPaymentMethodNameKindOneOf as eC, type RecordManuallyCollectedPaymentResponse as eD, type MarkOrderAsPaidRequest as eE, type BulkMarkOrdersAsPaidRequest as eF, type BulkOrderResult as eG, type ItemMetadata as eH, type ApplicationError as eI, type BulkActionMetadata as eJ, type GetRefundabilityStatusRequest as eK, type Refundability as eL, type RefundabilityAdditionalRefundabilityInfoOneOf as eM, type CreatePaymentGatewayOrderRequest as eN, type ChargedBy as eO, type ChargeMembershipsRequest as eP, type MembershipChargeItem as eQ, type MembershipName as eR, type ChargeMembershipsResponse as eS, type TriggerRefundRequest as eT, type RefundDetails as eU, type RefundItem as eV, type LineItemRefund as eW, type AdditionalFeeRefund as eX, type ShippingRefund as eY, type RefundSideEffects as eZ, type RestockInfo as e_, type TriggerReindexRequest as ea, type TriggerReindexResponse as eb, type DomainEvent as ec, type DomainEventBodyOneOf as ed, type EntityCreatedEvent as ee, type RestoreInfo as ef, type EntityUpdatedEvent as eg, type EntityDeletedEvent as eh, type ActionEvent as ei, type Empty as ej, type TriggerReindexOrderRequest as ek, type MessageEnvelope as el, type IdentificationData as em, type IdentificationDataIdOneOf as en, type AccountInfo as eo, type ImportOrderRequest as ep, type SetOrderNumberCounterRequest as eq, type BulkDeleteImportedOrdersRequest as er, type V1TriggerReindexRequest as es, type V1TriggerReindexResponse as et, type V1TriggerReindexOrderRequest as eu, type PreparePaymentCollectionRequest as ev, type RedirectUrls as ew, type DelayedCaptureSettings as ex, type Duration as ey, type GetPaymentCollectabilityStatusRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type PreviewEmailByTypeResponse as f$, type OrderTransactions as f0, type Payment as f1, type PaymentPaymentDetailsOneOf as f2, type PaymentReceiptInfoOneOf as f3, type PaymentStatusDetailsOneOf as f4, type RegularPaymentDetails as f5, type RegularPaymentDetailsPaymentMethodDetailsOneOf as f6, type CreditCardPaymentMethodDetails as f7, type AuthorizationDetails as f8, type AuthorizationCapture as f9, type VoidAuthorizedPaymentsRequest as fA, type CaptureAuthorizedPaymentsRequest as fB, type ChargeSavedPaymentMethodRequest as fC, type ChargeSavedPaymentMethodResponse as fD, type SendBuyerConfirmationEmailRequest as fE, type SendBuyerConfirmationEmailResponse as fF, type SendBuyerPaymentsReceivedEmailRequest as fG, type SendBuyerPaymentsReceivedEmailResponse as fH, type SendBuyerPickupConfirmationEmailRequest as fI, type SendBuyerPickupConfirmationEmailResponse as fJ, type BulkSendBuyerPickupConfirmationEmailsRequest as fK, type BulkSendBuyerPickupConfirmationEmailsResponse as fL, type SendBuyerShippingConfirmationEmailRequest as fM, type SendBuyerShippingConfirmationEmailResponse as fN, type BulkSendBuyerShippingConfirmationEmailsRequest as fO, type BulkSendBuyerShippingConfirmationEmailsResponse as fP, type SendMerchantOrderReceivedNotificationRequest as fQ, type SendMerchantOrderReceivedNotificationResponse as fR, type SendCancelRefundEmailRequest as fS, type SendCancelRefundEmailResponse as fT, type SendRefundEmailRequest as fU, type SendRefundEmailResponse as fV, type SendFulfillmentEmailRequest as fW, type SendFulfillmentEmailResponse as fX, type SendMerchantOrderReceivedPushRequest as fY, type SendMerchantOrderReceivedPushResponse as fZ, type PreviewEmailByTypeRequest as f_, type AuthorizationActionFailureDetails as fa, type AuthorizationVoid as fb, type V1ScheduledAction as fc, type Chargeback as fd, type PaymentMethodName as fe, type GiftCardPaymentDetails as ff, type MembershipPaymentDetails as fg, type FutureMembershipDetails as fh, type WixReceiptInfo as fi, type ExternalReceiptInfo as fj, type CashRoundingDetails as fk, type CanceledStatusDetails as fl, type DeclinedStatusDetails as fm, type VoidedStatusDetails as fn, type PaymentStatusDetails as fo, type PaymentStatusDetailsStatusDetailsOneOf as fp, type Refund as fq, type RefundTransaction as fr, type RefundStatusInfo as fs, type AggregatedRefundSummary as ft, type RefundItemsBreakdown as fu, type LineItemRefundSummary as fv, type CalculateRefundRequest as fw, type CalculateRefundItemRequest as fx, type CalculateRefundResponse as fy, type CalculateRefundItemResponse as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type PlatformPaging as g$, type PreviewRefundEmailRequest as g0, type PreviewRefundEmailResponse as g1, type PreviewCancelEmailRequest as g2, type PreviewCancelEmailResponse as g3, type PreviewCancelRefundEmailRequest as g4, type PreviewCancelRefundEmailResponse as g5, type PreviewBuyerPaymentsReceivedEmailRequest as g6, type PreviewBuyerPaymentsReceivedEmailResponse as g7, type PreviewBuyerConfirmationEmailRequest as g8, type PreviewBuyerConfirmationEmailResponse as g9, type SitePurgedExternally as gA, type OdeditorAssigned as gB, type OdeditorUnassigned as gC, type PicassoAssigned as gD, type PicassoUnassigned as gE, type WixelAssigned as gF, type WixelUnassigned as gG, type StudioTwoAssigned as gH, type StudioTwoUnassigned as gI, type UserDomainMediaEnabled as gJ, type UserDomainMediaDisabled as gK, type EditorlessAssigned as gL, type EditorlessUnassigned as gM, type HasCustomEmailConfigurationsRequest as gN, type HasCustomEmailConfigurationsResponse as gO, type AddToAutomationMigrationPopulationRequest as gP, type AddToAutomationMigrationPopulationResponse as gQ, type IsInAutomationMigrationPopulationRequest as gR, type IsInAutomationMigrationPopulationResponse as gS, type DiffmatokyPayload as gT, type ErrorInformation as gU, type GetOrderRequest as gV, type GetOrderResponse as gW, type InternalQueryOrdersRequest as gX, type PlatformQuery as gY, type PlatformQueryPagingMethodOneOf as gZ, type Sorting as g_, type PreviewBuyerPickupConfirmationEmailRequest as ga, type PreviewBuyerPickupConfirmationEmailResponse as gb, type PreviewShippingConfirmationEmailRequest as gc, type PreviewShippingConfirmationEmailResponse as gd, type PreviewResendDownloadLinksEmailRequest as ge, type PreviewResendDownloadLinksEmailResponse as gf, type MetaSiteSpecialEvent as gg, type MetaSiteSpecialEventPayloadOneOf as gh, type Asset as gi, type SiteCreated as gj, type SiteTransferred as gk, type SiteDeleted as gl, type DeleteContext as gm, type SiteUndeleted as gn, type SitePublished as go, type SiteUnpublished as gp, type SiteMarkedAsTemplate as gq, type SiteMarkedAsWixSite as gr, type ServiceProvisioned as gs, type ServiceRemoved as gt, type SiteRenamed as gu, type SiteHardDeleted as gv, type NamespaceChanged as gw, type StudioAssigned as gx, type StudioUnassigned as gy, type SiteUrlChanged as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type TrackingLinkAdded as h$, type CursorPaging as h0, type InternalQueryOrdersResponse as h1, type PlatformPagingMetadata as h2, type Cursors as h3, type QueryOrderRequest as h4, type QueryOrderResponse as h5, type SearchOrdersRequest as h6, type CursorSearch as h7, type CursorSearchPagingMethodOneOf as h8, type CursorPagingMetadata as h9, type BulkUnArchiveOrdersResponse as hA, type BulkUnArchiveOrdersByFilterRequest as hB, type BulkUnArchiveOrdersByFilterResponse as hC, type UpdateBuyerInfoRequest as hD, type BuyerInfoUpdate as hE, type UpdateBuyerInfoResponse as hF, type UpdateBuyerEmailRequest as hG, type UpdateBuyerEmailResponse as hH, type UpdateOrderShippingAddressRequest as hI, type UpdateOrderShippingAddressResponse as hJ, type UpdateBillingContactDetailsRequest as hK, type UpdateBillingContactDetailsResponse as hL, type UpdateOrderLineItemRequest as hM, type UpdateOrderLineItemsRequest as hN, type MaskedOrderLineItem as hO, type UpdateOrderLineItemsResponse as hP, type AddInternalActivityRequest as hQ, type InternalActivity as hR, type InternalActivityContentOneOf as hS, type OrderPlaced as hT, type OrderPaid as hU, type OrderFulfilled as hV, type OrderNotFulfilled as hW, type OrderCanceled as hX, type DownloadLinkSent as hY, type TrackingNumberAdded as hZ, type TrackingNumberEdited as h_, type CreateOrderRequest as ha, type OrderCreationSettings as hb, type OrderCreationSettingsEditableByOneOf as hc, type OrderCreateNotifications as hd, type CreateOrderResponse as he, type UpdateOrderRequest as hf, type UpdateOrderResponse as hg, type BulkUpdateOrdersRequest as hh, type CommitDeltasRequest as hi, type DraftOrderDiffs as hj, type DraftOrderDiffsShippingUpdateInfoOneOf as hk, type DraftOrderDiffsBuyerUpdateInfoOneOf as hl, type DraftOrderDiffsBillingUpdateInfoOneOf as hm, type DraftOrderDiffsRecipientUpdateInfoOneOf as hn, type V1LineItemDelta as ho, type V1LineItemDeltaDeltaOneOf as hp, type CommitDeltasResponse as hq, type ArchiveOrderRequest as hr, type ArchiveOrderResponse as hs, type BulkArchiveOrdersRequest as ht, type BulkArchiveOrdersResponse as hu, type BulkArchiveOrdersByFilterRequest as hv, type BulkArchiveOrdersByFilterResponse as hw, type UnArchiveOrderRequest as hx, type UnArchiveOrderResponse as hy, type BulkUnArchiveOrdersRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type Cancel as i$, type ShippingConfirmationEmailSent as i0, type InvoiceAdded as i1, type InvoiceSent as i2, type FulfillerEmailSent as i3, type ShippingAddressEdited as i4, type EmailEdited as i5, type PickupReadyEmailSent as i6, type OrderPartiallyPaid as i7, type OrderPending as i8, type OrderRejected as i9, type BulkMarkAsUnfulfilledByFilterResponse as iA, type BulkSetBusinessLocationRequest as iB, type BulkSetBusinessLocationResponse as iC, type BulkSetBusinessLocationResult as iD, type V1MarkOrderAsPaidRequest as iE, type V1MarkOrderAsPaidResponse as iF, type V1BulkMarkOrdersAsPaidRequest as iG, type V1BulkMarkOrdersAsPaidResponse as iH, type V1CreatePaymentGatewayOrderRequest as iI, type V1CreatePaymentGatewayOrderResponse as iJ, type GetShipmentsRequest as iK, type GetShipmentsResponse as iL, type AggregateOrdersRequest as iM, type DecrementItemsQuantityRequest as iN, type DecrementData as iO, type DecrementItemsQuantityResponse as iP, type BulkUpdateOrderTagsRequest as iQ, type TagsTags as iR, type TagsTagList as iS, type BulkUpdateOrderTagsResult as iT, type SendOrderUpdatedDomainEventRequest as iU, type SendOrderUpdatedDomainEventResponse as iV, type Task as iW, type TaskKey as iX, type TaskAction as iY, type TaskActionActionOneOf as iZ, type Complete as i_, type AddInternalActivityResponse as ia, type AddActivityRequest as ib, type PublicActivityContentOneOf as ic, type AddActivitiesRequest as id, type UpdateActivityRequest as ie, type DeleteActivityRequest as ig, type UpdateLineItemsDescriptionLinesRequest as ih, type LineItemUpdate as ii, type UpdateLineItemsDescriptionLinesResponse as ij, type MarkOrderAsSeenByHumanRequest as ik, type MarkOrderAsSeenByHumanResponse as il, type CancelOrderRequest as im, type UpdateOrderStatusRequest as io, type MarkAsFulfilledRequest as ip, type MarkAsFulfilledResponse as iq, type BulkMarkAsFulfilledRequest as ir, type BulkMarkAsFulfilledResponse as is, type BulkMarkAsFulfilledByFilterRequest as it, type BulkMarkAsFulfilledByFilterResponse as iu, type MarkAsUnfulfilledRequest as iv, type MarkAsUnfulfilledResponse as iw, type BulkMarkAsUnfulfilledRequest as ix, type BulkMarkAsUnfulfilledResponse as iy, type BulkMarkAsUnfulfilledByFilterRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type AdditionalFeeSourceWithLiterals as j$, type Reschedule as j0, type InvoiceSentEvent as j1, type IdAndVersion as j2, type InvoiceFields as j3, type Customer as j4, type Email as j5, type QuotesAddress as j6, type AddressDescription as j7, type Phone as j8, type Company as j9, type BaseEventMetadata as jA, type EventMetadata as jB, type AccountInfoMetadata as jC, type OrderSearchSpec as jD, utils as jE, type DescriptionLineTypeWithLiterals as jF, type DimensionsUnitWithLiterals as jG, type ItemTypePresetWithLiterals as jH, type PaymentOptionTypeWithLiterals as jI, type JurisdictionTypeWithLiterals as jJ, type SubscriptionFrequencyWithLiterals as jK, type ProductPeriodAlignmentWithLiterals as jL, type AdjustmentTypeWithLiterals as jM, type TaxableAddressTypeWithLiterals as jN, type MeasurementUnitWithLiterals as jO, type PaymentStatusEnumPaymentStatusWithLiterals as jP, type FulfillmentStatusWithLiterals as jQ, type WeightUnitWithLiterals as jR, type VatTypeWithLiterals as jS, type PickupMethodWithLiterals as jT, type DiscountTypeWithLiterals as jU, type DiscountReasonWithLiterals as jV, type LineItemQuantityChangeTypeWithLiterals as jW, type ActivityTypeWithLiterals as jX, type OrderActivityTypeEnumActivityTypeWithLiterals as jY, type AttributionSourceWithLiterals as jZ, type ChannelTypeWithLiterals as j_, type CommonAddress as ja, type CommonAddressStreetOneOf as jb, type Subdivision as jc, type StandardDetails as jd, type ShippingContactDetails as je, type InvoiceDates as jf, type LineItems as jg, type LineItem as jh, type BigDecimalWrapper as ji, type LineItemTax as jj, type Source as jk, type LineItemMetaData as jl, type Locale as jm, type TotalPrice as jn, type ItemizedFee as jo, type Discount as jp, type DiscountOneDiscountTypeOneOf as jq, type CalculatedTaxes as jr, type CalculatedTax as js, type Payments as jt, type InvoicesPayment as ju, type MetaData as jv, type InvoiceDynamicPriceTotals as jw, type CustomFieldValue as jx, type Value as jy, type Deposit as jz, type GetRefundabilityStatusResponse as k, triggerRefund as k$, type OrderActionTypeWithLiterals as k0, type SpecificItemsCouponBehaviorWithLiterals as k1, type ChargeTypeWithLiterals as k2, type VersioningModeWithLiterals as k3, type DeltaPaymentOptionTypeWithLiterals as k4, type InventoryActionWithLiterals as k5, type WebhookIdentityTypeWithLiterals as k6, type ScheduledActionWithLiterals as k7, type DurationUnitWithLiterals as k8, type PaymentCollectabilityStatusWithLiterals as k9, type SubdivisionTypeWithLiterals as kA, type SourceTypeWithLiterals as kB, type CustomFieldGroupWithLiterals as kC, type ValueTypeWithLiterals as kD, type DepositTypeWithLiterals as kE, type InvoiceStatusWithLiterals as kF, type CommonSearchWithEntityContext as kG, onOrderApproved as kH, onOrderCanceled as kI, onOrderCommitted as kJ, onOrderCreated as kK, onOrderFulfilled as kL, onOrderImported as kM, onOrderImportedOrderDeleted as kN, onOrderPaymentStatusUpdated as kO, onOrderUpdated as kP, importOrder as kQ, setOrderNumberCounter as kR, bulkDeleteImportedOrders as kS, preparePaymentCollection as kT, getPaymentCollectabilityStatus as kU, recordManuallyCollectedPayment as kV, paymentCollectionMarkOrderAsPaid as kW, paymentCollectionBulkMarkOrdersAsPaid as kX, getRefundabilityStatus as kY, paymentCollectionCreatePaymentGatewayOrder as kZ, chargeMemberships as k_, type PredefinedPaymentMethodWithLiterals as ka, type RefundableStatusWithLiterals as kb, type NonRefundableReasonWithLiterals as kc, type ManuallyRefundableReasonWithLiterals as kd, type RestockTypeWithLiterals as ke, type TransactionStatusWithLiterals as kf, type AuthorizationCaptureStatusWithLiterals as kg, type AuthorizationVoidStatusWithLiterals as kh, type ReasonWithLiterals as ki, type ActionTypeWithLiterals as kj, type ChargebackStatusWithLiterals as kk, type MembershipPaymentStatusWithLiterals as kl, type PaymentStatusWithLiterals as km, type CanceledReasonWithLiterals as kn, type DeclinedReasonWithLiterals as ko, type VoidedReasonWithLiterals as kp, type RefundStatusWithLiterals as kq, type PreviewEmailTypeWithLiterals as kr, type StateWithLiterals as ks, type SiteCreatedContextWithLiterals as kt, type NamespaceWithLiterals as ku, type DeleteStatusWithLiterals as kv, type OriginWithLiterals as kw, type SortOrderWithLiterals as kx, type OrderApprovalStrategyWithLiterals as ky, type PlacementWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, voidAuthorizedPayments as l0, captureAuthorizedPayments as l1, getOrder as l2, createOrder as l3, updateOrder as l4, bulkUpdateOrders as l5, updateOrderLineItem as l6, addActivity as l7, addActivities as l8, updateActivity as l9, deleteActivity as la, cancelOrder as lb, updateOrderStatus as lc, aggregateOrders as ld, bulkUpdateOrderTags as le, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };
10850
+ export { type CancelOrderOptions as $, type UpdateOrderApplicationErrors as A, type BulkDeleteImportedOrdersResponse as B, type CreatePaymentGatewayOrderResponse as C, type MaskedOrder as D, type BulkUpdateOrdersOptions as E, type BulkUpdateOrdersResponse as F, type GetPaymentCollectabilityStatusResponse as G, type UpdateOrderLineItemIdentifiers as H, type ImportOrderResponse as I, type UpdateOrderLineItem as J, type UpdateOrderLineItemResponse as K, type PublicActivity as L, type MarkOrderAsPaidResponse as M, type AddActivityResponse as N, type Order as O, type Price as P, type AddActivitiesOptions as Q, type RecordManuallyCollectedPaymentOptions as R, type SetOrderNumberCounterOptions as S, type TriggerRefundOptions as T, type UpdateOrder as U, type VoidAuthorizedPaymentsResponse as V, type AddActivitiesResponse as W, type UpdateActivityIdentifiers as X, type UpdateActivityResponse as Y, type DeleteActivityIdentifiers as Z, type DeleteActivityResponse as _, type ImportOrderApplicationErrors as a, RefundableStatus as a$, type CancelOrderResponse as a0, type CancelOrderApplicationErrors as a1, type OrderStatusWithLiterals as a2, type UpdateOrderStatusResponse as a3, type UpdateOrderStatusApplicationErrors as a4, type AggregateOrdersOptions as a5, type AggregateOrdersResponse as a6, type BulkUpdateOrderTagsOptions as a7, type BulkUpdateOrderTagsResponse as a8, type OrderApprovedEnvelope as a9, CrossBorderNotApplicableReason as aA, CrossBorderRepricingMode as aB, DiscountType as aC, DiscountReason as aD, LineItemQuantityChangeType as aE, ActivityType as aF, OrderActivityTypeEnumActivityType as aG, AttributionSource as aH, ChannelType as aI, AdditionalFeeSource as aJ, OrderActionType as aK, SpecificItemsCouponBehavior as aL, ChargeType as aM, VersioningMode as aN, DeltaPaymentOptionType as aO, InventoryAction as aP, WebhookIdentityType as aQ, PreviewEmailType as aR, State as aS, SiteCreatedContext as aT, Namespace as aU, DeleteStatus as aV, Origin as aW, ScheduledAction as aX, DurationUnit as aY, PaymentCollectabilityStatus as aZ, PredefinedPaymentMethod as a_, type OrderCanceledEnvelope as aa, type OrderCommittedEnvelope as ab, type OrderCreatedEnvelope as ac, type OrderFulfilledEnvelope as ad, type OrderImportedEnvelope as ae, type OrderImportedOrderDeletedEnvelope as af, type OrderPaymentStatusUpdatedEnvelope as ag, type OrderUpdatedEnvelope as ah, DescriptionLineType as ai, DimensionsUnit as aj, ItemTypePreset as ak, PaymentOptionType as al, JurisdictionType as am, SubscriptionFrequency as an, ProductPeriodAlignment as ao, AdjustmentType as ap, TaxableAddressType as aq, MeasurementUnit as ar, RepriceStatus as as, BaseRateSource as at, PaymentStatusEnumPaymentStatus as au, FulfillmentStatus as av, WeightUnit as aw, VatType as ax, PickupMethod as ay, OrderStatus as az, type SetOrderNumberCounterResponse as b, type CrossBorderPriceAdjustment as b$, NonRefundableReason as b0, ManuallyRefundableReason as b1, RestockType as b2, TransactionStatus as b3, AuthorizationCaptureStatus as b4, AuthorizationVoidStatus as b5, Reason as b6, ActionType as b7, ChargebackStatus as b8, MembershipPaymentStatus as b9, type ItemType as bA, type ItemTypeItemTypeDataOneOf as bB, type RestockLocation as bC, type ItemTaxFullDetails as bD, type LineItemTaxInfo as bE, type LineItemTaxBreakdown as bF, type DigitalFile as bG, type SubscriptionInfo as bH, type SubscriptionTitle as bI, type SubscriptionDescription as bJ, type SubscriptionSettings as bK, type FreeTrialPeriod as bL, type BillingSettings as bM, type BillingAdjustment as bN, type BillingAdjustmentPriceSummary as bO, type CyclePriceOverride as bP, type PriceDescription as bQ, type LocationAndQuantity as bR, type TaxableAddress as bS, type TaxableAddressTaxableAddressDataOneOf as bT, type DecimalQuantity as bU, type DecimalQuantityUnitOneOf as bV, type TranslatableString as bW, type ExtendedFields as bX, type ModifierGroup as bY, type ItemModifier as bZ, type ServiceProperties as b_, PaymentStatus as ba, CanceledReason as bb, DeclinedReason as bc, VoidedReason as bd, RefundStatus as be, SortOrder as bf, OrderApprovalStrategy as bg, Placement as bh, SubdivisionType as bi, SourceType as bj, CustomFieldGroup as bk, ValueType as bl, DepositType as bm, InvoiceStatus as bn, type OrderLineItem as bo, type ProductName as bp, type CatalogReference as bq, type DescriptionLine as br, type DescriptionLineValueOneOf as bs, type DescriptionLineDescriptionLineValueOneOf as bt, type DescriptionLineName as bu, type PlainTextValue as bv, type Color as bw, type FocalPoint as bx, type PhysicalProperties as by, type Dimensions as bz, type SetOrderNumberCounterApplicationErrors as c, type RefundedPayment as c$, type BuyerInfo as c0, type BuyerInfoIdOneOf as c1, type CurrencyConversionDetails as c2, type CrossBorderRepricing as c3, type PriceSummary as c4, type AddressWithContact as c5, type Address as c6, type StreetAddress as c7, type AddressLocation as c8, type FullAddressContactDetails as c9, type MerchantComment as cA, type OrderRefunded as cB, type OrderCreatedFromExchange as cC, type NewExchangeOrderCreated as cD, type LineItemExchangeData as cE, type DraftOrderChangesApplied as cF, type OrderChange as cG, type OrderChangeValueOneOf as cH, type LineItemChanges as cI, type LineItemQuantityChange as cJ, type LineItemPriceChange as cK, type LineItemProductNameChange as cL, type LineItemDescriptionLineChange as cM, type LineItemModifiersChange as cN, type ManagedLineItem as cO, type ManagedDiscount as cP, type TranslatedValue as cQ, type LineItemAmount as cR, type ManagedAdditionalFee as cS, type TotalPriceChange as cT, type ShippingInformationChange as cU, type ShippingInformation as cV, type SavedPaymentMethod as cW, type AuthorizedPaymentCreated as cX, type AuthorizedPaymentCaptured as cY, type AuthorizedPaymentVoided as cZ, type RefundInitiated as c_, type VatId as ca, type V1ShippingInformation as cb, type DeliveryLogistics as cc, type DeliveryLogisticsAddressOneOf as cd, type PickupDetails as ce, type PickupAddress as cf, type DeliveryTimeSlot as cg, type ShippingPrice as ch, type ShippingRegion as ci, type TaxSummary as cj, type OrderTaxInfo as ck, type OrderTaxBreakdown as cl, type CrossBorderCalculation as cm, type AppliedDiscount as cn, type AppliedDiscountDiscountSourceOneOf as co, type Coupon as cp, type MerchantDiscount as cq, type MerchantDiscountMerchantDiscountReasonOneOf as cr, type DiscountRule as cs, type DiscountRuleName as ct, type LineItemDiscount as cu, type ItemCombination as cv, type ItemCombinationLineItem as cw, type Activity as cx, type ActivityContentOneOf as cy, type CustomActivity as cz, type PreparePaymentCollectionOptions as d, type ImportedOrderDeleted as d$, type RefundedPaymentKindOneOf as d0, type RegularPaymentRefund as d1, type GiftCardPaymentRefund as d2, type MembershipPaymentRefund as d3, type PaymentRefunded as d4, type PaymentRefundFailed as d5, type RefundedAsStoreCredit as d6, type PaymentPending as d7, type PaymentPendingPaymentDetailsOneOf as d8, type RegularPayment as d9, type Location as dA, type OrderSettings as dB, type OrderSettingsAllowedActionsOneOf as dC, type OrderSettingsEditableByOneOf as dD, type CustomAllowedActions as dE, type OwnerApps as dF, type FormInfo as dG, type FormIdentifier as dH, type PlatformFeeSummary as dI, type PlatformFee as dJ, type UpdateInternalDocumentsEvent as dK, type UpdateInternalDocumentsEventOperationOneOf as dL, type InternalDocument as dM, type InternalDocumentUpdateOperation as dN, type DeleteByIdsOperation as dO, type DeleteByFilterOperation as dP, type InternalDocumentUpdateByFilterOperation as dQ, type InternalUpdateExistingOperation as dR, type VersionedDocumentUpdateOperation as dS, type VersionedDeleteByIdsOperation as dT, type VersionedDocumentId as dU, type OrderApproved as dV, type OrdersExperiments as dW, type OrderRejectedEventOrderRejected as dX, type OrderItemsRestocked as dY, type V1RestockItem as dZ, type OrderImported as d_, type RegularPaymentPaymentMethodDetailsOneOf as da, type CreditCardDetails as db, type PaymentCanceled as dc, type PaymentCanceledPaymentDetailsOneOf as dd, type PaymentDeclined as de, type PaymentDeclinedPaymentDetailsOneOf as df, type ReceiptCreated as dg, type ReceiptCreatedReceiptInfoOneOf as dh, type WixReceipt as di, type ExternalReceipt as dj, type ReceiptSent as dk, type ReceiptSentReceiptInfoOneOf as dl, type ChargebackCreated as dm, type ChargebackReversed as dn, type CreatedBy as dp, type CreatedByStringOneOf as dq, type ChannelInfo as dr, type CustomField as ds, type BalanceSummary as dt, type Balance as du, type CashRounding as dv, type AdditionalFee as dw, type FulfillmentStatusesAggregate as dx, type Tags as dy, type TagList as dz, type PreparePaymentCollectionResponse as e, type LineItemRefund as e$, type PaymentStatusUpdated as e0, type FulfillmentStatusUpdated as e1, type OrderCanceledEventOrderCanceled as e2, type OrderDeltasCommitted as e3, type CommittedDiffs as e4, type CommittedDiffsShippingUpdateInfoOneOf as e5, type ItemChangedDetails as e6, type OrderLineItemChangedDetails as e7, type DecimalQuantityUpdate as e8, type CrossBorderAdjustmentUpdate as e9, type SendBuyerConfirmationEmailRequest as eA, type SendBuyerConfirmationEmailResponse as eB, type SendBuyerPaymentsReceivedEmailRequest as eC, type SendBuyerPaymentsReceivedEmailResponse as eD, type SendBuyerPickupConfirmationEmailRequest as eE, type SendBuyerPickupConfirmationEmailResponse as eF, type BulkSendBuyerPickupConfirmationEmailsRequest as eG, type BulkSendBuyerPickupConfirmationEmailsResponse as eH, type SendBuyerShippingConfirmationEmailRequest as eI, type SendBuyerShippingConfirmationEmailResponse as eJ, type BulkSendBuyerShippingConfirmationEmailsRequest as eK, type BulkSendBuyerShippingConfirmationEmailsResponse as eL, type SendMerchantOrderReceivedNotificationRequest as eM, type SendMerchantOrderReceivedNotificationResponse as eN, type SendCancelRefundEmailRequest as eO, type SendCancelRefundEmailResponse as eP, type SendRefundEmailRequest as eQ, type SendRefundEmailResponse as eR, type SendFulfillmentEmailRequest as eS, type SendFulfillmentEmailResponse as eT, type SendMerchantOrderReceivedPushRequest as eU, type SendMerchantOrderReceivedPushResponse as eV, type PreviewEmailByTypeRequest as eW, type PreviewEmailByTypeResponse as eX, type PreviewRefundEmailRequest as eY, type RefundDetails as eZ, type RefundItem as e_, type LineItemDelta as ea, type LineItemDeltaDeltaOneOf as eb, type AppliedDiscountDelta as ec, type AppliedDiscountDeltaDeltaOneOf as ed, type AdditionalFeeDelta as ee, type AdditionalFeeDeltaDeltaOneOf as ef, type DraftOrderCommitSettings as eg, type InventoryUpdateDetails as eh, type TriggerReindexRequest as ei, type TriggerReindexResponse as ej, type DomainEvent as ek, type DomainEventBodyOneOf as el, type EntityCreatedEvent as em, type RestoreInfo as en, type EntityUpdatedEvent as eo, type EntityDeletedEvent as ep, type ActionEvent as eq, type Empty as er, type TriggerReindexOrderRequest as es, type MessageEnvelope as et, type IdentificationData as eu, type IdentificationDataIdOneOf as ev, type AccountInfo as ew, type ImportOrderRequest as ex, type SetOrderNumberCounterRequest as ey, type BulkDeleteImportedOrdersRequest as ez, type PreparePaymentCollectionApplicationErrors as f, type UserDefinedPaymentMethodNameKindOneOf as f$, type AdditionalFeeRefund as f0, type ShippingRefund as f1, type PreviewRefundEmailResponse as f2, type PreviewCancelEmailRequest as f3, type PreviewCancelEmailResponse as f4, type PreviewCancelRefundEmailRequest as f5, type PreviewCancelRefundEmailResponse as f6, type PreviewBuyerPaymentsReceivedEmailRequest as f7, type PreviewBuyerPaymentsReceivedEmailResponse as f8, type PreviewBuyerConfirmationEmailRequest as f9, type SiteUrlChanged as fA, type SitePurgedExternally as fB, type OdeditorAssigned as fC, type OdeditorUnassigned as fD, type PicassoAssigned as fE, type PicassoUnassigned as fF, type WixelAssigned as fG, type WixelUnassigned as fH, type StudioTwoAssigned as fI, type StudioTwoUnassigned as fJ, type UserDomainMediaEnabled as fK, type UserDomainMediaDisabled as fL, type EditorlessAssigned as fM, type EditorlessUnassigned as fN, type HasCustomEmailConfigurationsRequest as fO, type HasCustomEmailConfigurationsResponse as fP, type AddToAutomationMigrationPopulationRequest as fQ, type AddToAutomationMigrationPopulationResponse as fR, type IsInAutomationMigrationPopulationRequest as fS, type IsInAutomationMigrationPopulationResponse as fT, type PreparePaymentCollectionRequest as fU, type RedirectUrls as fV, type DelayedCaptureSettings as fW, type Duration as fX, type GetPaymentCollectabilityStatusRequest as fY, type RecordManuallyCollectedPaymentRequest as fZ, type UserDefinedPaymentMethodName as f_, type PreviewBuyerConfirmationEmailResponse as fa, type PreviewBuyerPickupConfirmationEmailRequest as fb, type PreviewBuyerPickupConfirmationEmailResponse as fc, type PreviewShippingConfirmationEmailRequest as fd, type PreviewShippingConfirmationEmailResponse as fe, type PreviewResendDownloadLinksEmailRequest as ff, type PreviewResendDownloadLinksEmailResponse as fg, type MetaSiteSpecialEvent as fh, type MetaSiteSpecialEventPayloadOneOf as fi, type Asset as fj, type SiteCreated as fk, type SiteTransferred as fl, type SiteDeleted as fm, type DeleteContext as fn, type SiteUndeleted as fo, type SitePublished as fp, type SiteUnpublished as fq, type SiteMarkedAsTemplate as fr, type SiteMarkedAsWixSite as fs, type ServiceProvisioned as ft, type ServiceRemoved as fu, type SiteRenamed as fv, type SiteHardDeleted as fw, type NamespaceChanged as fx, type StudioAssigned as fy, type StudioUnassigned as fz, type RecordManuallyCollectedPaymentApplicationErrors as g, type DiffmatokyPayload as g$, type RecordManuallyCollectedPaymentResponse as g0, type MarkOrderAsPaidRequest as g1, type BulkMarkOrdersAsPaidRequest as g2, type BulkOrderResult as g3, type ItemMetadata as g4, type ApplicationError as g5, type BulkActionMetadata as g6, type GetRefundabilityStatusRequest as g7, type Refundability as g8, type RefundabilityAdditionalRefundabilityInfoOneOf as g9, type MembershipPaymentDetails as gA, type FutureMembershipDetails as gB, type WixReceiptInfo as gC, type ExternalReceiptInfo as gD, type CashRoundingDetails as gE, type CanceledStatusDetails as gF, type DeclinedStatusDetails as gG, type VoidedStatusDetails as gH, type PaymentStatusDetails as gI, type PaymentStatusDetailsStatusDetailsOneOf as gJ, type Refund as gK, type RefundTransaction as gL, type RefundStatusInfo as gM, type AggregatedRefundSummary as gN, type RefundItemsBreakdown as gO, type LineItemRefundSummary as gP, type CalculateRefundRequest as gQ, type CalculateRefundItemRequest as gR, type CalculateRefundResponse as gS, type CalculateRefundItemResponse as gT, type VoidAuthorizedPaymentsRequest as gU, type CaptureAuthorizedPaymentsRequest as gV, type ChargeSavedPaymentMethodRequest as gW, type ChargeSavedPaymentMethodResponse as gX, type V1TriggerReindexRequest as gY, type V1TriggerReindexResponse as gZ, type V1TriggerReindexOrderRequest as g_, type CreatePaymentGatewayOrderRequest as ga, type ChargedBy as gb, type ChargeMembershipsRequest as gc, type MembershipChargeItem as gd, type MembershipName as ge, type ChargeMembershipsResponse as gf, type TriggerRefundRequest as gg, type RefundSideEffects as gh, type RestockInfo as gi, type RestockItem as gj, type OrderTransactions as gk, type Payment as gl, type PaymentPaymentDetailsOneOf as gm, type PaymentReceiptInfoOneOf as gn, type PaymentStatusDetailsOneOf as go, type RegularPaymentDetails as gp, type RegularPaymentDetailsPaymentMethodDetailsOneOf as gq, type CreditCardPaymentMethodDetails as gr, type AuthorizationDetails as gs, type AuthorizationCapture as gt, type AuthorizationActionFailureDetails as gu, type AuthorizationVoid as gv, type V1ScheduledAction as gw, type Chargeback as gx, type PaymentMethodName as gy, type GiftCardPaymentDetails as gz, type PaymentCollectionMarkOrderAsPaidOptions as h, type OrderPlaced as h$, type ErrorInformation as h0, type GetOrderRequest as h1, type GetOrderResponse as h2, type InternalQueryOrdersRequest as h3, type PlatformQuery as h4, type PlatformQueryPagingMethodOneOf as h5, type Sorting as h6, type PlatformPaging as h7, type CursorPaging as h8, type InternalQueryOrdersResponse as h9, type ArchiveOrderResponse as hA, type BulkArchiveOrdersRequest as hB, type BulkArchiveOrdersResponse as hC, type BulkArchiveOrdersByFilterRequest as hD, type BulkArchiveOrdersByFilterResponse as hE, type UnArchiveOrderRequest as hF, type UnArchiveOrderResponse as hG, type BulkUnArchiveOrdersRequest as hH, type BulkUnArchiveOrdersResponse as hI, type BulkUnArchiveOrdersByFilterRequest as hJ, type BulkUnArchiveOrdersByFilterResponse as hK, type UpdateBuyerInfoRequest as hL, type BuyerInfoUpdate as hM, type UpdateBuyerInfoResponse as hN, type UpdateBuyerEmailRequest as hO, type UpdateBuyerEmailResponse as hP, type UpdateOrderShippingAddressRequest as hQ, type UpdateOrderShippingAddressResponse as hR, type UpdateBillingContactDetailsRequest as hS, type UpdateBillingContactDetailsResponse as hT, type UpdateOrderLineItemRequest as hU, type UpdateOrderLineItemsRequest as hV, type MaskedOrderLineItem as hW, type UpdateOrderLineItemsResponse as hX, type AddInternalActivityRequest as hY, type InternalActivity as hZ, type InternalActivityContentOneOf as h_, type PlatformPagingMetadata as ha, type Cursors as hb, type QueryOrderRequest as hc, type QueryOrderResponse as hd, type SearchOrdersRequest as he, type CursorSearch as hf, type CursorSearchPagingMethodOneOf as hg, type CursorPagingMetadata as hh, type CreateOrderRequest as hi, type OrderCreationSettings as hj, type OrderCreationSettingsEditableByOneOf as hk, type OrderCreateNotifications as hl, type CreateOrderResponse as hm, type UpdateOrderRequest as hn, type UpdateOrderResponse as ho, type BulkUpdateOrdersRequest as hp, type CommitDeltasRequest as hq, type DraftOrderDiffs as hr, type DraftOrderDiffsShippingUpdateInfoOneOf as hs, type DraftOrderDiffsBuyerUpdateInfoOneOf as ht, type DraftOrderDiffsBillingUpdateInfoOneOf as hu, type DraftOrderDiffsRecipientUpdateInfoOneOf as hv, type V1LineItemDelta as hw, type V1LineItemDeltaDeltaOneOf as hx, type CommitDeltasResponse as hy, type ArchiveOrderRequest as hz, type PaymentCollectionMarkOrderAsPaidApplicationErrors as i, type BulkUpdateOrderTagsResult as i$, type OrderPaid as i0, type OrderFulfilled as i1, type OrderNotFulfilled as i2, type OrderCanceled as i3, type DownloadLinkSent as i4, type TrackingNumberAdded as i5, type TrackingNumberEdited as i6, type TrackingLinkAdded as i7, type ShippingConfirmationEmailSent as i8, type InvoiceAdded as i9, type BulkMarkAsFulfilledResponse as iA, type BulkMarkAsFulfilledByFilterRequest as iB, type BulkMarkAsFulfilledByFilterResponse as iC, type MarkAsUnfulfilledRequest as iD, type MarkAsUnfulfilledResponse as iE, type BulkMarkAsUnfulfilledRequest as iF, type BulkMarkAsUnfulfilledResponse as iG, type BulkMarkAsUnfulfilledByFilterRequest as iH, type BulkMarkAsUnfulfilledByFilterResponse as iI, type BulkSetBusinessLocationRequest as iJ, type BulkSetBusinessLocationResponse as iK, type BulkSetBusinessLocationResult as iL, type V1MarkOrderAsPaidRequest as iM, type V1MarkOrderAsPaidResponse as iN, type V1BulkMarkOrdersAsPaidRequest as iO, type V1BulkMarkOrdersAsPaidResponse as iP, type V1CreatePaymentGatewayOrderRequest as iQ, type V1CreatePaymentGatewayOrderResponse as iR, type GetShipmentsRequest as iS, type GetShipmentsResponse as iT, type AggregateOrdersRequest as iU, type DecrementItemsQuantityRequest as iV, type DecrementData as iW, type DecrementItemsQuantityResponse as iX, type BulkUpdateOrderTagsRequest as iY, type TagsTags as iZ, type TagsTagList as i_, type InvoiceSent as ia, type FulfillerEmailSent as ib, type ShippingAddressEdited as ic, type EmailEdited as id, type PickupReadyEmailSent as ie, type OrderPartiallyPaid as ig, type OrderPending as ih, type OrderRejected as ii, type AddInternalActivityResponse as ij, type AddActivityRequest as ik, type PublicActivityContentOneOf as il, type AddActivitiesRequest as im, type UpdateActivityRequest as io, type DeleteActivityRequest as ip, type UpdateLineItemsDescriptionLinesRequest as iq, type LineItemUpdate as ir, type UpdateLineItemsDescriptionLinesResponse as is, type MarkOrderAsSeenByHumanRequest as it, type MarkOrderAsSeenByHumanResponse as iu, type CancelOrderRequest as iv, type UpdateOrderStatusRequest as iw, type MarkAsFulfilledRequest as ix, type MarkAsFulfilledResponse as iy, type BulkMarkAsFulfilledRequest as iz, type BulkMarkOrdersAsPaidResponse as j, type WeightUnitWithLiterals as j$, type SendOrderUpdatedDomainEventRequest as j0, type SendOrderUpdatedDomainEventResponse as j1, type Task as j2, type TaskKey as j3, type TaskAction as j4, type TaskActionActionOneOf as j5, type Complete as j6, type Cancel as j7, type Reschedule as j8, type InvoiceSentEvent as j9, type CalculatedTax as jA, type Payments as jB, type InvoicesPayment as jC, type MetaData as jD, type InvoiceDynamicPriceTotals as jE, type CustomFieldValue as jF, type Value as jG, type Deposit as jH, type BaseEventMetadata as jI, type EventMetadata as jJ, type AccountInfoMetadata as jK, type OrderSearchSpec as jL, utils as jM, type DescriptionLineTypeWithLiterals as jN, type DimensionsUnitWithLiterals as jO, type ItemTypePresetWithLiterals as jP, type PaymentOptionTypeWithLiterals as jQ, type JurisdictionTypeWithLiterals as jR, type SubscriptionFrequencyWithLiterals as jS, type ProductPeriodAlignmentWithLiterals as jT, type AdjustmentTypeWithLiterals as jU, type TaxableAddressTypeWithLiterals as jV, type MeasurementUnitWithLiterals as jW, type RepriceStatusWithLiterals as jX, type BaseRateSourceWithLiterals as jY, type PaymentStatusEnumPaymentStatusWithLiterals as jZ, type FulfillmentStatusWithLiterals as j_, type IdAndVersion as ja, type InvoiceFields as jb, type Customer as jc, type Email as jd, type QuotesAddress as je, type AddressDescription as jf, type Phone as jg, type Company as jh, type CommonAddress as ji, type CommonAddressStreetOneOf as jj, type Subdivision as jk, type StandardDetails as jl, type ShippingContactDetails as jm, type InvoiceDates as jn, type LineItems as jo, type LineItem as jp, type BigDecimalWrapper as jq, type LineItemTax as jr, type Source as js, type LineItemMetaData as jt, type Locale as ju, type TotalPrice as jv, type ItemizedFee as jw, type Discount as jx, type DiscountOneDiscountTypeOneOf as jy, type CalculatedTaxes as jz, type GetRefundabilityStatusResponse as k, onOrderUpdated as k$, type VatTypeWithLiterals as k0, type PickupMethodWithLiterals as k1, type CrossBorderNotApplicableReasonWithLiterals as k2, type CrossBorderRepricingModeWithLiterals as k3, type DiscountTypeWithLiterals as k4, type DiscountReasonWithLiterals as k5, type LineItemQuantityChangeTypeWithLiterals as k6, type ActivityTypeWithLiterals as k7, type OrderActivityTypeEnumActivityTypeWithLiterals as k8, type AttributionSourceWithLiterals as k9, type ReasonWithLiterals as kA, type ActionTypeWithLiterals as kB, type ChargebackStatusWithLiterals as kC, type MembershipPaymentStatusWithLiterals as kD, type PaymentStatusWithLiterals as kE, type CanceledReasonWithLiterals as kF, type DeclinedReasonWithLiterals as kG, type VoidedReasonWithLiterals as kH, type RefundStatusWithLiterals as kI, type SortOrderWithLiterals as kJ, type OrderApprovalStrategyWithLiterals as kK, type PlacementWithLiterals as kL, type SubdivisionTypeWithLiterals as kM, type SourceTypeWithLiterals as kN, type CustomFieldGroupWithLiterals as kO, type ValueTypeWithLiterals as kP, type DepositTypeWithLiterals as kQ, type InvoiceStatusWithLiterals as kR, type CommonSearchWithEntityContext as kS, onOrderApproved as kT, onOrderCanceled as kU, onOrderCommitted as kV, onOrderCreated as kW, onOrderFulfilled as kX, onOrderImported as kY, onOrderImportedOrderDeleted as kZ, onOrderPaymentStatusUpdated as k_, type ChannelTypeWithLiterals as ka, type AdditionalFeeSourceWithLiterals as kb, type OrderActionTypeWithLiterals as kc, type SpecificItemsCouponBehaviorWithLiterals as kd, type ChargeTypeWithLiterals as ke, type VersioningModeWithLiterals as kf, type DeltaPaymentOptionTypeWithLiterals as kg, type InventoryActionWithLiterals as kh, type WebhookIdentityTypeWithLiterals as ki, type PreviewEmailTypeWithLiterals as kj, type StateWithLiterals as kk, type SiteCreatedContextWithLiterals as kl, type NamespaceWithLiterals as km, type DeleteStatusWithLiterals as kn, type OriginWithLiterals as ko, type ScheduledActionWithLiterals as kp, type DurationUnitWithLiterals as kq, type PaymentCollectabilityStatusWithLiterals as kr, type PredefinedPaymentMethodWithLiterals as ks, type RefundableStatusWithLiterals as kt, type NonRefundableReasonWithLiterals as ku, type ManuallyRefundableReasonWithLiterals as kv, type RestockTypeWithLiterals as kw, type TransactionStatusWithLiterals as kx, type AuthorizationCaptureStatusWithLiterals as ky, type AuthorizationVoidStatusWithLiterals as kz, type PaymentCollectionCreatePaymentGatewayOrderOptions as l, importOrder as l0, setOrderNumberCounter as l1, bulkDeleteImportedOrders as l2, preparePaymentCollection as l3, getPaymentCollectabilityStatus as l4, recordManuallyCollectedPayment as l5, paymentCollectionMarkOrderAsPaid as l6, paymentCollectionBulkMarkOrdersAsPaid as l7, getRefundabilityStatus as l8, paymentCollectionCreatePaymentGatewayOrder as l9, chargeMemberships as la, triggerRefund as lb, voidAuthorizedPayments as lc, captureAuthorizedPayments as ld, getOrder as le, createOrder as lf, updateOrder as lg, bulkUpdateOrders as lh, updateOrderLineItem as li, addActivity as lj, addActivities as lk, updateActivity as ll, deleteActivity as lm, cancelOrder as ln, updateOrderStatus as lo, aggregateOrders as lp, bulkUpdateOrderTags as lq, type PaymentCollectionCreatePaymentGatewayOrderApplicationErrors as m, type ChargeMembershipsOptions as n, type PaymentRefund as o, type TriggerRefundResponse as p, type TriggerRefundApplicationErrors as q, type VoidAuthorizedPaymentsApplicationErrors as r, type PaymentCapture as s, type CaptureAuthorizedPaymentsResponse as t, type CaptureAuthorizedPaymentsApplicationErrors as u, type GetOrderApplicationErrors as v, type OrderSearch as w, type SearchOrdersResponse as x, type CreateOrderOptions as y, type CreateOrderApplicationErrors as z };