@shipengine/js-api 0.0.3

package/insurance/api.d.ts

@@ -0,0 +1,7 @@
+import { AxiosInstance } from "axios";
+import { InsuranceAccount, InsuranceProvider } from "./types";
+export declare class InsuranceAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    get: (insuranceProvider: InsuranceProvider) => Promise<import("axios").AxiosResponse<InsuranceAccount, any>>;
+}

package/insurance/index.d.ts

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

package/insurance/types.d.ts

@@ -0,0 +1,9 @@
+import { Currency } from "../payments";
+/**
+ * @category Entities
+ */
+export interface InsuranceAccount {
+    amount: number;
+    currency: Currency;
+}
+export type InsuranceProvider = "shipsurance";

package/labels/api.d.ts

@@ -0,0 +1,22 @@
+import { AxiosInstance } from "axios";
+import { Label, LabelLayout, VoidRequest } from "./types";
+export interface CreateLabelOptions {
+    displayScheme?: string;
+    labelDownloadType?: string;
+    labelFormat?: string;
+    labelLayout?: LabelLayout;
+    validateAddress?: string;
+}
+export interface ListLabelsParams {
+    shipmentId?: string;
+}
+export declare class LabelsAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    get: (labelId: string) => Promise<import("axios").AxiosResponse<Label, any>>;
+    list: (params?: ListLabelsParams) => Promise<import("axios").AxiosResponse<{
+        labels: Label[];
+    }, any>>;
+    createByRateId: (rateId: string, options: CreateLabelOptions) => Promise<import("axios").AxiosResponse<Label, any>>;
+    void: (labelId: string) => Promise<import("axios").AxiosResponse<VoidRequest, any>>;
+}

package/labels/index.d.ts

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

package/labels/types.d.ts

@@ -0,0 +1,65 @@
+import { Money } from "../payments";
+import { RelayPoint } from "../relay-points";
+import { Download, LinkedResource } from "../resources";
+import { ShipmentPackage } from "../shipments";
+/**
+ * @category Entities
+ */
+export type LabelChargeEvent = "carrier_default" | "on_creation" | "on_carrier_acceptance";
+/**
+ * @category Entities
+ */
+export type LabelDisplayScheme = "label" | "qr_code";
+/**
+ * @category Entities
+ */
+export type LabelFormat = "pdf" | "png" | "zpl";
+/**
+ * @category Entities
+ */
+export type LabelLayout = "4x6" | "letter";
+/**
+ * @category Entities
+ */
+export type Label = {
+    batchId: string;
+    carrierCode: string;
+    carrierId: string;
+    chargeEvent: LabelChargeEvent;
+    createdAt: string;
+    displayScheme: LabelDisplayScheme;
+    formDownload: LinkedResource;
+    insuranceClaim: LinkedResource;
+    insuranceCost: Money;
+    isInternational: boolean;
+    isReturnLabel: boolean;
+    labelDownload: Download;
+    labelFormat: LabelFormat;
+    labelId: string;
+    labelImageId: string;
+    labelLayout: LabelLayout;
+    packageCode: string;
+    packages: ShipmentPackage[];
+    relayPoints: {
+        shipFrom: RelayPoint;
+        shipTo: RelayPoint;
+    };
+    rmaNumber: string;
+    serviceCode: string;
+    shipDate: string;
+    shipmentCost: Money;
+    shipmentId: string;
+    status: "processing" | "completed" | "error" | "voided";
+    trackable: boolean;
+    trackingNumber: string;
+    trackingStatus: string;
+    voided: boolean;
+    voidedAt: string;
+};
+/**
+ * @category Entities
+ */
+export type VoidRequest = {
+    approved: boolean;
+    message: string;
+};

package/order-sources/api.d.ts

