@shipengine/js-api 4.2.0 → 4.3.0

package/account-billing/types.d.ts

@@ -1,4 +1,15 @@
 export type AccountBillingProvider = "visa" | "mastercard" | "americanExpress" | "discover";
+type PaymentMethod = {
+    bankAccountInfo: {
+        lastFour: string;
+        provider: string;
+    } | null;
+    creditCardInfo: {
+        cardNumberLastFour: string;
+        provider: AccountBillingProvider;
+    } | null;
+    paymentMethodId?: string;
+};
 export type AccountBillingResponse = {
     addressLine1: string;
     addressLine2?: string;
@@ -7,12 +18,7 @@ export type AccountBillingResponse = {
     countryCode: string;
     email: string;
     fullName: string;
-    paymentMethod?: {
-        creditCardInfo: {
-            cardNumberLastFour: string;
-            provider: AccountBillingProvider;
-        };
-    };
+    paymentMethod?: PaymentMethod;
     phone: string;
     postalCode: string;
     stateProvince: string;
@@ -32,3 +38,4 @@ export type UpsertAccountBillingRequestBody = {
     postalCode: string;
     stateProvince: string;
 };
+export {};

package/funding-sources/api.d.ts

@@ -1,7 +1,7 @@
 import { AxiosInstance } from "axios";
 import { Money } from "../payments";
 import { CreationRangeQuery, PageableQuery } from "../resources";
-import { AddFundsResponse, AuctanePayInfo, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceCreateResponse, FundingSourceTransactionsResponse, InsuranceFundingSourceAcceptedTermsResponse, MetadataResponse } from "./types";
+import { AddFundsResponse, AuctanePayInfo, BankAccountInfo, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, FundingSourceCreateResponse, FundingSourceTransactionsResponse, InsuranceFundingSourceAcceptedTermsResponse, MetadataResponse } from "./types";
 /**
  * @internal
  * # Funding Sources API module - /v1/funding_sources
@@ -30,7 +30,7 @@ export declare class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    update: (billingInfo: FundingSourceAddress, creditCardInfo: CreditCardInfo | undefined, auctanePayInfo: AuctanePayInfo | undefined, fundingSourceId: string) => Promise<import("axios").AxiosResponse<{
+    update: (billingInfo: FundingSourceAddress, creditCardInfo: CreditCardInfo | undefined, bankAccountInfo: BankAccountInfo | undefined, auctanePayInfo: AuctanePayInfo | undefined, fundingSourceId: string) => Promise<import("axios").AxiosResponse<{
         fundingSource: FundingSource;
     }, any>>;
     /**

package/funding-sources/types.d.ts

@@ -12,6 +12,7 @@ export type CreateFundingSource = {
     billingInfo: FundingSourceAddress;
     iovationBlackBox: IovationBlackBox;
     paymentMethod: {
+        bankAccountInfo?: BankAccountInfo;
         creditCardInfo?: CreditCardInfo;
         paymentMethodId?: string;
         sessionId?: string;
@@ -25,6 +26,7 @@ export type FundingSource = {
     defaultCarrierId: string;
     fundingSourceId: string;
     paymentMethod: {
+        bankAccountInfo: BankAccountInfo | null;
         creditCardInfo: AbbreviatedCreditCardInfo | null;
         paymentMethodId?: string;
         sessionId?: string;
@@ -92,6 +94,10 @@ export interface CreditCardInfo {
     name: string;
     provider: Provider;
 }
+export interface BankAccountInfo {
+    lastFour: string;
+    provider: string;
+}
 /** @internal */
 export interface Term {
     termType: string;

package/index.js

@@ -3545,7 +3545,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, auctanePayInfo, fundingSourceId) => __async$4(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, bankAccountInfo, auctanePayInfo, fundingSourceId) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3556,6 +3556,7 @@ class FundingSourcesAPI {
           billingInfo,
           endUserIpAddress,
           paymentMethod: __spreadValues$3({
+            bankAccountInfo,
             creditCardInfo
           }, auctanePayInfo)
         }
@@ -3724,10 +3725,10 @@ class LabelsAPI {
       return this.client.put(`/v1/labels/${labelId}/void`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of labels based on the provided parameters.
+     * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/labels/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/labels/export", {
         headers: {
           Accept: "text/csv"
         },
@@ -4196,10 +4197,10 @@ class ShipmentsAPI {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     * The `export` method allows to export a CSV document of shipments based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/shipments/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/shipments/export", {
         headers: {
           Accept: "text/csv"
         },

package/index.mjs

@@ -3541,7 +3541,7 @@ class FundingSourcesAPI {
      * user to update the billing address or payment information associated with the
      * funding source.
      */
-    this.update = (billingInfo, creditCardInfo, auctanePayInfo, fundingSourceId) => __async$4(this, null, function* () {
+    this.update = (billingInfo, creditCardInfo, bankAccountInfo, auctanePayInfo, fundingSourceId) => __async$4(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress) {
         return Promise.reject([new CodedError("Unable to get IP address")]);
@@ -3552,6 +3552,7 @@ class FundingSourcesAPI {
           billingInfo,
           endUserIpAddress,
           paymentMethod: __spreadValues$3({
+            bankAccountInfo,
             creditCardInfo
           }, auctanePayInfo)
         }
@@ -3720,10 +3721,10 @@ class LabelsAPI {
       return this.client.put(`/v1/labels/${labelId}/void`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of labels based on the provided parameters.
+     * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/labels/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/labels/export", {
         headers: {
           Accept: "text/csv"
         },
@@ -4192,10 +4193,10 @@ class ShipmentsAPI {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
     /**
-     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     * The `export` method allows to export a CSV document of shipments based on the provided parameters.
      */
-    this.download = (params) => {
-      return this.client.get("/v1/shipments/downloads", {
+    this.export = (params) => {
+      return this.client.get("/v1/shipments/export", {
         headers: {
           Accept: "text/csv"
         },

package/labels/api.d.ts

@@ -1,5 +1,5 @@
 import { AxiosInstance } from "axios";
-import { CreateLabelOptions, DownloadLabelsParams, Label, ListLabelsParams, ListLabelsResult, VoidRequest } from "./types";
+import { CreateLabelOptions, ExportLabelsParams, Label, ListLabelsParams, ListLabelsResult, VoidRequest } from "./types";
 /**
  * # Labels API module - /v1/labels
  */
@@ -33,7 +33,7 @@ export declare class LabelsAPI {
      */
     void: (labelId: string) => Promise<import("axios").AxiosResponse<VoidRequest, any>>;
     /**
-     * The `download` method allows for downloading a CSV document of labels based on the provided parameters.
+     * The `export` method allows to export a CSV document of labels based on the provided parameters.
      */
-    download: (params?: DownloadLabelsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
+    export: (params?: ExportLabelsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/labels/types.d.ts

@@ -143,7 +143,7 @@ export interface CreateLabelOptions {
      */
     validateAddress?: string;
 }
-export type DownloadLabelsParams = {
+export type ExportLabelsParams = {
     /**
      * CSV column names to export
      */

package/package.json

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

package/shipments/api.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
 import { PageableResult } from "../resources";
-import { DownloadShipmentsParams, ListShipmentOptions, Shipment, ShipmentRateResponse } from "./types";
+import { ExportShipmentsParams, ListShipmentOptions, Shipment, ShipmentRateResponse } from "./types";
 /**
  * # Shipments - Get Shipment Rates Options
  */
@@ -72,7 +72,7 @@ export declare class ShipmentsAPI {
      */
     cancel: (shipmentId: string) => Promise<import("axios").AxiosResponse<any, any>>;
     /**
-     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     * The `export` method allows to export a CSV document of shipments based on the provided parameters.
      */
-    download: (params?: DownloadShipmentsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
+    export: (params?: ExportShipmentsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/shipments/types.d.ts

@@ -274,7 +274,7 @@ export type ListShipmentOptions = {
     shipmentStatus?: ShipmentStatus;
 } & BatchableQuery & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery & TaggableQuery;
 export type ShipmentColumns = "shipment_id" | "packages" | "recipient" | "shipping_service" | "created_date" | "modified_at" | "status";
-export type DownloadShipmentsParams = {
+export type ExportShipmentsParams = {
     /**
      * CSV column names to export
      */