@shipengine/js-api 1.0.0-next.5 → 1.0.0

package/README.md

@@ -0,0 +1,30 @@
+# ShipEngine JS Api
+
+The `shipengine/js-api` library instantiates a batteries-included, vanilla JavaScript client for interacting with the [ShipEngine API](https://shipengine.github.io/shipengine-openapi/). The client provides a set of fully-typed methods that map directly to ShipEngine API operations[^1], bound to a user specified via platform token.
+
+## Features:
+
+- Converts all outbound JSON keys to `snake_case` for consumption by the ShipEngine API.
+- Converts all inbound JSON keys to `camelCase` for use in JS.
+- Attempts to refresh expired tokens on `401 Unauthorized` responses, followed by retrying the original request.
+- Logs all requests and responses to the console.
+
+In addition to the client, the `shipengine/js-api` lib provides TypeScript types for all ShipEngine API entities.
+
+## Basic Usage
+
+```tsx
+import { ShipEngineAPI } from "@shipengine/js-api";
+
+const client = new ShipEngineAPI("your-platform-token", {
+  // Used when attempting to refresh the token on 401 responses
+  getToken: async () => {
+    return "your-platform-token";
+  },
+});
+
+client.shipments.list().then((response) => {
+  console.log(response.data);
+  // > an object matching the response schema of https://shipengine.github.io/shipengine-openapi/#operation/list_shipments
+});
+```

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

@@ -0,0 +1,17 @@
+import { AxiosInstance } from "axios";
+import { AccountBillingPlanResponse, UpdateAccountBillingPlanRequestBody, UpdateAccountBillingPlanResponse } 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>>;
+    /**
+     * The `update` method updates the code of the account billing plan
+     */
+    update: (reqBody: UpdateAccountBillingPlanRequestBody) => Promise<import("axios").AxiosResponse<UpdateAccountBillingPlanResponse, any>>;
+}

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

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

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

@@ -0,0 +1,37 @@
+export declare enum AccountBillingPlanChangeType {
+    Downgrade = "Downgrade",
+    Cancellation = "Cancellation"
+}
+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;
+};
+export type UpdateAccountBillingPlanResponse = {
+    code: string;
+    name: string;
+};
+export type UpdateAccountBillingPlanRequestBody = {
+    code: string;
+};

package/account-settings/api.d.ts

@@ -1,8 +1,35 @@
 import { AxiosInstance } from "axios";
-import { AccountSettings } from "./types";
+import { AccountImage, AccountImageResponse, AccountImagesResponse, AccountSettings, UpdateAccountImage } 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>>;
-    update: (settings: AccountSettings) => 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>>;
+    /**
+     * The `createImage` method creates an image that can be used in your printed labels.
+     */
+    createImage: (data: AccountImage) => Promise<import("axios").AxiosResponse<AccountImageResponse, any>>;
+    /**
+     * The `updateImage` method updates specific image data for a given image id.
+     */
+    updateImage: ({ labelImageId, ...data }: UpdateAccountImage) => Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * The `getImages` method retrieves a list of images for a given user.
+     */
+    getImages: () => Promise<import("axios").AxiosResponse<AccountImagesResponse, any>>;
+    /**
+     * The `deleteAccountImage` method deletes an image by id.
+     */
+    deleteImage: (labelImageId: string) => Promise<import("axios").AxiosResponse<void, any>>;
 }

package/account-settings/types.d.ts

@@ -1,8 +1,24 @@
 import { DimensionUnit } from "../dimensions";
 import { LabelLayout } from "../labels";
+import { PageableResult } from "../resources";
 import { WeightUnit } from "../weight";
 export interface AccountSettings {
-    defaultLabelLayout?: LabelLayout;
-    dimension?: DimensionUnit;
-    weight?: WeightUnit;
+    defaultLabelLayout: LabelLayout;
+    dimensionsUnit: DimensionUnit;
+    weightUnit: WeightUnit;
 }
+export type AccountImage = {
+    imageContentType: string;
+    imageData: string;
+    isDefault: boolean;
+    name: string;
+};
+export type AccountImageResponse = AccountImage & {
+    createdAt: string;
+    labelImageId: string;
+    modifiedAt: string;
+};
+export type AccountImagesResponse = {
+    images: AccountImageResponse[];
+} & PageableResult;
+export type UpdateAccountImage = Partial<Omit<AccountImageResponse, "isDefault" | "createdAt" | "modifiedAt">> & Pick<AccountImageResponse, "isDefault">;

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,17 +1,84 @@
 import { AxiosInstance } from "axios";
