@shipengine/alchemy 5.0.25 → 5.0.26

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 +38 -0
  2. package/index.mjs +37 -1
  3. package/package.json +1 -1
package/index.js CHANGED
@@ -16495,6 +16495,19 @@ class ShippingRulesAPI {
16495
16495
  }
16496
16496
  }
16497
16497
 
16498
+ class ThemesAPI {
16499
+ constructor(client) {
16500
+ this.client = client;
16501
+ /**
16502
+ * The `get` method retrieves a specific theme by `themeId`.
16503
+ */
16504
+ this.get = (themeId) => {
16505
+ return this.client.get(`/v1/themes/${themeId}`);
16506
+ };
16507
+ this.client = client;
16508
+ }
16509
+ }
16510
+
16498
16511
  class WarehousesAPI {
16499
16512
  constructor(client) {
16500
16513
  this.client = client;
@@ -16813,6 +16826,14 @@ class ShipEngineAPI {
16813
16826
  get shipments() {
16814
16827
  return new ShipmentsAPI(this.client);
16815
16828
  }
16829
+ /**
16830
+ * The `themes` method provides access to the Themes endpoints in ShipEngine API.
16831
+ *
16832
+ * @see {@link ThemesAPI | The Themes API module}
16833
+ */
16834
+ get themes() {
16835
+ return new ThemesAPI(this.client);
16836
+ }
16816
16837
  /**
16817
16838
  * The `warehouses` method provides access to the Warehouses endpoints in ShipEngine
16818
16839
  * API. e.g. List Warehouses, Get Warehouse, etc.
@@ -18465,6 +18486,21 @@ const useGetShippingRuleById = (shippingRuleId) => {
18465
18486
  });
18466
18487
  };
18467
18488
 
18489
+ const useGetThemeById = (themeId) => {
18490
+ const { client } = useShipEngine();
18491
+ return reactQuery.useQuery({
18492
+ enabled: !!themeId,
18493
+ onError,
18494
+ queryFn: () => {
18495
+ if (themeId)
18496
+ return client.themes.get(themeId);
18497
+ return Promise.reject(new Error("themeId is required"));
18498
+ },
18499
+ queryKey: ["useGetThemeById", themeId],
18500
+ select: (result) => result.data
18501
+ });
18502
+ };
18503
+
18468
18504
  var __async$4 = (__this, __arguments, generator) => {
18469
18505
  return new Promise((resolve, reject) => {
18470
18506
  var fulfilled = (value) => {
@@ -19780,6 +19816,7 @@ exports.ShipEngineAPI = ShipEngineAPI;
19780
19816
  exports.ShipEngineContext = ShipEngineContext;
19781
19817
  exports.ShipmentsAPI = ShipmentsAPI;
19782
19818
  exports.ShippingRulesAPI = ShippingRulesAPI;
19819
+ exports.ThemesAPI = ThemesAPI;
19783
19820
  exports.WarehousesAPI = WarehousesAPI;
19784
19821
  exports.alchemy = alchemy;
19785
19822
  exports.default = alchemy;
@@ -19831,6 +19868,7 @@ exports.useGetShipment = useGetShipment;
19831
19868
  exports.useGetShipmentRates = useGetShipmentRates;
19832
19869
  exports.useGetShippingRuleById = useGetShippingRuleById;
19833
19870
  exports.useGetShippingRuleConditionsOptions = useGetShippingRuleConditionsOptions;
19871
+ exports.useGetThemeById = useGetThemeById;
19834
19872
  exports.useGetWalletHistory = useGetWalletHistory;
19835
19873
  exports.useGetZonesByCarrier = useGetZonesByCarrier;
19836
19874
  exports.useI18n = useI18n;
package/index.mjs CHANGED
@@ -16473,6 +16473,19 @@ class ShippingRulesAPI {
16473
16473
  }
16474
16474
  }
16475
16475
 
16476
+ class ThemesAPI {
16477
+ constructor(client) {
16478
+ this.client = client;
16479
+ /**
16480
+ * The `get` method retrieves a specific theme by `themeId`.
16481
+ */
16482
+ this.get = (themeId) => {
16483
+ return this.client.get(`/v1/themes/${themeId}`);
16484
+ };
16485
+ this.client = client;
16486
+ }
16487
+ }
16488
+
16476
16489
  class WarehousesAPI {
16477
16490
  constructor(client) {
16478
16491
  this.client = client;
@@ -16791,6 +16804,14 @@ class ShipEngineAPI {
16791
16804
  get shipments() {
16792
16805
  return new ShipmentsAPI(this.client);
16793
16806
  }
16807
+ /**
16808
+ * The `themes` method provides access to the Themes endpoints in ShipEngine API.
16809
+ *
16810
+ * @see {@link ThemesAPI | The Themes API module}
16811
+ */
16812
+ get themes() {
16813
+ return new ThemesAPI(this.client);
16814
+ }
16794
16815
  /**
16795
16816
  * The `warehouses` method provides access to the Warehouses endpoints in ShipEngine
16796
16817
  * API. e.g. List Warehouses, Get Warehouse, etc.
@@ -18443,6 +18464,21 @@ const useGetShippingRuleById = (shippingRuleId) => {
18443
18464
  });
18444
18465
  };
18445
18466
 
18467
+ const useGetThemeById = (themeId) => {
18468
+ const { client } = useShipEngine();
18469
+ return useQuery({
18470
+ enabled: !!themeId,
18471
+ onError,
18472
+ queryFn: () => {
18473
+ if (themeId)
18474
+ return client.themes.get(themeId);
18475
+ return Promise.reject(new Error("themeId is required"));
18476
+ },
18477
+ queryKey: ["useGetThemeById", themeId],
18478
+ select: (result) => result.data
18479
+ });
18480
+ };
18481
+
18446
18482
  var __async$4 = (__this, __arguments, generator) => {
18447
18483
  return new Promise((resolve, reject) => {
18448
18484
  var fulfilled = (value) => {
@@ -19724,4 +19760,4 @@ const alchemy = {
19724
19760
  createElement
19725
19761
  };
19726
19762
 
19727
- export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, 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, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetWalletHistory, useGetZonesByCarrier, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useLoadIcons, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, useUpdateAccountSettings, useUpdateAutoFunding, useUpdateFundingSource, useUpdateRateCard, useUpdateSalesOrderShipment, useUpdateWarehouse, useUploadRateCard, useValidateAddresses, useVoidLabel };
19763
+ export { AccountSettingsAPI, AddressesAPI, AlchemyContext, AlchemyProvider, AlchemyTestProvider, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, Element, ErrorBoundary, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngine, ShipEngineAPI, ShipEngineContext, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, alchemy, alchemy as default, delay, getEmotionCache, getEndUserIpAddress, isCodedError, isCodedErrors, logger, onError, retryUntil, useAddFunds, useAlchemy, useCalculateRates, useConnectCarrier, useCreateAccountImage, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteAccountImage, useDeleteRateCard, useDeleteShippingRule, useDeleteWarehouse, useDownloadRateCard, useEditShippingRule, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountImages, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, useGetFundingSourceTransactions, useGetInsuranceAccount, useGetLabel, useGetPackageRatingGroupByCarrier, useGetRateCardById, useGetSalesOrder, useGetSalesOrderShipment, useGetServicesByCarrier, useGetShipment, useGetShipmentRates, useGetShippingRuleById, useGetShippingRuleConditionsOptions, useGetThemeById, useGetWalletHistory, useGetZonesByCarrier, useI18n, useListCarriers, useListCustomPackageTypes, useListFundingSources, useListLabels, useListOrderSources, useListRateCards, useListSalesOrderShipments, useListSalesOrders, useListShipments, useListShippingRules, useListWarehouses, useLoadIcons, useNotifySalesOrderShipped, useParseAddress, usePublishRateCard, useRefreshOrderSource, useRefreshOrderSourceAsync, useRegisterCarrier, useShipEngine, useUpdateAccountBillingPlan, useUpdateAccountImage, 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": "5.0.25",
3
+ "version": "5.0.26",
4
4
  "main": "./index.js",
5
5
  "types": "./index.d.ts",
6
6
  "exports": {