@shipengine/js-api 4.1.0 → 4.2.1

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)
         }
@@ -4195,6 +4196,18 @@ class ShipmentsAPI {
     this.cancel = (shipmentId) => {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
+    /**
+     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     */
+    this.download = (params) => {
+      return this.client.get("/v1/shipments/downloads", {
+        headers: {
+          Accept: "text/csv"
+        },
+        params,
+        responseType: "blob"
+      });
+    };
     this.client = client;
   }
 }

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)
         }
@@ -4191,6 +4192,18 @@ class ShipmentsAPI {
     this.cancel = (shipmentId) => {
       return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
     };
+    /**
+     * The `download` method allows for downloading a CSV document of shipments based on the provided parameters.
+     */
+    this.download = (params) => {
+      return this.client.get("/v1/shipments/downloads", {
+        headers: {
+          Accept: "text/csv"
+        },
+        params,
+        responseType: "blob"
+      });
+    };
     this.client = client;
   }
 }

package/package.json

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

package/shipments/api.d.ts

@@ -1,6 +1,6 @@
 import { AxiosInstance } from "axios";
-import { BatchableQuery, CreationRangeQuery, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery, TaggableQuery } from "../resources";
-import { Shipment, ShipmentRateResponse, ShipmentStatus } from "./types";
+import { PageableResult } from "../resources";
+import { DownloadShipmentsParams, ListShipmentOptions, Shipment, ShipmentRateResponse } from "./types";
 /**
  * # Shipments - Get Shipment Rates Options
  */
@@ -15,17 +15,6 @@ export type GetShipmentRatesOptions = {
      */
     shipmentId: string;
 };
-export type ListShipmentOptions = {
-    /**
-     * `salesOrderIds` is an array of sales order IDs to be used when listing sales
-     * orders.
-     */
-    salesOrderId?: string;
-    /**
-     * `shipmentStatus` is the current fulfillment status of the shipment.
-     */
-    shipmentStatus?: ShipmentStatus;
-} & BatchableQuery & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery & TaggableQuery;
 /**
  * # Shipments - List Shipments Result
  */
@@ -82,4 +71,8 @@ export declare class ShipmentsAPI {
      * https://shipengine.github.io/shipengine-openapi/#operation/cancel_shipments
      */
     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.
+     */
+    download: (params?: DownloadShipmentsParams) => Promise<import("axios").AxiosResponse<Blob, any>>;
 }

package/shipments/types.d.ts

@@ -4,7 +4,7 @@ import { CodedError } from "../errors";
 import { OrderSourceCode } from "../order-sources";
 import { Money } from "../payments";
 import { Rate } from "../rates";
-import { Download, LinkedResource } from "../resources";
+import { BatchableQuery, CreationRangeQuery, Download, LinkedResource, ModificationRangeQuery, PageableQuery, SortableQuery, TaggableQuery } from "../resources";
 import { WeightWithUnit } from "../weight";
 export type AddressValidationOptions = "no_validation" | "validate_only" | "validate_and_clean";
 export type CustomsContents = "documents" | "gift" | "merchandise" | "returned_goods" | "sample";
@@ -254,3 +254,33 @@ export type ShipmentRateResponse = {
     shipmentId: string;
     status: "working" | "completed" | "partial" | "error";
 }[];
+export type ListShipmentOptions = {
+    /**
+     * `batchId` is an optional string to retrieve shipments within a given batch.
+     */
+    batchId?: string;
+    /**
+     * `salesOrderIds` is an array of sales order IDs to be used when listing sales
+     * orders.
+     */
+    salesOrderId?: string;
+    /**
+     * Specific shipment number to filter by
+     */
+    shipmentNumber?: string;
+    /**
+     * `shipmentStatus` is the current fulfillment status of the shipment.
+     */
+    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 = {
+    /**
+     * CSV column names to export
+     */
+    columns?: ShipmentColumns[];
+    /**
+     * Specific shipment ID to filter by
+     */
+    shipmentId?: string;
+} & ListShipmentOptions;