@shipengine/js-api 0.32.0 → 0.33.0

package/index.mjs

@@ -98,9 +98,17 @@ const types = /*#__PURE__*/Object.freeze(/*#__PURE__*/Object.defineProperty({
 class AccountSettingsAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `get` method retrieves the account settings for a given user.
+     */
     this.get = () => {
       return this.client.get("/v1/account/settings");
     };
+    /**
+     * The `update` method updates specific account settings for a given user.
+     *
+     * @params Partial<AccountSettings> The account settings to update.
+     */
     this.update = (settings) => {
       return this.client.put("/v1/account/settings", settings);
     };
@@ -111,9 +119,17 @@ class AccountSettingsAPI {
 class AddressesAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `validate` method validates a list of addresses.
+     *
+     * @params Address[] The addresses to be validated.
+     */
     this.validate = (addresses) => {
       return this.client.post("/v1/addresses/validate", addresses);
     };
+    /**
+     * The `parse` method parses a string of text to extract addresses.
+     */
     this.parse = (text, address) => {
       return this.client.put("/v1/addresses/recognize", {
         address,
@@ -917,12 +933,21 @@ var __async$3 = (__this, __arguments, generator) => {
 class CarriersAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of connected carriers for a given user.
+     */
     this.list = () => {
       return this.client.get("/v1/carriers");
     };
+    /**
+     * The `get` method retrieves a specific carrier by `carrierId`.
+     */
     this.get = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}`);
     };
+    /**
+     * The `connect` method connects a carrier account to a user's ShipEngine account.
+     */
     this.connect = (_a) => __async$3(this, null, function* () {
       var _b = _a, { carrierCode } = _b, connection = __objRest(_b, ["carrierCode"]);
       const endUserIpAddress = yield getEndUserIpAddress();
@@ -932,20 +957,44 @@ class CarriersAPI {
         endUserIpAddress
       }));
     });
+    /**
+     * 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.
+     */
     this.addFunds = (carrierId, funds) => {
       return this.client.put(`/v1/carriers/${carrierId}/add_funds`, funds);
     };
+    /**
+     * 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.
+     */
     this.updateAutoFunding = (carrierId, options) => {
       return this.client.post(
         `/v1/carriers/${carrierId}/auto_funding`,
         options
       );
     };
+    /**
+     * 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.
+     */
     this.getAutoFunding = (carrierId) => {
       return this.client.get(
         `/v1/carriers/${carrierId}/auto_funding`
       );
     };
+    /**
+     * The `getWalletHistory` method retrieves the wallet transaction history for
+     * a ShipEngine wallet account.
+     */
     this.getWalletHistory = (startDate, endDate, page) => {
       return this.client.get(`/v1/carriers/wallet_history`, {
         params: {
@@ -955,20 +1004,43 @@ class CarriersAPI {
         }
       });
     };
+    /**
+     * The `getServices` method retrieves a list of shipping services that a given carrier offers.
+     */
     this.getServices = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}/services`);
     };
+    /**
+     * 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.
+     */
     this.getPackageRatingGroup = (carrierId) => {
       return this.client.get(
         `/v1/carriers/${carrierId}/package_rating_group`
       );
     };
+    /**
+     * The `getCountries` method retrieves a list of countries that a given carrier
+     * supports shipping to.
+     */
     this.getCountries = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}/countries`);
     };
+    /**
+     * The `getCurrencies` method retrieves a list of currencies that a given carrier
+     * supports the usage of.
+     */
     this.getCurrencies = (carrierId) => {
       return this.client.get(`/v1/carriers/${carrierId}/currencies`);
     };
+    /**
+     * The `getZones` method retrieves a list of zones for which the attached carrier
+     * provides support to.
+     */
+    this.getZones = (carrierId) => {
+      return this.client.get(`/v1/carriers/${carrierId}/zones`);
+    };
     this.client = client;
   }
 }
@@ -3153,6 +3225,9 @@ var lib = {
 class CustomPackagesAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of custom packages a given user has created.
+     */
     this.list = () => {
       return this.client.get("/v1/packages");
     };
@@ -3199,12 +3274,22 @@ var __async$2 = (__this, __arguments, generator) => {
 class FundingSourcesAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of funding sources for a given user.
+     */
     this.list = () => {
       return this.client.get("/v1/funding_sources");
     };
+    /**
+     * The `get` method retrieves a specific funding source by `fundingSourceId`.
+     */
     this.get = (fundingSourceId) => {
       return this.client.get(`/v1/funding_sources/${fundingSourceId}`);
     };
+    /**
+     * The `create` method creates a new funding source for a given user. This requires
+     * payment information to be collected from the user.
+     */
     this.create = (createFundingSource) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -3213,6 +3298,11 @@ class FundingSourcesAPI {
         endUserIpAddress
       }, createFundingSource));
     });
+    /**
+     * 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.
+     */
     this.update = (billingInfo, creditCardInfo, fundingSourceId) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -3226,6 +3316,10 @@ class FundingSourcesAPI {
         }
       );
     });
+    /**
+     * The `registerCarrier` method registers a carrier account and associates
+     * it with a given funding source.
+     */
     this.registerCarrier = (carrier) => __async$2(this, null, function* () {
       const endUserIpAddress = yield getEndUserIpAddress();
       if (!endUserIpAddress)
@@ -3234,6 +3328,9 @@ class FundingSourcesAPI {
         endUserIpAddress
       }, carrier));
     });
+    /**
+     * The `addFunds` method allows you to add funds to a funding source.
+     */
     this.addFunds = (amount, fundingSourceId) => __async$2(this, null, function* () {
       return yield this.client.put(
         `/v1/funding_sources/${fundingSourceId}/add_funds`,
@@ -3247,6 +3344,10 @@ class FundingSourcesAPI {
 class InsuranceAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `get` method retrieves the insurance balance for a given `insuranceProvider`
+     * by ID.
+     */
     this.get = (insuranceProvider) => {
       return this.client.get(`/v1/insurance/${insuranceProvider}/balance`);
     };
@@ -3257,15 +3358,31 @@ class InsuranceAPI {
 class LabelsAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `get` method retrieves a specific label by `labelId`.
+     */
     this.get = (labelId) => {
       return this.client.get(`/v1/labels/${labelId}`);
     };
+    /**
+     * The `list` method retrieves a list of labels created by a given user.
+     */
     this.list = (params = {}) => {
       return this.client.get("/v1/labels", { params });
     };
+    /**
+     * 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.
+     */
     this.createByRateId = (rateId, options) => {
       return this.client.post(`/v1/labels/rates/${rateId}`, options);
     };
+    /**
+     * The `void` method allows a user to void a label by `labelId`.
+     */
     this.void = (labelId) => {
       return this.client.put(`/v1/labels/${labelId}/void`);
     };
@@ -3276,12 +3393,22 @@ class LabelsAPI {
 class OrderSourcesAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of connected order sources for a given user.
+     */
     this.list = () => {
       return this.client.get("/v-beta/order_sources");
     };
+    /**
+     * The `get` method retrieves a specific order source by `orderSourceId`.
+     */
     this.get = (orderSourceId) => {
       return this.client.get(`/v-beta/order_sources/${orderSourceId}`);
     };
+    /**
+     * The `refresh` method refreshes a specific order source by `orderSourceId`.
+     * This will pull in any `new orders` since the last order import.
+     */
     this.refresh = (orderSourceId) => {
       return this.client.put(`/v-beta/order_sources/${orderSourceId}/refresh`);
     };
@@ -3292,20 +3419,36 @@ class OrderSourcesAPI {
 class RateCardsAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of rate cards for a given list of carrier ID's.
+     */
     this.list = (carrierIds) => {
       return this.client.get(
         `/v1/rate_cards?carrier_ids=${carrierIds.toString()}`
       );
     };
+    /**
+     * The `get` method retrieves a specific rate card by `rateCardId`.
+     */
     this.get = (rateCardId) => {
       return this.client.get(`/v1/rate_cards/${rateCardId}`);
     };
+    /**
+     * The `create` method creates a new rate card for a given user.
+     */
     this.create = (rateCardInput) => {
       return this.client.post("/v1/rate_cards", rateCardInput);
     };
+    /**
+     * The `update` method updates a specific rate card by `rateCardId` with a new
+     * `RateCard`.
+     */
     this.update = (rateCard) => {
       return this.client.put(`/v1/rate_cards/${rateCard.id}`, rateCard);
     };
+    /**
+     * The `download` method allows for downloading a given rate card by `rateCardId`.
+     */
     this.download = (rateCardId) => {
       return this.client.get(`/v1/rate_cards/${rateCardId}/rates/download`, {
         headers: {
@@ -3314,6 +3457,9 @@ class RateCardsAPI {
         responseType: "blob"
       });
     };
+    /**
+     * The `upload` method allows for uploading a given rate card as a spreadsheet file.
+     */
     this.upload = (rateCardId, file) => {
       const formData = new FormData();
       formData.append("file", file);
@@ -3323,6 +3469,9 @@ class RateCardsAPI {
         }
       });
     };
+    /**
+     * The `publish` method allows for publishing a given rate card by `rateCardId`.
+     */
     this.publish = (rateCardId) => {
       return this.client.post(`/v1/rate_cards/${rateCardId}/publish`);
     };
@@ -3339,6 +3488,10 @@ class RateCardsAPI {
 class RatesAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `calculate` method calculates rates for a shipment by shipment ID based
+     * on the shipment's options.
+     */
     this.calculateByShipmentId = (shipmentId, options) => {
       return this.client.post("/v1/rates", {
         rateOptions: options,
@@ -3352,20 +3505,32 @@ class RatesAPI {
 class SalesOrderShipmentsAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of sales order shipments for a given user.
+     */
     this.list = (body = {}, params) => {
       return this.client.post("/v-beta/shipments/list", body, {
         params
       });
     };
+    /**
+     * The `get` method retrieves a specific sales order shipment by `shipmentId`.
+     */
     this.get = (shipmentId) => {
       return this.client.get(`/v-beta/shipments/${shipmentId}`);
     };
+    /**
+     * The `create` method creates a new shipment for a sales order.
+     */
     this.create = (salesOrderId, shipment) => {
       return this.client.post(
         `/v-beta/shipments/sales_order/${salesOrderId}`,
         shipment
       );
     };
+    /**
+     * The `update` method updates a specific sales order shipment by `shipmentId`.
+     */
     this.update = (shipmentId, shipment) => {
       return this.client.put(`/v-beta/shipments/${shipmentId}`, shipment);
     };
@@ -3376,12 +3541,23 @@ class SalesOrderShipmentsAPI {
 class SalesOrdersAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of sales orders.
+     */
     this.list = (params = {}) => {
       return this.client.get("/v-beta/sales_orders", { params });
     };
+    /**
+     * The `get` method retrieves a specific sales order by `salesOrderId`.
+     */
     this.get = (salesOrderId) => {
       return this.client.get(`/v-beta/sales_orders/${salesOrderId}`);
     };
+    /**
+     * 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.
+     */
     this.notifyShipped = (salesOrderId, tracking) => {
       return this.client.post(`/v-beta/sales_orders/${salesOrderId}/notify`, tracking);
     };
@@ -3412,15 +3588,26 @@ var __async$1 = (__this, __arguments, generator) => {
 class ShipmentsAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `getShipmentRates` method retrieves rates for a given shipment by
+     * shipment ID.
+     */
     this.getShipmentRates = ({ shipmentId, createdAtStart }) => {
       return this.client.get(
         `/v1/shipments/${shipmentId}/rates`,
         createdAtStart !== void 0 ? { params: { createdAtStart } } : void 0
       );
     };
+    /**
+     * The `list` method retrieves a list of shipments for a given user.
+     */
     this.list = (options) => {
       return this.client.get("/v1/shipments", { params: options });
     };
+    /**
+     * The `create` method allows for creating shipments based on a list of shipment
+     * items passed into this method.
+     */
     this.create = (...shipments) => __async$1(this, null, function* () {
       return this.client.post("/v1/shipments", {
         shipments
@@ -3433,15 +3620,31 @@ class ShipmentsAPI {
 class WarehousesAPI {
   constructor(client) {
     this.client = client;
+    /**
+     * The `list` method retrieves a list of `warehouses` (Ship From Locations)
+     * for a given user.
+     */
     this.list = () => {
       return this.client.get("/v1/warehouses");
     };
+    /**
+     * The `create` method allows for creation of warehouses (Ship From Locations)
+     * on a users ShipEngine account.
+     */
     this.create = (warehouse) => {
       return this.client.post("/v1/warehouses", warehouse);
     };
+    /**
+     * The `update` method updates a specific warehouse (Ship From Location) for a
+     * given user by `warehouseId`.
+     */
     this.update = (warehouseId, warehouse) => {
       return this.client.put(`/v1/warehouses/${warehouseId}`, warehouse);
     };
+    /**
+     * The `delete` method deletes a specific warehouse (Ship From Location) by
+     * `warehouseId` from a users ShipEngine account.
+     */
     this.delete = (warehouseId) => {
       return this.client.delete(`/v1/warehouses/${warehouseId}`);
     };
@@ -3602,48 +3805,135 @@ class ShipEngineAPI {
     );
     this.client = client;
   }
+  /**
+   * The `token` method takes in a string and sets it as the Authorization header for all requests.
+   */
   set token(token) {
     this.client.defaults.headers.common["Authorization"] = `Bearer ${token}`;
   }
+  /**
+   * The `accountSettings` method provides access to the Account Settings endpoints
+   * in ShipEngine API.
+   *
+   * @see {@link AccountSettingsAPI | The Account Settings API module}
+   */
   get accountSettings() {
     return new AccountSettingsAPI(this.client);
   }
+  /**
+   * 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() {
     return new AddressesAPI(this.client);
   }
+  /**
+   * 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() {
     return new CarriersAPI(this.client);
   }
+  /**
+   * 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() {
     return new CustomPackagesAPI(this.client);
   }
+  /**
+   * The `fundingSources` method provides access to the Funding Sources endpoints
+   * in ShipEngine API.
+   *
+   * @see {@link FundingSourcesAPI | The Funding Sources API module}
+   */
   get fundingSources() {
     return new FundingSourcesAPI(this.client);
   }
+  /**
+   * 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() {
     return new InsuranceAPI(this.client);
   }
+  /**
+   * 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() {
     return new LabelsAPI(this.client);
   }
+  /**
+   * 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() {
     return new OrderSourcesAPI(this.client);
   }
+  /**
+   * The `rateCards` method provides access to the Rate Cards endpoints in ShipEngine
+   * API.
+   *
+   * @see {@link RateCardsAPI | The Rate Cards API module}
+   */
   get rateCards() {
     return new RateCardsAPI(this.client);
   }
+  /**
+   * 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() {
     return new RatesAPI(this.client);
   }
+  /**
+   * 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() {
     return new SalesOrderShipmentsAPI(this.client);
   }
+  /**
+   * 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() {
     return new SalesOrdersAPI(this.client);
   }
+  /**
+   * 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() {
     return new ShipmentsAPI(this.client);
   }
+  /**
+   * 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() {
     return new WarehousesAPI(this.client);
   }

package/insurance/api.d.ts

@@ -1,7 +1,14 @@
 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,22 +1,73 @@
 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>>;
 }