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

package/shipments/types.d.ts

@@ -1,7 +1,9 @@
 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";
 /**
@@ -49,6 +51,63 @@ export declare enum CustomsNonDeliveryType {
     RETURN_TO_SENDER = "return_to_sender",
     TREAT_AS_ABANDONED = "treat_as_abandoned"
 }
+/**
+ * @category Entities
+ */
+export type CustomsTermsOfTradeCode = "exw" | "fca" | "cpt" | "cip" | "dpu" | "dap" | "ddp" | "fas" | "fob" | "cfr" | "cif" | "ddu" | "daf" | "deq" | "des";
+/**
+ * @category Entities
+ */
+export interface CustomsInvoiceAdditionalDetails {
+    discount?: Money;
+    freightCharge?: Money;
+    insuranceCharge?: Money;
+    otherChargeDescription?: string;
+    otherCharges?: Money;
+}
+/**
+ * @category Entities
+ */
+export interface DangerousGoods {
+    AddionalDescription?: string;
+    dangerousAmount?: {
+        amount: number;
+        unit?: string;
+    };
+    idNumber?: string;
+    packagingGroup?: DangerousGoodsPackagingGroup;
+    packagingInstruction?: string;
+    packagingInstructionSection?: DangerousGoodsPackagingInstructionSection;
+    packagingType?: string;
+    productClass?: string;
+    productClassSubsidiary?: string;
+    quantity?: number;
+    radioactive?: boolean;
+    regulationAuthority?: string;
+    regulationLevel?: DangerousGoodsRegulationLevel;
+    reportableQuantity?: boolean;
+    shippingName?: string;
+    technicalName?: string;
+    transportCategory?: string;
+    transportMean?: DangerousGoodsTransportMean;
+    tunnelCode?: string;
+}
+/**
+ * @category Entities
+ */
+export type DangerousGoodsPackagingGroup = "i" | "ii" | "iii";
+/**
+ * @category Entities
+ */
+export type DangerousGoodsPackagingInstructionSection = "section_1" | "section_2" | "section_1a" | "section_1b";
+/**
+ * @category Entities
+ */
+export type DangerousGoodsRegulationLevel = "lightly_regulated" | "fully_regulated" | "limited_quantities" | "excepted_quantity";
+/**
+ * @category Entities
+ */
+export type DangerousGoodsTransportMean = "ground" | "water" | "cargo_aircraft_only" | "passenger_aircraft";
 /**
  * @category Entities
  */
@@ -73,16 +132,21 @@ export type TaxableIdentifierType = "vat" | "eori" | "ssn" | "ein" | "tin" | "io
 /**
  * @category Entities
  */
