@shipengine/js-api 3.12.1 → 3.13.0

package/account-billing/api.d.ts

@@ -0,0 +1,18 @@
+import { AxiosInstance } from "axios";
+import { AccountBillingResponse, UpsertAccountBillingRequestBody } from "./types";
+/**
+ * # Account Billing API module - /v1/account/billing
+ * https://auctane.atlassian.net/wiki/spaces/SEEU/pages/5951389743/API+Contract+for+Subscriptions+Billing+Info
+ */
+export declare class AccountBillingAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves the account billing for the current user.
+     */
+    get: () => Promise<import("axios").AxiosResponse<AccountBillingResponse, any>>;
+    /**
+     * The `post` method updates (or create) the Billing Info for the current user.
+     */
+    post: (reqBody: UpsertAccountBillingRequestBody) => Promise<import("axios").AxiosResponse<AccountBillingResponse, any>>;
+}

package/account-billing/index.d.ts

@@ -0,0 +1,2 @@
+export * from "./api";
+export * from "./types";

package/account-billing/types.d.ts

@@ -0,0 +1,34 @@
+export type AccountBillingProvider = "visa" | "mastercard" | "americanExpress" | "discover";
+export type AccountBillingResponse = {
+    addressLine1: string;
+    addressLine2?: string;
+    cityLocality: string;
+    company?: string;
+    countryCode: string;
+    email: string;
+    fullName: string;
+    paymentMethod?: {
+        creditCardInfo: {
+            cardNumberLastFour: string;
+            provider: AccountBillingProvider;
+        };
+    };
+    phone: string;
+    postalCode: string;
+    stateProvince: string;
+};
+export type UpsertAccountBillingRequestBody = {
+    addressLine1: string;
+    addressLine2?: string;
+    cityLocality: string;
+    company?: string;
+    countryCode: string;
+    email: string;
+    fullName: string;
+    paymentMethod: {
+        sessionId: string;
+    };
+    phone: string;
+    postalCode: string;
+    stateProvince: string;
+};

package/client.d.ts

@@ -1,4 +1,5 @@
 import { AxiosError, AxiosRequestHeaders } from "axios";
+import { AccountBillingAPI } from "./account-billing";
 import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
@@ -103,6 +104,11 @@ export declare class ShipEngineAPI {
      * in ShipEngine API.
      */
     get accountBillingPlan(): AccountBillingPlanAPI;
+    /**
+     * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
+     * in ShipEngine API.
+     */
+    get accountBilling(): AccountBillingAPI;
     /**
      * The `addresses` method provides access to the Address Validation endpoints
      * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.

package/funding-sources/types.d.ts

@@ -12,8 +12,9 @@ export type CreateFundingSource = {
     billingInfo: FundingSourceAddress;
     iovationBlackBox: IovationBlackBox;
     paymentMethod: {
-        auctanePayInfo?: AuctanePayInfo;
         creditCardInfo?: CreditCardInfo;
+        paymentMethodId?: string;
+        sessionId?: string;
     };
 };
 /** @internal */

package/index.d.ts

@@ -2,6 +2,8 @@ export * as SE from "./types";
 export * from "./account-settings";
 export * from "./addresses";
 export * from "./auctane-pay";
+export * from "./account-billing-plan";
+export * from "./account-billing";
 export * from "./carriers";
 export * from "./connections";
 export * from "./client";

package/index.js

@@ -256,6 +256,44 @@ class AuctanePayAPI {
   }
 }
 
+class AccountBillingPlanAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing_plan");
+    };
+    /**
+     * The `update` method updates the code of the account billing plan
+     */
+    this.update = (reqBody) => {
+      return this.client.put(`/v1/account/billing_plan`, reqBody);
+    };
+    this.client = client;
+  }
+}
+
+class AccountBillingAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing");
+    };
+    /**
+     * The `post` method updates (or create) the Billing Info for the current user.
+     */
+    this.post = (reqBody) => {
+      return this.client.post("/v1/account/billing", reqBody);
+    };
+    this.client = client;
+  }
+}
+
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
 const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
@@ -3417,25 +3455,6 @@ var lib = {
     stringify: stringify
 };
 
