@wix/auto_sdk_ecom_delivery-profile 1.0.48 → 1.0.50

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/index.d.ts +61 -18
  2. package/build/cjs/index.js +1 -0
  3. package/build/cjs/index.js.map +1 -1
  4. package/build/cjs/{ecom-v1-delivery-profile-delivery-profile.universal-CiA87hsc.d.ts → index.typings.d.ts} +460 -1
  5. package/build/cjs/index.typings.js +1175 -0
  6. package/build/cjs/index.typings.js.map +1 -0
  7. package/build/cjs/meta.d.ts +2 -1
  8. package/build/es/index.d.mts +61 -18
  9. package/build/es/index.mjs +1 -0
  10. package/build/es/index.mjs.map +1 -1
  11. package/build/es/{ecom-v1-delivery-profile-delivery-profile.universal-CiA87hsc.d.mts → index.typings.d.mts} +460 -1
  12. package/build/es/index.typings.mjs +1127 -0
  13. package/build/es/index.typings.mjs.map +1 -0
  14. package/build/es/meta.d.mts +2 -1
  15. package/build/internal/cjs/index.d.ts +61 -18
  16. package/build/internal/cjs/index.js +1 -0
  17. package/build/internal/cjs/index.js.map +1 -1
  18. package/build/internal/cjs/{ecom-v1-delivery-profile-delivery-profile.universal-CiA87hsc.d.ts → index.typings.d.ts} +460 -1
  19. package/build/internal/cjs/index.typings.js +1175 -0
  20. package/build/internal/cjs/index.typings.js.map +1 -0
  21. package/build/internal/cjs/meta.d.ts +2 -1
  22. package/build/internal/es/index.d.mts +61 -18
  23. package/build/internal/es/index.mjs +1 -0
  24. package/build/internal/es/index.mjs.map +1 -1
  25. package/build/internal/es/{ecom-v1-delivery-profile-delivery-profile.universal-CiA87hsc.d.mts → index.typings.d.mts} +460 -1
  26. package/build/internal/es/index.typings.mjs +1127 -0
  27. package/build/internal/es/index.typings.mjs.map +1 -0
  28. package/build/internal/es/meta.d.mts +2 -1
  29. package/package.json +2 -2
@@ -1,3 +1,5 @@
1
+ import { NonNullablePaths } from '@wix/sdk-types';
2
+
1
3
  /**
2
4
  * A DeliveryProfile is a ...
3
5
  * You can ...
@@ -1403,6 +1405,242 @@ declare enum WebhookIdentityType {
1403
1405
  }
1404
1406
  /** @enumType */
1405
1407
  type WebhookIdentityTypeWithLiterals = WebhookIdentityType | 'UNKNOWN' | 'ANONYMOUS_VISITOR' | 'MEMBER' | 'WIX_USER' | 'APP';
