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

package/account-settings/api.d.ts

@@ -1,19 +1,7 @@
 import { AxiosInstance } from "axios";
-import { AccountSettings } from "./types";
-/**
- * # Account Settings API module - /v1/account/settings
- */
+import { Settings } from "./types";
 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>>;
+    getAccountSettings: () => Promise<import("axios").AxiosResponse<Settings, any>>;
 }

package/account-settings/types.d.ts

@@ -1,8 +1,4 @@
-import { DimensionUnit } from "../dimensions";
 import { LabelLayout } from "../labels";
-import { WeightUnit } from "../weight";
-export interface AccountSettings {
-    defaultLabelLayout: LabelLayout;
-    dimensionsUnit: DimensionUnit;
-    weightUnit: WeightUnit;
+export interface Settings {
+    defaultLabelLayout: LabelLayout | null;
 }

package/addresses/api.d.ts

@@ -1,19 +1,8 @@
 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,89 +1,17 @@
 import { AxiosInstance } from "axios";
-import { Currency, Money } from "../payments";
-import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, CarrierZone, PackageRatingType, WalletTransactionHistory } from "./types";
-/**
- * # Carriers API module - /v1/carriers
- */
+import { Money } from "../payments";
+import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection } from "./types";
 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>>;
-    /**
-     * The `getZones` method retrieves a list of zones for which the attached carrier
-     * provides support to.
-     */
-    getZones: (carrierId: string) => Promise<import("axios").AxiosResponse<{
-        zones: CarrierZone[];
-    }, any>>;
 }

package/carriers/types.d.ts

@@ -1,7 +1,6 @@
 import { Address } from "../addresses";
 import { DimensionsWithUnit } from "../dimensions";
 import { CreditCard, Money } from "../payments";
-import { WeightWithUnit } from "../weight";
 /**
  * @category Entities
  */
@@ -48,20 +47,6 @@ export interface CarrierPackage {
     packageCode: string;
     packageId?: string;
 }
-/**
- * @category Entities
- */
-export interface PackageRatingType {
-    apiCode?: string;
-    carrierPackageTypeCode: string;
-    description: string;
-    dimensions: DimensionsWithUnit;
-    maxWeight: WeightWithUnit;
-    name: string;
-    packageId: string;
-    packageTypeId?: string;
-    status: string;
-}
 /**
  * @category Entities
  */
@@ -101,15 +86,15 @@ export type CarrierConnection = {
     carrierCode: "dhl_express_walleted";
     nickname: string;
 };
-export type WalletTransactionType = "adjustment" | "purchase" | "reload" | "void";
 export type WalletTransaction = {
     amount: number;
     balance: number;
-    carrier: Pick<Carrier, "carrierId" | "carrierCode" | "friendlyName">;
+    carrierId: string;
+    carrierProvider: string;
     labelId: string;
     transactionDate: string;
     transactionId: string;
-    transactionType: WalletTransactionType;
+    transactionType: "fund" | "void" | "adjustment" | "purchase";
 };
 export type TransactionHistoryCsvLink = {
     transactionHistoryReport: string;
@@ -121,7 +106,3 @@ export type WalletTransactionHistory = {
     total: number;
     transactions: WalletTransaction[];
 };
-export type CarrierZone = {
-    apiCode: string;
-    name: string;
-};

package/client.d.ts

@@ -1,162 +1,34 @@
 import { AxiosRequestHeaders } from "axios";
-import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
 import { CarriersAPI } from "./carriers";
 import { CustomPackagesAPI } from "./custom-packages";
-import { FundingSourcesAPI } from "./funding-sources";
 import { InsuranceAPI } from "./insurance";
 import { LabelsAPI } from "./labels";
 import { OrderSourcesAPI } from "./order-sources";
-import { RateCardsAPI } from "./rate-cards";
 import { RatesAPI } from "./rates";
 import { SalesOrderShipmentsAPI } from "./sales-order-shipments";
 import { SalesOrdersAPI } from "./sales-orders";
-import { ShipmentsAPI } from "./shipments";
-import { ShippingRulesAPI } from "./shipping-rules";
 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 `accountBillingPlan` method provides access to the Account Billing Plan endpoints
-     * in ShipEngine API.
-     */
-    get accountBillingPlan(): AccountBillingPlanAPI;
-    /**
-     * 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 accountSettings(): AccountSettingsAPI;
     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;
-    /**
-     * The `shippingRules` method provides access to the Shipping Rules endpoints in ShipEngine
-     * API.
-     *
-     * @see {@link ShippingRulesAPI | The Shipping Rules API module}
-     */
-    get shippingRules(): ShippingRulesAPI;
 }

package/custom-packages/api.d.ts

@@ -1,14 +1,8 @@
 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/dimensions/types.d.ts

@@ -6,13 +6,8 @@ export type DimensionUnit = "inch" | "centimeter";
  * @category Entities
  */
 export interface Dimensions {
-    girth?: number;
     height: number;
     length: number;
-    lengthPlusGirth?: number;
-    noThreeSidesExceed?: number;
-    noTwoSidesExceed?: number;
-    volume?: number;
     width: number;
 }
 /**

package/errors/types.d.ts

@@ -1,11 +1,11 @@
 /**
  * @category Entities
  */
-export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "duplicated_rate_card" | "empty_file" | "field_conflict" | "field_value_required" | "forbidden" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "insufficient_rate_card_data" | "invalid_address" | "invalid_billing_plan" | "invalid_currency" | "invalid_field_value" | "invalid_file_type" | "invalid_file_size" | "invalid_identifier" | "invalid_status" | "invalid_string_length" | "invalid_zones" | "invalid_packages" | "invalid_weight_bands" | "invalid_weight_bands_rates" | "invalid_rates" | "label_images_not_supported" | "meter_failure" | "not_found" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "repeated_surcharges_in_rate_card" | "repeated_surcharges_in_services" | "repeated_surcharges_in_zone" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict";
+export type CodedErrorCode = "auto_fund_not_supported" | "batch_cannot_be_modified" | "carrier_conflict" | "carrier_disconnected" | "carrier_not_connected" | "carrier_not_supported" | "confirmation_not_supported" | "default_warehouse_cannot_be_deleted" | "field_conflict" | "field_value_required" | "forbidden" | "identifier_conflict" | "identifiers_must_match" | "insufficient_funds" | "invalid_address" | "invalid_billing_plan" | "invalid_field_value" | "invalid_identifier" | "invalid_status" | "invalid_string_length" | "label_images_not_supported" | "meter_failure" | "order_source_not_active" | "rate_limit_exceeded" | "refresh_not_supported" | "request_body_required" | "return_label_not_supported" | "settings_not_supported" | "subscription_inactive" | "terms_not_accepted" | "tracking_not_supported" | "trial_expired" | "unauthorized" | "unknown" | "unspecified" | "verification_failure" | "warehouse_conflict" | "webhook_event_type_conflict";
 /**
  * @category Entities
  */
-export type CodedErrorSource = "carrier" | "order_source" | "shipengine" | "elements" | "client" | "rate_card_manager";
+export type CodedErrorSource = "carrier" | "order_source" | "shipengine" | "elements" | "client";
 /**
  * @category Entities
  */

package/index.d.ts

@@ -6,20 +6,15 @@ export * from "./client";
 export * from "./custom-packages";
 export * from "./dimensions";
 export * from "./errors";
-export * from "./funding-sources";
 export * from "./insurance";
 export * from "./labels";
 export * from "./order-sources";
 export * from "./payments";
 export * from "./rates";
-export * from "./rate-cards";
 export * from "./relay-points";
 export * from "./resources";
 export * from "./sales-order-shipments";
 export * from "./sales-orders";
 export * from "./shipments";
-export * from "./shipping-rules";
-export * from "./utilities";
 export * from "./warehouses";
 export * from "./weight";
-export * from "./zones";