@@ -0,0 +1,11 @@
+import { AxiosInstance } from "axios";
+import { OrderSource } from "./types";
+export declare class OrderSourcesAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    list: () => Promise<import("axios").AxiosResponse<{
+        orderSources: OrderSource[];
+    }, any>>;
+    get: (orderSourceId: string) => Promise<import("axios").AxiosResponse<OrderSource, any>>;
+    refresh: (orderSourceId: string) => Promise<import("axios").AxiosResponse<OrderSource, any>>;
+}

package/order-sources/index.d.ts

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

package/order-sources/types.d.ts

@@ -0,0 +1,23 @@
+/**
+ * @category Entities
+ */
+export type OrderSourceCode = "3dcart" | "abantecart" | "acumatica" | "acumatica_v2" | "alibaba" | "amazon" | "amazon_au" | "amazon_ca" | "amazon_de" | "amazon_es" | "amazon_fr" | "amazon_it" | "amazon_jp" | "amazon_mx" | "amazon_uk" | "americommerce" | "auctane-orders" | "back-market" | "bandcamp" | "big_cartel" | "bigcommerce" | "bigcommerce_v3" | "bigcommerce_v2" | "bizelo" | "bluepark" | "bonanza" | "brightpearl" | "cdiscount" | "celery" | "channeladvisor" | "channelsale" | "choxi" | "cin7" | "commerceinterface" | "corecommerce" | "coupang" | "cratejoy" | "cs-cart" | "custom_store" | "dear_systems" | "dummy-marketplace" | "ebay" | "ebay_au" | "ebay_ca" | "ebay_uk" | "ebay_fr" | "ebay_v2" | "ecwid" | "ecwid_v1" | "edesk" | "ekm" | "etsy" | "facebook" | "fnac" | "foxycart" | "freestyle" | "fullscreen_direct" | "geekseller" | "goodsie" | "google" | "google_checkout" | "gorgias" | "groopdealz" | "groupon_goods" | "handshake" | "hatch" | "highwire" | "homeroots" | "houzz" | "idealo_de" | "inksoft" | "jane" | "jet" | "kaufland" | "labelapi" | "lemonstand" | "lengow" | "liftoff" | "linnworks" | "listingmirror" | "magento" | "zoey" | "magento_go" | "memberly" | "mercado_libre" | "mijoshop" | "best_buy_ca" | "catch" | "darty" | "fanatics" | "kohls" | "kroger" | "urbn" | "miva_merchant" | "morecommerce" | "mozu" | "neto" | "newegg" | "newegg_business" | "newegg_ca" | "notonthehighstreet" | "oauth_dummy" | "odbc" | "onbuy" | "opencart" | "order_time" | "ordersource_api" | "oscommerce" | "overstock" | "oxatis" | "paypal" | "paypal_v2" | "payvment" | "penny" | "prestashop" | "rakuten" | "best_buy" | "rakuten-fr" | "rate_browser" | "redditgifts" | "reverb" | "revolutionparts" | "salesforce_commerce_cloud" | "salesforce_core" | "sap_anywhere" | "scout_topshelf" | "sears" | "securestore" | "sellbrite" | "selleractive" | "shipengine_api" | "shipengine_merchant" | "shipstation" | "shop_premium_outlets" | "shopify" | "shoppingfeed" | "shopware_de" | "simplepart" | "skuvault" | "soldsie" | "sophio" | "spark_shipping" | "spree" | "spreesy" | "square" | "squarespace" | "stitch_labs" | "storenvy" | "stripe" | "suredone" | "tanga" | "tophatter" | "trade_me" | "tradegecko" | "ultracart" | "unbranded_ecommerce_store" | "unleashed" | "vault" | "visualsoft" | "volo" | "volusion" | "vtex" | "walmart" | "walmart_ca" | "wayfair" | "webflow" | "weebly" | "wish" | "wix" | "woocommerce" | "woocommerce_v2" | "woot" | "x-cart" | "yahoo" | "sec_yumbles" | "zen_cart" | "zonos";
+/**
+ * @category Entities
+ */
+export type OrderSourceStatus = "idle" | "preparing_update" | "updating" | "error" | "unknown";
+/**
+ * @category Entities
+ */
+export interface OrderSource {
+    active: boolean;
+    orderSourceCode: OrderSourceCode;
+    orderSourceFriendlyName: string;
+    orderSourceId: string;
+    orderSourceNickname: string;
+    refreshInfo: {
+        lastRefreshAttempt?: string;
+        refreshDate?: string;
+        status: OrderSourceStatus;
+    };
+}

package/package.json

@@ -0,0 +1,18 @@
+{
+  "name": "@shipengine/js-api",
+  "version": "0.0.3",
+  "main": "./index.js",
+  "types": "./index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./index.mjs",
+      "require": "./index.js"
+    }
+  },
+  "typedoc": {
+    "displayName": "@shipengine/js-api",
+    "entryPoint": "./src/index.ts",
+    "readmeFile": "./README.md",
+    "tsconfig": "./tsconfig.lib.json"
+  }
+}

package/payments/index.d.ts

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

package/payments/types.d.ts

@@ -0,0 +1,37 @@
+/**
+ * @category Entities
+ */
+export declare enum CreditCardVendor {
+    AMERICAN_EXPRESS = "americanexpress",
+    DISCOVER = "discover",
+    MASTERCARD = "mastercard",
+    VISA = "visa"
+}
+/**
+ * @category Entities
+ */
+export interface CreditCard {
+    expirationMonth: string;
+    expirationYear: string;
+    name: string;
+    number: string;
+    type: CreditCardVendor;
+}
+/**
+ * @category Entities
+ */
+export declare enum Currency {
+    USD = "usd",
+    CAD = "cad",
+    AUD = "aud",
+    GBP = "gbp",
+    EUR = "eur",
+    NZD = "nzd"
+}
+/**
+ * @category Entities
+ */
+export interface Money {
+    amount: number;
+    currency: Currency;
+}

package/rates/api.d.ts

@@ -0,0 +1,20 @@
+import { AxiosInstance } from "axios";
+import { Currency } from "../payments";
+import { RateResponse } from "./types";
+export interface CalculateRatesOptions {
+    calculateTaxAmount?: boolean;
+    carrierIds: string[];
+    packageTypes?: string[];
+    preferredCurrency?: Currency;
+    serviceCodes?: string[];
+}
+export declare class RatesAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    calculateByShipmentId: (shipmentId: string, options: CalculateRatesOptions) => Promise<import("axios").AxiosResponse<Omit<import("../shipments").Shipment, "items"> & {
+        items: import("../sales-order-shipments").SalesOrderShipmentItem[];
+        salesOrderIds: string[];
+    } & {
+        rateResponse: RateResponse;
+    }, any>>;
+}

package/rates/index.d.ts

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

package/rates/types.d.ts

@@ -0,0 +1,52 @@
+import { CodedError } from "../errors";
+import { Money } from "../payments";
+/**
+ * @category Entities
+ */
+export type RateType = "check" | "shipment";
+/**
+ * @category Entities
+ */
+export type RateValidationStatus = "valid" | "invalid" | "has_warnings" | "unknown";
+/**
+ * @category Entities
+ */
+export interface Rate {
+    carrierCode: string;
+    carrierDeliveryDays: string;
+    carrierFriendlyName: string;
+    carrierId: string;
+    carrierNickname: string;
+    confirmationAmount: Money;
+    deliveryDays: number;
+    errorMessages: string[];
+    estimatedDeliveryDate: string;
+    guaranteedService: boolean;
+    insuranceAmount: Money;
+    negotiatedRate: boolean;
+    otherAmount: Money;
+    packageType: string;
+    rateId: string;
+    rateType: RateType;
+    serviceCode: string;
+    serviceType: string;
+    shipDate: string;
+    shippingAmount: Money;
+    taxAmount?: Money;
+    trackable: boolean;
+    validationStatus: RateValidationStatus;
+    warningMessages: string[];
+    zone?: number;
+}
+/**
+ * @category Entities
+ */
+export interface RateResponse {
+    createdAt: string;
+    errors: CodedError[];
+    invalidRates: Rate[];
+    rateRequestId: string;
+    rates: Rate[];
+    shipmentId: string;
+    status: "working" | "completed" | "partial" | "error";
+}