1408
+ type CreateDeliveryProfileApplicationErrors = {
1409
+ code?: 'DESTINATIONS_COLLISION';
1410
+ description?: string;
1411
+ data?: Record<string, any>;
1412
+ } | {
1413
+ code?: 'SINGLE_DEFAULT_DELIVERY_PROFILE';
1414
+ description?: string;
1415
+ data?: Record<string, any>;
1416
+ } | {
1417
+ code?: 'UNKNOWN_DELIVERY_CARRIER';
1418
+ description?: string;
1419
+ data?: Record<string, any>;
1420
+ } | {
1421
+ code?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE';
1422
+ description?: string;
1423
+ data?: Record<string, any>;
1424
+ } | {
1425
+ code?: 'DELIVERY_PROVIDER_PRECONDITIONS_NOT_MET';
1426
+ description?: string;
1427
+ data?: Record<string, any>;
1428
+ };
1429
+ type CreateDeliveryProfileValidationErrors = {
1430
+ ruleName?: 'DESTINATION_NOT_SUPPORTED';
1431
+ };
1432
+ type UpdateDeliveryProfileApplicationErrors = {
1433
+ code?: 'DELIVERY_REGION_CANNOT_BE_UPDATED';
1434
+ description?: string;
1435
+ data?: Record<string, any>;
1436
+ } | {
1437
+ code?: 'DEFAULT_CANNOT_BE_UPDATED';
1438
+ description?: string;
1439
+ data?: Record<string, any>;
1440
+ };
1441
+ type AddDeliveryRegionApplicationErrors = {
1442
+ code?: 'DELIVERY_PROFILE_NOT_FOUND';
1443
+ description?: string;
1444
+ data?: Record<string, any>;
1445
+ } | {
1446
+ code?: 'DESTINATIONS_COLLISION';
1447
+ description?: string;
1448
+ data?: Record<string, any>;
1449
+ } | {
1450
+ code?: 'UNKNOWN_DELIVERY_CARRIER';
1451
+ description?: string;
1452
+ data?: Record<string, any>;
1453
+ } | {
1454
+ code?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE';
1455
+ description?: string;
1456
+ data?: Record<string, any>;
1457
+ } | {
1458
+ code?: 'DELIVERY_CARRIER_PRECONDITIONS_NOT_MET';
1459
+ description?: string;
1460
+ data?: Record<string, any>;
1461
+ };
1462
+ type AddDeliveryRegionValidationErrors = {
1463
+ ruleName?: 'DELIVERY_REGION_NAME_ALREADY_EXISTS';
1464
+ } | {
1465
+ ruleName?: 'DESTINATION_NOT_SUPPORTED';
1466
+ };
1467
+ type UpdateDeliveryRegionApplicationErrors = {
1468
+ code?: 'DELIVERY_PROFILE_NOT_FOUND';
1469
+ description?: string;
1470
+ data?: Record<string, any>;
1471
+ } | {
1472
+ code?: 'DELIVERY_REGION_NOT_FOUND';
1473
+ description?: string;
1474
+ data?: Record<string, any>;
1475
+ } | {
1476
+ code?: 'DESTINATIONS_COLLISION';
1477
+ description?: string;
1478
+ data?: Record<string, any>;
1479
+ } | {
1480
+ code?: 'DELIVERY_CARRIER_PRECONDITIONS_NOT_MET';
1481
+ description?: string;
1482
+ data?: Record<string, any>;
1483
+ } | {
1484
+ code?: 'DELIVERY_CARRIER_CANNOT_BE_UPDATED';
1485
+ description?: string;
1486
+ data?: Record<string, any>;
1487
+ };
1488
+ type UpdateDeliveryRegionValidationErrors = {
1489
+ ruleName?: 'DELIVERY_REGION_NAME_ALREADY_EXISTS';
1490
+ } | {
1491
+ ruleName?: 'DESTINATION_NOT_SUPPORTED';
1492
+ };
1493
+ type GetDeliveryProfileByDeliveryRegionIdApplicationErrors = {
1494
+ code?: 'DELIVERY_REGION_NOT_FOUND';
1495
+ description?: string;
1496
+ data?: Record<string, any>;
1497
+ };
1498
+ type RemoveDeliveryRegionApplicationErrors = {
1499
+ code?: 'DELIVERY_PROFILE_NOT_FOUND';
1500
+ description?: string;
1501
+ data?: Record<string, any>;
1502
+ } | {
1503
+ code?: 'DELIVERY_REGION_NOT_FOUND';
1504
+ description?: string;
1505
+ data?: Record<string, any>;
1506
+ };
1507
+ type AddDeliveryCarrierApplicationErrors = {
1508
+ code?: 'DELIVERY_REGION_NOT_FOUND';
1509
+ description?: string;
1510
+ data?: Record<string, any>;
1511
+ } | {
1512
+ code?: 'CARRIER_ALREADY_EXISTS_IN_REGION';
1513
+ description?: string;
1514
+ data?: Record<string, any>;
1515
+ } | {
1516
+ code?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE';
1517
+ description?: string;
1518
+ data?: Record<string, any>;
1519
+ } | {
1520
+ code?: 'DELIVERY_CARRIER_PRECONDITIONS_NOT_MET';
1521
+ description?: string;
1522
+ data?: Record<string, any>;
1523
+ } | {
1524
+ code?: 'UNKNOWN_DELIVERY_CARRIER';
1525
+ description?: string;
1526
+ data?: Record<string, any>;
1527
+ } | {
1528
+ code?: 'UNAUTHORIZED_APPLICATION';
1529
+ description?: string;
1530
+ data?: Record<string, any>;
1531
+ };
1532
+ type AddDeliveryCarrierValidationErrors = {
1533
+ ruleName?: 'DELIVERY_CARRIER_MISSING_BACKUP_RATE';
1534
+ };
1535
+ type RemoveDeliveryCarrierApplicationErrors = {
1536
+ code?: 'DELIVERY_REGION_NOT_FOUND';
1537
+ description?: string;
1538
+ data?: Record<string, any>;
1539
+ } | {
1540
+ code?: 'UNAUTHORIZED_APPLICATION';
1541
+ description?: string;
1542
+ data?: Record<string, any>;
1543
+ };
1544
+ type UpdateDeliveryCarrierApplicationErrors = {
1545
+ code?: 'DELIVERY_REGION_NOT_FOUND';
1546
+ description?: string;
1547
+ data?: Record<string, any>;
1548
+ } | {
1549
+ code?: 'DELIVERY_CARRIER_NOT_FOUND';
1550
+ description?: string;
1551
+ data?: Record<string, any>;
1552
+ } | {
1553
+ code?: 'DELIVERY_CARRIER_PRECONDITIONS_NOT_MET';
1554
+ description?: string;
1555
+ data?: Record<string, any>;
1556
+ } | {
1557
+ code?: 'UNKNOWN_DELIVERY_CARRIER';
1558
+ description?: string;
1559
+ data?: Record<string, any>;
1560
+ } | {
1561
+ code?: 'UNAUTHORIZED_APPLICATION';
1562
+ description?: string;
1563
+ data?: Record<string, any>;
1564
+ } | {
1565
+ code?: 'APP_ID_CANNOT_BE_UPDATED';
1566
+ description?: string;
1567
+ data?: Record<string, any>;
1568
+ };
1569
+ type ListDeliveryCarriersApplicationErrors = {
1570
+ code?: 'DELIVERY_CARRIER_NOT_FOUND';
1571
+ description?: string;
1572
+ data?: Record<string, any>;
1573
+ } | {
1574
+ code?: 'DELIVERY_PROFILE_NOT_FOUND';
1575
+ description?: string;
1576
+ data?: Record<string, any>;
1577
+ };
1578
+ type UpdateCarrierSettingsApplicationErrors = {
1579
+ code?: 'DELIVERY_CARRIER_NOT_FOUND';
1580
+ description?: string;
1581
+ data?: Record<string, any>;
1582
+ };
1583
+ type DeliveryProfileNonNullablePaths = `deliveryRegions`;
1584
+ /**
1585
+ * Creates a DeliveryProfile.
1586
+ *
1587
+ * The request body must include the DeliveryProfiles name. DeliveryRegions are optional.
1588
+ * @param deliveryProfile - DeliveryProfile to be created.
1589
+ * @public
1590
+ * @documentationMaturity preview
1591
+ * @requiredField deliveryProfile
1592
+ * @requiredField deliveryProfile.deliveryRegions.destinations
1593
+ * @requiredField deliveryProfile.deliveryRegions.destinations.countryCode
1594
+ * @requiredField deliveryProfile.deliveryRegions.name
1595
+ * @requiredField deliveryProfile.name
1596
+ * @permissionId ECOM.DELIVERY_PROFILE_CREATE
1597
+ * @applicableIdentity APP
1598
+ * @returns The created DeliveryProfile.
1599
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.CreateDeliveryProfile
1600
+ */
1601
+ declare function createDeliveryProfile(deliveryProfile: NonNullablePaths<DeliveryProfile, `deliveryRegions.${number}.destinations` | `deliveryRegions.${number}.destinations.${number}.countryCode` | `deliveryRegions.${number}.name` | `name`>): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths> & {
1602
+ __applicationErrorsType?: CreateDeliveryProfileApplicationErrors;
1603
+ __validationErrorsType?: CreateDeliveryProfileValidationErrors;
1604
+ }>;
1605
+ /**
1606
+ * Retrieves a DeliveryProfile.
1607
+ * @param deliveryProfileId - ID of the DeliveryProfile to retrieve.
1608
+ * @public
1609
+ * @documentationMaturity preview
1610
+ * @requiredField deliveryProfileId
1611
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
1612
+ * @applicableIdentity APP
1613
+ * @applicableIdentity VISITOR
1614
+ * @returns The requested DeliveryProfile.
1615
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryProfile
1616
+ */
1617
+ declare function getDeliveryProfile(deliveryProfileId: string): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths>>;
1618
+ /**
1619
+ * Updates a DeliveryProfile.
1620
+ *
1621
+ *
1622
+ * Each time the DeliveryProfile is updated,
1623
+ * `revision` increments by 1.
1624
+ * The current `revision` must be passed when updating the DeliveryProfile.
1625
+ * This ensures you're working with the latest DeliveryProfile
1626
+ * and prevents unintended overwrites.
1627
+ *
1628
+ * This method does not allow updating the DeliveryRegions in this DeliveryProfile.
1629
+ * Use AddDeliveryRegion, UpdateDeliveryRegion and RemoveDeliveryRegion for these functionalities.
1630
+ * @param _id - DeliveryProfile ID.
1631
+ * @public
1632
+ * @documentationMaturity preview
1633
+ * @requiredField _id
1634
+ * @requiredField deliveryProfile
1635
+ * @requiredField deliveryProfile.revision
1636
+ * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
1637
+ * @applicableIdentity APP
1638
+ * @returns Updated DeliveryProfile.
1639
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryProfile
1640
+ */
1641
+ declare function updateDeliveryProfile(_id: string, deliveryProfile: NonNullablePaths<UpdateDeliveryProfile, `revision`>): Promise<NonNullablePaths<DeliveryProfile, DeliveryProfileNonNullablePaths> & {
1642
+ __applicationErrorsType?: UpdateDeliveryProfileApplicationErrors;
1643
+ }>;
1406
1644
  interface UpdateDeliveryProfile {
1407
1645
  /**
1408
1646
  * DeliveryProfile ID.
@@ -1446,6 +1684,36 @@ interface UpdateDeliveryProfile {
1446
1684
  /** [Extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields ) must be configured in the app dashboard before they can be accessed with API calls. */
1447
1685
  extendedFields?: ExtendedFields;
1448
1686
  }
