@wix/auto_sdk_ecom_draft-orders 1.0.190 → 1.0.192

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.
@@ -445,10 +445,7 @@ interface LineItemTaxInfo {
445
445
  * @maxSize 7
446
446
  */
447
447
  taxBreakdown?: LineItemTaxBreakdown[];
448
- /**
449
- * Amount of the line item price that was exempt from tax.
450
- * @internal
451
- */
448
+ /** Amount of the line item price that was exempt from tax. */
452
449
  exemptAmount?: Price;
453
450
  }
454
451
  /**
@@ -486,10 +483,7 @@ interface LineItemTaxBreakdown {
486
483
  nonTaxableAmount?: Price;
487
484
  /** Taxable amount of the line item price. */
488
485
  taxableAmount?: Price;
489
- /**
490
- * Amount of the line item price that was exempt from this authority.
491
- * @internal
492
- */
486
+ /** Amount of the line item price that was exempt from this authority. */
493
487
  exemptAmount?: Price;
494
488
  }
495
489
  /** JurisdictionType represents the type of the jurisdiction in which this tax detail applies (e.g. Country,State,County,City,Special). */
@@ -503,6 +497,76 @@ declare enum JurisdictionType {
503
497
  }
504
498
  /** @enumType */
505
499
  type JurisdictionTypeWithLiterals = JurisdictionType | 'UNDEFINED' | 'COUNTRY' | 'STATE' | 'COUNTY' | 'CITY' | 'SPECIAL';
500
+ /**
501
+ * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
502
+ * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
503
+ *
504
+ * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
505
+ * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
506
+ * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
507
+ */
508
+ interface CrossBorderPriceAdjustment {
509
+ /**
510
+ * ID of the tax region whose tax is built into the catalog prices.
511
+ * @format GUID
512
+ */
513
+ baseTaxRegionId?: string;
514
+ /**
515
+ * ID of the tax region resolved for the destination. Absent when no region matched.
516
+ * @format GUID
517
+ */
518
+ destinationTaxRegionId?: string | null;
519
+ /** Price per unit as entered by the merchant, with the base region's tax inside it. */
520
+ catalogPrice?: Price;
521
+ /** 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. */
522
+ baseTaxAmount?: Price;
523
+ /** Outcome of the repricing for this line. */
524
+ status?: RepriceStatusWithLiterals;
525
+ /** 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`. */
526
+ baseRateSource?: BaseRateSourceWithLiterals;
527
+ /**
528
+ * 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.
529
+ * @format DECIMAL_VALUE
530
+ * @decimalValue options { gte:0, maxScale:6 }
531
+ */
532
+ baseRate?: string | null;
533
+ /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
534
+ baseRateCapturedDate?: Date | null;
535
+ /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
536
+ destinationTaxIncluded?: boolean | null;
537
+ }
538
+ /** Outcome of the repricing for one line. */
539
+ declare enum RepriceStatus {
540
+ /** Base tax removed and the destination's tax applied. */
541
+ APPLIED = "APPLIED",
542
+ /** The caller asked for the line to be left at its price. Nothing was removed. */
543
+ KEPT = "KEPT",
544
+ /** 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`. */
545
+ STRIP_ONLY = "STRIP_ONLY",
546
+ /** The destination is the base region. Nothing was removed. */
547
+ SAME_REGION = "SAME_REGION",
548
+ /** 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. */
549
+ SAME_COUNTRY = "SAME_COUNTRY",
550
+ /** No tax region matched the destination. Base tax removed and no destination tax applied. */
551
+ NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
552
+ /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
553
+ NOT_APPLICABLE = "NOT_APPLICABLE",
554
+ /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
555
+ NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
556
+ /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
557
+ CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
558
+ }
559
+ /** @enumType */
560
+ type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
561
+ /** Where the base region's rate came from. */
562
+ declare enum BaseRateSource {
563
+ /** The manual tax calculator computed the base tax for this calculation. */
564
+ MANUAL_SPI = "MANUAL_SPI",
565
+ /** The rate captured from Avalara by the embedded-rate probe. */
566
+ AVALARA_PROBE = "AVALARA_PROBE"
567
+ }
568
+ /** @enumType */
569
+ type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
506
570
  interface OrderLineItem {
507
571
  /**
508
572
  * Line item ID.
@@ -1311,76 +1375,6 @@ interface ServiceProperties {
1311
1375
  */
1312
1376
  endDate?: Date | null;
1313
1377
  }
1314
- /**
1315
- * Record of the cross-border repricing of a single line item, shipping option or fee on a site whose catalog prices include tax:
1316
- * the catalog price the merchant entered, the base region's tax removed from it per unit, and the rate used.
1317
- *
1318
- * This record describes how the price was reached, not the resulting amount. The repriced figures are on the line itself:
1319
- * `price` and `taxInfo` on an order line item, and their counterparts on a shipping cost or a fee.
1320
- * Written by the calculation that priced the line and carried unchanged onto orders, draft orders and subscription contracts.
1321
- */
1322
- interface CrossBorderPriceAdjustment {
1323
- /**
1324
- * ID of the tax region whose tax is built into the catalog prices.
1325
- * @format GUID
1326
- */
1327
- baseTaxRegionId?: string;
1328
- /**
1329
- * ID of the tax region resolved for the destination. Absent when no region matched.
1330
- * @format GUID
1331
- */
1332
- destinationTaxRegionId?: string | null;
1333
- /** Price per unit as entered by the merchant, with the base region's tax inside it. */
1334
- catalogPrice?: Price;
1335
- /** 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. */
1336
- baseTaxAmount?: Price;
1337
- /** Outcome of the repricing for this line. */
1338
- status?: RepriceStatusWithLiterals;
1339
- /** 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`. */
1340
- baseRateSource?: BaseRateSourceWithLiterals;
1341
- /**
1342
- * 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.
1343
- * @format DECIMAL_VALUE
1344
- * @decimalValue options { gte:0, maxScale:6 }
1345
- */
1346
- baseRate?: string | null;
1347
- /** When the base region's rate was captured. Set only when `baseRateSource` is `AVALARA_PROBE`. */
1348
- baseRateCapturedDate?: Date | null;
1349
- /** Whether the destination's tax is included in the repriced amount. Reserved for per-region display; not populated. */
1350
- destinationTaxIncluded?: boolean | null;
1351
- }
1352
- /** Outcome of the repricing for one line. */
1353
- declare enum RepriceStatus {
1354
- /** Base tax removed and the destination's tax applied. */
1355
- APPLIED = "APPLIED",
1356
- /** The caller asked for the line to be left at its price. Nothing was removed. */
1357
- KEPT = "KEPT",
1358
- /** 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`. */
1359
- STRIP_ONLY = "STRIP_ONLY",
1360
- /** The destination is the base region. Nothing was removed. */
1361
- SAME_REGION = "SAME_REGION",
1362
- /** 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. */
1363
- SAME_COUNTRY = "SAME_COUNTRY",
1364
- /** No tax region matched the destination. Base tax removed and no destination tax applied. */
1365
- NO_DESTINATION_REGION = "NO_DESTINATION_REGION",
1366
- /** The calculation didn't reprice this line, for example because the feature was off or a pass failed. Nothing was removed. */
1367
- NOT_APPLICABLE = "NOT_APPLICABLE",
1368
- /** The line's modifiers exceed its price at the destination's rate. Nothing was removed. */
1369
- NOT_APPLICABLE_MODIFIERS = "NOT_APPLICABLE_MODIFIERS",
1370
- /** A subscription line in a checkout whose currency differs from the site currency. Nothing was removed. */
1371
- CONVERTED_CURRENCY_SUBSCRIPTION = "CONVERTED_CURRENCY_SUBSCRIPTION"
1372
- }
1373
- /** @enumType */
1374
- type RepriceStatusWithLiterals = RepriceStatus | 'APPLIED' | 'KEPT' | 'STRIP_ONLY' | 'SAME_REGION' | 'SAME_COUNTRY' | 'NO_DESTINATION_REGION' | 'NOT_APPLICABLE' | 'NOT_APPLICABLE_MODIFIERS' | 'CONVERTED_CURRENCY_SUBSCRIPTION';
1375
- /** Where the base region's rate came from. */
1376
- declare enum BaseRateSource {
1377
- /** The manual tax calculator computed the base tax for this calculation. */
1378
- MANUAL_SPI = "MANUAL_SPI",
1379
- /** The rate captured from Avalara by the embedded-rate probe. */
1380
- AVALARA_PROBE = "AVALARA_PROBE"
1381
- }
1382
- /** @enumType */
1383
- type BaseRateSourceWithLiterals = BaseRateSource | 'MANUAL_SPI' | 'AVALARA_PROBE';
1384
1378
  interface ItemChangedDetails {
1385
1379
  /**
1386
1380
  * Line item quantity before change.
@@ -1435,6 +1429,11 @@ interface ItemChangedImplicitlyDetails {
1435
1429
  priceBeforeDiscountsBeforeChange?: Price;
1436
1430
  /** Line item price before line-item discounts and tax, before the implicit change. */
1437
1431
  priceBeforeDiscountsAndTaxBeforeChange?: Price;
1432
+ /**
1433
+ * Cross-border repricing record of the line item before the implicit change.
1434
+ * @internal
1435
+ */
1436
+ crossBorderAdjustmentBeforeChange?: CrossBorderPriceAdjustment;
1438
1437
  }
1439
1438
  interface ShippingDetails extends ShippingDetailsChangeTypeOneOf {
1440
1439
  /** Whether shipping info was added as part of the draft. */
@@ -2455,8 +2454,7 @@ interface OrderTaxInfo {
2455
2454
  */
2456
2455
  taxExempt?: boolean | null;
2457
2456
  /**
2458
- * The total amount that was exempt from tax calculations.
2459
- * @internal
2457
+ * Total amount exempt from tax calculations.
2460
2458
  * @readonly
2461
2459
  */
2462
2460
  totalExempt?: Price;
@@ -2502,10 +2500,7 @@ interface OrderTaxBreakdown {
2502
2500
  * @internal
2503
2501
  */
2504
2502
  aggregatedTaxableAmount?: Price;
2505
- /**
2506
- * The aggregated exempt amount from all line items for tax identifiers.
2507
- * @internal
2508
- */
2503
+ /** Total amount exempt from this tax, summed across all line items. */
2509
2504
  aggregatedExemptAmount?: Price;
2510
2505
  }
2511
2506
  /** Cross-border repricing outcome of one calculation. Replaced on every recalculation of the order; the order-level marker that never changes is `Order.crossBorderRepricing`. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wix/auto_sdk_ecom_draft-orders",
3
- "version": "1.0.190",
3
+ "version": "1.0.192",
4
4
  "license": "MIT",
5
5
  "publishConfig": {
6
6
  "registry": "https://registry.npmjs.org/",
@@ -50,5 +50,5 @@
50
50
  "fqdn": "wix.ecom.v1.draft_order"
51
51
  }
52
52
  },
53
- "falconPackageHash": "0d63b79eefee0a830e766d64819bffe18358afe83d82be073bc0e394"
53
+ "falconPackageHash": "d81ebf65c348f511ebfb8153ea1e64900a074b842f8b167956864330"
54
54
  }