@shipengine/js-api 0.31.0 → 0.32.1

package/account-settings/api.d.ts

@@ -1,8 +1,19 @@
 import { AxiosInstance } from "axios";
 import { AccountSettings } from "./types";
+/**
+ * # Account Settings API module - /v1/account/settings
+ */
 export declare class AccountSettingsAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves the account settings for a given user.
+     */
     get: () => Promise<import("axios").AxiosResponse<AccountSettings, any>>;
+    /**
+     * The `update` method updates specific account settings for a given user.
+     *
+     * @params Partial<AccountSettings> The account settings to update.
+     */
     update: (settings: Partial<AccountSettings>) => Promise<import("axios").AxiosResponse<AccountSettings, any>>;
 }

package/addresses/api.d.ts

@@ -1,8 +1,19 @@
 import { AxiosInstance } from "axios";
 import { Address, AddressExtraction, AddressValidation } from "./types";
+/**
+ * # Addresses API module - /v1/addresses
+ */
 export declare class AddressesAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `validate` method validates a list of addresses.
+     *
+     * @params Address[] The addresses to be validated.
+     */
     validate: (addresses: Address[]) => Promise<import("axios").AxiosResponse<AddressValidation[], any>>;
+    /**
+     * The `parse` method parses a string of text to extract addresses.
+     */
     parse: (text: string, address?: Partial<Address>) => Promise<import("axios").AxiosResponse<AddressExtraction, any>>;
 }

package/carriers/api.d.ts

@@ -1,29 +1,81 @@
 import { AxiosInstance } from "axios";
 import { Currency, Money } from "../payments";
 import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, PackageRatingType, WalletTransactionHistory } from "./types";
+/**
+ * # Carriers API module - /v1/carriers
+ */
 export declare class CarriersAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of connected carriers for a given user.
+     */
     list: () => Promise<import("axios").AxiosResponse<{
         carriers: Carrier[];
     }, any>>;
+    /**
+     * The `get` method retrieves a specific carrier by `carrierId`.
+     */
     get: (carrierId: string) => Promise<import("axios").AxiosResponse<Carrier, any>>;
+    /**
+     * The `connect` method connects a carrier account to a user's ShipEngine account.
+     */
     connect: ({ carrierCode, ...connection }: CarrierConnection) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `addFunds` method allows a user to add funds to their carrier account balance.
+     * Not all carrier providers allow you to maintain a balance.
+     *
+     * - For example, FedEx does
+     * not require you to maintain a balance that will be used when purchasing labels.
+     */
     addFunds: (carrierId: string, funds: Money) => Promise<import("axios").AxiosResponse<{
         balance: Money;
     }, any>>;
+    /**
+     * The `updateAutoFunding` method allows a user to update the auto-funding settings
+     * on their ShipEngine account.
+     *
+     * e.g. Enable auto-funding, set a balance threshold, and a maximum number of time
+     * per day you wish to auto-fund your account.
+     */
     updateAutoFunding: (carrierId: string, options: CarrierAutoFundingSettings) => Promise<import("axios").AxiosResponse<CarrierAutoFundingSettingsResponse, any>>;
+    /**
+     * The `getAutoFunding` method retrieves the current auto-funding settings.
+     *
+     * If no auto-funding rules have been set, the response will contain the default
+     * values for auto-funding. Auto-funding is disabled by default.
+     */
     getAutoFunding: (carrierId: string) => Promise<import("axios").AxiosResponse<CarrierAutoFundingSettingsResponse, any>>;
+    /**
+     * The `getWalletHistory` method retrieves the wallet transaction history for
+     * a ShipEngine wallet account.
+     */
     getWalletHistory: (startDate: Date, endDate: Date, page: number) => Promise<import("axios").AxiosResponse<WalletTransactionHistory, any>>;
+    /**
+     * The `getServices` method retrieves a list of shipping services that a given carrier offers.
+     */
     getServices: (carrierId: string) => Promise<import("axios").AxiosResponse<{
         services: CarrierService[];
     }, any>>;
+    /**
+     * The `getPackageRatingGroup` method retrieves a list of package rating groups.
+     * This is primarily used for carriers that support negotiated rates, and a user
+     * has a rate card with multiple package rating groups.
+     */
     getPackageRatingGroup: (carrierId: string) => Promise<import("axios").AxiosResponse<{
         packageRatingGroup: PackageRatingType[];
     }, any>>;
+    /**
+     * The `getCountries` method retrieves a list of countries that a given carrier
+     * supports shipping to.
+     */
     getCountries: (carrierId: string) => Promise<import("axios").AxiosResponse<{
         countries: string[];
     }, any>>;
+    /**
+     * The `getCurrencies` method retrieves a list of currencies that a given carrier
+     * supports the usage of.
+     */
     getCurrencies: (carrierId: string) => Promise<import("axios").AxiosResponse<{
         currencies: Currency[];
     }, any>>;

package/client.d.ts

@@ -13,28 +13,136 @@ import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
 import { ShipmentsAPI } from "./shipments";
 import { WarehousesAPI } from "./warehouses";
+/**
+ * # ShipEngine API Client Headers
+ */
 export type ShipEngineAPIHeaders = AxiosRequestHeaders;
+/**
+ * # ShipEngine API Client Configuration
+ */
 export interface ShipEngineAPIConfig {
+    /**
+     * `baseURL` is an optional string that represents the base URL to be used for all requests.
+     */
     baseURL?: string;
+    /**
+     * `getToken` is an optional callback function that returns a token to used to authenticate all requests.
+     */
     getToken: () => Promise<string> | string;
+    /**
+     * `headers` are optional HTTP headers to be sent with all requests.
+     */
     headers?: ShipEngineAPIHeaders;
 }
+/**
+ * # ShipEngine API Client
+ *
+ * - This class is the ShipEngine API Client that facilitates all requests. e.g.
+ * Rate Shopping, Label Creation, etc.
+ */
 export declare class ShipEngineAPI {
     private client;
     constructor(token: string, { baseURL, headers, getToken }: ShipEngineAPIConfig);
+    /**
+     * The `token` method takes in a string and sets it as the Authorization header for all requests.
+     */
     set token(token: string);
+    /**
+     * The `accountSettings` method provides access to the Account Settings endpoints
+     * in ShipEngine API.
+     *
+     * @see {@link AccountSettingsAPI | The Account Settings API module}
+     */
     get accountSettings(): AccountSettingsAPI;
+    /**
+     * The `addresses` method provides access to the Address Validation endpoints
+     * in ShipEngine API. e.g. Validate Addresses, Parse Addresses, etc.
+     *
+     * @see {@link AddressesAPI | The Addresses API module}
+     */
     get addresses(): AddressesAPI;
+    /**
+     * The `carriers` method provides access to the Carrier endpoints in ShipEngine
+     * API. e.g. List Carriers, Get Carrier, Connect Carrier, etc.
+     *
+     * @see {@link CarriersAPI | The Carriers API module}
+     */
     get carriers(): CarriersAPI;
+    /**
+     * The `customPackages` method provides access to the Packages endpoint in ShipEngine
+     * API. e.g. List Packages
+     *
+     * @see {@link CustomPackagesAPI | The Custom Packages API module}
+     */
     get customPackages(): CustomPackagesAPI;
+    /**
+     * The `fundingSources` method provides access to the Funding Sources endpoints
+     * in ShipEngine API.
+     *
+     * @see {@link FundingSourcesAPI | The Funding Sources API module}
+     */
     get fundingSources(): FundingSourcesAPI;
+    /**
+     * The `insurance` method provides access to the Insurance endpoint in ShipEngine
+     * API. e.g. Get Insurance Balance
+     *
+     * @see {@link InsuranceAPI | The Insurance API module}
+     */
     get insurance(): InsuranceAPI;
+    /**
+     * The `labels` method provides access to the Label endpoints in ShipEngine API.
+     * e.g. Create Label, Get Label, Void Label, etc.
+     *
+     * @see {@link LabelsAPI | The Labels API module}
+     */
     get labels(): LabelsAPI;
+    /**
+     * The `orderSources` method provides access to the Order Sources endpoints in
+     * ShipEngine API. e.g. List Order Sources, Get Order Source, Refresh Order Source, etc.
+     *
+     * @see {@link OrderSourcesAPI | The Order Sources API module}
+     */
     get orderSources(): OrderSourcesAPI;
+    /**
+     * The `rateCards` method provides access to the Rate Cards endpoints in ShipEngine
+     * API.
+     *
+     * @see {@link RateCardsAPI | The Rate Cards API module}
+     */
     get rateCards(): RateCardsAPI;
+    /**
+     * The `rates` method provides access to the Rate endpoints in ShipEngine API.
+     * e.g. Get Rates
+     *
+     * @see {@link RatesAPI | The Rates API module}
+     */
     get rates(): RatesAPI;
+    /**
+     * The `salesOrderShipments` method provides access to the `v-beta` Sales
+     * Order Shipments endpoints in ShipEngine API.
+     *
+     * @see {@link SalesOrderShipmentsAPI | The Sales Order Shipments API module}
+     */
     get salesOrderShipments(): SalesOrderShipmentsAPI;
+    /**
+     * The `salesOrders` method provides access to the `v-beta` Sales Order endpoints
+     * in ShipEngine API.
+     *
+     * @see {@link SalesOrdersAPI | The Sales Orders API module}
+     */
     get salesOrders(): SalesOrdersAPI;
+    /**
+     * The `shipments` method provides access to the Shipment endpoints in ShipEngine
+     * API. e.g. Create Shipment, Get Shipment, etc.
+     *
+     * @see {@link ShipmentsAPI | The Shipments API module}
+     */
     get shipments(): ShipmentsAPI;
+    /**
+     * The `warehouses` method provides access to the Warehouses endpoints in ShipEngine
+     * API. e.g. List Warehouses, Get Warehouse, etc.
+     *
+     * @see {@link WarehousesAPI | The Warehouses API module}
+     */
     get warehouses(): WarehousesAPI;
 }

package/custom-packages/api.d.ts

@@ -1,8 +1,14 @@
 import { AxiosInstance } from "axios";
 import { CustomPackage } from "./types";
+/**
+ * # Custom Packages API module - /v1/packages
+ */
 export declare class CustomPackagesAPI {
     private client;
     constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves a list of custom packages a given user has created.
+     */
     list: () => Promise<import("axios").AxiosResponse<{
         packages: CustomPackage[];
     }, any>>;

package/funding-sources/api.d.ts

@@ -1,19 +1,44 @@
 import { AxiosInstance } from "axios";
 import { Money } from "../payments";
 import { AddFundsResponse, CarrierRegistration, CarrierRegistrationResponse, CreateFundingSource, CreditCardInfo, FundingSource, FundingSourceAddress } from "./types";
+/**
+ * # Funding Sources API module - /v1/funding_sources
+ */
 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>>;
 }