@shipengine/js-api 0.40.0 → 1.0.0-next.0

package/insurance/api.d.ts

@@ -1,14 +1,7 @@
 import { AxiosInstance } from "axios";
 import { InsuranceAccount, InsuranceProvider } from "./types";
-/**
- * # Insurance API module - /v1/insurance
- */
 export declare class InsuranceAPI {
     private client;
     constructor(client: AxiosInstance);
-    /**
-     * The `get` method retrieves the insurance balance for a given `insuranceProvider`
-     * by ID.
-     */
     get: (insuranceProvider: InsuranceProvider) => Promise<import("axios").AxiosResponse<InsuranceAccount, any>>;
 }

package/labels/api.d.ts

@@ -1,73 +1,22 @@
 import { AxiosInstance } from "axios";
 import { Label, LabelLayout, VoidRequest } from "./types";
-/**
- * # Labels API - Create Label Options
- */
 export interface CreateLabelOptions {
-    /**
-     * `displayScheme` is an optional string to control the display scheme of the label.
-     */
     displayScheme?: string;
-    /**
-     * `labelDownloadType` is an optional string to control the download type of the label.
-     *
-     * e.g. `url` or `inline`
-     */
     labelDownloadType?: string;
-    /**
-     * `labelFormat` is an optional string to control the format of the label.
-     *
-     * e.g. `pdf` or `zpl`
-     */
     labelFormat?: string;
-    /**
-     * `labelLayout` is an optional string to control the layout of the label.
-     *
-     * e.g. `4x6` or `8.5x11`
-     */
     labelLayout?: LabelLayout;
-    /**
-     * `validateAddress` is an optional string to control address validation during
-     * label purchase.
-     */
     validateAddress?: string;
 }
-/**
- * # Labels API - List Labels Params
- */
 export interface ListLabelsParams {
-    /**
-     * `shipmentId` is an optional string to filter labels by shipment ID. This
-     * is a unique identifier that ShipEngine API associates with your shipment.
-     */
     shipmentId?: string;
 }
-/**
- * # Labels API module - /v1/labels
- */
 export declare class LabelsAPI {
     private client;
     constructor(client: AxiosInstance);
-    /**
-     * The `get` method retrieves a specific label by `labelId`.
-     */
     get: (labelId: string) => Promise<import("axios").AxiosResponse<Label, any>>;
-    /**
-     * The `list` method retrieves a list of labels created by a given user.
-     */
     list: (params?: ListLabelsParams) => Promise<import("axios").AxiosResponse<{
         labels: Label[];
     }, any>>;
-    /**
-     * The `createByRateId` allows you to create a shipping label by using a `rateId`
-     * which is a unique identifier tied to a specific rate.
-     *
-     * This helps ensure that when a user is rate shopping, they can purchase a
-     * label for the price they were initially rated.
-     */
     createByRateId: (rateId: string, options: CreateLabelOptions) => Promise<import("axios").AxiosResponse<Label, any>>;
-    /**
-     * The `void` method allows a user to void a label by `labelId`.
-     */
     void: (labelId: string) => Promise<import("axios").AxiosResponse<VoidRequest, any>>;
 }

package/order-sources/api.d.ts

@@ -1,24 +1,11 @@
 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.40.0",
+  "version": "1.0.0-next.0",
   "main": "./index.js",
   "types": "./index.d.ts",
   "exports": {
@@ -14,8 +14,5 @@
     "entryPoint": "./src/index.ts",
     "readmeFile": "./README.md",
     "tsconfig": "./tsconfig.lib.json"
-  },
-  "peerDependencies": {
-    "axios": "^0.26.1"
   }
-}
+}

package/rates/api.d.ts

@@ -1,42 +1,16 @@
 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/resources/types.d.ts

@@ -14,37 +14,3 @@ 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,100 +1,15 @@
 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.
