@shipengine/js-api 2.5.2 → 2.7.0

package/funding-sources/types.d.ts

@@ -14,6 +14,7 @@ export type CreateFundingSource = {
     };
 };
 export type FundingSource = {
+    billingInfo: FundingSourceAddress;
     currencyCode: string;
     defaultCarrierId: string;
     fundingSourceId: string;
@@ -123,6 +124,13 @@ export type MetadataCarrierProfile = {
     requiredTerms: MetadataRequiredTerm[];
 };
 export type TransactionCategory = "adjustment" | "credit" | "debit" | "funds_added" | "insurance" | "label" | "refund" | "service_charge" | "unknown";
+export type FundingSourceTransactionInvoice = {
+    invoiceDownload: {
+        pdf: string;
+    };
+    invoiceId: string;
+    reference: string;
+};
 export type FundingSourceTransaction = {
     description?: string | null;
     endingBalance: {
@@ -131,6 +139,7 @@ export type FundingSourceTransaction = {
     };
     fundingSourceId: string;
     fundingSourceTransactionId: string;
+    invoice: FundingSourceTransactionInvoice | null;
     labelIds: string[];
     relatedFundingSourceTransactionIds: string[];
     shipmentIds: string[];

package/index.js

@@ -4132,6 +4132,17 @@ class ShipmentsAPI {
         shipments
       });
     });
+    /**
+     * The `cancel` method by `shipmentId`
+     * Marks a shipment cancelled, if it is no longer needed or being used by your organization.
+     * Any label associated with the shipment needs to be voided first
+     * An example use case would be if a batch label creation job is going to run at a set time and only queries pending shipments.
+     * Marking a shipment as cancelled would remove it from this process
+     * https://shipengine.github.io/shipengine-openapi/#operation/cancel_shipments
+     */
+    this.cancel = (shipmentId) => {
+      return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
+    };
     this.client = client;
   }
 }

package/index.mjs

@@ -4128,6 +4128,17 @@ class ShipmentsAPI {
         shipments
       });
     });
+    /**
+     * The `cancel` method by `shipmentId`
+     * Marks a shipment cancelled, if it is no longer needed or being used by your organization.
+     * Any label associated with the shipment needs to be voided first
+     * An example use case would be if a batch label creation job is going to run at a set time and only queries pending shipments.
+     * Marking a shipment as cancelled would remove it from this process
+     * https://shipengine.github.io/shipengine-openapi/#operation/cancel_shipments
+     */
+    this.cancel = (shipmentId) => {
+      return this.client.put(`/v1/shipments/${shipmentId}/cancel`);
+    };
     this.client = client;
   }
 }

package/package.json

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

package/shipments/api.d.ts

@@ -73,4 +73,13 @@ export declare class ShipmentsAPI {
      * items passed into this method.
      */
     create: (...shipments: Partial<Omit<Shipment, "items">>[]) => Promise<import("axios").AxiosResponse<CreateShipmentResult, any>>;
+    /**
+     * The `cancel` method by `shipmentId`
+     * Marks a shipment cancelled, if it is no longer needed or being used by your organization.
+     * Any label associated with the shipment needs to be voided first
+     * An example use case would be if a batch label creation job is going to run at a set time and only queries pending shipments.
+     * Marking a shipment as cancelled would remove it from this process
+     * https://shipengine.github.io/shipengine-openapi/#operation/cancel_shipments
+     */
+    cancel: (shipmentId: string) => Promise<import("axios").AxiosResponse<any, any>>;
 }