@shipengine/js-api 0.6.3 → 0.7.0

package/client.d.ts

@@ -9,6 +9,7 @@ import { OrderSourcesAPI } from "./order-sources";
 import { RatesAPI } from "./rates";
 import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
+import { ShipmentsAPI } from "./shipments";
 import { WarehousesAPI } from "./warehouses";
 export type ShipEngineAPIHeaders = AxiosRequestHeaders;
 export interface ShipEngineAPIConfig {
@@ -30,5 +31,6 @@ export declare class ShipEngineAPI {
     get rates(): RatesAPI;
     get salesOrderShipments(): SalesOrderShipmentsAPI;
     get salesOrders(): SalesOrdersAPI;
+    get shipments(): ShipmentsAPI;
     get warehouses(): WarehousesAPI;
 }

package/index.js

@@ -5180,6 +5180,19 @@ class SalesOrdersAPI {
   }
 }
 
+class ShipmentsAPI {
+  constructor(client) {
+    this.client = client;
+    this.getShipmentRates = ({ shipmentId, createdAtStart }) => {
+      return this.client.get(
+        `/v1/shipments/${shipmentId}/rates`,
+        createdAtStart !== void 0 ? { params: { createdAtStart } } : void 0
+      );
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -5367,6 +5380,9 @@ class ShipEngineAPI {
   get salesOrders() {
     return new SalesOrdersAPI(this.client);
   }
+  get shipments() {
+    return new ShipmentsAPI(this.client);
+  }
   get warehouses() {
     return new WarehousesAPI(this.client);
   }
@@ -5391,6 +5407,7 @@ exports.SE = types;
 exports.SalesOrderShipmentsAPI = SalesOrderShipmentsAPI;
 exports.SalesOrdersAPI = SalesOrdersAPI;
 exports.ShipEngineAPI = ShipEngineAPI;
+exports.ShipmentsAPI = ShipmentsAPI;
 exports.WarehousesAPI = WarehousesAPI;
 exports.isCodedError = isCodedError;
 exports.isCodedErrors = isCodedErrors;

package/index.mjs

@@ -5176,6 +5176,19 @@ class SalesOrdersAPI {
   }
 }
 
+class ShipmentsAPI {
+  constructor(client) {
+    this.client = client;
+    this.getShipmentRates = ({ shipmentId, createdAtStart }) => {
+      return this.client.get(
+        `/v1/shipments/${shipmentId}/rates`,
+        createdAtStart !== void 0 ? { params: { createdAtStart } } : void 0
+      );
+    };
+    this.client = client;
+  }
+}
+
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
@@ -5363,9 +5376,12 @@ class ShipEngineAPI {
   get salesOrders() {
     return new SalesOrdersAPI(this.client);
   }
+  get shipments() {
+    return new ShipmentsAPI(this.client);
+  }
   get warehouses() {
     return new WarehousesAPI(this.client);
   }
 }
 
-export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, WarehousesAPI, isCodedError, isCodedErrors };
+export { AccountSettingsAPI, AddressesAPI, CarriersAPI, CodedError, ConfirmationType, CreditCardVendor, Currency, CustomPackagesAPI, CustomsContentsType, CustomsNonDeliveryType, InsuranceAPI, InsuranceProviderType, LabelsAPI, OrderSourcesAPI, RatesAPI, types as SE, SalesOrderShipmentsAPI, SalesOrdersAPI, ShipEngineAPI, ShipmentsAPI, WarehousesAPI, isCodedError, isCodedErrors };

package/package.json

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

package/shipments/api.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from "axios";
+import { ShipmentRateResponse } from "./types";
+export type GetShipmentRatesOptions = {
+    /**
+     * Date to filter rates by (they must be more recent than this date if passed)
+     * @example "2019-03-12T19:24:13.657Z"
+     */
+    createdAtStart?: string;
+    shipmentId: string;
+};
+export declare class ShipmentsAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    getShipmentRates: ({ shipmentId, createdAtStart }: GetShipmentRatesOptions) => Promise<import("axios").AxiosResponse<ShipmentRateResponse, any>>;
+}

package/shipments/index.d.ts

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

package/shipments/types.d.ts

@@ -1,7 +1,9 @@
 import { Address, AddressValidation } from "../addresses";
 import { CarrierPackage } from "../carriers";
+import { CodedError } from '../errors';
 import { OrderSourceCode } from "../order-sources";
 import { Money } from "../payments";
+import { Rate } from '../rates';
 import { Download, LinkedResource } from "../resources";
 import { WeightWithUnit } from "../weight";
 /**
@@ -195,3 +197,12 @@ export interface Shipment {
     validateAddress?: AddressValidationOptions;
     warehouseId?: string;
 }
+export type ShipmentRateResponse = {
+    created_at: string;
+    errors: CodedError[];
+    invalidRates: Rate[];
+    rate_request_id: string;
+    rates: Rate[];
+    shipment_id: string;
+    status: "working" | "completed" | "partial" | "error";
+}[];