@shipengine/react-api 2.1.2 → 2.2.0

package/hooks/index.d.ts

@@ -17,3 +17,4 @@ export * from "./themes";
 export * from "./warehouses";
 export * from "./rate-cards";
 export * from "./account-billing-plan";
+export * from "./service-points";

package/hooks/service-points/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./use-list-service-points";
+export * from "./use-get-service-point";

package/hooks/service-points/use-get-service-point.d.ts

@@ -0,0 +1,7 @@
+import { GetServicePointParams } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/service_points_get_by_id)
+ */
+export declare const useGetServicePoint: ({ carrierCode, countryCode, id, }: Partial<GetServicePointParams>) => import("@tanstack/react-query").UseQueryResult<any, import("@shipengine/js-api").CodedError[]>;

package/hooks/service-points/use-list-service-points.d.ts

@@ -0,0 +1,7 @@
+import { ListServicePointsOptions } from "@shipengine/js-api";
+/**
+ * @category ShipEngine API Hooks
+ *
+ * @see [ShipEngine API Reference](https://shipengine.github.io/shipengine-openapi/#operation/service_points_list)
+ */
+export declare const useListServicePoints: (options: ListServicePointsOptions) => import("@tanstack/react-query").UseQueryResult<import("@shipengine/js-api").ServicePointsListResponse, import("@shipengine/js-api").CodedError[]>;

package/hooks/shipping-rules/use-create-shipping-rule.d.ts

@@ -1,6 +1,6 @@
-import { ShippingRuleInput } from "@shipengine/js-api";
+import { ShippingRuleCreateInput } from "@shipengine/js-api";
 /**
  * @category ShipEngine API Hooks
  *
  */
-export declare const useCreateShippingRule: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[], ShippingRuleInput, unknown>;
+export declare const useCreateShippingRule: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[], ShippingRuleCreateInput, unknown>;

package/hooks/shipping-rules/use-edit-shipping-rule.d.ts

@@ -1,6 +1,6 @@
-import { ShippingRule } from "@shipengine/js-api";
+import { ShippingRuleEditInput } from "@shipengine/js-api";
 /**
  * @category ShipEngine API Hooks
  *
  */
-export declare const useEditShippingRule: () => import("@tanstack/react-query").UseMutationResult<ShippingRule, import("@shipengine/js-api").CodedError[], ShippingRule, unknown>;
+export declare const useEditShippingRule: () => import("@tanstack/react-query").UseMutationResult<import("@shipengine/js-api").ShippingRule, import("@shipengine/js-api").CodedError[], ShippingRuleEditInput, unknown>;

package/index.js

@@ -1965,6 +1965,39 @@ const useUpdateAccountBillingPlan = () => {
   });
 };
 
+const useListServicePoints = (options) => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    onError,
+    queryFn: () => client.servicePoints.list(options),
+    queryKey: ["useListServicePoints"],
+    select: (result) => result.data
+  });
+};
+
+const useGetServicePoint = ({
+  carrierCode,
+  countryCode,
+  id
+}) => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    enabled: !!carrierCode && !!countryCode && !!id,
+    onError,
+    queryFn: () => {
+      if (carrierCode === void 0)
+        return Promise.reject(new Error("carrierCode required"));
+      if (countryCode === void 0)
+        return Promise.reject(new Error("countryCode required"));
+      if (id === void 0)
+        return Promise.reject(new Error("id required"));
+      return client.servicePoints.get({ carrierCode, countryCode, id });
+    },
+    queryKey: ["useGetServicePoint", carrierCode, countryCode, id],
+    select: (result) => result.data
+  });
+};
+
 exports.ShipEngine = ShipEngine;
 exports.ShipEngineContext = ShipEngineContext;
 exports.delay = delay;
@@ -2008,6 +2041,7 @@ exports.useGetPackageRatingGroupByCarrier = useGetPackageRatingGroupByCarrier;
 exports.useGetRateCardById = useGetRateCardById;
 exports.useGetSalesOrder = useGetSalesOrder;
 exports.useGetSalesOrderShipment = useGetSalesOrderShipment;
+exports.useGetServicePoint = useGetServicePoint;
 exports.useGetServicesByCarrier = useGetServicesByCarrier;
 exports.useGetShipment = useGetShipment;
 exports.useGetShipmentRates = useGetShipmentRates;
@@ -2024,6 +2058,7 @@ exports.useListOrderSources = useListOrderSources;
 exports.useListRateCards = useListRateCards;
 exports.useListSalesOrderShipments = useListSalesOrderShipments;
 exports.useListSalesOrders = useListSalesOrders;
+exports.useListServicePoints = useListServicePoints;
 exports.useListShipments = useListShipments;
 exports.useListShippingRules = useListShippingRules;
 exports.useListWarehouses = useListWarehouses;

package/index.mjs

@@ -1962,4 +1962,37 @@ const useUpdateAccountBillingPlan = () => {
   });
 };
 
-export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useAddInsuranceFunds, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeactivateOrderSource, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCarrierConnectionForm, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarrierConnections, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
+const useListServicePoints = (options) => {
+  const { client } = useShipEngine();
+  return useQuery({
+    onError,
+    queryFn: () => client.servicePoints.list(options),
+    queryKey: ["useListServicePoints"],
+    select: (result) => result.data
+  });
+};
+
+const useGetServicePoint = ({
+  carrierCode,
+  countryCode,
+  id
+}) => {
+  const { client } = useShipEngine();
+  return useQuery({
+    enabled: !!carrierCode && !!countryCode && !!id,
+    onError,
+    queryFn: () => {
+      if (carrierCode === void 0)
+        return Promise.reject(new Error("carrierCode required"));
+      if (countryCode === void 0)
+        return Promise.reject(new Error("countryCode required"));
+      if (id === void 0)
+        return Promise.reject(new Error("id required"));
+      return client.servicePoints.get({ carrierCode, countryCode, id });
+    },
+    queryKey: ["useGetServicePoint", carrierCode, countryCode, id],
+    select: (result) => result.data
+  });
+};
+
+export { ShipEngine, ShipEngineContext, delay, logger, onError, retryUntil, useAddFunds, useAddInsuranceFunds, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeactivateOrderSource, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCarrierConnectionForm, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicePoint, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetZonesByCarrier, useListCarrierConnections, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListServicePoints, useListShipments, useListShippingRules, useListWarehouses, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/react-api",
-  "version": "2.1.2",
+  "version": "2.2.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {