@shipengine/js-api 0.32.0 → 0.33.0

package/order-sources/api.d.ts

@@ -1,11 +1,24 @@
 import { AxiosInstance } from "axios";
 import { OrderSource } from "./types";
+/**
+ * # Order Sources API module - /v-beta/order_sources
+ */
 export declare class OrderSourcesAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of connected order sources for a given user.
+     */
     list: () => Promise<import("axios").AxiosResponse<{
         orderSources: OrderSource[];
     }, any>>;
+    /**
+     * The `get` method retrieves a specific order source by `orderSourceId`.
+     */
     get: (orderSourceId: string) => Promise<import("axios").AxiosResponse<OrderSource, any>>;
+    /**
+     * The `refresh` method refreshes a specific order source by `orderSourceId`.
+     * This will pull in any `new orders` since the last order import.
+     */
     refresh: (orderSourceId: string) => Promise<import("axios").AxiosResponse<OrderSource, any>>;
 }

package/package.json

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

package/rate-cards/api.d.ts

@@ -1,16 +1,41 @@
 import { AxiosInstance } from "axios";
 import { RateCard, RateCardInput } from "./types";
+/**
+ * # Rate Cards API module - /v1/rate_cards
+ */
 export declare class RateCardsAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of rate cards for a given list of carrier ID's.
+     */
     list: (carrierIds: string[]) => Promise<import("axios").AxiosResponse<{
         rateCards: RateCard[];
     }, any>>;
+    /**
+     * The `get` method retrieves a specific rate card by `rateCardId`.
+     */
     get: (rateCardId: string) => Promise<import("axios").AxiosResponse<RateCard, any>>;
+    /**
+     * The `create` method creates a new rate card for a given user.
+     */
     create: (rateCardInput: RateCardInput) => Promise<import("axios").AxiosResponse<RateCard, any>>;
+    /**
+     * The `update` method updates a specific rate card by `rateCardId` with a new
+     * `RateCard`.
+     */
     update: (rateCard: RateCard) => Promise<import("axios").AxiosResponse<RateCard, any>>;
+    /**
+     * The `download` method allows for downloading a given rate card by `rateCardId`.
+     */
     download: (rateCardId: string) => Promise<import("axios").AxiosResponse<Blob, any>>;
+    /**
+     * The `upload` method allows for uploading a given rate card as a spreadsheet file.
+     */
     upload: (rateCardId: string, file: File) => Promise<import("axios").AxiosResponse<RateCard, any>>;
+    /**
+     * The `publish` method allows for publishing a given rate card by `rateCardId`.
+     */
     publish: (rateCardId: string) => Promise<import("axios").AxiosResponse<any, any>>;
     /**
      * @description https://auctane.atlassian.net/wiki/spaces/TE/pages/3837431603/Inc+1+3.+Rate+Card+Details#Delete-Rate-Card

package/rates/api.d.ts

@@ -1,16 +1,42 @@
 import { AxiosInstance } from "axios";
 import { Currency } from "../payments";
 import { RateResponse } from "./types";
+/**
+ * # Rates API - Calculate Rates Options
+ */
 export interface CalculateRatesOptions {
+    /**
+     * `calculateTaxAmount` is an optional boolean that indicates rates returned
+     * should include the tax amount.
+     */
     calculateTaxAmount?: boolean;
+    /**
+     * `carrierIds` is an array of carrier IDs to filter rates by.
+     */
     carrierIds: string[];
+    /**
+     * `packageTypes` is an optional array of package types to filter rates by.
+     */
     packageTypes?: string[];
+    /**
+     * `preferredCurrency` is an optional indicator of the currency to return rates in.
+     */
     preferredCurrency?: Currency;
+    /**
+     * `serviceCodes` is an optional array of specific carrier service codes to filter rates by.
+     */
     serviceCodes?: string[];
 }
+/**
+ * # Rates API module - /v1/rates
+ */
 export declare class RatesAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `calculate` method calculates rates for a shipment by shipment ID based