1687
+ /**
1688
+ * Deletes a DeliveryProfile.
1689
+ *
1690
+ * Deleting a DeliveryProfile permanently removes them from the DeliveryProfile List.
1691
+ * @param deliveryProfileId - Id of the DeliveryProfile to delete.
1692
+ * @public
1693
+ * @documentationMaturity preview
1694
+ * @requiredField deliveryProfileId
1695
+ * @permissionId ECOM.DELIVERY_PROFILE_DELETE
1696
+ * @applicableIdentity APP
1697
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.DeleteDeliveryProfile
1698
+ */
1699
+ declare function deleteDeliveryProfile(deliveryProfileId: string): Promise<void>;
1700
+ /**
1701
+ * Retrieves a list of DeliveryProfiles, given the provided [paging, filtering, and sorting][1].
1702
+ *
1703
+ * Up to 1,000 DeliveryProfiles can be returned per request.
1704
+ *
1705
+ * To learn how to query DeliveryProfiles, see [API Query Language][2].
1706
+ *
1707
+ * [1]: https://dev.wix.com/api/rest/getting-started/sorting-and-paging
1708
+ * [2]: https://dev.wix.com/api/rest/getting-started/api-query-language
1709
+ * @public
1710
+ * @documentationMaturity preview
1711
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
1712
+ * @applicableIdentity APP
1713
+ * @applicableIdentity VISITOR
1714
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.QueryDeliveryProfiles
1715
+ */
1716
+ declare function queryDeliveryProfiles(): DeliveryProfilesQueryBuilder;
1449
1717
  interface QueryCursorResult {
1450
1718
  cursors: Cursors;
1451
1719
  hasNext: () => boolean;
@@ -1523,6 +1791,26 @@ interface DeliveryProfilesQueryBuilder {
1523
1791
  /** @documentationMaturity preview */
1524
1792
  find: () => Promise<DeliveryProfilesQueryResult>;
1525
1793
  }
1794
+ /**
1795
+ * Creates a new DeliveryRegion in an existing DeliveryProfile.
1796
+ * @param deliveryProfileId - delivery profile id to associated with the DeliveryRegion
1797
+ * @param deliveryRegion - DeliveryRegion to be created
1798
+ * @public
1799
+ * @documentationMaturity preview
1800
+ * @requiredField deliveryProfileId
1801
+ * @requiredField deliveryRegion
1802
+ * @requiredField deliveryRegion.destinations.countryCode
1803
+ * @requiredField deliveryRegion.name
1804
+ * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
1805
+ * @applicableIdentity APP
1806
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.AddDeliveryRegion
1807
+ */
1808
+ declare function addDeliveryRegion(deliveryProfileId: string, deliveryRegion: NonNullablePaths<DeliveryRegion, `destinations.${number}.countryCode` | `name`>, options?: AddDeliveryRegionOptions): Promise<NonNullablePaths<AddDeliveryRegionResponse, {
1809
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1810
+ }[DeliveryProfileNonNullablePaths]> & {
1811
+ __applicationErrorsType?: AddDeliveryRegionApplicationErrors;
1812
+ __validationErrorsType?: AddDeliveryRegionValidationErrors;
1813
+ }>;
1526
1814
  interface AddDeliveryRegionOptions {
1527
1815
  /**
1528
1816
  * DeliveryProfile revision.
@@ -1530,6 +1818,28 @@ interface AddDeliveryRegionOptions {
1530
1818
  */
1531
1819
  revision?: string | null;
1532
1820
  }
1821
+ /**
1822
+ * Update a DeliveryRegion, supports partial update
1823
+ * Pass the latest `revision` for a successful update
1824
+ *
1825
+ * This method does not allow setting or updating the delivery delivery_carriers in this delivery_region.
1826
+ * Use AddDeliveryCarrier, UpdateDeliveryCarrier and RemoveDeliveryCarrier for these functionalities.
1827
+ * @public
1828
+ * @documentationMaturity preview
1829
+ * @requiredField deliveryRegion
1830
+ * @requiredField identifiers
1831
+ * @requiredField identifiers.deliveryProfileId
1832
+ * @requiredField identifiers.deliveryRegionId
1833
+ * @permissionId ECOM.DELIVERY_REGION_UPDATE
1834
+ * @applicableIdentity APP
1835
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryRegion
1836
+ */
1837
+ declare function updateDeliveryRegion(identifiers: NonNullablePaths<UpdateDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, deliveryRegion: UpdateDeliveryRegion, options?: UpdateDeliveryRegionOptions): Promise<NonNullablePaths<UpdateDeliveryRegionResponse, {
1838
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1839
+ }[DeliveryProfileNonNullablePaths]> & {
1840
+ __applicationErrorsType?: UpdateDeliveryRegionApplicationErrors;
1841
+ __validationErrorsType?: UpdateDeliveryRegionValidationErrors;
1842
+ }>;
1533
1843
  interface UpdateDeliveryRegionIdentifiers {
1534
1844
  /**
1535
1845
  * DeliveryProfile id that owns the DeliveryRegion
@@ -1582,6 +1892,38 @@ interface UpdateDeliveryRegionOptions {
1582
1892
  */
1583
1893
  revision?: string | null;
1584
1894
  }
1895
+ /**
1896
+ * Retrieves a DeliveryProfile by delivery region ID.
1897
+ * @param deliveryRegionId - ID of the DeliveryRegion to retrieve the profile for.
1898
+ * @public
1899
+ * @documentationMaturity preview
1900
+ * @requiredField deliveryRegionId
1901
+ * @permissionId ECOM.DELIVERY_PROFILE_READ
1902
+ * @applicableIdentity APP
1903
+ * @applicableIdentity VISITOR
1904
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.GetDeliveryProfileByDeliveryRegionId
1905
+ */
1906
+ declare function getDeliveryProfileByDeliveryRegionId(deliveryRegionId: string): Promise<NonNullablePaths<GetDeliveryProfileByDeliveryRegionIdResponse, {
1907
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1908
+ }[DeliveryProfileNonNullablePaths]> & {
1909
+ __applicationErrorsType?: GetDeliveryProfileByDeliveryRegionIdApplicationErrors;
1910
+ }>;
1911
+ /**
1912
+ * Delete a DeliveryRegion
1913
+ * @public
1914
+ * @documentationMaturity preview
1915
+ * @requiredField identifiers
1916
+ * @requiredField identifiers.deliveryProfileId
1917
+ * @requiredField identifiers.deliveryRegionId
1918
+ * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
1919
+ * @applicableIdentity APP
1920
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.RemoveDeliveryRegion
1921
+ */
1922
+ declare function removeDeliveryRegion(identifiers: NonNullablePaths<RemoveDeliveryRegionIdentifiers, `deliveryProfileId` | `deliveryRegionId`>, options?: RemoveDeliveryRegionOptions): Promise<NonNullablePaths<RemoveDeliveryRegionResponse, {
1923
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1924
+ }[DeliveryProfileNonNullablePaths]> & {
1925
+ __applicationErrorsType?: RemoveDeliveryRegionApplicationErrors;
1926
+ }>;
1585
1927
  interface RemoveDeliveryRegionIdentifiers {
1586
1928
  /**
1587
1929
  * DeliveryProfile id that owns the DeliveryRegion
@@ -1601,10 +1943,45 @@ interface RemoveDeliveryRegionOptions {
1601
1943
  */
1602
1944
  revision?: string | null;
1603
1945
  }
1946
+ /**
1947
+ * Add a delivery_carrier to a delivery region
1948
+ * @param deliveryRegionId - delivery_region id to associated with the delivery_carrier.
1949
+ * @public
1950
+ * @documentationMaturity preview
1951
+ * @requiredField deliveryRegionId
1952
+ * @requiredField options
1953
+ * @requiredField options.deliveryCarrier
1954
+ * @permissionId ECOM.DELIVERY_CARRIER_ADD
1955
+ * @applicableIdentity APP
1956
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.AddDeliveryCarrier
1957
+ */
1958
+ declare function addDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<AddDeliveryCarrierOptions, `deliveryCarrier`>): Promise<NonNullablePaths<AddDeliveryCarrierResponse, {
1959
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1960
+ }[DeliveryProfileNonNullablePaths]> & {
1961
+ __applicationErrorsType?: AddDeliveryCarrierApplicationErrors;
1962
+ __validationErrorsType?: AddDeliveryCarrierValidationErrors;
1963
+ }>;
1604
1964
  interface AddDeliveryCarrierOptions {
1605
1965
  /** delivery_carrier to be added. */
1606
1966
  deliveryCarrier: DeliveryCarrier;
1607
1967
  }
1968
+ /**
1969
+ * Remove a delivery_carrier from a delivery region
1970
+ * @param deliveryRegionId - Id of the DeliveryRegion
1971
+ * @public
1972
+ * @documentationMaturity preview
1973
+ * @requiredField deliveryRegionId
1974
+ * @requiredField options
1975
+ * @requiredField options.appId
1976
+ * @permissionId ECOM.DELIVERY_CARRIER_REMOVE
1977
+ * @applicableIdentity APP
1978
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.RemoveDeliveryCarrier
1979
+ */
1980
+ declare function removeDeliveryCarrier(deliveryRegionId: string, options: NonNullablePaths<RemoveDeliveryCarrierOptions, `appId`>): Promise<NonNullablePaths<RemoveDeliveryCarrierResponse, {
1981
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
1982
+ }[DeliveryProfileNonNullablePaths]> & {
1983
+ __applicationErrorsType?: RemoveDeliveryCarrierApplicationErrors;
1984
+ }>;
1608
1985
  interface RemoveDeliveryCarrierOptions {
1609
1986
  /**
1610
1987
  * DeliveryCarrier app id to be removed.
@@ -1612,10 +1989,59 @@ interface RemoveDeliveryCarrierOptions {
1612
1989
  */
1613
1990
  appId: string;
1614
1991
  }