package/relay-points/index.d.ts

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

package/relay-points/types.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @category Entities
+ */
+export interface RelayPoint {
+    addressLine1: string;
+    cityLocality: string;
+    companyName: string;
+    countryCode: string;
+    postalCode: string;
+    relayPointId: string;
+    stateProvince: string;
+}

package/resources/index.d.ts

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

package/resources/types.d.ts

@@ -0,0 +1,16 @@
+/**
+ * @category Entities
+ */
+export interface Download {
+    href: string;
+    pdf: string;
+    png: string;
+    zpl: string;
+}
+/**
+ * @category Entities
+ */
+export interface LinkedResource {
+    href: string;
+    type: string;
+}

package/sales-order-shipments/api.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from "axios";
+import { SalesOrderShipment } from "./types";
+export interface ListSalesOrderShipmentsParams {
+    salesOrderIds?: string[];
+}
+export declare class SalesOrderShipmentsAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    list: (params?: ListSalesOrderShipmentsParams) => Promise<import("axios").AxiosResponse<{
+        shipments: SalesOrderShipment[];
+    }, any>>;
+    get: (shipmentId: string) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
+    create: (salesOrderId: string, shipment: Partial<SalesOrderShipment>) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
+    update: (shipmentId: string, shipment: Partial<SalesOrderShipment>) => Promise<import("axios").AxiosResponse<SalesOrderShipment, any>>;
+}

package/sales-order-shipments/index.d.ts

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

package/sales-order-shipments/types.d.ts

@@ -0,0 +1,16 @@
+import { Shipment, ShipmentItem } from "../shipments";
+/**
+ * @category Entities
+ */
+export type SalesOrderShipmentItem = ShipmentItem & {
+    name?: string;
+    salesOrderId?: string;
+    salesOrderItemId?: string;
+};
+/**
+ * @category Entities
+ */
+export type SalesOrderShipment = Omit<Shipment, "items"> & {
+    items: SalesOrderShipmentItem[];
+    salesOrderIds: string[];
+};

package/sales-orders/api.d.ts

@@ -0,0 +1,15 @@
+import { AxiosInstance } from "axios";
+import { SalesOrder, SalesOrderTracking } from "./types";
+export interface ListSalesOrdersParams {
+    externalOrderId?: string;
+    externalOrderNumber?: string;
+}
+export declare class SalesOrdersAPI {
+    private client;
+    constructor(client: AxiosInstance);
+    list: (params?: ListSalesOrdersParams) => Promise<import("axios").AxiosResponse<{
+        salesOrders: SalesOrder[];
+    }, any>>;
+    get: (salesOrderId: string) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
+    notifyShipped: (salesOrderId: string, tracking: SalesOrderTracking) => Promise<import("axios").AxiosResponse<SalesOrder, any>>;
+}

package/sales-orders/index.d.ts

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

package/sales-orders/types.d.ts

@@ -0,0 +1,78 @@
+import { Address } from "../addresses";
+import { OrderSource } from "../order-sources";
+import { Money } from "../payments";
+import { WeightWithUnit } from "../weight";
+/**
+ * @category Entities
+ */
+export type PaymentStatus = "unknown" | "paid" | "unpaid" | "partially_paid";
+/**
+ * @category Entities
+ */
+export type FulfillmentStatus = "unknown" | "fulfilled" | "unfulfilled" | "partially_fulfilled" | "on_hold";
+/**
+ * @category Entities
+ */
+export interface SalesOrderItem {
+    isGift: boolean;
+    lineItemDetails: {
+        asin: string;
+        name: string;
+        sku: string;
+        weight: WeightWithUnit;
+    };
+    priceSummary: {
+        estimatedShipping?: Money;
+        estimatedTax: Money;
+        total?: Money;
+        unitPrice: Money;
+    };
+    quantity: number;
+    requestedShippingOptions: {
+        shipDate: string | null;
+        shippingService: string;
+    };
+    salesOrderItemId: string;
+    shipTo: Address;
+}
+/**
+ * @category Entities
+ */
+export interface SalesOrderTracking {
+    carrierCode: string;
+    trackingNumber: string;
+}
+/**
+ * @category Entities
+ */
+export interface SalesOrder {
+    billTo: {
+        address: Address;
+        email: string;
+    };
+    createdAt: string;
+    customer: {
+        email: string;
+        name: string;
+        phone: string;
+    };
+    externalOrderId?: string;
+    externalOrderNumber?: string;
+    modifiedAt: string;
+    orderDate: string;
+    orderSource: OrderSource;
+    paymentDetails: {
+        estimatedShipping: Money;
+        estimatedTax: Money;
+        grandTotal: Money;
+        subtotal: Money;
+    };
+    salesOrderId: string;
+    salesOrderItems: SalesOrderItem[];
+    salesOrderStatus: {
+        fulfillmentStatus: FulfillmentStatus;
+        isCancelled: boolean;
+        paymentStatus: PaymentStatus;
+    };
+    shipTo: Address;
+}

package/shipments/index.d.ts

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

package/shipments/types.d.ts

@@ -0,0 +1,195 @@
+import { Address, AddressValidation } from "../addresses";
+import { CarrierPackage } from "../carriers";
+import { OrderSourceCode } from "../order-sources";
+import { Money } from "../payments";
+import { Download, LinkedResource } from "../resources";
+import { WeightWithUnit } from "../weight";
+/**
+ * @category Entities
+ */
+export type AddressValidationOptions = "no_validation" | "validate_only" | "validate_and_clean";
+/**
+ * @category Entities
+ */
+export type CustomsContents = "documents" | "gift" | "merchandise" | "returned_goods" | "sample";
+/**
+ * @category Entities
+ */
+export type CustomsNonDeliveryOptions = "return_to_sender" | "treat_as_abandoned";
+/**
+ * @category Entities
+ */
+export type BillToParties = "recipient" | "third_party";
+/**
+ * @category Entities
+ */
+export declare enum ConfirmationType {
+    DELIVERY = "delivery",
+    SIGNATURE = "signature",
+    ADULT_SIGNATURE = "adult_signature",
+    DIRECT_SIGNATURE = "direct_signature",
+    VERBAL_CONFIRMATION = "verbal_confirmation",
+    DELIVERY_MAILED = "delivery_mailed",
+    NONE = "none"
+}
+/**
+ * @category Entities
+ */
+export declare enum CustomsContentsType {
+    DOCUMENTS = "documents",
+    GIFT = "gift",
+    MERCHANDISE = "merchandise",
+    RETURNED_GOODS = "returned_goods",
+    SAMPLE = "sample"
+}
+/**
+ * @category Entities
+ */
+export declare enum CustomsNonDeliveryType {
+    RETURN_TO_SENDER = "return_to_sender",
+    TREAT_AS_ABANDONED = "treat_as_abandoned"
+}
+/**
+ * @category Entities
+ */
+export declare enum InsuranceProviderType {
+    SHIPSURANCE = "shipsurance",
+    CARRIER = "carrier",
+    THIRD_PARTY = "third_party",
+    NONE = "none"
+}
+/**
+ * @category Entities
+ */
+export type ShipmentStatus = "cancelled" | "label_purchased" | "pending" | "processing";
+/**
+ * @category Entities
+ */
+export type TaxableEntityType = "shipper" | "recipient";
+/**
+ * @category Entities
+ */
+export type TaxableIdentifierType = "vat" | "eori" | "ssn" | "ein" | "tin" | "ioss" | "pan" | "voec";
+/**
+ * @category Entities
+ */
+export interface CustomsItem {
+    countryOfOrigin?: string;
+    customsItemId?: string;
+    description?: string;
+    harmonizedTariffCode?: string;
+    quantity: number;
+    sku?: string;
+    skuDescription?: string;
+    unitOfMeasure?: string;
+    value: Money | number;
+}
+/**
+ * @category Entities
+ */
+export interface ShipmentItem {
+    asin?: string;
+    externalOrderId?: string;
+    externalOrderItemId?: string;
+    name?: string;
+    orderSourceCode: OrderSourceCode;
+    quantity: number;
+    sku?: string;
+}
+/**
+ * @category Entities
+ */
+export type ShipmentPackage = Omit<CarrierPackage, "name"> & {
+    externalPackageId?: string;
+    formDownload?: LinkedResource;
+    insuredValue?: Money;
+    labelDownload?: Download;
+    labelMessages?: {
+        reference1: string;
+        reference2: string;
+        reference3: string;
+    };
+    sequence?: number;
+    trackingNumber?: string;
+    weight: WeightWithUnit;
+};
+/**
+ * @category Entities
+ */
+export interface TaxIdentifier {
+    identifierType: TaxableIdentifierType;
+    issuingAuthority: string;
+    taxableEntityType: TaxableEntityType;
+    value: string;
+}
+/**
+ * @category Entities
+ */
+export type OriginTypes = "pickup" | "drop_off";
+/**
+ * @category Entities
+ */
+export type PaymentTypes = "any" | "cash" | "cash_equivalent" | "none";
+/**
+ * @category Entities
+ */
+export type Customs = {
+    contents: CustomsContents;
+    customsItems: CustomsItem[];
+    nonDelivery: CustomsNonDeliveryOptions;
+};
+/**
+ * @category Entities
+ */
+export interface Shipment {
+    addressValidation?: AddressValidation;
+    advancedOptions?: {
+        billToAccount?: string;
+        billToCountryCode?: string;
+        billToParty?: BillToParties;
+        billToPostalCode?: string;
+        collectOnDelivery?: {
+            paymentAmount: Money;
+            paymentType: PaymentTypes;
+        };
+        containsAlcohol?: boolean;
+        customField1?: string;
+        customField2?: string;
+        customField3?: string;
+        deliveredDutyPaid?: boolean;
+        dryIce?: boolean;
+        dryIceWeight?: WeightWithUnit;
+        freightClass?: string;
+        nonMachinable?: boolean;
+        originType?: OriginTypes;
+        saturdayDelivery?: boolean;
+        shipperRelease?: boolean;
+        useUpsGroundFreightPricing?: boolean;
+    };
+    carrierId: string;
+    confirmation: ConfirmationType;
+    createdAt: string;
+    customs?: Customs;
+    externalOrderId?: string;
+    externalShipmentId?: string;
+    insuranceProvider: InsuranceProviderType;
+    items: ShipmentItem[];
+    modifiedAt: string;
+    orderSourceCode: OrderSourceCode;
+    originType?: OriginTypes;
+    packages: ShipmentPackage[];
+    returnTo: Address | null;
+    serviceCode: string | null;
+    shipDate?: string;
+    shipFrom: Address | null;
+    shipmentId: string;
+    shipmentStatus: ShipmentStatus;
+    shipTo: Address;
+    tags: {
+        name: string;
+    }[];
+    taxIdentifiers?: TaxIdentifier[];
+    totalWeight: WeightWithUnit;
+    validateAddress?: AddressValidationOptions;
+    warehouseId?: string;
+}