@shipengine/alchemy 4.1.6 → 4.1.8

package/index.js

@@ -2469,6 +2469,12 @@ Object.defineProperty(dist, "__esModule", { value: true });
 var _default = dist.default = (function () {
 });
 
+var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeType2) => {
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Downgrade"] = 0] = "Downgrade";
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Cancellation"] = 1] = "Cancellation";
+  return AccountBillingPlanChangeType2;
+})(AccountBillingPlanChangeType || {});
+
 var __getOwnPropSymbols$d = Object.getOwnPropertySymbols;
 var __hasOwnProp$d = Object.prototype.hasOwnProperty;
 var __propIsEnum$d = Object.prototype.propertyIsEnumerable;
@@ -2498,6 +2504,38 @@ class CodedError {
   }
 }
 
+var MetadataCapability = /* @__PURE__ */ ((MetadataCapability2) => {
+  MetadataCapability2["AutoFunding"] = "auto_funding";
+  MetadataCapability2["UpdatePaymentMethod"] = "update_payment_method";
+  MetadataCapability2["DefaultPurchaseAmount"] = "default_purchase_amount";
+  MetadataCapability2["ReportsLink"] = "reports_link";
+  MetadataCapability2["BalanceHistory"] = "balance_history";
+  MetadataCapability2["Nickname"] = "nickname";
+  MetadataCapability2["RefreshServices"] = "refresh_services";
+  MetadataCapability2["UpdatePassword"] = "update_password";
+  MetadataCapability2["AccountSettingsLink"] = "account_settings_link";
+  MetadataCapability2["Unknown"] = "unknown";
+  return MetadataCapability2;
+})(MetadataCapability || {});
+var MetadataRequirement = /* @__PURE__ */ ((MetadataRequirement2) => {
+  MetadataRequirement2["BillingAddress"] = "billing_address";
+  MetadataRequirement2["CurrencyCode"] = "currency_code";
+  MetadataRequirement2["IovationBlackBox"] = "iovation_black_box";
+  MetadataRequirement2["Nickname"] = "nickname";
+  MetadataRequirement2["PaymentMethod"] = "payment_method";
+  MetadataRequirement2["PickupAddress"] = "pickup_address";
+  MetadataRequirement2["Unknown"] = "unknown";
+  return MetadataRequirement2;
+})(MetadataRequirement || {});
+var MetadataSatisfyingFormTypes = /* @__PURE__ */ ((MetadataSatisfyingFormTypes2) => {
+  MetadataSatisfyingFormTypes2["Address"] = "address";
+  MetadataSatisfyingFormTypes2["CreditCard"] = "credit_card";
+  MetadataSatisfyingFormTypes2["StampsAccountCredentials"] = "stamps_account_credentials";
+  MetadataSatisfyingFormTypes2["StampSellerLabelProvider"] = "stamps_seller_label_provider";
+  MetadataSatisfyingFormTypes2["Unknown"] = "unknown";
+  return MetadataSatisfyingFormTypes2;
+})(MetadataSatisfyingFormTypes || {});
+
 var CreditCardVendor = /* @__PURE__ */ ((CreditCardVendor2) => {
   CreditCardVendor2["AMERICAN_EXPRESS"] = "americanexpress";
   CreditCardVendor2["DISCOVER"] = "discover";
@@ -2555,6 +2593,7 @@ var InsuranceProviderType = /* @__PURE__ */ ((InsuranceProviderType2) => {
 
 const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   __proto__: null,
+  AccountBillingPlanChangeType,
   CodedError,
   ConfirmationType,
   CreditCardVendor,
@@ -2562,6 +2601,9 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   CustomsContentsType,
   CustomsNonDeliveryType,
   InsuranceProviderType,
+  MetadataCapability,
+  MetadataRequirement,
+  MetadataSatisfyingFormTypes,
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
@@ -7750,6 +7792,13 @@ class FundingSourcesAPI {
         amount
       );
     });
+    /**
+     * The `metadata` method returns seller-specific requirements for creating funding sources
+     * and attaching carriers
+     */
+    this.metadata = () => __async$u(this, null, function* () {
+      return yield this.client.get("/v1/funding_sources/metadata");
+    });
     this.client = client;
   }
 }
@@ -9009,6 +9058,16 @@ const useUpdateFundingSource = () => {
   });
 };
 
+const useGetFundingSourceMetadata = () => {
+  const { client } = useShipEngine();
+  return reactQuery.useQuery({
+    onError,
+    queryFn: () => client.fundingSources.metadata(),
+    queryKey: ["useGetFundingSourceMetadata"],
+    select: (result) => result.data
+  });
+};
+
 const useGetInsuranceAccount = (insuranceProvider) => {
   const { client } = useShipEngine();
   return reactQuery.useQuery({
@@ -11055,6 +11114,9 @@ exports.FundingSourcesAPI = FundingSourcesAPI;
 exports.InsuranceAPI = InsuranceAPI;
 exports.InsuranceProviderType = InsuranceProviderType;
 exports.LabelsAPI = LabelsAPI;
+exports.MetadataCapability = MetadataCapability;
+exports.MetadataRequirement = MetadataRequirement;
+exports.MetadataSatisfyingFormTypes = MetadataSatisfyingFormTypes;
 exports.OrderSourcesAPI = OrderSourcesAPI;
 exports.RateCardStatus = RateCardStatus;
 exports.RateCardsAPI = RateCardsAPI;
@@ -11100,6 +11162,7 @@ exports.useGetCarrierById = useGetCarrierById;
 exports.useGetCountriesByCarrier = useGetCountriesByCarrier;
 exports.useGetCurrenciesByCarrier = useGetCurrenciesByCarrier;
 exports.useGetFundingSourceById = useGetFundingSourceById;
+exports.useGetFundingSourceMetadata = useGetFundingSourceMetadata;
 exports.useGetInsuranceAccount = useGetInsuranceAccount;
 exports.useGetLabel = useGetLabel;
 exports.useGetPackageRatingGroupByCarrier = useGetPackageRatingGroupByCarrier;

package/index.mjs

@@ -2447,6 +2447,12 @@ Object.defineProperty(dist, "__esModule", { value: true });
 var _default = dist.default = (function () {
 });
 
+var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeType2) => {
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Downgrade"] = 0] = "Downgrade";
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Cancellation"] = 1] = "Cancellation";
+  return AccountBillingPlanChangeType2;
+})(AccountBillingPlanChangeType || {});
+
 var __getOwnPropSymbols$d = Object.getOwnPropertySymbols;
 var __hasOwnProp$d = Object.prototype.hasOwnProperty;
 var __propIsEnum$d = Object.prototype.propertyIsEnumerable;
@@ -2476,6 +2482,38 @@ class CodedError {
   }
 }
 
+var MetadataCapability = /* @__PURE__ */ ((MetadataCapability2) => {
+  MetadataCapability2["AutoFunding"] = "auto_funding";
+  MetadataCapability2["UpdatePaymentMethod"] = "update_payment_method";
+  MetadataCapability2["DefaultPurchaseAmount"] = "default_purchase_amount";
+  MetadataCapability2["ReportsLink"] = "reports_link";
+  MetadataCapability2["BalanceHistory"] = "balance_history";
+  MetadataCapability2["Nickname"] = "nickname";
+  MetadataCapability2["RefreshServices"] = "refresh_services";
+  MetadataCapability2["UpdatePassword"] = "update_password";
+  MetadataCapability2["AccountSettingsLink"] = "account_settings_link";
+  MetadataCapability2["Unknown"] = "unknown";
+  return MetadataCapability2;
+})(MetadataCapability || {});
+var MetadataRequirement = /* @__PURE__ */ ((MetadataRequirement2) => {
+  MetadataRequirement2["BillingAddress"] = "billing_address";
+  MetadataRequirement2["CurrencyCode"] = "currency_code";
+  MetadataRequirement2["IovationBlackBox"] = "iovation_black_box";
+  MetadataRequirement2["Nickname"] = "nickname";
+  MetadataRequirement2["PaymentMethod"] = "payment_method";
+  MetadataRequirement2["PickupAddress"] = "pickup_address";
+  MetadataRequirement2["Unknown"] = "unknown";
+  return MetadataRequirement2;
+})(MetadataRequirement || {});
+var MetadataSatisfyingFormTypes = /* @__PURE__ */ ((MetadataSatisfyingFormTypes2) => {
+  MetadataSatisfyingFormTypes2["Address"] = "address";
+  MetadataSatisfyingFormTypes2["CreditCard"] = "credit_card";
+  MetadataSatisfyingFormTypes2["StampsAccountCredentials"] = "stamps_account_credentials";
+  MetadataSatisfyingFormTypes2["StampSellerLabelProvider"] = "stamps_seller_label_provider";
+  MetadataSatisfyingFormTypes2["Unknown"] = "unknown";
+  return MetadataSatisfyingFormTypes2;
+})(MetadataSatisfyingFormTypes || {});
+
 var CreditCardVendor = /* @__PURE__ */ ((CreditCardVendor2) => {
   CreditCardVendor2["AMERICAN_EXPRESS"] = "americanexpress";
   CreditCardVendor2["DISCOVER"] = "discover";
@@ -2533,6 +2571,7 @@ var InsuranceProviderType = /* @__PURE__ */ ((InsuranceProviderType2) => {
 
 const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   __proto__: null,
+  AccountBillingPlanChangeType,
   CodedError,
   ConfirmationType,
   CreditCardVendor,
@@ -2540,6 +2579,9 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   CustomsContentsType,
   CustomsNonDeliveryType,
   InsuranceProviderType,
+  MetadataCapability,
+  MetadataRequirement,
+  MetadataSatisfyingFormTypes,
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
@@ -7728,6 +7770,13 @@ class FundingSourcesAPI {
         amount
       );
     });
+    /**
+     * The `metadata` method returns seller-specific requirements for creating funding sources
+     * and attaching carriers
+     */
+    this.metadata = () => __async$u(this, null, function* () {
+      return yield this.client.get("/v1/funding_sources/metadata");
+    });
     this.client = client;
   }
 }
@@ -8987,6 +9036,16 @@ const useUpdateFundingSource = () => {
   });
 };
 
+const useGetFundingSourceMetadata = () => {
+  const { client } = useShipEngine();
+  return useQuery({
+    onError,
+    queryFn: () => client.fundingSources.metadata(),
+    queryKey: ["useGetFundingSourceMetadata"],
+    select: (result) => result.data
+  });
+};
+
 const useGetInsuranceAccount = (insuranceProvider) => {
   const { client } = useShipEngine();
   return useQuery({
@@ -11014,4 +11073,4 @@ const alchemy = {
   createElement
 };
 
-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, useCreateShippingRule, 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 };
+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, useCreateFundingSource, useCreateLabel, useCreateRateCard, useCreateSalesOrderShipment, useCreateShipment, useCreateShippingRule, useCreateWarehouse, useDeleteRateCard, useDeleteWarehouse, useDownloadRateCard, useFundingSourcesAddFunds, useGetAccountBillingPlan, useGetAccountSettings, useGetAutoFundingConfiguration, useGetCarrierById, useGetCountriesByCarrier, useGetCurrenciesByCarrier, useGetFundingSourceById, useGetFundingSourceMetadata, 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

@@ -1,6 +1,6 @@
 {
   "name": "@shipengine/alchemy",
-  "version": "4.1.6",
+  "version": "4.1.8",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {