@shipengine/alchemy 4.1.0 → 4.1.1

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 +31 -0
  2. package/index.mjs +31 -1
  3. package/package.json +1 -1
package/index.js CHANGED
@@ -7622,6 +7622,19 @@ var lib = {
7622
7622
  stringify: stringify
7623
7623
  };
7624
7624
 
7625
+ class AccountBillingPlanAPI {
7626
+ constructor(client) {
7627
+ this.client = client;
7628
+ /**
7629
+ * The `get` method retrieves the account billing plan for the current user.
7630
+ */
7631
+ this.get = () => {
7632
+ return this.client.get("/v1/account/billing_plan");
7633
+ };
7634
+ this.client = client;
7635
+ }
7636
+ }
7637
+
7625
7638
  class CustomPackagesAPI {
7626
7639
  constructor(client) {
7627
7640
  this.client = client;
@@ -8220,6 +8233,13 @@ class ShipEngineAPI {
8220
8233
  get accountSettings() {
8221
8234
  return new AccountSettingsAPI(this.client);
8222
8235
  }
8236
+ /**
8237
+ * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
8238
+ * in ShipEngine API.
8239
+ */
8240
+ get accountBillingPlan() {
8241
+ return new AccountBillingPlanAPI(this.client);
8242
+ }
8223
8243
  /**
8224
8244
  * The `addresses` method provides access to the Address Validation endpoints
8225
8245
  * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -9819,6 +9839,16 @@ const useUpdateWarehouse = () => {
9819
9839
  });
9820
9840
  };
9821
9841
 
9842
+ const useGetAccountBillingPlan = () => {
9843
+ const { client } = useShipEngine();
9844
+ return reactQuery.useQuery({
9845
+ onError,
9846
+ queryFn: () => client.accountBillingPlan.get(),
9847
+ queryKey: ["useGetAccountBillingPlan"],
9848
+ select: (result) => result.data
9849
+ });
9850
+ };
9851
+
9822
9852
  const fallbackThemeData = {
9823
9853
  borderRadius: {
9824
9854
  L: "16px",
@@ -10989,6 +11019,7 @@ exports.useDeleteRateCard = useDeleteRateCard;
10989
11019
  exports.useDeleteWarehouse = useDeleteWarehouse;
10990
11020
  exports.useDownloadRateCard = useDownloadRateCard;
10991
11021
  exports.useFundingSourcesAddFunds = useFundingSourcesAddFunds;
11022
+ exports.useGetAccountBillingPlan = useGetAccountBillingPlan;
10992
11023
  exports.useGetAccountSettings = useGetAccountSettings;
10993
11024
  exports.useGetAutoFundingConfiguration = useGetAutoFundingConfiguration;
10994
11025
  exports.useGetCarrierById = useGetCarrierById;
package/index.mjs CHANGED
@@ -7600,6 +7600,19 @@ var lib = {
7600
7600
  stringify: stringify
7601
7601
  };
7602
7602
 
7603
+ class AccountBillingPlanAPI {
7604
+ constructor(client) {
7605
+ this.client = client;
7606
+ /**
7607
+ * The `get` method retrieves the account billing plan for the current user.
7608
+ */
7609
+ this.get = () => {
7610
+ return this.client.get("/v1/account/billing_plan");
7611
+ };
7612
+ this.client = client;
7613
+ }
7614
+ }
7615
+
7603
7616
  class CustomPackagesAPI {
7604
7617
  constructor(client) {
7605
7618
  this.client = client;
@@ -8198,6 +8211,13 @@ class ShipEngineAPI {
8198
8211
  get accountSettings() {
8199
8212
  return new AccountSettingsAPI(this.client);
8200
8213
  }
8214
+ /**
8215
+ * The `accountBillingPlan` method provides access to the Account Billing Plan endpoints
8216
+ * in ShipEngine API.
8217
+ */
8218
+ get accountBillingPlan() {
8219
+ return new AccountBillingPlanAPI(this.client);
8220
+ }
8201
8221
  /**
8202
8222
  * The `addresses` method provides access to the Address Validation endpoints
8203
8223
  * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -9797,6 +9817,16 @@ const useUpdateWarehouse = () => {
9797
9817
  });
9798
9818
  };
9799
9819
 
9820
+ const useGetAccountBillingPlan = () => {
9821
+ const { client } = useShipEngine();
9822
+ return useQuery({
9823
+ onError,
9824
+ queryFn: () => client.accountBillingPlan.get(),
9825
+ queryKey: ["useGetAccountBillingPlan"],
9826
+ select: (result) => result.data
9827
+ });
9828
+ };
9829
+
9800
9830
  const fallbackThemeData = {
9801
9831
  borderRadius: {
9802
9832
  L: "16px",
@@ -10912,4 +10942,4 @@ const alchemy = {
10912
10942
  createElement
10913
10943
  };
10914
10944
 
10915
- 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, 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 };
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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@shipengine/alchemy",
3
- "version": "4.1.0",
3
+ "version": "4.1.1",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {