@shipengine/alchemy 4.1.1 → 4.1.3

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 +36 -0
  2. package/index.mjs +35 -1
  3. package/package.json +1 -1
package/index.js CHANGED
@@ -8030,6 +8030,19 @@ class ShipmentsAPI {
8030
8030
  }
8031
8031
  }
8032
8032
 
8033
+ class ShippingRulesAPI {
8034
+ constructor(client) {
8035
+ this.client = client;
8036
+ /**
8037
+ * The `list` method retrieves the list of shipping rules by seller.
8038
+ */
8039
+ this.list = () => {
8040
+ return this.client.get(`/v1/shipping_rules`);
8041
+ };
8042
+ this.client = client;
8043
+ }
8044
+ }
8045
+
8033
8046
  class WarehousesAPI {
8034
8047
  constructor(client) {
8035
8048
  this.client = client;
@@ -8357,6 +8370,15 @@ class ShipEngineAPI {
8357
8370
  get warehouses() {
8358
8371
  return new WarehousesAPI(this.client);
8359
8372
  }
8373
+ /**
8374
+ * The `shippingRules` method provides access to the Shipping Rules endpoints in ShipEngine
8375
+ * API.
8376
+ *
8377
+ * @see {@link ShippingRulesAPI | The Shipping Rules API module}
8378
+ */
8379
+ get shippingRules() {
8380
+ return new ShippingRulesAPI(this.client);
8381
+ }
8360
8382
  }
8361
8383
 
8362
8384
  const ShipEngineContext = React.createContext(void 0);
@@ -9715,6 +9737,18 @@ const useListShipments = (_params) => {
9715
9737
  });
9716
9738
  };
9717
9739
 
9740
+ const useListShippingRules = () => {
9741
+ const { client } = useShipEngine();
9742
+ return reactQuery.useQuery({
9743
+ onError,
9744
+ queryFn: () => {
9745
+ return client.shippingRules.list();
9746
+ },
9747
+ queryKey: ["useListShippingRules"],
9748
+ select: (result) => result.data.shippingRules
9749
+ });
9750
+ };
9751
+
9718
9752
  var __async$3 = (__this, __arguments, generator) => {
9719
9753
  return new Promise((resolve, reject) => {
9720
9754
  var fulfilled = (value) => {
@@ -10994,6 +11028,7 @@ exports.ShipEngine = ShipEngine;
10994
11028
  exports.ShipEngineAPI = ShipEngineAPI;
10995
11029
  exports.ShipEngineContext = ShipEngineContext;
10996
11030
  exports.ShipmentsAPI = ShipmentsAPI;
11031
+ exports.ShippingRulesAPI = ShippingRulesAPI;
10997
11032
  exports.WarehousesAPI = WarehousesAPI;
10998
11033
  exports.alchemy = alchemy;
10999
11034
  exports.default = alchemy;
@@ -11047,6 +11082,7 @@ exports.useListRateCards = useListRateCards;
11047
11082
  exports.useListSalesOrderShipments = useListSalesOrderShipments;
11048
11083
  exports.useListSalesOrders = useListSalesOrders;
11049
11084
  exports.useListShipments = useListShipments;
11085
+ exports.useListShippingRules = useListShippingRules;
11050
11086
  exports.useListWarehouses = useListWarehouses;
11051
11087
  exports.useLoadIcons = useLoadIcons;
11052
11088
  exports.useNotifySalesOrderShipped = useNotifySalesOrderShipped;
package/index.mjs CHANGED
@@ -8008,6 +8008,19 @@ class ShipmentsAPI {
8008
8008
  }
8009
8009
  }
8010
8010
 
8011
+ class ShippingRulesAPI {
8012
+ constructor(client) {
8013
+ this.client = client;
8014
+ /**
8015
+ * The `list` method retrieves the list of shipping rules by seller.
8016
+ */
8017
+ this.list = () => {
8018
+ return this.client.get(`/v1/shipping_rules`);
8019
+ };
8020
+ this.client = client;
8021
+ }
8022
+ }
8023
+
8011
8024
  class WarehousesAPI {
8012
8025
  constructor(client) {
8013
8026
  this.client = client;
@@ -8335,6 +8348,15 @@ class ShipEngineAPI {
8335
8348
  get warehouses() {
8336
8349
  return new WarehousesAPI(this.client);
8337
8350
  }
8351
+ /**
8352
+ * The `shippingRules` method provides access to the Shipping Rules endpoints in ShipEngine
8353
+ * API.
8354
+ *
8355
+ * @see {@link ShippingRulesAPI | The Shipping Rules API module}
8356
+ */
8357
+ get shippingRules() {
8358
+ return new ShippingRulesAPI(this.client);
8359
+ }
8338
8360
  }
8339
8361
 
8340
8362
  const ShipEngineContext = createContext(void 0);
@@ -9693,6 +9715,18 @@ const useListShipments = (_params) => {
9693
9715
  });
9694
9716
  };
9695
9717
 
9718
+ const useListShippingRules = () => {
9719
+ const { client } = useShipEngine();
9720
+ return useQuery({
9721
+ onError,
9722
+ queryFn: () => {
9723
+ return client.shippingRules.list();
9724
+ },
9725
+ queryKey: ["useListShippingRules"],
9726
+ select: (result) => result.data.shippingRules
9727
+ });
9728
+ };
9729
+
9696
9730
  var __async$3 = (__this, __arguments, generator) => {
9697
9731
  return new Promise((resolve, reject) => {
9698
9732
  var fulfilled = (value) => {
@@ -10942,4 +10976,4 @@ const alchemy = {
10942
10976
  createElement
10943
10977
  };
10944
10978
 
10945
- export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEmotionCache, getEndUserIpAddress, isCodedError, isCodedErrors, logger, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useFundingSourcesAddFunds, useGetAccountBillingPlan, 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, useLoadIcons, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
10979
+ export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, ShippingRulesAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEmotionCache, getEndUserIpAddress, isCodedError, isCodedErrors, logger, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useFundingSourcesAddFunds, useGetAccountBillingPlan, 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, useListShippingRules, useListWarehouses, useLoadIcons, 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": "4.1.1",
3
+ "version": "4.1.3",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {