@shipengine/js-api 0.38.1 → 0.40.0

package/funding-sources/api.d.ts

@@ -1,8 +1,9 @@
 import { AxiosInstance } from "axios";
 import { Money } from "../payments";
-import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress } from "./types";
+import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, MetadataResponse } from "./types";
 /**
  * # Funding Sources API module - /v1/funding_sources
+ * Docs: https://auctane.atlassian.net/wiki/spaces/SE/pages/3628370266/ShipEngine+Funding+Sources+API
  */
 export declare class FundingSourcesAPI {
     private client;
@@ -41,4 +42,9 @@ export declare class FundingSourcesAPI {
      * The `addFunds` method allows you to add funds to a funding source.
      */
     addFunds: (amount: Money, fundingSourceId: string) => Promise<import("axios").AxiosResponse<AddFundsResponse, any>>;
+    /**
+     * The `metadata` method returns seller-specific requirements for creating funding sources
+     * and attaching carriers
+     */
+    metadata: () => Promise<import("axios").AxiosResponse<MetadataResponse, any>>;
 }

package/funding-sources/types.d.ts

@@ -1,9 +1,3 @@
-export type AddFundsResponse = {
-    balance: {
-        amount: number;
-        currency: string;
-    };
-};
 /**
  * An encoded device fingerprint string containing information about the end-user's computing device such as OS, browser, etc.
  * Required for carrier registration and US Wallet creation.
@@ -35,7 +29,7 @@ export interface CarrierRegistration {
         {
             acceptedTerms: Term[];
             agreeToTerms: boolean;
-            carrierCode: "stamps_com" | "ups_walleted" | "dhl_express_worldwide";
+            carrierCode: string;
             fundingSourceId: string;
             iovationBlackBox: IovationBlackBox;
             pickupAddress?: FundingSourceAddress;
@@ -66,6 +60,42 @@ export interface Term {
     termType: string;
     version: string;
 }
+export type MetadataRequiredTerm = {
+    termType: string;
+    version: string;
+};
+export declare enum MetadataCapability {
+    AutoFunding = "auto_funding",
+    UpdatePaymentMethod = "update_payment_method",
+    DefaultPurchaseAmount = "default_purchase_amount",
+    ReportsLink = "reports_link",
+    BalanceHistory = "balance_history",
+    Nickname = "nickname",
+    RefreshServices = "refresh_services",
+    UpdatePassword = "update_password",
+    AccountSettingsLink = "account_settings_link",
+    Unknown = "unknown"
+}
+export declare enum MetadataRequirement {
+    BillingAddress = "billing_address",
+    CurrencyCode = "currency_code",
+    IovationBlackBox = "iovation_black_box",
+    Nickname = "nickname",
+    PaymentMethod = "payment_method",
+    PickupAddress = "pickup_address",
+    Unknown = "unknown"
+}
+export declare enum MetadataSatisfyingFormTypes {
+    Address = "address",
+    CreditCard = "credit_card",
+    StampsAccountCredentials = "stamps_account_credentials",
+    StampSellerLabelProvider = "stamps_seller_label_provider",
+    Unknown = "unknown"
+}
+export type MetadataRegistrationRequirement = {
+    requirementType: MetadataRequirement;
+    satisfyingFormTypes: MetadataSatisfyingFormTypes[];
+};
 export interface CarrierRegistrationResponse {
     carrierAttachmentResults: [
         {
@@ -77,4 +107,29 @@ export interface CarrierRegistrationResponse {
         }
     ];
 }
+export interface MetadataResponse {
+    defaultFundingSourceProfile: {
+        capabilities: MetadataCapability[] | null;
+        countryCode: string;
+        currencyCode: string;
+        registrationRequirements: MetadataRegistrationRequirement[];
+        requiredTerms: MetadataRequiredTerm[];
+    };
+    defaultRegionProfile: {
+        carrierProfiles: Array<{
+            capabilities: MetadataCapability[] | null;
+            carrierCode: string;
+            registrationRequirements: MetadataRegistrationRequirement[];
+            requiredTerms: MetadataRequiredTerm[];
+        }>;
+        countryCode: string;
+        currencyCode: string;
+    };
+}
+export type AddFundsResponse = {
+    balance: {
+        amount: number;
+        currency: string;
+    };
+};
 export {};

package/index.js

@@ -4,6 +4,12 @@ Object.defineProperty(exports, Symbol.toStringTag, { value: 'Module' });
 
 const axios = require('axios');
 
+var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeType2) => {
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Downgrade"] = 0] = "Downgrade";
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Cancellation"] = 1] = "Cancellation";
+  return AccountBillingPlanChangeType2;
+})(AccountBillingPlanChangeType || {});
+
 var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
 var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
 var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
@@ -33,6 +39,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";
@@ -90,6 +128,7 @@ var InsuranceProviderType = /* @__PURE__ */ ((InsuranceProviderType2) => {
 
 const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   __proto__: null,
+  AccountBillingPlanChangeType,
   CodedError,
   ConfirmationType,
   CreditCardVendor,
@@ -97,6 +136,9 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   CustomsContentsType,
   CustomsNonDeliveryType,
   InsuranceProviderType,
+  MetadataCapability,
+  MetadataRequirement,
+  MetadataSatisfyingFormTypes,
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
@@ -3355,6 +3397,13 @@ class FundingSourcesAPI {
         amount
       );
     });
+    /**
+     * The `metadata` method returns seller-specific requirements for creating funding sources
+     * and attaching carriers
+     */
+    this.metadata = () => __async$2(this, null, function* () {
+      return yield this.client.get("/v1/funding_sources/metadata");
+    });
     this.client = client;
   }
 }
@@ -3644,6 +3693,12 @@ class ShippingRulesAPI {
     this.list = () => {
       return this.client.get(`/v1/shipping_rules`);
     };
+    /**
+     * The `create` method creates a new shipping rule for a given user.
+     */
+    this.create = (shippingRule) => {
+      return this.client.post("/v1/shipping_rules", shippingRule);
+    };
     this.client = client;
   }
 }
@@ -4000,6 +4055,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;

package/index.mjs

@@ -1,5 +1,11 @@
 import axios from 'axios';
 
+var AccountBillingPlanChangeType = /* @__PURE__ */ ((AccountBillingPlanChangeType2) => {
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Downgrade"] = 0] = "Downgrade";
+  AccountBillingPlanChangeType2[AccountBillingPlanChangeType2["Cancellation"] = 1] = "Cancellation";
+  return AccountBillingPlanChangeType2;
+})(AccountBillingPlanChangeType || {});
+
 var __getOwnPropSymbols$3 = Object.getOwnPropertySymbols;
 var __hasOwnProp$3 = Object.prototype.hasOwnProperty;
 var __propIsEnum$3 = Object.prototype.propertyIsEnumerable;
@@ -29,6 +35,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";
@@ -86,6 +124,7 @@ var InsuranceProviderType = /* @__PURE__ */ ((InsuranceProviderType2) => {
 
 const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   __proto__: null,
+  AccountBillingPlanChangeType,
   CodedError,
   ConfirmationType,
   CreditCardVendor,
@@ -93,6 +132,9 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
   CustomsContentsType,
   CustomsNonDeliveryType,
   InsuranceProviderType,
+  MetadataCapability,
+  MetadataRequirement,
+  MetadataSatisfyingFormTypes,
   RateCardStatus
 }, Symbol.toStringTag, { value: 'Module' }));
 
@@ -3351,6 +3393,13 @@ class FundingSourcesAPI {
         amount
       );
     });
+    /**
+     * The `metadata` method returns seller-specific requirements for creating funding sources
+     * and attaching carriers
+     */
+    this.metadata = () => __async$2(this, null, function* () {
+      return yield this.client.get("/v1/funding_sources/metadata");
+    });
     this.client = client;
   }
 }
@@ -3640,6 +3689,12 @@ class ShippingRulesAPI {
     this.list = () => {
       return this.client.get(`/v1/shipping_rules`);
     };
+    /**
+     * The `create` method creates a new shipping rule for a given user.
+     */
+    this.create = (shippingRule) => {
+      return this.client.post("/v1/shipping_rules", shippingRule);
+    };
     this.client = client;
   }
 }
@@ -3982,4 +4037,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, WarehousesAPI, getEndUserIpAddress, isCodedError, isCodedErrors };

package/package.json

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

package/shipping-rules/api.d.ts

@@ -1,4 +1,5 @@
 import { AxiosInstance } from "axios";
+import { RequiredFields } from "../types";
 import { ShippingRule } from "./types";
 /**
  * # Shipping Rules API module - /v1/shipping_rules
@@ -12,4 +13,8 @@ export declare class ShippingRulesAPI {
     list: () => Promise<import("axios").AxiosResponse<{
         shippingRules: ShippingRule[];
     }, any>>;
+    /**
+     * The `create` method creates a new shipping rule for a given user.
+     */
+    create: (shippingRule: ShippingRule) => Promise<import("axios").AxiosResponse<RequiredFields<ShippingRule, "id">, any>>;
 }

package/shipping-rules/types.d.ts

@@ -10,7 +10,7 @@ type RuleTypeCondition = "is" | "is_less" | "is_more" | "is_not";
 /**
  * @category Entities
  */
-export interface Conditions {
+export interface ShippingRulesConditions {
     identifier: RuleType;
     operation: RuleTypeCondition;
     value: string;
@@ -18,7 +18,7 @@ export interface Conditions {
 /**
  * @category Entities
  */
-export interface SelectedService {
+export interface ShippingRuleSelectedService {
     carrierId: string;
     carrierServiceCode: string;
 }
@@ -30,8 +30,8 @@ export interface ShippingRule {
     code?: string;
     createdAt?: ISOString;
     default: {
-        services: SelectedService[];
-        sortBy: string;
+        services: ShippingRuleSelectedService[];
+        sortBy?: string;
     };
     deleted?: boolean;
     deletedAt?: ISOString;
@@ -39,10 +39,10 @@ export interface ShippingRule {
     name: string;
     rules?: [
         {
-            conditions: Conditions[];
+            conditions: ShippingRulesConditions[];
             priority: number;
-            services: SelectedService[];
-            sortBy: string;
+            services: ShippingRuleSelectedService[];
+            sortBy?: string;
         }
     ];
     updatedAt?: ISOString;

package/types.d.ts

@@ -1,4 +1,6 @@
+export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
 export * from "./account-settings/types";
+export * from "./account-billing-plan/types";
 export * from "./addresses/types";
 export * from "./carriers/types";
 export * from "./custom-packages/types";