1992
+ /**
1993
+ * Update a delivery carrier in a delivery region
1994
+ * @param deliveryRegionId - DeliveryRegion id
1995
+ * @public
1996
+ * @documentationMaturity preview
1997
+ * @requiredField deliveryRegionId
1998
+ * @requiredField options.deliveryCarrier.appId
1999
+ * @permissionId ECOM.DELIVERY_CARRIER_UPDATE
2000
+ * @applicableIdentity APP
2001
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateDeliveryCarrier
2002
+ */
2003
+ declare function updateDeliveryCarrier(deliveryRegionId: string, options?: NonNullablePaths<UpdateDeliveryCarrierOptions, `deliveryCarrier.appId`>): Promise<NonNullablePaths<UpdateDeliveryCarrierResponse, {
2004
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
2005
+ }[DeliveryProfileNonNullablePaths]> & {
2006
+ __applicationErrorsType?: UpdateDeliveryCarrierApplicationErrors;
2007
+ }>;
1615
2008
  interface UpdateDeliveryCarrierOptions {
1616
2009
  /** Updated delivery_carrier */
1617
2010
  deliveryCarrier?: DeliveryCarrier;
1618
2011
  }
2012
+ /**
2013
+ * List all installed delivery carriers in order to set their ids in delivery rules
2014
+ * @public
2015
+ * @documentationMaturity preview
2016
+ * @permissionId ECOM.DELIVERY_CARRIER_DETAILS_READ
2017
+ * @applicableIdentity APP
2018
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListDeliveryCarrierDetails
2019
+ * @deprecated
2020
+ * @replacedBy ListInstalledDeliveryCarriers
2021
+ * @targetRemovalDate 2025-04-01
2022
+ */
2023
+ declare function listDeliveryCarrierDetails(): Promise<NonNullablePaths<ListDeliveryCarrierDetailsResponse, `deliveryCarrierDetails` | `deliveryCarrierDetails.${number}._id` | `deliveryCarrierDetails.${number}.displayName` | `deliveryCarrierDetails.${number}.toggleGetCarrierSettingsEnabled` | `deliveryCarrierDetails.${number}.toggleUpdateCarrierActiveStatusEnabled`>>;
2024
+ /** @public
2025
+ * @documentationMaturity preview
2026
+ * @permissionId ECOM.DELIVERY_CARRIER_READ
2027
+ * @applicableIdentity APP
2028
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListInstalledDeliveryCarriers
2029
+ */
2030
+ declare function listInstalledDeliveryCarriers(): Promise<NonNullablePaths<ListInstalledDeliveryCarriersResponse, `installedDeliveryCarriers` | `installedDeliveryCarriers.${number}._id` | `installedDeliveryCarriers.${number}.displayName` | `installedDeliveryCarriers.${number}.toggleGetCarrierSettingsEnabled`>>;
2031
+ /**
2032
+ * Get delivery carrier settings for a delivery profile and delivery region.
2033
+ * These are returned in a table format for the dashboard.
2034
+ * @param deliveryProfileId - Delivery profile id.
2035
+ * @public
2036
+ * @documentationMaturity preview
2037
+ * @requiredField deliveryProfileId
2038
+ * @permissionId ECOM.DELIVERY_CARRIER_READ
2039
+ * @applicableIdentity APP
2040
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.ListDeliveryCarriers
2041
+ */
2042
+ declare function listDeliveryCarriers(deliveryProfileId: string, options?: ListDeliveryCarriersOptions): Promise<NonNullablePaths<ListDeliveryCarriersResponse, `results` | `results.${number}.deliveryCarrierMetadata.success` | `results.${number}.deliveryCarrierMetadata.error.code` | `results.${number}.deliveryCarrierMetadata.error.description` | `results.${number}.deliveryCarrierDetails._id` | `results.${number}.deliveryCarrierDetails.displayName` | `results.${number}.deliveryCarrierDetails.toggleGetCarrierSettingsEnabled` | `results.${number}.deliveryCarrierDetails.toggleUpdateCarrierActiveStatusEnabled` | `bulkActionMetadata.totalSuccesses` | `bulkActionMetadata.totalFailures` | `bulkActionMetadata.undetailedFailures`> & {
2043
+ __applicationErrorsType?: ListDeliveryCarriersApplicationErrors;
2044
+ }>;
1619
2045
  interface ListDeliveryCarriersOptions {
1620
2046
  /**
1621
2047
  * Delivery app ids to get settings for.
@@ -1625,6 +2051,22 @@ interface ListDeliveryCarriersOptions {
1625
2051
  */
1626
2052
  appIds?: string[];
1627
2053
  }
