shipbob-node-sdk 0.0.1 → 0.0.2

package/dist/index.d.ts

@@ -0,0 +1,729 @@
+export type Nullable<T> = T | null;
+export declare enum WebhookTopic {
+    OrderShipped = "order_shipped",
+    ShipmentDelivered = "shipment_delivered",
+    ShipmentException = "shipment_exception",
+    ShipmentOnHold = "shipment_onhold",
+    ShipmentCancelled = "shipment_cancelled"
+}
+export type Credentials = {
+    token: string;
+    channelId?: number;
+};
+export type DataResponse<T> = ({
+    /**
+     * HTTP status code received was in 200's.
+     */
+    success: true;
+    data: T;
+} | {
+    /**
+     * HTTP status code not in 200s (ie: 302 (auth redirect - check location header), 422 (validation), 524 (cloudflare))
+     */
+    success: false;
+    /**
+     * for 422 is Record<keyof T, string[]>?
+     */
+    data: object | string;
+}) & {
+    statusCode: number;
+};
+export type ChannelsResponse = {
+    id: number;
+    name: string;
+    application_name: string;
+    scopes: string[];
+}[];
+export type Address = {
+    /**
+     * First line of the address
+     */
+    address1: string;
+    /**
+     * Second line of the address
+     */
+    address2?: Nullable<string>;
+    /**
+     * Name of the company receiving the shipment
+     */
+    company_name?: Nullable<string>;
+    /**
+     * The city
+     */
+    city: Required<string>;
+    /**
+     * The state or province
+     * Not required, but not all countries have state/province
+     */
+    state: Nullable<string>;
+    /**
+     * The country (Must be ISO Alpha-2 for estimates)
+     */
+    country: string;
+    /**
+     * The zip code or postal code
+     */
+    zip_code: string;
+};
+/**
+ * Returns also everything else including onhand, etc.  Stuff that makes no sense at this point.
+ */
+export type AddProductResponse = {
+    id: number;
+    reference_id: string;
+};
+export type GetProductResult = {
+    id: number;
+    reference_id: string;
+};
+export type OrderType = 'DTC' | 'DropShip' | 'B2B' | 'Transportation';
+export type AnyProduct = ({
+    /**
+     * Unique reference id of the product
+     */
+    reference_id: string;
+    /**
+     * Name of the product. Required if there is not an existing ShipBob product with a matching reference_id value.
+     */
+    name?: Nullable<string>;
+    /**
+     * Global Trade Item Number - unique and internationally recognized identifier assigned to item by company GS1 (0-50 chars)
+     */
+    gtin?: Nullable<string>;
+    /**
+     * Universal Product Code - Unique external identifier
+     */
+    upc?: Nullable<string>;
+    /**
+     * Price for one item
+     */
+    unit_price?: Nullable<number>;
+    /**
+     * Product SKU
+     */
+    sku?: Nullable<string>;
+} & {
+    /**
+     * Unique Id of the product.  Not sure who would track **their** product ids..
+     */
+    id: number;
+}) | {
+    /**
+     * Numeric assignment per item. Used as a reference number for multiple purposes such as split orders, split containers, etc.
+     */
+    external_line_id?: number;
+    /**
+     * The quantity of this product ordered
+     * (< 2147483647 LOL)
+     */
+    quantity: number;
+    /**
+     * Defined standard for measure for an item (each, inner pack, case, pallet). Values: EA, INP, CS and PL
+     */
+    quantity_unit_of_measure_code?: Nullable<string>;
+    required_lot?: {
+        lot_number: Nullable<string>;
+        /**
+         * string or null <date-time>
+         * Manually specified lot date
+         */
+        lot_date: Nullable<string>;
+    };
+};
+export type CancelOrderResponse = {
+    order_id: number;
+    order: {
+        id: number;
+        reference_id: string;
+        order_number: string;
+        status: string;
+    };
+    /**
+     * ie: "Success"
+     */
+    status: string;
+    canceled_shipment_results: {
+        /**
+         * ie: "Cancel".  The docs are wrong.  This is actually a number like 6.
+         */
+        action: number;
+        shipment_id: number;
+        is_success: boolean;
+        /**
+         * ie: "Order cancelled"
+         */
+        reason: string;
+    }[];
+};
+export type PlaceOrderResponse = {
+    id: number;
+    /**
+     * ISO date.  ie: "2019-08-24T14:15:22Z"
+     */
+    created_date: string;
+    /**
+     * ISO date.  ie: "2019-08-24T14:15:22Z"
+     */
+    purchase_date: string;
+    reference_id: string;
+    order_number: string;
+    /**
+     * probably always "Processing" - we should be able to get order status updates via webhook
+     */
+    status: 'Processing';
+    type: OrderType;
+    channel: {
+        id: number;
+        /**
+         * ie: "ShipBobs-Shopify-Store"
+         */
+        name: string;
+    };
+    /**
+     * ie: "Free 2-day Shipping"
+     */
+    shipping_method: string;
+    recipient: {
+        name: string;
+        address: Address;
+        email: string;
+        phone_number: string;
+    };
+    products: {
+        id: number;
+        reference_id: string;
+        quantity: number;
+        quantity_unit_of_measure_code: string;
+        sku: string;
+        gtin: string;
+        upc: string;
+        unit_price: number;
+        external_line_id: number;
+    }[];
+    tags: string[];
+    shipments: {
+        id: number;
+        order_id: number;
+        reference_id: string;
+        recipient: {
+            name: string;
+            address: Address;
+            email: string;
+            phone_number: string;
+        };
+    }[];
+    gift_message: string;
+    shipping_terms: {
+        /**
+         * ie: "Parcel"
+         */
+        carrier_type: CarrierShipType;
+        payment_term: PaymentShipTerm;
+    };
+};
+export type PaymentShipTerm = 'Collect' | 'ThirdParty' | 'Prepaid' | 'MerchantResponsible';
+export type CarrierShipType = 'Parcel' | 'Freight';
+export type PlaceOrderRequest = {
+    /**
+     * User friendly orderId or store order number that will be shown on the Orders Page. If not provided, referenceId will be used (<= 400 characters)
+     */
+    order_number: Nullable<string>;
+    recipient: {
+        name: string;
+        address: Address;
+        /**
+         * Email address of the recipient
+         */
+        email?: Nullable<string>;
+        /**
+         * Phone number of the recipient (<= 50 characters)
+         */
+        phone_number?: Nullable<string>;
+    };
+    /**
+     * Products included in the order. Products identified by reference_id must also include the product name if there is no matching ShipBob product.
+     */
+    products: AnyProduct[];
+    /**
+     * Unique and immutable order identifier from your upstream system.
+     *
+     * Discussions with Simon. This is a forever unique identifier. ie: cannot be an IC order number like 18888888 - we could not reship.
+     *
+     * NOTE: reusing generates 422 error: "Cannot insert order with existing ReferenceId"
+     */
+    reference_id: string;
+    /**
+     * Contains properties that needs to be used for fulfilling B2B/Dropship orders.
+     */
+    retailer_program_data?: {
+        /**
+         * First initial documentation sent from buyer to seller with item(s) and quantities.
+         */
+        purchase_order_number: string;
+        /**
+         * Identifies retailer-merchant combination
+         */
+        retailer_program_type: string;
+        /**
+         * Store Number
+         */
+        mark_for_store?: Nullable<string>;
+        /**
+         * Identifies a merchant's store department
+         */
+        department?: Nullable<string>;
+        /**
+         * Expected delivery date
+         */
+        delivery_date?: Nullable<string>;
+        /**
+         * Customer Ticket Number
+         */
+        customer_ticket_number?: Nullable<string>;
+        /**
+         * The date the retailer has requested the order to ship by.
+         */
+        shipByDate?: Nullable<string>;
+        /**
+         * The date the retailer does not want the order shipped by.
+         */
+        doNotShipBeforeDate?: Nullable<string>;
+    };
+    /**
+     * Client-defined shipping method matching what the user has listed as the shipping method on the Ship Option Mapping setup page in the ShipBob Merchant Portal.
+     * If they don’t match, we will create a new one and default it to Standard
+     * (non-empty)
+     * ie: "Standard"
+     */
+    shipping_method: string;
+    /**
+     * Contains shipping properties that need to be used for fulfilling an order.
+     */
+    shipping_terms?: {
+        /**
+         * CarrierShipType:  Enum: "Parcel" "Freight"
+         */
+        carrier_type: CarrierShipType;
+        /**
+         * PaymentShipTerm
+         */
+        payment_term: PaymentShipTerm;
+    };
+    /**
+     * Enum: "DTC" "DropShip" "B2B" "Transportation"
+     */
+    type: OrderType;
+};
+export type Webhook = {
+    id: number;
+    /**
+     * ISO date format: "2025-02-14T22:21:33.4911731"
+     */
+    created_at: string;
+    /**
+     * The subscription topic for the webhook
+     */
+    topic: WebhookTopic;
+    /**
+     * This is what we provided to them.
+     */
+    subscription_url: string;
+};
+export type FulfillmentCenter = {
+    id: number;
+    /**
+     * ie: "Cicero (IL)"
+     */
+    name: string;
+    /**
+     * ie: "Central Standard Time"
+     */
+    timezone: string;
+    address1: string;
+    address2: string;
+    city: string;
+    /**
+     * ie: "IL"
+     */
+    state: string;
+    /**
+     * ie: "USA"
+     */
+    country: string;
+    zip_code: string;
+    phone_number: string;
+    email: string;
+};
+export type PackageType = 'Package' | 'Pallet' | 'FloorLoadedContainer';
+export type BoxPackagingType = 'EverythingInOneBox' | 'OneSkuPerBox' | 'MultipleSkuPerBox';
+/**
+ * The receiving order to create
+ */
+export type WarehouseReceivingOrderRequest = {
+    /**
+     * Model containing information that assigns a receiving order to a fulfillment center.
+     * If the fulfillment center provided is in a receiving hub region, then the response will be the receiving hub location.
+     */
+    fulfillment_center: {
+        /**
+         * ID of the fulfillment center to assign this receiving order to
+         */
+        id: number;
+    };
+    package_type: PackageType;
+    box_packaging_type: BoxPackagingType;
+    /**
+     * Box shipments to be added to this receiving order
+     */
+    boxes: {
+        /**
+         * Tracking number for the box shipment.
+         *
+         * The API docs say "string or null", but if you pass null will get a 400: Boxes[...] 'The TrackingNumber field is required.'
+         */
+        tracking_number: string;
+        /**
+         * Items contained in this box
+         */
+        box_items: {
+            /**
+             * Quantity of the items in the box
+             *
+             * NOTE: integer <int32> [ 1 .. 2147483647 ].  LOL.  2 billion
+             */
+            quantity: number;
+            /**
+             * Unique inventory id of the items in the box
+             */
+            inventory_id: number;
+            /**
+             * Lot number of the items in the box
+             */
+            lot_number?: Nullable<string>;
+            /**
+             * Lot expiration date for the items in the box
+             */
+            lot_date?: Nullable<string>;
+        }[];
+    }[];
+    /**
+     * Expected arrival date of all the box shipments in this receiving order
+     * ie: ISO date "2019-08-24T14:15:22Z"
+     */
+    expected_arrival_date: string;
+    /**
+     * Purchase order number for this receiving order,
+     *
+     * NOTE: Supporting idempotency this must be unique across WROs
+     *       Otherwise 422: "Request could not be completed, PO reference already exists and must be a unique value"
+     */
+    purchase_order_number?: Nullable<string>;
+};
+export type ReceivingStatus = 'Awaiting' | 'Processing' | 'Completed' | 'Cancelled' | 'Incomplete' | 'Arrived' | 'PartiallyArrived' | 'PartiallyArrivedAtHub' | 'ArrivedAtHub' | 'ProcessingAtHub' | 'InternalTransfer';
+export type WarehouseReceivingOrderResponse = {
+    id: number;
+    /**
+     * Not sure what these could be. "Awaiting" is a staging status.
+     */
+    status: ReceivingStatus;
+    /**
+     * What was sent in the request
+     */
+    package_type: PackageType;
+    /**
+     * What was sent in the request
+     */
+    box_packaging_type: BoxPackagingType;
+    /**
+     * What was sent in the request (ISO date)
+     */
+    expected_arrival_date: string;
+    /**
+     * ISO date: "2025-02-18T19:25:13.034265+00:00"
+     */
+    insert_date: string;
+    /**
+     * ISO date
+     */
+    last_updated_date: string;
+    /**
+     * ie: "/2.0/receiving/442945/labels"
+     */
+    box_labels_uri: string;
+    fulfillment_center: FulfillmentCenter;
+    purchase_order_number: Nullable<string>;
+    inventory_quantities: {
+        inventory_id: number;
+        sku: string;
+        expected_quantity: number;
+        received_quantity: number;
+        stowed_quantity: number;
+    }[];
+    /**
+     * The timestamp in UTC when a 3rd party integrator has set in ShipBob system
+     *
+     * We set this in their receiving-extended API endpoints.  Use case is for acknowledging completed orders.
+     * Their API has example: "2019-08-24T14:15:22Z"
+     */
+    external_sync_timestamp: Nullable<string>;
+};
+/**
+ * The simulation will work on our SandBox Environment.
+ */
+export type Simulation = {
+    /**
+     * Identifies what action to perform on shipment.
+     */
+    action: 'ShipOrder' | 'DeliverOrder';
+    /**
+     * Delay time for action in minutes to be triggered after.
+     *
+     * NOTE: anything over 2880 will be clamped
+     */
+    delay?: Nullable<number>;
+    /**
+     * Next simulation action to be performed after it.
+     */
+    next?: Nullable<SimulateShipmentRequest>;
+};
+export type SimulateShipmentRequest = {
+    /**
+     * Shipment Id for simulation.
+     */
+    shipment_id: number;
+    /**
+     * Simulation actions object.
+     */
+    simulation: Simulation;
+};
+export type SimulateShipmentResponse = {
+    /**
+     * Simulation id for register simulation request.
+     * UUID ie: 439a9dec-9bff-4339-9564-89975d3a8f5c
+     */
+    simulation_id: string;
+    /**
+     * ie: "Simulation registered successfully"
+     */
+    message: string;
+};
+export type SimulationDetails = {
+    /**
+     * Identifies the action that was performed.
+     */
+    action: 'ShipOrder' | 'DeliverOrder';
+    /**
+     * Status of the simulation action.
+     */
+    status: 'Success' | 'Failed' | 'Pending' | 'Skipped';
+    /**
+     * Additional message for the action.
+     *
+     * ie:
+     * - "This simulated action has been completed successfully."
+     * - "This simulation action is not executed yet."
+     */
+    message: string;
+    /**
+     * Scheduled time if the action had a delay.
+     * ie: ISO date '2025-02-19T00:09:53.77' or NULL
+     */
+    schedule_time: Nullable<string>;
+    /**
+     * Nested object with details of subsequent simulation actions. This value would be null if there is no subsequent action.
+     */
+    next: Nullable<SimulationDetails>;
+};
+export type SimulationResponse = {
+    /**
+     * Simulation id for register simulation request.
+     */
+    simulation_id: string;
+    /**
+     * ID of the entity for which the simulation was registered.
+     */
+    entity_id: string;
+    /**
+     * Type of entity for which the simulation was registered.
+     *
+     * ie: "Order"
+     */
+    entity_type: string;
+    /**
+     * Object with details of simulation actions
+     * type:  SimulationDetails (not described in docs)
+     */
+    simulation: SimulationDetails;
+};
+/**
+ * For each WRO that was supplied, if ExternalSync was updated
+ */
+export type SetExternalSyncResponse = {
+    results: {
+        id: number;
+        action: 'ExternalSync';
+        is_success: boolean;
+        /**
+         * Probably a reason if it didn't succeed.  Empty when it does succeed.
+         * ie: ""
+         */
+        reason: string;
+    }[];
+};
+export type BoxStatus = 'Awaiting' | 'Arrived' | 'Completed' | 'Counting' | 'Stowing' | 'Cancelled' | 'InternalTransfer';
+/**
+ * Get Warehouse Receiving Order Boxes response
+ */
+export type WarehouseReceivingOrderBoxesResponse = {
+    box_id: number;
+    /**
+     * The number of the box in the receiving order
+     */
+    box_number: number;
+    box_status: BoxStatus;
+    /**
+     * Date the box arrived
+     */
+    arrived_date: Nullable<string>;
+    /**
+     * Date the box was received
+     */
+    received_date: Nullable<string>;
+    /**
+     * Date counting of the box's inventory items started
+     */
+    counting_started_date: Nullable<string>;
+    /**
+     * Tracking number of the box shipment
+     */
+    tracking_number: Nullable<string>;
+    /**
+     * type: BoxItemViewModel
+     */
+    box_items: {
+        /**
+         * Quantity of the item included
+         */
+        quantity: number;
+        /**
+         * Quantity of the item that was received after processing the receiving order
+         */
+        received_quantity: number;
+        /**
+         * Quantity of the item that has been stowed
+         */
+        stowed_quantity: number;
+        /**
+         * Unique identifier of the inventory item
+         */
+        inventory_id: number;
+        /**
+         * Lot number the item belongs to
+         */
+        lot_number: Nullable<string>;
+        /**
+         * Expiration date of the item's lot
+         */
+        lot_date: Nullable<string>;
+    }[];
+}[];
+/**
+ * Create API with PAT (personal access token) - defaults to sandbox endpoints and "SMA" channel.
+ *
+ * NOTE: We used token based auth, so did not need to implement the other auth mechanism(s).
+ *
+ * TODO: Consider adding global parameters like timeout (or per method).  Some endpoints are slower than others.
+ *
+ * @param personalAccessToken passing *undefined* or empty string has a guar clause that will throw
+ * @param apiBaseUrl
+ * @param channelApplicationName
+ * @returns
+ */
+export declare const createShipBobApi: (personalAccessToken: string | undefined, apiBaseUrl?: string, channelApplicationName?: string) => Promise<{
+    getProductById: (productId: number) => Promise<DataResponse<GetProductResult>>;
+    getProducts: (query: Partial<{
+        ReferenceIds: string;
+        Page: number;
+        Limit: number;
+        IDs: string;
+        Search: string;
+        ActiveStatus: "Any" | "Active" | "Inactive";
+        BundleStatus: "Any" | "Bundle" | "NotBundle";
+    }>) => Promise<DataResponse<GetProductResult[]>>;
+    addProduct: (product: {
+        reference_id: string;
+        sku: string;
+        name: string;
+        barcode: string;
+    }) => Promise<DataResponse<AddProductResponse>>;
+    placeOrder: (order: PlaceOrderRequest) => Promise<DataResponse<PlaceOrderResponse>>;
+    /**
+     * Cancel single Order by Order Id
+     *
+     * @param orderId The order Id to cancel
+     */
+    cancelSingleOrderByOrderId: (orderId: number) => Promise<DataResponse<CancelOrderResponse>>;
+    getWebhooks: () => Promise<DataResponse<Webhook[][]>>;
+    createWebhookSubscription: (webhook: Omit<Webhook, "id" | "created_at">) => Promise<DataResponse<Webhook>>;
+    getFulfillmentCenters: () => Promise<DataResponse<FulfillmentCenter[]>>;
+    createWarehouseReceivingOrder: (request: WarehouseReceivingOrderRequest) => Promise<DataResponse<WarehouseReceivingOrderResponse>>;
+    getWarehouseReceivingOrder: (orderId: number) => Promise<DataResponse<WarehouseReceivingOrderResponse>>;
+    getWarehouseReceivingOrderBoxes: (orderId: number) => Promise<DataResponse<WarehouseReceivingOrderBoxesResponse>>;
+    getReceivingExtended: (query: Partial<{
+        Statuses: string;
+        ExternalSync: boolean;
+    }>) => Promise<DataResponse<GetProductResult[]>>;
+    /**
+     * This must be for setting/clearing if it has been synced externally.
+     *
+     * Use case is interop via searching for "completed" that are not yet synced.
+     *
+     * NOTE: this is tagged experimental, so might change or be dropped
+     */
+    experimentalReceivingSetExternalSync: (ids: number[], isExternalSync: boolean) => Promise<DataResponse<SetExternalSyncResponse>>;
+    listInventory: (query: Partial<{
+        /**
+         * Page of inventory items to get
+         */
+        Page: number;
+        /**
+         * Amount of inventory items per page to request
+         */
+        Limit: number;
+        IsActive: boolean;
+        IsDigital: boolean;
+        IDs: number[];
+        /**
+         * Sort will default to ascending order for each field. To sort in descending order please pass a "-" in front of the field name. For example, Sort=-onHand,name will sort by onHand descending
+         *
+         * NOTE: if you sort a non-valid field will be a 422.  ie: on_hand is not an available sort property
+         *
+         * NOTE: their API is a mix of pascalCase and snake_case.
+         */
+        Sort: string;
+        /**
+         * Search is available for 2 fields, Inventory ID and Name -
+         *
+         * Expected behavior for search by Inventory ID is exact match
+         * Expected behavior for search by Inventory Name is partial match, i.e. does not have to be start of word, but must be consecutive characters. This is not case sensitive.
+         */
+        Search: string;
+        /**
+         * LocationType is valid for hub, spoke, or lts. LocationType will default to all locations.
+         */
+        LocationType: string;
+    }>) => Promise<DataResponse<GetProductResult[]>>;
+    /**
+     * Only for sandbox: https://developer.shipbob.com/sandbox-simulations/
+     *
+     * NOTE: generates a 200 instead of a 201 like everywhere else
+     */
+    simulateShipment: (request: SimulateShipmentRequest) => Promise<DataResponse<SimulateShipmentResponse>>;
+    /**
+     *
+     * Only for sandbox: https://developer.shipbob.com/sandbox-simulations/
+     *
+     * @param simulationId UUID from "/2.0/simulate/shipment" call
+     */
+    getSimulationStatus: (simulationId: string) => Promise<DataResponse<SimulationResponse>>;
+}>;

package/dist/index.js

@@ -0,0 +1,303 @@
+/* eslint-disable @typescript-eslint/consistent-type-definitions */
+import https from 'https';
+import url from 'url';
+export var WebhookTopic;
+(function (WebhookTopic) {
+    WebhookTopic["OrderShipped"] = "order_shipped";
+    WebhookTopic["ShipmentDelivered"] = "shipment_delivered";
+    WebhookTopic["ShipmentException"] = "shipment_exception";
+    WebhookTopic["ShipmentOnHold"] = "shipment_onhold";
+    WebhookTopic["ShipmentCancelled"] = "shipment_cancelled";
+})(WebhookTopic || (WebhookTopic = {}));
+// ShipBob is potentially extending their 2.0 release 2025-04
+const PATH_1_0_CHANNEL = '/1.0/channel';
+const PATH_1_0_PRODUCT = '/1.0/product';
+const PATH_1_0_ORDER = '/1.0/order';
+/**
+ * Warehouse Receiving Order
+ */
+const PATH_2_0_RECEIVING = '/2.0/receiving';
+/**
+ * Note part of API docs
+ */
+const PATH_2_0_RECEIVING_EXTENDED = '/2.0/receiving-extended';
+/**
+ * Warehouse Receiving Order
+ */
+const PATH_EXPERIMENTAL_RECEIVING = '/experimental/receiving';
+const PATH_1_0_INVENTORY = '/1.0/inventory';
+const PATH_1_0_FULFILLMENT_CENTER = '/1.0/fulfillmentCenter';
+const PATH_1_0_WEBHOOK = '/1.0/webhook';
+const PATH_2_0_SIMULATE = '/2.0/simulate';
+/**
+ * Works for GET and POST/PATCH responses.  Some types area JSON.
+ */
+function resolvePromise(response, messageBody, resolve, reject) {
+    if (response.statusCode !== undefined && (response.statusCode < 200 || response.statusCode > 299)) {
+        /**
+         * Maybe we should be looking at the header Content-Type for parsing
+         */
+        switch (response.statusCode) {
+            case 400:
+            case 422:
+                resolve({
+                    success: false,
+                    statusCode: response.statusCode,
+                    data: JSON.parse(messageBody),
+                });
+                break;
+            default:
+                // this could be a 524 from CloudFlare, for example.
+                resolve({
+                    success: false,
+                    statusCode: response.statusCode,
+                    data: messageBody,
+                });
+                break;
+        }
+    }
+    else {
+        try {
+            resolve({
+                success: true,
+                statusCode: response.statusCode,
+                data: JSON.parse(messageBody),
+            });
+        }
+        catch (e) {
+            console.error('unable to parse JSON');
+            reject(e);
+        }
+    }
+}
+/**
+ * Create API with PAT (personal access token) - defaults to sandbox endpoints and "SMA" channel.
+ *
+ * NOTE: We used token based auth, so did not need to implement the other auth mechanism(s).
+ *
+ * TODO: Consider adding global parameters like timeout (or per method).  Some endpoints are slower than others.
+ *
+ * @param personalAccessToken passing *undefined* or empty string has a guar clause that will throw
+ * @param apiBaseUrl
+ * @param channelApplicationName
+ * @returns
+ */
+export const createShipBobApi = async (personalAccessToken, apiBaseUrl = 'sandbox-api.shipbob.com', channelApplicationName = 'SMA' /*, authBaseUrl = 'authstage.shipbob.com'*/) => {
+    if (personalAccessToken === undefined || personalAccessToken === '') {
+        throw new Error('Cannot create a ShipBob API without a PAT');
+    }
+    const credentials = {
+        token: personalAccessToken,
+    };
+    /**
+     * Will GET using our PAT and SAM channel
+     */
+    const httpGet = async (credentials, path, query, timeoutMilliseconds = 5000, port) => {
+        const requestUrl = url.parse(url.format({
+            protocol: 'https',
+            hostname: apiBaseUrl,
+            pathname: path,
+            query,
+        }));
+        console.log(` > GET: ${requestUrl.hostname}${requestUrl.path}`);
+        const options = {
+            hostname: requestUrl.hostname,
+            port: port ?? 443,
+            path: requestUrl.path,
+            method: 'GET',
+            timeout: timeoutMilliseconds,
+            headers: {
+                Authorization: `Bearer ${credentials.token}`,
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+                'User-Agent': 'KITS SDK interface',
+            },
+        };
+        return new Promise((resolve, reject) => {
+            const req = https.request(options, (response) => {
+                const body = [];
+                response.on('data', (chunk) => {
+                    body.push(chunk);
+                });
+                response.on('end', () => {
+                    const messageBody = body.join('');
+                    resolvePromise(response, messageBody, resolve, reject);
+                });
+            });
+            req.on('error', (error) => {
+                reject(error);
+            });
+            req.end();
+        });
+    };
+    /**
+     * Will post to Shipbob a request as JSON.  Can be used for any type of request
+     */
+    const httpData = async (credentials, data, path, timeoutMilliseconds = 5000, port) => {
+        if (credentials.channelId === undefined) {
+            throw new Error('Channel ID missing');
+        }
+        // NOTE: we're not sending content-length.  Their API is OK with that.
+        const options = {
+            hostname: apiBaseUrl,
+            port: port ?? 443,
+            path,
+            method: 'POST',
+            timeout: timeoutMilliseconds,
+            headers: {
+                Authorization: `Bearer ${credentials.token}`,
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+                'User-Agent': 'KITS SDK interface',
+                shipbob_channel_id: credentials.channelId,
+            },
+        };
+        return new Promise((resolve, reject) => {
+            const req = https.request(options, (response) => {
+                const body = [];
+                response.on('data', (chunk) => {
+                    body.push(chunk);
+                });
+                response.on('end', () => {
+                    const messageBody = body.join('');
+                    resolvePromise(response, messageBody, resolve, reject);
+                });
+            });
+            req.on('error', (error) => {
+                reject(error);
+            });
+            if (data) {
+                const postBody = JSON.stringify(data);
+                req.write(postBody);
+            }
+            req.end();
+        });
+    };
+    const channelsResponse = await httpGet(credentials, PATH_1_0_CHANNEL);
+    if (!channelsResponse.success) {
+        throw new Error(`${channelsResponse.statusCode} '${channelsResponse.data}'`);
+    }
+    const smaChannel = channelsResponse.data.find((c) => c.application_name === channelApplicationName);
+    if (smaChannel === undefined) {
+        throw new Error(`Did not find SMA channel {${channelsResponse.data.map((c) => c.application_name).join(',')}}`);
+    }
+    credentials.channelId = smaChannel.id;
+    return {
+        getProductById: async (productId) => {
+            // productId would need to be URL encoded - not for us, it's just numeric digits
+            // NOTE: /1.0/product/888290263059
+            // ERROR: {"productId":["The value '888290263059' is not valid."]}
+            const getProductResult = await httpGet(credentials, `${PATH_1_0_PRODUCT}/${productId}`);
+            console.log('get product:', getProductResult.success, getProductResult.success === false ? getProductResult.statusCode : 'found');
+            return getProductResult;
+        },
+        getProducts: async (query) => {
+            const getProductResult = await httpGet(credentials, PATH_1_0_PRODUCT, query);
+            console.log('get product:', getProductResult.success, getProductResult.success === false ? getProductResult.statusCode : 'found');
+            return getProductResult;
+        },
+        addProduct: async (product) => {
+            const addProductResponse = await httpData(credentials, product, PATH_1_0_PRODUCT);
+            console.log(' > Added product:', addProductResponse.success ? addProductResponse.data.reference_id : 'failed');
+            return addProductResponse;
+        },
+        placeOrder: async (order) => {
+            const placeOrderResponse = await httpData(credentials, order, PATH_1_0_ORDER);
+            console.log('place order:', placeOrderResponse);
+            return placeOrderResponse;
+        },
+        /**
+         * Cancel single Order by Order Id
+         *
+         * @param orderId The order Id to cancel
+         */
+        cancelSingleOrderByOrderId: async (orderId) => {
+            const placeOrderResponse = await httpData(credentials, undefined, `${PATH_1_0_ORDER}/${orderId}/cancel`);
+            console.log('place order:', placeOrderResponse);
+            return placeOrderResponse;
+        },
+        getWebhooks: async () => {
+            const webhooks = await httpGet(credentials, PATH_1_0_WEBHOOK);
+            console.log('webhooks:', webhooks);
+            return webhooks;
+        },
+        createWebhookSubscription: async (webhook) => {
+            const createdWebhook = await httpData(credentials, webhook, PATH_1_0_WEBHOOK);
+            return createdWebhook;
+        },
+        getFulfillmentCenters: async () => {
+            const fulfillmentCenters = await httpGet(credentials, PATH_1_0_FULFILLMENT_CENTER);
+            console.log('fulfillment centers:', fulfillmentCenters);
+            return fulfillmentCenters;
+        },
+        createWarehouseReceivingOrder: async (request) => {
+            const createdWRO = await httpData(credentials, request, PATH_2_0_RECEIVING);
+            return createdWRO;
+        },
+        getWarehouseReceivingOrder: async (orderId) => {
+            const wro = await httpGet(credentials, `${PATH_2_0_RECEIVING}/${orderId}`);
+            return wro;
+        },
+        getWarehouseReceivingOrderBoxes: async (orderId) => {
+            const wroBoxes = await httpGet(credentials, `${PATH_2_0_RECEIVING}/${orderId}/boxes`);
+            return wroBoxes;
+        },
+        getReceivingExtended: async (query) => {
+            const getReceivingExtendedResult = await httpGet(credentials, PATH_2_0_RECEIVING_EXTENDED, query);
+            console.log('get receiving extended:', getReceivingExtendedResult.success, getReceivingExtendedResult.success === false ? getReceivingExtendedResult.statusCode : 'found');
+            return getReceivingExtendedResult;
+        },
+        /**
+         * This must be for setting/clearing if it has been synced externally.
+         *
+         * Use case is interop via searching for "completed" that are not yet synced.
+         *
+         * NOTE: this is tagged experimental, so might change or be dropped
+         */
+        experimentalReceivingSetExternalSync: async (ids, isExternalSync) => {
+            console.log(`Setting: ${ids.join(',')} to external sync: ${isExternalSync}`);
+            const response = await httpData(credentials, {
+                ids,
+                is_external_sync: isExternalSync,
+            }, `${PATH_EXPERIMENTAL_RECEIVING}/:set-external-sync`);
+            if (response.success) {
+                for (const result of response.data.results) {
+                    console.log(` > ${result.id} ${result.action}. Success: ${result.is_success} Reason:'${result.reason}'`);
+                }
+                console.log('');
+            }
+            return response;
+        },
+        listInventory: async (query) => {
+            const getInventoryResult = await httpGet(credentials, PATH_1_0_INVENTORY, query);
+            console.log('get inventory:', getInventoryResult.success, getInventoryResult.success === false ? getInventoryResult.statusCode : 'found');
+            return getInventoryResult;
+        },
+        /**
+         * Only for sandbox: https://developer.shipbob.com/sandbox-simulations/
+         *
+         * NOTE: generates a 200 instead of a 201 like everywhere else
+         */
+        simulateShipment: async (request) => {
+            const result = await httpData(credentials, request, `${PATH_2_0_SIMULATE}/shipment`);
+            if (result.success) {
+                console.log('simulate shipment sent', result.data.simulation_id, result.data.message);
+            }
+            else {
+                console.log('simulate shipment failed:', result.data);
+            }
+            return result;
+        },
+        /**
+         *
+         * Only for sandbox: https://developer.shipbob.com/sandbox-simulations/
+         *
+         * @param simulationId UUID from "/2.0/simulate/shipment" call
+         */
+        getSimulationStatus: async (simulationId) => {
+            const result = await httpGet(credentials, `${PATH_2_0_SIMULATE}/status/${simulationId}`);
+            return result;
+        },
+    };
+};
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,mEAAmE;AACnE,OAAO,KAAK,MAAM,OAAO,CAAC;AAG1B,OAAO,GAAG,MAAM,KAAK,CAAC;AAItB,MAAM,CAAN,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,8CAA8B,CAAA;IAC9B,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IACxC,kDAAkC,CAAA;IAClC,wDAAwC,CAAA;AAC1C,CAAC,EANW,YAAY,KAAZ,YAAY,QAMvB;AA6BD,6DAA6D;AAE7D,MAAM,gBAAgB,GAAG,cAAc,CAAC;AACxC,MAAM,gBAAgB,GAAG,cAAc,CAAC;AACxC,MAAM,cAAc,GAAG,YAAY,CAAC;AACpC;;GAEG;AACH,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAC5C;;GAEG;AACH,MAAM,2BAA2B,GAAG,yBAAyB,CAAC;AAC9D;;GAEG;AACH,MAAM,2BAA2B,GAAG,yBAAyB,CAAC;AAE9D,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAC5C,MAAM,2BAA2B,GAAG,wBAAwB,CAAC;AAC7D,MAAM,gBAAgB,GAAG,cAAc,CAAC;AACxC,MAAM,iBAAiB,GAAG,eAAe,CAAC;AAgpB1C;;GAEG;AACH,SAAS,cAAc,CACrB,QAAyB,EACzB,WAAmB,EACnB,OAAwE,EACxE,MAAgC;IAEhC,IAAI,QAAQ,CAAC,UAAU,KAAK,SAAS,IAAI,CAAC,QAAQ,CAAC,UAAU,GAAG,GAAG,IAAI,QAAQ,CAAC,UAAU,GAAG,GAAG,CAAC,EAAE,CAAC;QAClG;;WAEG;QACH,QAAQ,QAAQ,CAAC,UAAU,EAAE,CAAC;YAC5B,KAAK,GAAG,CAAC;YACT,KAAK,GAAG;gBACN,OAAO,CAAC;oBACN,OAAO,EAAE,KAAK;oBACd,UAAU,EAAE,QAAQ,CAAC,UAAU;oBAC/B,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAW;iBACxC,CAAC,CAAC;gBACH,MAAM;YACR;gBACE,oDAAoD;gBACpD,OAAO,CAAC;oBACN,OAAO,EAAE,KAAK;oBACd,UAAU,EAAE,QAAQ,CAAC,UAAU;oBAC/B,IAAI,EAAE,WAAW;iBAClB,CAAC,CAAC;gBACH,MAAM;QACV,CAAC;IACH,CAAC;SAAM,CAAC;QACN,IAAI,CAAC;YACH,OAAO,CAAC;gBACN,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,QAAQ,CAAC,UAAW;gBAChC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,WAAW,CAAM;aACnC,CAAC,CAAC;QACL,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,OAAO,CAAC,KAAK,CAAC,sBAAsB,CAAC,CAAC;YACtC,MAAM,CAAC,CAAU,CAAC,CAAC;QACrB,CAAC;IACH,CAAC;AACH,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,CAAC,MAAM,gBAAgB,GAAG,KAAK,EACnC,mBAAuC,EACvC,UAAU,GAAG,yBAAyB,EACtC,sBAAsB,GAAG,KAAK,CAAC,2CAA2C,EAC1E,EAAE;IACF,IAAI,mBAAmB,KAAK,SAAS,IAAI,mBAAmB,KAAK,EAAE,EAAE,CAAC;QACpE,MAAM,IAAI,KAAK,CAAC,2CAA2C,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,WAAW,GAAgB;QAC/B,KAAK,EAAE,mBAAmB;KAC3B,CAAC;IAEF;;OAEG;IACH,MAAM,OAAO,GAAG,KAAK,EACnB,WAAwB,EACxB,IAAY,EACZ,KAAoD,EACpD,mBAAmB,GAAG,IAAI,EAC1B,IAAa,EACa,EAAE;QAC5B,MAAM,UAAU,GAAG,GAAG,CAAC,KAAK,CAC1B,GAAG,CAAC,MAAM,CAAC;YACT,QAAQ,EAAE,OAAO;YACjB,QAAQ,EAAE,UAAU;YACpB,QAAQ,EAAE,IAAI;YACd,KAAK;SACN,CAAC,CACH,CAAC;QAEF,OAAO,CAAC,GAAG,CAAC,WAAW,UAAU,CAAC,QAAQ,GAAG,UAAU,CAAC,IAAI,EAAE,CAAC,CAAC;QAEhE,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,UAAU,CAAC,QAAQ;YAC7B,IAAI,EAAE,IAAI,IAAI,GAAG;YACjB,IAAI,EAAE,UAAU,CAAC,IAAI;YACrB,MAAM,EAAE,KAAK;YACb,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,WAAW,CAAC,KAAK,EAAE;gBAC5C,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,YAAY,EAAE,oBAAoB;aACnC;SACF,CAAC;QAEF,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,QAAyB,EAAE,EAAE;gBAC/D,MAAM,IAAI,GAAa,EAAE,CAAC;gBAC1B,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC5B,IAAI,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;gBAC7B,CAAC,CAAC,CAAC;gBAEH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBACtB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAClC,cAAc,CAAI,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC5D,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxB,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,GAAG,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,QAAQ,GAAG,KAAK,EACpB,WAAwB,EACxB,IAAwB,EACxB,IAAY,EACZ,mBAAmB,GAAG,IAAI,EAC1B,IAAa,EACa,EAAE;QAC5B,IAAI,WAAW,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,sEAAsE;QACtE,MAAM,OAAO,GAAG;YACd,QAAQ,EAAE,UAAU;YACpB,IAAI,EAAE,IAAI,IAAI,GAAG;YACjB,IAAI;YACJ,MAAM,EAAE,MAAM;YACd,OAAO,EAAE,mBAAmB;YAC5B,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,WAAW,CAAC,KAAK,EAAE;gBAC5C,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,YAAY,EAAE,oBAAoB;gBAClC,kBAAkB,EAAE,WAAW,CAAC,SAAS;aAC1C;SACF,CAAC;QAEF,OAAO,IAAI,OAAO,CAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE;YACtD,MAAM,GAAG,GAAG,KAAK,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC,QAAyB,EAAE,EAAE;gBAC/D,MAAM,IAAI,GAAa,EAAE,CAAC;gBAC1B,QAAQ,CAAC,EAAE,CAAC,MAAM,EAAE,CAAC,KAAK,EAAE,EAAE;oBAC5B,IAAI,CAAC,IAAI,CAAC,KAAe,CAAC,CAAC;gBAC7B,CAAC,CAAC,CAAC;gBAEH,QAAQ,CAAC,EAAE,CAAC,KAAK,EAAE,GAAG,EAAE;oBACtB,MAAM,WAAW,GAAG,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;oBAClC,cAAc,CAAI,QAAQ,EAAE,WAAW,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;gBAC5D,CAAC,CAAC,CAAC;YACL,CAAC,CAAC,CAAC;YAEH,GAAG,CAAC,EAAE,CAAC,OAAO,EAAE,CAAC,KAAK,EAAE,EAAE;gBACxB,MAAM,CAAC,KAAK,CAAC,CAAC;YAChB,CAAC,CAAC,CAAC;YAEH,IAAI,IAAI,EAAE,CAAC;gBACT,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC;gBACtC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC;YAED,GAAG,CAAC,GAAG,EAAE,CAAC;QACZ,CAAC,CAAC,CAAC;IACL,CAAC,CAAC;IAEF,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAmB,WAAW,EAAE,gBAAgB,CAAC,CAAC;IAExF,IAAI,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,GAAG,gBAAgB,CAAC,UAAU,KAAK,gBAAgB,CAAC,IAAc,GAAG,CAAC,CAAC;IACzF,CAAC;IACD,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,KAAK,sBAAsB,CAAC,CAAC;IACpG,IAAI,UAAU,KAAK,SAAS,EAAE,CAAC;QAC7B,MAAM,IAAI,KAAK,CAAC,6BAA6B,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,gBAAgB,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;IAClH,CAAC;IAED,WAAW,CAAC,SAAS,GAAG,UAAU,CAAC,EAAE,CAAC;IAEtC,OAAO;QACL,cAAc,EAAE,KAAK,EAAE,SAAiB,EAAE,EAAE;YAC1C,gFAAgF;YAChF,kCAAkC;YAClC,kEAAkE;YAClE,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAmB,WAAW,EAAE,GAAG,gBAAgB,IAAI,SAAS,EAAE,CAAC,CAAC;YAC1G,OAAO,CAAC,GAAG,CACT,cAAc,EACd,gBAAgB,CAAC,OAAO,EACxB,gBAAgB,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAC3E,CAAC;YACF,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QACD,WAAW,EAAE,KAAK,EAChB,KAQE,EACF,EAAE;YACF,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAqB,WAAW,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACjG,OAAO,CAAC,GAAG,CACT,cAAc,EACd,gBAAgB,CAAC,OAAO,EACxB,gBAAgB,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAC3E,CAAC;YACF,OAAO,gBAAgB,CAAC;QAC1B,CAAC;QACD,UAAU,EAAE,KAAK,EAAE,OAA6E,EAAE,EAAE;YAClG,MAAM,kBAAkB,GAAG,MAAM,QAAQ,CAAqB,WAAW,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;YACtG,OAAO,CAAC,GAAG,CAAC,mBAAmB,EAAE,kBAAkB,CAAC,OAAO,CAAC,CAAC,CAAC,kBAAkB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC;YAC/G,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD,UAAU,EAAE,KAAK,EAAE,KAAwB,EAAE,EAAE;YAC7C,MAAM,kBAAkB,GAAG,MAAM,QAAQ,CAAqB,WAAW,EAAE,KAAK,EAAE,cAAc,CAAC,CAAC;YAClG,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;YAChD,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD;;;;WAIG;QACH,0BAA0B,EAAE,KAAK,EAAE,OAAe,EAAE,EAAE;YACpD,MAAM,kBAAkB,GAAG,MAAM,QAAQ,CACvC,WAAW,EACX,SAAS,EACT,GAAG,cAAc,IAAI,OAAO,SAAS,CACtC,CAAC;YACF,OAAO,CAAC,GAAG,CAAC,cAAc,EAAE,kBAAkB,CAAC,CAAC;YAChD,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD,WAAW,EAAE,KAAK,IAAI,EAAE;YACtB,MAAM,QAAQ,GAAG,MAAM,OAAO,CAAc,WAAW,EAAE,gBAAgB,CAAC,CAAC;YAC3E,OAAO,CAAC,GAAG,CAAC,WAAW,EAAE,QAAQ,CAAC,CAAC;YACnC,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,yBAAyB,EAAE,KAAK,EAAE,OAA2C,EAAE,EAAE;YAC/E,MAAM,cAAc,GAAG,MAAM,QAAQ,CAAU,WAAW,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;YACvF,OAAO,cAAc,CAAC;QACxB,CAAC;QACD,qBAAqB,EAAE,KAAK,IAAI,EAAE;YAChC,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAsB,WAAW,EAAE,2BAA2B,CAAC,CAAC;YACxG,OAAO,CAAC,GAAG,CAAC,sBAAsB,EAAE,kBAAkB,CAAC,CAAC;YACxD,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD,6BAA6B,EAAE,KAAK,EAAE,OAAuC,EAAE,EAAE;YAC/E,MAAM,UAAU,GAAG,MAAM,QAAQ,CAAkC,WAAW,EAAE,OAAO,EAAE,kBAAkB,CAAC,CAAC;YAC7G,OAAO,UAAU,CAAC;QACpB,CAAC;QACD,0BAA0B,EAAE,KAAK,EAAE,OAAe,EAAE,EAAE;YACpD,MAAM,GAAG,GAAG,MAAM,OAAO,CAAkC,WAAW,EAAE,GAAG,kBAAkB,IAAI,OAAO,EAAE,CAAC,CAAC;YAC5G,OAAO,GAAG,CAAC;QACb,CAAC;QACD,+BAA+B,EAAE,KAAK,EAAE,OAAe,EAAE,EAAE;YACzD,MAAM,QAAQ,GAAG,MAAM,OAAO,CAC5B,WAAW,EACX,GAAG,kBAAkB,IAAI,OAAO,QAAQ,CACzC,CAAC;YACF,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,oBAAoB,EAAE,KAAK,EACzB,KAGE,EACF,EAAE;YACF,MAAM,0BAA0B,GAAG,MAAM,OAAO,CAC9C,WAAW,EACX,2BAA2B,EAC3B,KAAK,CACN,CAAC;YACF,OAAO,CAAC,GAAG,CACT,yBAAyB,EACzB,0BAA0B,CAAC,OAAO,EAClC,0BAA0B,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,0BAA0B,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAC/F,CAAC;YACF,OAAO,0BAA0B,CAAC;QACpC,CAAC;QACD;;;;;;WAMG;QACH,oCAAoC,EAAE,KAAK,EAAE,GAAa,EAAE,cAAuB,EAAE,EAAE;YACrF,OAAO,CAAC,GAAG,CAAC,YAAY,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,sBAAsB,cAAc,EAAE,CAAC,CAAC;YAC7E,MAAM,QAAQ,GAAG,MAAM,QAAQ,CAC7B,WAAW,EACX;gBACE,GAAG;gBACH,gBAAgB,EAAE,cAAc;aACjC,EACD,GAAG,2BAA2B,qBAAqB,CACpD,CAAC;YACF,IAAI,QAAQ,CAAC,OAAO,EAAE,CAAC;gBACrB,KAAK,MAAM,MAAM,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;oBAC3C,OAAO,CAAC,GAAG,CAAC,MAAM,MAAM,CAAC,EAAE,IAAI,MAAM,CAAC,MAAM,cAAc,MAAM,CAAC,UAAU,YAAY,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;gBAC3G,CAAC;gBACD,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAClB,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,aAAa,EAAE,KAAK,EAClB,KA+BE,EACF,EAAE;YACF,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAqB,WAAW,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;YACrG,OAAO,CAAC,GAAG,CACT,gBAAgB,EAChB,kBAAkB,CAAC,OAAO,EAC1B,kBAAkB,CAAC,OAAO,KAAK,KAAK,CAAC,CAAC,CAAC,kBAAkB,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAC/E,CAAC;YACF,OAAO,kBAAkB,CAAC;QAC5B,CAAC;QACD;;;;WAIG;QACH,gBAAgB,EAAE,KAAK,EAAE,OAAgC,EAAE,EAAE;YAC3D,MAAM,MAAM,GAAG,MAAM,QAAQ,CAA2B,WAAW,EAAE,OAAO,EAAE,GAAG,iBAAiB,WAAW,CAAC,CAAC;YAC/G,IAAI,MAAM,CAAC,OAAO,EAAE,CAAC;gBACnB,OAAO,CAAC,GAAG,CAAC,wBAAwB,EAAE,MAAM,CAAC,IAAI,CAAC,aAAa,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;YACxF,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,GAAG,CAAC,2BAA2B,EAAE,MAAM,CAAC,IAAI,CAAC,CAAC;YACxD,CAAC;YACD,OAAO,MAAM,CAAC;QAChB,CAAC;QACD;;;;;WAKG;QACH,mBAAmB,EAAE,KAAK,EAAE,YAAoB,EAAE,EAAE;YAClD,MAAM,MAAM,GAAG,MAAM,OAAO,CAAqB,WAAW,EAAE,GAAG,iBAAiB,WAAW,YAAY,EAAE,CAAC,CAAC;YAC7G,OAAO,MAAM,CAAC;QAChB,CAAC;KACF,CAAC;AACJ,CAAC,CAAC"}

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "shipbob-node-sdk",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "description": "ShipBob API node SDK",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
   "scripts": {
-    "prebuild": "rimraf dist && eslint && prettier \"**/*.ts\" --check",
+    "prebuild": "rimraf dist && eslint . --ignore-pattern generated/ && prettier \"**/*.ts\" --check",
     "build": "tsc",
-    "lint": "eslint .",
+    "lint": "eslint . --ignore-pattern generated/",
     "prettier:write": "prettier \"**/*.ts\" --write",
     "generate:client": "openapi-generator-cli generate -i openapi.json -g typescript -o generated/openapi --additional-properties=npmName=restClient,supportsES6=true,withInterfaces=true",
     "test": "mocha"