@shipengine/js-api 0.18.0 → 0.19.0

package/index.js

@@ -3311,8 +3311,10 @@ class RatesAPI {
 class SalesOrderShipmentsAPI {
   constructor(client) {
     this.client = client;
-    this.list = (params = {}) => {
-      return this.client.post("/v-beta/shipments/list", params);
+    this.list = (body = {}, params) => {
+      return this.client.post("/v-beta/shipments/list", body, {
+        params
+      });
     };
     this.get = (shipmentId) => {
       return this.client.get(`/v-beta/shipments/${shipmentId}`);
@@ -3375,6 +3377,9 @@ class ShipmentsAPI {
         createdAtStart !== void 0 ? { params: { createdAtStart } } : void 0
       );
     };
+    this.list = (options) => {
+      return this.client.get("/v1/shipments", { params: options });
+    };
     this.create = (...shipments) => __async$1(this, null, function* () {
       return this.client.post("/v1/shipments", {
         shipments

package/index.mjs

@@ -3307,8 +3307,10 @@ class RatesAPI {
 class SalesOrderShipmentsAPI {
   constructor(client) {
     this.client = client;
-    this.list = (params = {}) => {
-      return this.client.post("/v-beta/shipments/list", params);
+    this.list = (body = {}, params) => {
+      return this.client.post("/v-beta/shipments/list", body, {
+        params
+      });
     };
     this.get = (shipmentId) => {
       return this.client.get(`/v-beta/shipments/${shipmentId}`);
@@ -3371,6 +3373,9 @@ class ShipmentsAPI {
         createdAtStart !== void 0 ? { params: { createdAtStart } } : void 0
       );
     };
+    this.list = (options) => {
+      return this.client.get("/v1/shipments", { params: options });
+    };
     this.create = (...shipments) => __async$1(this, null, function* () {
       return this.client.post("/v1/shipments", {
         shipments

package/package.json

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

package/resources/types.d.ts

@@ -14,3 +14,37 @@ export interface LinkedResource {
     href: string;
     type: string;
 }
+export type ISOString = string;
+export type PageableQuery = {
+    page?: number;
+    pageSize?: number;
+};
+export type PageableResult = {
+    links: {
+        first: LinkedResource;
+        last: LinkedResource;
+        next: LinkedResource;
+        prev: LinkedResource;
+    };
+    page: number;
+    pages: number;
+    total: number;
+};
+export type BatchableQuery = {
+    batchId?: string;
+};
+export type TaggableQuery = {
+    tag?: string;
+};
+export type CreationRangeQuery = {
+    createdAtEnd?: ISOString;
+    createdAtStart?: ISOString;
+};
+export type ModificationRangeQuery = {
+    modifiedAtEnd?: ISOString;
+    modifiedAtStart?: ISOString;
+};
+export type SortableQuery<TSortKeys = "created_at" | "modified_at"> = {
+    sortBy?: TSortKeys;
+    sortDir?: "asc" | "desc";
+};

package/sales-order-shipments/api.d.ts

@@ -1,14 +1,29 @@
 import { AxiosInstance } from "axios";
+import { CreationRangeQuery, ISOString, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery } from "../resources";
+import { FulfillmentStatus, PaymentStatus } from "../sales-orders";
 import { SalesOrderShipment } from "./types";
-export interface ListSalesOrderShipmentsParams {
+export type ListSalesOrderShipmentsParams = {
+    cancelled?: boolean;
+    externalOrderId?: string;
+    externalOrderNumber?: string;
+    fulfillmentStatus?: FulfillmentStatus;
+    orderDateEnd?: ISOString;
+    orderDateStart?: ISOString;
+    orderSourceId?: string;
+    paymentStatus?: PaymentStatus;
     salesOrderIds?: string[];
-}
+} & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery<"created_at" | "modified_at" | "order_date">;
+export type ListSalesOrderShipmentBody = {
+    salesOrderIds?: string[];
+    shipments?: SalesOrderShipment[];
+};
+export type ListSalesOrderShipmentsResult = {
+    shipments: SalesOrderShipment[];
+} & PageableResult;
 export declare class SalesOrderShipmentsAPI {
     private client;
     constructor(client: AxiosInstance);
-    list: (params?: ListSalesOrderShipmentsParams) => Promise<import("axios").AxiosResponse<{
-        shipments: SalesOrderShipment[];
-    }, any>>;
+    list: (body?: ListSalesOrderShipmentBody | undefined, params?: ListSalesOrderShipmentsParams) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
     get: (shipmentId: string) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
     create: (salesOrderId: string, shipment: Partial<SalesOrderShipment>) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
     update: (shipmentId: string, shipment: Partial<SalesOrderShipment>) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;

package/shipments/api.d.ts

@@ -1,5 +1,6 @@
 import { AxiosInstance } from "axios";
-import { Shipment, ShipmentRateResponse } from "./types";
+import { BatchableQuery, CreationRangeQuery, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery, TaggableQuery } from "../resources";
+import { Shipment, ShipmentRateResponse, ShipmentStatus } from "./types";
 export type GetShipmentRatesOptions = {
     /**
      * Date to filter rates by (they must be more recent than this date if passed)
@@ -8,12 +9,21 @@ export type GetShipmentRatesOptions = {
     createdAtStart?: string;
     shipmentId: string;
 };
+export type ListShipmentOptions = {
+    salesOrderId?: string;
+    shipmentStatus?: ShipmentStatus;
+} & BatchableQuery & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery & TaggableQuery;
+export type ListShipmentResult = {
+    shipments: Shipment[];
+} & PageableResult;
+export type CreateShipmentResult = {
+    hasErrors: boolean;
+    shipments: Shipment[];
+};
 export declare class ShipmentsAPI {
     private client;
     constructor(client: AxiosInstance);
     getShipmentRates: ({ shipmentId, createdAtStart }: GetShipmentRatesOptions) => Promise<import("axios").AxiosResponse<ShipmentRateResponse, any>>;
-    create: (...shipments: Partial<Omit<Shipment, "items">>[]) => Promise<import("axios").AxiosResponse<{
-        has_errors: boolean;
-        shipments: Shipment[];
-    }, any>>;
+    list: (options?: ListShipmentOptions) => Promise<import("axios").AxiosResponse<ListShipmentResult, any>>;
+    create: (...shipments: Partial<Omit<Shipment, "items">>[]) => Promise<import("axios").AxiosResponse<CreateShipmentResult, any>>;
 }

package/utilities/types.d.ts

@@ -1 +0,0 @@
-export type RequireField<T, K extends keyof T> = T & Required<Pick<T, K>>;