2054
+ /**
2055
+ * Update carrier's external active settings
2056
+ * @param carrierId - Carrier id.
2057
+ * @public
2058
+ * @documentationMaturity preview
2059
+ * @requiredField carrierId
2060
+ * @requiredField options
2061
+ * @requiredField options.active
2062
+ * @requiredField options.rowId
2063
+ * @permissionId ECOM.DELIVERY_CARRIER_UPDATE
2064
+ * @applicableIdentity APP
2065
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateCarrierSettings
2066
+ */
2067
+ declare function updateCarrierSettings(carrierId: string, options: NonNullablePaths<UpdateCarrierSettingsOptions, `active` | `rowId`>): Promise<void & {
2068
+ __applicationErrorsType?: UpdateCarrierSettingsApplicationErrors;
2069
+ }>;
1628
2070
  interface UpdateCarrierSettingsOptions {
1629
2071
  /**
1630
2072
  * Row id triggered the change
@@ -1634,9 +2076,26 @@ interface UpdateCarrierSettingsOptions {
1634
2076
  /** New status */
1635
2077
  active: boolean | null;
1636
2078
  }
2079
+ /**
2080
+ * Updates extended fields of a DeliveryProfile without incrementing revision
2081
+ * @param _id - ID of the entity to update.
2082
+ * @param namespace - Identifier for the app whose extended fields are being updated.
2083
+ * @public
2084
+ * @documentationMaturity preview
2085
+ * @requiredField _id
2086
+ * @requiredField namespace
2087
+ * @requiredField options
2088
+ * @requiredField options.namespaceData
2089
+ * @permissionId ECOM.DELIVERY_PROFILE_UPDATE
2090
+ * @applicableIdentity APP
2091
+ * @fqn wix.ecom.deliveryprofile.v1.DeliveryProfiles.UpdateExtendedFields
2092
+ */
2093
+ declare function updateExtendedFields(_id: string, namespace: string, options: NonNullablePaths<UpdateExtendedFieldsOptions, `namespaceData`>): Promise<NonNullablePaths<UpdateExtendedFieldsResponse, {
2094
+ [P in DeliveryProfileNonNullablePaths]: `deliveryProfile.${P}`;
2095
+ }[DeliveryProfileNonNullablePaths]>>;
1637
2096
  interface UpdateExtendedFieldsOptions {
1638
2097
  /** Data to update. Structured according to the [schema](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields#json-schema-for-extended-fields) defined when the extended fields were configured. */
1639
2098
  namespaceData: Record<string, any> | null;
1640
2099
  }
1641
2100
 