+     * on the shipment's options.
+     */
     calculateByShipmentId: (shipmentId: string, options: CalculateRatesOptions) => Promise<import("axios").AxiosResponse<Omit<import("..").Shipment, "items"> & {
         items: import("../sales-order-shipments").SalesOrderShipmentItem[];
         salesOrderIds: string[];

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

@@ -2,29 +2,99 @@ import { AxiosInstance } from "axios";
 import { CreationRangeQuery, ISOString, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery } from "../resources";
 import { FulfillmentStatus, PaymentStatus } from "../sales-orders";
 import { SalesOrderShipment } from "./types";
+/**
+ *
+ */
 export type ListSalesOrderShipmentsParams = {
+    /**
+     * `cancelled` is an optional boolean indicating if cancelled shipments
+     * should be included in the response.
+     */
     cancelled?: boolean;
+    /**
+     * `externalOrderId` is an optional unique ID that can be set by the user to
+     * associate shipments with an external system.
+     */
     externalOrderId?: string;
+    /**
+     * `externalOrderNumber` is an optional unique ID that can be set by the
+     * user to associate orders with an external system.
+     */
     externalOrderNumber?: string;
+    /**
+     * `fulfillmentStatus` is an optional string that indicates the fulfillment
+     * status of the shipments to be returned.
+     */
     fulfillmentStatus?: FulfillmentStatus;
+    /**
+     * `orderDateEnd` is an optional ISO 8601 string that indicates the end of the
+     * date range to query orders from.
+     */
     orderDateEnd?: ISOString;
+    /**
+     * `orderDateStart` is an optional ISO 8601 string that indicates the start of
+     * the date range to query orders from.
+     */
     orderDateStart?: ISOString;
+    /**
+     * `orderSourceId` is an optional string that indicates the order source ID
+     * to query orders from.
+     */
     orderSourceId?: string;
+    /**
+     * `paymentStatus` is an optional string that indicates the payment status of
+     * the shipments to be returned.
+     */
     paymentStatus?: PaymentStatus;
+    /**
+     * `salesOrderIds` is an optional array of sales order IDs to be used when
+     * querying sales orders.
+     */
     salesOrderIds?: string[];
 } & PageableQuery & CreationRangeQuery & ModificationRangeQuery & SortableQuery<"created_at" | "modified_at" | "order_date">;
+/**
+ * # Sales Order Shipments - List Sales Order Shipments Body
+ */
 export type ListSalesOrderShipmentBody = {
+    /**
+     * `salesOrderIds` is an array of sales order IDs to be used when listing sales
+     * orders.
+     */
     salesOrderIds?: string[];
+    /**
+     * `shipments` is an array of shipments associated with the sales orders.
+     */
     shipments?: SalesOrderShipment[];
 };
+/**
+ * # Sales Order Shipments - List Sales Order Shipments Result
+ */
 export type ListSalesOrderShipmentsResult = {
+    /**
+     * `shipments` is an array of sales order shipments.
+     */
     shipments: SalesOrderShipment[];
 } & PageableResult;
+/**
+ * # Sales Order Shipments API module - /v-beta/shipments
+ */
 export declare class SalesOrderShipmentsAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of sales order shipments for a given user.
+     */
     list: (body?: ListSalesOrderShipmentBody | undefined, params?: ListSalesOrderShipmentsParams) => Promise<import("axios").AxiosResponse<ListSalesOrderShipmentsResult, any>>;
+    /**
+     * The `get` method retrieves a specific sales order shipment by `shipmentId`.
+     */
     get: (shipmentId: string) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
+    /**
+     * The `create` method creates a new shipment for a sales order.
+     */
     create: (salesOrderId: string, shipment: Partial<SalesOrderShipment>) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
+    /**
+     * The `update` method updates a specific sales order shipment by `shipmentId`.
+     */
     update: (shipmentId: string, shipment: Partial<SalesOrderShipment>) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
 }

package/sales-orders/api.d.ts

@@ -1,15 +1,40 @@
 import { AxiosInstance } from "axios";
 import { SalesOrder, SalesOrderTracking } from "./types";
+/**
+ * # Sales Orders - List Sales Orders Params
+ */
 export interface ListSalesOrdersParams {
+    /**
+     * `externalOrderId` is an optional unique ID that can be set by the user to
+     * associate shipments with an external system.
+     */
     externalOrderId?: string;
+    /**
+     * `externalOrderNumber` is an optional unique identifier that can be set by
+     * the user to associate shipments with an external order system.
+     */
     externalOrderNumber?: string;
 }
+/**
+ * # Sales Orders API module - /v-beta/sales_orders
+ */
 export declare class SalesOrdersAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of sales orders.
+     */
     list: (params?: ListSalesOrdersParams) => Promise<import("axios").AxiosResponse<{
         salesOrders: SalesOrder[];
     }, any>>;
+    /**
+     * The `get` method retrieves a specific sales order by `salesOrderId`.
+     */
     get: (salesOrderId: string) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
+    /**
+     * The `notifyShipped` method notifies order source that the order has been
+     * shipped. Typically, the order source will then notify the user based on
+     * this update from ShipEngine API.
+     */
     notifyShipped: (salesOrderId: string, tracking: SalesOrderTracking) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
 }

package/shipments/api.d.ts

@@ -1,29 +1,72 @@
 import { AxiosInstance } from "axios";
 import { BatchableQuery, CreationRangeQuery, ModificationRangeQuery, PageableQuery, PageableResult, SortableQuery, TaggableQuery } from "../resources";
 import { Shipment, ShipmentRateResponse, ShipmentStatus } from "./types";
+/**
+ * # Shipments - Get Shipment Rates Options
+ */
 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` is the unique identifier of the shipment to retrieve.
+     */
     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
+ */
 export type ListShipmentResult = {
+    /**
+     * `shipments` is an array of shipments to be returned.
+     */
     shipments: Shipment[];
 } & PageableResult;
+/**
+ * # Shipments - Create Shipments Result
+ */
 export type CreateShipmentResult = {
+    /**
+     * `hasErrors` is a boolean that indicates if any errors occurred during the
+     * creation of the shipments.
+     */
     hasErrors: boolean;
+    /**
+     * `shipments` is an array of shipments that were created.
+     */
     shipments: Shipment[];
 };
+/**
+ * # Shipments API module - /v1/shipments
+ */
 export declare class ShipmentsAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `getShipmentRates` method retrieves rates for a given shipment by
+     * shipment ID.
+     */
     getShipmentRates: ({ shipmentId, createdAtStart }: GetShipmentRatesOptions) => Promise<import("axios").AxiosResponse<ShipmentRateResponse, any>>;
+    /**
+     * The `list` method retrieves a list of shipments for a given user.
+     */
     list: (options?: ListShipmentOptions) => Promise<import("axios").AxiosResponse<ListShipmentResult, any>>;
+    /**
+     * The `create` method allows for creating shipments based on a list of shipment
+     * items passed into this method.
+     */
     create: (...shipments: Partial<Omit<Shipment, "items">>[]) => Promise<import("axios").AxiosResponse<CreateShipmentResult, any>>;
 }

package/warehouses/api.d.ts

@@ -1,12 +1,31 @@
 import { AxiosInstance } from "axios";
 import { Warehouse } from "./types";
+/**
+ * # Warehouses API module - /v1/warehouses
+ */
 export declare class WarehousesAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of `warehouses` (Ship From Locations)
+     * for a given user.
+     */
     list: () => Promise<import("axios").AxiosResponse<{
         warehouses: Warehouse[];
     }, any>>;
+    /**
+     * The `create` method allows for creation of warehouses (Ship From Locations)
+     * on a users ShipEngine account.
+     */
     create: (warehouse: Partial<Warehouse>) => Promise<import("axios").AxiosResponse<Warehouse, any>>;
+    /**
+     * The `update` method updates a specific warehouse (Ship From Location) for a
+     * given user by `warehouseId`.
+     */
     update: (warehouseId: string, warehouse: Partial<Warehouse>) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `delete` method deletes a specific warehouse (Ship From Location) by
+     * `warehouseId` from a users ShipEngine account.
+     */
     delete: (warehouseId: string) => Promise<import("axios").AxiosResponse<void, any>>;
 }