-import { Money } from "../payments";
-import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection } from "./types";
+import { Currency, Money } from "../payments";
+import { Carrier, CarrierAutoFundingSettings, CarrierAutoFundingSettingsResponse, CarrierConnection, CarrierService, CarrierZone, PackageRatingType } 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 `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,6 +1,7 @@
 import { Address } from "../addresses";
 import { DimensionsWithUnit } from "../dimensions";
 import { CreditCard, Money } from "../payments";
+import { WeightWithUnit } from "../weight";
 /**
  * @category Entities
  */
@@ -47,6 +48,20 @@ 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
  */
@@ -86,12 +101,11 @@ export type CarrierConnection = {
     carrierCode: "dhl_express_walleted";
     nickname: string;
 };
-export type WalletTransactionType = "adjustment" | "fund" | "purchase" | "reload" | "void";
+export type WalletTransactionType = "adjustment" | "purchase" | "reload" | "void";
 export type WalletTransaction = {
     amount: number;
     balance: number;
-    carrierId: string;
-    carrierProvider: string;
+    carrier: Pick<Carrier, "carrierId" | "carrierCode" | "friendlyName">;
     labelId: string;
     transactionDate: string;
     transactionId: string;
@@ -107,3 +121,7 @@ export type WalletTransactionHistory = {
     total: number;
     transactions: WalletTransaction[];
 };
+export type CarrierZone = {
+    apiCode: string;
+    name: string;
+};

package/client.d.ts

@@ -1,34 +1,188 @@
-import { AxiosRequestHeaders } from "axios";
+import { AxiosError, AxiosRequestHeaders } from "axios";
+import { AccountBillingPlanAPI } from "./account-billing-plan";
 import { AccountSettingsAPI } from "./account-settings";
 import { AddressesAPI } from "./addresses";
 import { CarriersAPI } from "./carriers";
+import { ConnectionsAPI } from "./connections";
 import { CustomPackagesAPI } from "./custom-packages";
+import { CodedError } from "./errors";
+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 { ThemesAPI } from "./themes";
 import { WarehousesAPI } from "./warehouses";
+/**
+ * # ShipEngine API Client Headers
+ */
 export type ShipEngineAPIHeaders = AxiosRequestHeaders;
+/**
+ * # ShipEngine API axios error response
+ */
+export type ApiError = AxiosError<{
+    errors: CodedError[];
+} | CodedError[] | CodedError | string>;
+/**
+ * # 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;
+    /**
+     * `onApiError` is an optional callback function that will be executed whenever there is an error.
+     */
+    onApiError?: (errors: CodedError[], error: ApiError) => void;
 }
+/**
+ * # 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);
+    constructor(token: string, { baseURL, headers, getToken, onApiError }: 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 carriers(): CarriersAPI;
+    /**
+     * The `connections` method provides access to the Connections endpoints in ShipEngine
+     * API. e.g. List Carrier Connections, Get Carrier Connection Form
+     *
+     * @see {@link ConnectionsAPI | The Connections API module}
+     */
+    get connections(): ConnectionsAPI;
+    /**
+     * 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 `themes` method provides access to the Themes endpoints in ShipEngine API.
+     *
+     * @see {@link ThemesAPI | The Themes API module}
+     */
+    get themes(): ThemesAPI;
+    /**
+     * 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/connections/api.d.ts

@@ -0,0 +1,18 @@
+import { AxiosInstance } from "axios";
+import { GetCarrierConnectionFormParams, GetCarrierConnectionFormResponse, ListCarrierConnectionsParams, ListCarrierConnectionsResponse } from "./types";
+/**
+ * # Carriers API module - /v1/carriers
+ */
+export declare class ConnectionsAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `listCarriers` method retrieves a list of carriers available to be connected.
+     */
+    listCarriers: (params?: ListCarrierConnectionsParams) => Promise<import("axios").AxiosResponse<ListCarrierConnectionsResponse, any>>;
+    /**
+     * The `getCarrierConnectionForm` method retrieves a JSON Form Schema for collecting
+     * information required to connect to the carrier.
+     */
+    getCarrierConnectionForm: (carrierName: string, params: GetCarrierConnectionFormParams) => Promise<import("axios").AxiosResponse<GetCarrierConnectionFormResponse, any>>;
+}

package/connections/index.d.ts

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

package/connections/types.d.ts

@@ -0,0 +1,36 @@
+import { GenericObject, LocaleBasedQuery } from "../resources";
+/**
+ * @category Requests
+ */
+export type ListCarrierConnectionsParams = LocaleBasedQuery;
+export type GetCarrierConnectionFormParams = LocaleBasedQuery;
+/**
+ * @category Responses
+ */
+export type GetCarrierConnectionFormResponse = {
+    formMetadata: {
+        connectionNames?: string[];
+        defaultConnectionName?: string;
+        formSchema: {
+            jsonSchema: GenericObject;
+            uiSchema: GenericObject;
+        };
+    };
+};
+export type ListCarrierConnectionsResponse = [
+    {
+        beta: boolean;
+        carrierFeatures?: [
+            {
+                country: string;
+                featureList: string[];
+            }
+        ];
+        carrierName: string;
+        description: string;
+        iconUrl: string;
+        logoUrl: string;
+        name: string;
+        searchTerms?: string[];
+    }
+];

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/dimensions/types.d.ts

@@ -6,8 +6,13 @@ 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" | "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";
+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_name" | "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_size" | "invalid_file_type" | "invalid_identifier" | "invalid_packages" | "invalid_rates" | "invalid_service" | "invalid_shipping_rule" | "invalid_status" | "invalid_string_length" | "invalid_weight_bands_rates" | "invalid_weight_bands" | "invalid_zones" | "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";
 /**
  * @category Entities
  */
-export type CodedErrorSource = "carrier" | "order_source" | "shipengine" | "elements" | "client";
+export type CodedErrorSource = "carrier" | "client" | "elements" | "order_source" | "rate_card_manager" | "shipengine" | "shipping_rule_api";
 /**
  * @category Entities
  */

package/errors/utils.d.ts

@@ -1,3 +1,7 @@
 import { CodedError } from "./types";
 export declare const isCodedErrors: (errs: any) => errs is CodedError[];
 export declare const isCodedError: (err: any) => err is CodedError;
+export declare const isDataCodedErrors: (data: any) => data is {
+    errors: CodedError[];
+};
+export declare const parseError: (err: any) => CodedError[];