1642
- export { type DeleteDefaultDeliveryProfileRequest as $, type AddDeliveryRegionOptions as A, type BackupRate as B, ChargeType as C, type DeliveryProfile as D, type AdditionalCharge as E, type Destination as F, type GetDeliveryProfileByDeliveryRegionIdResponse as G, type CreatedBy as H, type CreatedByIdOneOf as I, type ExtendedFields as J, type DeliveryRegionAdded as K, type ListDeliveryCarrierDetailsResponse as L, type DeliveryRegionRemoved as M, Namespace as N, type DeliveryRegionUpdated as O, type CreateDeliveryProfileRequest as P, type CreateDeliveryProfileResponse as Q, type RemoveDeliveryRegionIdentifiers as R, SortOrder as S, type GetDeliveryProfileRequest as T, type UpdateDeliveryProfile as U, type GetDeliveryProfileResponse as V, WebhookIdentityType as W, type UpdateDeliveryProfileRequest as X, type UpdateDeliveryProfileResponse as Y, type DeleteDeliveryProfileRequest as Z, type DeleteDeliveryProfileResponse as _, type DeliveryProfilesQueryBuilder as a, type DomainEventBodyOneOf as a$, type DeleteDefaultDeliveryProfileResponse as a0, type QueryDeliveryProfilesRequest as a1, type CursorQuery as a2, type CursorQueryPagingMethodOneOf as a3, type Sorting as a4, type CursorPaging as a5, type QueryDeliveryProfilesResponse as a6, type CursorPagingMetadata as a7, type Cursors as a8, type AddDeliveryRegionRequest as a9, type MetaSiteSpecialEvent as aA, type MetaSiteSpecialEventPayloadOneOf as aB, type Asset as aC, type SiteCreated as aD, type SiteTransferred as aE, type SiteDeleted as aF, type DeleteContext as aG, type SiteUndeleted as aH, type SitePublished as aI, type SiteUnpublished as aJ, type SiteMarkedAsTemplate as aK, type SiteMarkedAsWixSite as aL, type ServiceProvisioned as aM, type ServiceRemoved as aN, type SiteRenamed as aO, type SiteHardDeleted as aP, type NamespaceChanged as aQ, type StudioAssigned as aR, type StudioUnassigned as aS, type SiteUrlChanged as aT, type SitePurgedExternally as aU, type OdeditorAssigned as aV, type OdeditorUnassigned as aW, type PicassoAssigned as aX, type PicassoUnassigned as aY, type Empty as aZ, type DomainEvent as a_, type UpdateDeliveryRegionRequest as aa, type GetDeliveryProfileByDeliveryRegionIdRequest as ab, type RemoveDeliveryRegionRequest as ac, type AddDeliveryCarrierRequest as ad, type RemoveDeliveryCarrierRequest as ae, type UpdateDeliveryCarrierRequest as af, type ListDeliveryCarrierDetailsRequest as ag, type DeliveryCarrierDetails as ah, type ListInstalledDeliveryCarriersRequest as ai, type InstalledDeliveryCarrier as aj, type ListDeliveryDestinationsRequest as ak, type ListDeliveryDestinationsResponse as al, type RequiredZipcodeRequest as am, type RequiredZipcodeResponse as an, type ListDeliveryCarriersRequest as ao, type ListDeliveryCarriersResult as ap, type ItemMetadata as aq, type ApplicationError as ar, type DeliveryCarrierRegionalSettings as as, type DashboardTable as at, type Column as au, type Row as av, type BulkActionMetadata as aw, type UpdateCarrierSettingsRequest as ax, type UpdateCarrierSettingsResponse as ay, type UpdateExtendedFieldsRequest as az, type DeliveryRegion as b, type EntityCreatedEvent as b0, type RestoreInfo as b1, type EntityUpdatedEvent as b2, type EntityDeletedEvent as b3, type ActionEvent as b4, type MessageEnvelope as b5, type IdentificationData as b6, type IdentificationDataIdOneOf as b7, type DeliveryProfilesQueryResult as b8, type AddDeliveryRegionResponse as c, type UpdateDeliveryRegionIdentifiers as d, type UpdateDeliveryRegion as e, type UpdateDeliveryRegionOptions as f, type UpdateDeliveryRegionResponse as g, type RemoveDeliveryRegionOptions as h, type RemoveDeliveryRegionResponse as i, type AddDeliveryCarrierOptions as j, type AddDeliveryCarrierResponse as k, type RemoveDeliveryCarrierOptions as l, type RemoveDeliveryCarrierResponse as m, type UpdateDeliveryCarrierOptions as n, type UpdateDeliveryCarrierResponse as o, type ListInstalledDeliveryCarriersResponse as p, type ListDeliveryCarriersOptions as q, type ListDeliveryCarriersResponse as r, type UpdateCarrierSettingsOptions as s, type UpdateExtendedFieldsOptions as t, type UpdateExtendedFieldsResponse as u, DestinationScope as v, State as w, SiteCreatedContext as x, DeleteStatus as y, type DeliveryCarrier as z };
2101
+ export { type ActionEvent, type AddDeliveryCarrierApplicationErrors, type AddDeliveryCarrierOptions, type AddDeliveryCarrierRequest, type AddDeliveryCarrierResponse, type AddDeliveryCarrierValidationErrors, type AddDeliveryRegionApplicationErrors, type AddDeliveryRegionOptions, type AddDeliveryRegionRequest, type AddDeliveryRegionResponse, type AddDeliveryRegionValidationErrors, type AdditionalCharge, type ApplicationError, type Asset, type BackupRate, type BulkActionMetadata, ChargeType, type ChargeTypeWithLiterals, type Column, type CreateDeliveryProfileApplicationErrors, type CreateDeliveryProfileRequest, type CreateDeliveryProfileResponse, type CreateDeliveryProfileValidationErrors, type CreatedBy, type CreatedByIdOneOf, type CursorPaging, type CursorPagingMetadata, type CursorQuery, type CursorQueryPagingMethodOneOf, type Cursors, type DashboardTable, type DeleteContext, type DeleteDefaultDeliveryProfileRequest, type DeleteDefaultDeliveryProfileResponse, type DeleteDeliveryProfileRequest, type DeleteDeliveryProfileResponse, DeleteStatus, type DeleteStatusWithLiterals, type DeliveryCarrier, type DeliveryCarrierDetails, type DeliveryCarrierRegionalSettings, type DeliveryProfile, type DeliveryProfilesQueryBuilder, type DeliveryProfilesQueryResult, type DeliveryRegion, type DeliveryRegionAdded, type DeliveryRegionRemoved, type DeliveryRegionUpdated, type Destination, DestinationScope, type DestinationScopeWithLiterals, type DomainEvent, type DomainEventBodyOneOf, type Empty, type EntityCreatedEvent, type EntityDeletedEvent, type EntityUpdatedEvent, type ExtendedFields, type GetDeliveryProfileByDeliveryRegionIdApplicationErrors, type GetDeliveryProfileByDeliveryRegionIdRequest, type GetDeliveryProfileByDeliveryRegionIdResponse, type GetDeliveryProfileRequest, type GetDeliveryProfileResponse, type IdentificationData, type IdentificationDataIdOneOf, type InstalledDeliveryCarrier, type ItemMetadata, type ListDeliveryCarrierDetailsRequest, type ListDeliveryCarrierDetailsResponse, type ListDeliveryCarriersApplicationErrors, type ListDeliveryCarriersOptions, type ListDeliveryCarriersRequest, type ListDeliveryCarriersResponse, type ListDeliveryCarriersResult, type ListDeliveryDestinationsRequest, type ListDeliveryDestinationsResponse, type ListInstalledDeliveryCarriersRequest, type ListInstalledDeliveryCarriersResponse, type MessageEnvelope, type MetaSiteSpecialEvent, type MetaSiteSpecialEventPayloadOneOf, Namespace, type NamespaceChanged, type NamespaceWithLiterals, type OdeditorAssigned, type OdeditorUnassigned, type PicassoAssigned, type PicassoUnassigned, type QueryDeliveryProfilesRequest, type QueryDeliveryProfilesResponse, type RemoveDeliveryCarrierApplicationErrors, type RemoveDeliveryCarrierOptions, type RemoveDeliveryCarrierRequest, type RemoveDeliveryCarrierResponse, type RemoveDeliveryRegionApplicationErrors, type RemoveDeliveryRegionIdentifiers, type RemoveDeliveryRegionOptions, type RemoveDeliveryRegionRequest, type RemoveDeliveryRegionResponse, type RequiredZipcodeRequest, type RequiredZipcodeResponse, type RestoreInfo, type Row, type ServiceProvisioned, type ServiceRemoved, type SiteCreated, SiteCreatedContext, type SiteCreatedContextWithLiterals, type SiteDeleted, type SiteHardDeleted, type SiteMarkedAsTemplate, type SiteMarkedAsWixSite, type SitePublished, type SitePurgedExternally, type SiteRenamed, type SiteTransferred, type SiteUndeleted, type SiteUnpublished, type SiteUrlChanged, SortOrder, type SortOrderWithLiterals, type Sorting, State, type StateWithLiterals, type StudioAssigned, type StudioUnassigned, type UpdateCarrierSettingsApplicationErrors, type UpdateCarrierSettingsOptions, type UpdateCarrierSettingsRequest, type UpdateCarrierSettingsResponse, type UpdateDeliveryCarrierApplicationErrors, type UpdateDeliveryCarrierOptions, type UpdateDeliveryCarrierRequest, type UpdateDeliveryCarrierResponse, type UpdateDeliveryProfile, type UpdateDeliveryProfileApplicationErrors, type UpdateDeliveryProfileRequest, type UpdateDeliveryProfileResponse, type UpdateDeliveryRegion, type UpdateDeliveryRegionApplicationErrors, type UpdateDeliveryRegionIdentifiers, type UpdateDeliveryRegionOptions, type UpdateDeliveryRegionRequest, type UpdateDeliveryRegionResponse, type UpdateDeliveryRegionValidationErrors, type UpdateExtendedFieldsOptions, type UpdateExtendedFieldsRequest, type UpdateExtendedFieldsResponse, WebhookIdentityType, type WebhookIdentityTypeWithLiterals, addDeliveryCarrier, addDeliveryRegion, createDeliveryProfile, deleteDeliveryProfile, getDeliveryProfile, getDeliveryProfileByDeliveryRegionId, listDeliveryCarrierDetails, listDeliveryCarriers, listInstalledDeliveryCarriers, queryDeliveryProfiles, removeDeliveryCarrier, removeDeliveryRegion, updateCarrierSettings, updateDeliveryCarrier, updateDeliveryProfile, updateDeliveryRegion, updateExtendedFields };