-     */
+export interface ListSalesOrderShipmentsParams {
     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`.
-     */
+    list: (params?: ListSalesOrderShipmentsParams) => Promise<import("axios").AxiosResponse<{
+        shipments: SalesOrderShipment[];
+    }, any>>;
     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,40 +1,15 @@
 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/index.d.ts

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

package/shipments/types.d.ts

@@ -1,9 +1,7 @@
 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";
 /**
@@ -102,7 +100,6 @@ export interface ShipmentItem {
  * @category Entities
  */
 export type ShipmentPackage = Omit<CarrierPackage, "name"> & {
-    contentDescription?: string;
     externalPackageId?: string;
     formDownload?: LinkedResource;
     insuredValue?: Money;
@@ -147,7 +144,6 @@ export type Customs = {
 export interface Shipment {
     addressValidation?: AddressValidation;
     advancedOptions?: {
-        additionalHandling?: boolean;
         billToAccount?: string;
         billToCountryCode?: string;
         billToParty?: BillToParties;
@@ -197,12 +193,3 @@ 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";
-}[];

package/types.d.ts

@@ -1,25 +1,17 @@
-export type RequiredFields<T, K extends keyof T> = T & Required<Pick<T, K>>;
-export * from "./account-settings/types";
-export * from "./account-billing-plan/types";
 export * from "./addresses/types";
 export * from "./carriers/types";
 export * from "./custom-packages/types";
 export * from "./dimensions/types";
 export * from "./errors/types";
-export * from "./funding-sources/types";
 export * from "./insurance/types";
 export * from "./labels/types";
 export * from "./order-sources/types";
 export * from "./payments/types";
 export * from "./rates/types";
-export * from "./rate-cards/types";
 export * from "./relay-points/types";
 export * from "./resources/types";
 export * from "./sales-order-shipments/types";
 export * from "./sales-orders/types";
 export * from "./shipments/types";
-export * from "./shipping-rules/types";
 export * from "./warehouses/types";
 export * from "./weight/types";
-export * from "./weight-band/types";
-export * from "./zones/types";

package/warehouses/api.d.ts

@@ -1,31 +1,12 @@
 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>>;
 }

package/account-billing-plan/api.d.ts

@@ -1,13 +0,0 @@
-import { AxiosInstance } from "axios";
-import { AccountBillingPlanResponse } from "./types";
-/**
- * # Account Billing Plan API module - /v1/account/billing_plan
- */
-export declare class AccountBillingPlanAPI {
-    private client;
-    constructor(client: AxiosInstance);
-    /**
-     * The `get` method retrieves the account billing plan for the current user.
-     */
-    get: () => Promise<import("axios").AxiosResponse<AccountBillingPlanResponse, any>>;
-}

package/account-billing-plan/index.d.ts

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

package/account-billing-plan/types.d.ts

@@ -1,30 +0,0 @@
-export declare enum AccountBillingPlanChangeType {
-    Downgrade = 0,
-    Cancellation = 1
-}
-export type AccountBillingPlan = {
-    code: string;
-    name: string;
-};
-/**
- * Responses
- */
-/**
- * "cancelledAt", "pendingChange" and "trialEndAt" are only available when applies
- * won't be on the response otherwise
- */
-export type AccountBillingPlanResponse = {
-    billingPlan: AccountBillingPlan;
-    cancelledAt?: string;
-    currentBillingCycle: {
-        endsAt: string;
-        startedAt: string;
-    };
-    pendingChange?: {
-        changeTo: AccountBillingPlan;
-        effectiveAt: string;
-        requestedAt: string;
-        type: AccountBillingPlanChangeType;
-    };
-    trialEndAt?: string;
-};

package/funding-sources/api.d.ts

@@ -1,50 +0,0 @@
-import { AxiosInstance } from "axios";
-import { Money } from "../payments";
-import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress, MetadataResponse } from "./types";
-/**
- * # Funding Sources API module - /v1/funding_sources
- * Docs: https://auctane.atlassian.net/wiki/spaces/SE/pages/3628370266/ShipEngine+Funding+Sources+API
- */
-export declare class FundingSourcesAPI {
-    private client;
-    constructor(client: AxiosInstance);
-    /**
-     * The `list` method retrieves a list of funding sources for a given user.
-     */
-    list: () => Promise<import("axios").AxiosResponse<{
-        fundingSources: FundingSource[];
-    }, any>>;
-    /**
-     * The `get` method retrieves a specific funding source by `fundingSourceId`.
-     */
-    get: (fundingSourceId: string) => Promise<import("axios").AxiosResponse<FundingSource, any>>;
-    /**
-     * The `create` method creates a new funding source for a given user. This requires
-     * payment information to be collected from the user.
-     */
-    create: (createFundingSource: CreateFundingSource) => Promise<import("axios").AxiosResponse<{
-        fundingSource: FundingSource;
-    }, any>>;
-    /**
-     * The `update` method updates a funding source for a given user. This allows the
-     * user to update the billing address or payment information associated with the
-     * funding source.
-     */
-    update: (billingInfo: FundingSourceAddress, creditCardInfo: CreditCardInfo, fundingSourceId: string) => Promise<import("axios").AxiosResponse<{
-        fundingSource: FundingSource;
-    }, any>>;
-    /**
-     * The `registerCarrier` method registers a carrier account and associates
-     * it with a given funding source.
-     */
-    registerCarrier: (carrier: CarrierRegistration) => Promise<import("axios").AxiosResponse<CarrierRegistrationResponse, any>>;
-    /**
-     * The `addFunds` method allows you to add funds to a funding source.
-     */
-    addFunds: (amount: Money, fundingSourceId: string) => Promise<import("axios").AxiosResponse<AddFundsResponse, any>>;
-    /**
-     * The `metadata` method returns seller-specific requirements for creating funding sources
-     * and attaching carriers
-     */
-    metadata: () => Promise<import("axios").AxiosResponse<MetadataResponse, any>>;
-}

package/funding-sources/index.d.ts

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