-class AccountBillingPlanAPI {
-  constructor(client) {
-    this.client = client;
-    /**
-     * The `get` method retrieves the account billing plan for the current user.
-     */
-    this.get = () => {
-      return this.client.get("/v1/account/billing_plan");
-    };
-    /**
-     * The `update` method updates the code of the account billing plan
-     */
-    this.update = (reqBody) => {
-      return this.client.put(`/v1/account/billing_plan`, reqBody);
-    };
-    this.client = client;
-  }
-}
-
 class CustomPackagesAPI {
   constructor(client) {
     this.client = client;
@@ -21737,6 +21756,13 @@ class ShipEngineAPI {
   get accountBillingPlan() {
     return new AccountBillingPlanAPI(this.client);
   }
+  /**
+   * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
+   * in ShipEngine API.
+   */
+  get accountBilling() {
+    return new AccountBillingAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -21924,6 +21950,9 @@ class ShipEngineAPI {
   }
 }
 
+exports.AccountBillingAPI = AccountBillingAPI;
+exports.AccountBillingPlanAPI = AccountBillingPlanAPI;
+exports.AccountBillingPlanChangeType = AccountBillingPlanChangeType;
 exports.AccountSettingsAPI = AccountSettingsAPI;
 exports.AddressesAPI = AddressesAPI;
 exports.AuctanePayAPI = AuctanePayAPI;

package/index.mjs

@@ -252,6 +252,44 @@ class AuctanePayAPI {
   }
 }
 
+class AccountBillingPlanAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing plan for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing_plan");
+    };
+    /**
+     * The `update` method updates the code of the account billing plan
+     */
+    this.update = (reqBody) => {
+      return this.client.put(`/v1/account/billing_plan`, reqBody);
+    };
+    this.client = client;
+  }
+}
+
+class AccountBillingAPI {
+  constructor(client) {
+    this.client = client;
+    /**
+     * The `get` method retrieves the account billing for the current user.
+     */
+    this.get = () => {
+      return this.client.get("/v1/account/billing");
+    };
+    /**
+     * The `post` method updates (or create) the Billing Info for the current user.
+     */
+    this.post = (reqBody) => {
+      return this.client.post("/v1/account/billing", reqBody);
+    };
+    this.client = client;
+  }
+}
+
 const isCodedErrors = (errs) => Array.isArray(errs) && errs.every((err) => isCodedError(err));
 const isCodedError = (err) => !!err.errorCode;
 const isDataCodedErrors = (data) => !!data.errors && isCodedErrors(data.errors);
@@ -3413,25 +3451,6 @@ var lib = {
     stringify: stringify
 };
 
-class AccountBillingPlanAPI {
-  constructor(client) {
-    this.client = client;
-    /**
-     * The `get` method retrieves the account billing plan for the current user.
-     */
-    this.get = () => {
-      return this.client.get("/v1/account/billing_plan");
-    };
-    /**
-     * The `update` method updates the code of the account billing plan
-     */
-    this.update = (reqBody) => {
-      return this.client.put(`/v1/account/billing_plan`, reqBody);
-    };
-    this.client = client;
-  }
-}
-
 class CustomPackagesAPI {
   constructor(client) {
     this.client = client;
@@ -21733,6 +21752,13 @@ class ShipEngineAPI {
   get accountBillingPlan() {
     return new AccountBillingPlanAPI(this.client);
   }
+  /**
+   * The `accountBilling` method provides access to the Account Billing (Recurly) endpoints
+   * in ShipEngine API.
+   */
+  get accountBilling() {
+    return new AccountBillingAPI(this.client);
+  }
   /**
    * The `addresses` method provides access to the Address Validation endpoints
    * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
@@ -21920,4 +21946,4 @@ class ShipEngineAPI {
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };
+export { AccountBillingAPI, AccountBillingPlanAPI, AccountBillingPlanChangeType, AccountSettingsAPI, AddressesAPI, AuctanePayAPI, CarriersAPI, CodedError, ConfirmationType, ConnectionsAPI, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, FundingSourcesAPI, InsuranceAPI, InsuranceProviderType, InvoiceAddressAPI, LabelsAPI, MetadataCapability, MetadataRequirement, MetadataSatisfyingFormTypes, MovementIndicator, OrderSourcesAPI, RateCardStatus, RateCardsAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, SellersAPI, ServicePointsAPI, ShipEngineAPI, ShipmentsAPI, ShippingRulesAPI, ThemesAPI, WarehousesAPI, WebhooksAPI, camelizeKeys, decamelizeKeys, getEndUserIpAddress, isCodedError, isCodedErrors, isDataCodedErrors, isInvalidTokenError, parseError };

package/package.json

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

package/types.d.ts

@@ -1,6 +1,7 @@
 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 "./account-billing/types";
 export * from "./addresses/types";
 export * from "./auctane-pay/types";
 export * from "./carriers/types";