-export interface CustomsItem {
+export interface Product {
     countryOfOrigin?: string;
-    customsItemId?: string;
+    dangerousGoods?: DangerousGoods;
     description?: string;
     harmonizedTariffCode?: string;
+    midCode?: string;
+    productId?: string;
+    productUrl?: string;
     quantity: number;
     sku?: string;
     skuDescription?: string;
     unitOfMeasure?: string;
-    value: Money | number;
+    value: Money;
+    vatRate?: number;
+    weight?: WeightWithUnit;
 }
 /**
  * @category Entities
@@ -100,6 +164,7 @@ export interface ShipmentItem {
  * @category Entities
  */
 export type ShipmentPackage = Omit<CarrierPackage, "name"> & {
+    contentDescription?: string;
     externalPackageId?: string;
     formDownload?: LinkedResource;
     insuredValue?: Money;
@@ -109,6 +174,7 @@ export type ShipmentPackage = Omit<CarrierPackage, "name"> & {
         reference2: string;
         reference3: string;
     };
+    products?: Product[];
     sequence?: number;
     trackingNumber?: string;
     weight: WeightWithUnit;
@@ -135,8 +201,12 @@ export type PaymentTypes = "any" | "cash" | "cash_equivalent" | "none";
  */
 export type Customs = {
     contents: CustomsContents;
-    customsItems: CustomsItem[];
+    contentsExplanation?: string;
+    declaration?: string;
+    importerOfRecord?: Address;
+    invoiceAdditionalDetails?: CustomsInvoiceAdditionalDetails;
     nonDelivery: CustomsNonDeliveryOptions;
+    termsOfTradeCode?: CustomsTermsOfTradeCode;
 };
 /**
  * @category Entities
@@ -144,6 +214,7 @@ export type Customs = {
 export interface Shipment {
     addressValidation?: AddressValidation;
     advancedOptions?: {
+        additionalHandling?: boolean;
         billToAccount?: string;
         billToCountryCode?: string;
         billToParty?: BillToParties;
@@ -167,6 +238,7 @@ export interface Shipment {
         useUpsGroundFreightPricing?: boolean;
     };
     carrierId: string;
+    comparisonRateType?: string;
     confirmation: ConfirmationType;
     createdAt: string;
     customs?: Customs;
@@ -193,3 +265,12 @@ export interface Shipment {
     validateAddress?: AddressValidationOptions;
     warehouseId?: string;
 }
+export type ShipmentRateResponse = {
+    createdAt: string;
+    errors: CodedError[];
+    invalidRates: Rate[];
+    rateRequestId: string;
+    rates: Rate[];
+    shipmentId: string;
+    status: "working" | "completed" | "partial" | "error";
+}[];

package/shipping-rules/api.d.ts

@@ -0,0 +1,36 @@
+import { AxiosInstance } from "axios";
+import { RuleConditionsOptions, ShippingRule, ShippingRuleInput } from "./types";
+/**
+ * # Shipping Rules API module - /v1/shipping_rules
+ */
+export declare class ShippingRulesAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `list` method retrieves the list of shipping rules by seller.
+     */
+    list: () => Promise<import("axios").AxiosResponse<{
+        shippingRules: ShippingRule[];
+    }, any>>;
+    /**
+     * The `get` method retrieves a specific shipping rule by `shippingRuleId`.
+     */
+    get: (shippingRuleId: string) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
+    /**
+     * The `create` method creates a new shipping rule for a given user.
+     */
+    create: (shippingRule: ShippingRuleInput) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
+    /**
+     * The `delete` method deletes a shipping rule by `shippingRuleId`.
+     */
+    delete: (shippingRuleId: string) => Promise<import("axios").AxiosResponse<any, any>>;
+    /**
+     * The `edit` method edits a specific shipping rule by `shippingRuleId` with a new
+     * `ShippingRule`.
+     */
+    edit: (shippingRule: ShippingRule) => Promise<import("axios").AxiosResponse<ShippingRule, any>>;
+    /**
+     * The `getConditionOptions` method retrieves the list of condition options availables for creating shipping rules.
+     */
+    getConditionOptions: () => Promise<import("axios").AxiosResponse<RuleConditionsOptions[], any>>;
+}

package/shipping-rules/index.d.ts

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

package/shipping-rules/types.d.ts

@@ -0,0 +1,77 @@
+import { DimensionUnit } from "../dimensions";
+import { ISOString } from "../resources";
+import { WeightUnit } from "../weight";
+/**
+ * @category Entities
+ */
+export type RuleIdentifier = "MAX_DIMENSION" | "NUMBER_OF_PACKAGES" | "SHIP_FROM_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_FROM_COUNTRY_CODE" | "SHIP_TO_ADDRESS_RESIDENTIAL_INDICATOR" | "SHIP_TO_COUNTRY_CODE" | "SHIP_TO_POSTAL_CODE" | "SHIP_FROM_POSTAL_CODE" | "SHIPMENT_VALUE" | "WAREHOUSE_ID" | "WEIGHT";
+/**
+ * @category Entities
+ */
+export type RuleOperation = "IS" | "IS_LESS_THAN" | "IS_GREATER_THAN" | "IS_NOT" | "IN" | "NOT_IN" | "STARTS_WITH" | "IS_LESS_OR_EQUAL_TO" | "IS_GREATER_OR_EQUAL_TO";
+/**
+ * @category Entities
+ */
+export type RuleValueType = "STRING" | "LIST" | "INTEGER" | "DECIMAL";
+/**
+ * @category Entities
+ */
+export type RuleValueField = "SELECT" | "MULTISELECT" | "FIELD";
+/**
+ * @category Entities
+ */
+export type RuleValueUnit = DimensionUnit | WeightUnit;
+/**
+ * @category Entities
+ */
+export interface ShippingRulesConditions {
+    identifier: RuleIdentifier;
+    operation: RuleOperation;
+    value: string | string[] | number;
+    valueUnit?: RuleValueUnit;
+}
+/**
+ * @category Entities
+ */
+export interface Rule {
+    conditions: ShippingRulesConditions[];
+    priority: number;
+    service: ShippingRuleSelectedService;
+}
+/**
+ * @category Entities
+ */
+export interface ShippingRuleSelectedService {
+    carrierId: string;
+    serviceCode: string;
+}
+/**
+ * @category Entities
+ */
+export interface ShippingRule {
+    active?: boolean;
+    code?: string;
+    createdAt?: ISOString;
+    default?: ShippingRuleSelectedService;
+    deleted?: boolean;
+    deletedAt?: ISOString;
+    name: string;
+    rules?: Rule[];
+    shippingRuleId: string;
+    updatedAt?: ISOString;
+}
+/**
+ * @category Entities
+ */
+export type ShippingRuleInput = Omit<ShippingRule, "shippingRuleId">;
+/**
+ * @category Entities
+ */
+export interface RuleConditionsOptions {
+    identifier: RuleIdentifier;
+    operations: RuleOperation[];
+    unitOptions?: RuleValueUnit[];
+    valueField: RuleValueField;
+    valueOptions?: string[];
+    valueType: RuleValueType;
+}

package/themes/api.d.ts

@@ -0,0 +1,13 @@
+import { AxiosInstance } from "axios";
+import { PartnerTheme } from "./types";
+/**
+ * # Themes API module - /v1/themes
+ */
+export declare class ThemesAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    /**
+     * The `get` method retrieves a specific theme by `themeId`.
+     */
+    get: (themeId: string) => Promise<import("axios").AxiosResponse<PartnerTheme, any>>;
+}

package/themes/index.d.ts

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

package/themes/types.d.ts

@@ -0,0 +1,21 @@
+export type PartnerThemeLogo = {
+    contentType: "image/jpeg" | "image/png";
+    imageData: string;
+};
+export type PartnerThemeOnboarding = {
+    completeButtonText?: string;
+    completeText?: string;
+    completeTitle?: string;
+    startText?: string;
+    startTitle?: string;
+};
+export type PartnerTheme = {
+    brand: string;
+    createdAt: string;
+    logo?: PartnerThemeLogo;
+    modifiedAt: string;
+    name: string;
+    onboarding?: PartnerThemeOnboarding;
+    returnUrl?: string;
+    themeId: string;
+};

package/types.d.ts

@@ -1,17 +1,27 @@
+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 "./connections/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 "./themes/types";
 export * from "./warehouses/types";
 export * from "./weight/types";
+export * from "./weight-band/types";
+export * from "./zones/types";

package/utilities/index.d.ts

@@ -0,0 +1 @@
+export * from "./ip-address";

package/utilities/ip-address.d.ts

@@ -0,0 +1 @@
+export declare const getEndUserIpAddress: () => Promise<string | undefined>;

package/warehouses/api.d.ts

@@ -1,12 +1,31 @@
 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/weight-band/index.d.ts

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

package/weight-band/types.d.ts

@@ -0,0 +1,17 @@
+import { WeightUnit } from "../weight";
+/**
+ * @category Entities
+ */
+export type WeightBandIncremental = {
+    increment: number;
+    minimum: number;
+    unit: WeightUnit;
+};
+/**
+ * @category Entities
+ */
+export type WeightBandMinMax = {
+    maximum: number;
+    minimum: number;
+    unit: WeightUnit;
+};

package/zones/index.d.ts

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

package/zones/types.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @category Entities
+ */
+export type Zone = {
+    name: string;
+    zoneCode: string;
+};