@shipengine/alchemy 2.3.0 → 2.3.2

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 (3) hide show
  1. package/index.js +26 -0
  2. package/index.mjs +26 -1
  3. package/package.json +1 -1
package/index.js CHANGED
@@ -2525,6 +2525,7 @@ var Currency = /* @__PURE__ */ ((Currency2) => {
2525
2525
 
2526
2526
  var RateCardStatus = /* @__PURE__ */ ((RateCardStatus2) => {
2527
2527
  RateCardStatus2["DRAFT"] = "Draft";
2528
+ RateCardStatus2["DELETED"] = "Deleted";
2528
2529
  RateCardStatus2["PUBLISHED"] = "Published";
2529
2530
  return RateCardStatus2;
2530
2531
  })(RateCardStatus || {});
@@ -5441,6 +5442,13 @@ class CarriersAPI {
5441
5442
  this.getCurrencies = (carrierId) => {
5442
5443
  return this.client.get(`/v1/carriers/${carrierId}/currencies`);
5443
5444
  };
5445
+ /**
5446
+ * The `getZones` method retrieves a list of zones for which the attached carrier
5447
+ * provides support to.
5448
+ */
5449
+ this.getZones = (carrierId) => {
5450
+ return this.client.get(`/v1/carriers/${carrierId}/zones`);
5451
+ };
5444
5452
  this.client = client;
5445
5453
  }
5446
5454
  }
@@ -8778,6 +8786,23 @@ const useUpdateAutoFunding = (carrierId) => {
8778
8786
  });
8779
8787
  };
8780
8788
 
8789
+ const useGetZonesByCarrier = (carrierId) => {
8790
+ const { client } = useShipEngine();
8791
+ return reactQuery.useQuery({
8792
+ enabled: !!carrierId,
8793
+ onError,
8794
+ queryFn: () => {
8795
+ if (carrierId)
8796
+ return client.carriers.getZones(carrierId);
8797
+ return Promise.reject(new Error("carrierId is required"));
8798
+ },
8799
+ queryKey: ["useGetZonesByCarrier", carrierId],
8800
+ select: (result) => result.data.zones,
8801
+ // Fresh for 5 minutes
8802
+ staleTime: 5 * 60 * 1e3
8803
+ });
8804
+ };
8805
+
8781
8806
  const useListCustomPackageTypes = () => {
8782
8807
  const { client } = useShipEngine();
8783
8808
  return reactQuery.useQuery({
@@ -10649,6 +10674,7 @@ exports.useGetServicesByCarrier = useGetServicesByCarrier;
10649
10674
  exports.useGetShipment = useGetShipment;
10650
10675
  exports.useGetShipmentRates = useGetShipmentRates;
10651
10676
  exports.useGetWalletHistory = useGetWalletHistory;
10677
+ exports.useGetZonesByCarrier = useGetZonesByCarrier;
10652
10678
  exports.useI18n = useI18n;
10653
10679
  exports.useListCarriers = useListCarriers;
10654
10680
  exports.useListCustomPackageTypes = useListCustomPackageTypes;
package/index.mjs CHANGED
@@ -2503,6 +2503,7 @@ var Currency = /* @__PURE__ */ ((Currency2) => {
2503
2503
 
2504
2504
  var RateCardStatus = /* @__PURE__ */ ((RateCardStatus2) => {
2505
2505
  RateCardStatus2["DRAFT"] = "Draft";
2506
+ RateCardStatus2["DELETED"] = "Deleted";
2506
2507
  RateCardStatus2["PUBLISHED"] = "Published";
2507
2508
  return RateCardStatus2;
2508
2509
  })(RateCardStatus || {});
@@ -5419,6 +5420,13 @@ class CarriersAPI {
5419
5420
  this.getCurrencies = (carrierId) => {
5420
5421
  return this.client.get(`/v1/carriers/${carrierId}/currencies`);
5421
5422
  };
5423
+ /**
5424
+ * The `getZones` method retrieves a list of zones for which the attached carrier
5425
+ * provides support to.
5426
+ */
5427
+ this.getZones = (carrierId) => {
5428
+ return this.client.get(`/v1/carriers/${carrierId}/zones`);
5429
+ };
5422
5430
  this.client = client;
5423
5431
  }
5424
5432
  }
@@ -8756,6 +8764,23 @@ const useUpdateAutoFunding = (carrierId) => {
8756
8764
  });
8757
8765
  };
8758
8766
 
8767
+ const useGetZonesByCarrier = (carrierId) => {
8768
+ const { client } = useShipEngine();
8769
+ return useQuery({
8770
+ enabled: !!carrierId,
8771
+ onError,
8772
+ queryFn: () => {
8773
+ if (carrierId)
8774
+ return client.carriers.getZones(carrierId);
8775
+ return Promise.reject(new Error("carrierId is required"));
8776
+ },
8777
+ queryKey: ["useGetZonesByCarrier", carrierId],
8778
+ select: (result) => result.data.zones,
8779
+ // Fresh for 5 minutes
8780
+ staleTime: 5 * 60 * 1e3
8781
+ });
8782
+ };
8783
+
8759
8784
  const useListCustomPackageTypes = () => {
8760
8785
  const { client } = useShipEngine();
8761
8786
  return useQuery({
@@ -10554,4 +10579,4 @@ const alchemy = {
10554
10579
  createElement
10555
10580
  };
10556
10581
 
10557
- export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ElementContainerProvider, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEndUserIpAddress, isCodedError, isCodedErrors, logger, memoizedCreateCache, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useElementContainer, useFundingSourcesAddFunds, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useLoadFonts, useLoadIcons, useLoadTheme, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
10582
+ export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ElementContainerProvider, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEndUserIpAddress, isCodedError, isCodedErrors, logger, memoizedCreateCache, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useElementContainer, useFundingSourcesAddFunds, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetWalletHistory, useGetZonesByCarrier, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListWarehouses, useLoadFonts, useLoadIcons, useLoadTheme, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/alchemy",
3
- "version": "2.3.0",
3
+ "version": "2.3.2",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {