shipbob-node-sdk 0.0.1 → 0.0.3

package/dist/index.js

@@ -0,0 +1,358 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createShipBobApi = exports.ReturnAction = exports.PackagingMaterial = exports.PackagingRequirement = exports.WebhookTopic = void 0;
+/* eslint-disable @typescript-eslint/consistent-type-definitions */
+const node_url_1 = require("node:url"); // WHATWG
+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 || (exports.WebhookTopic = WebhookTopic = {}));
+// ShipBob is potentially extending 2.0 publicly
+// see /docs/Product Catalog API Examples.pdf
+const PATH_1_0_CHANNEL = '/1.0/channel';
+const PATH_1_0_PRODUCT = '/1.0/product';
+const PATH_2_0_PRODUCT = '/2.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';
+var PackagingRequirement;
+(function (PackagingRequirement) {
+    // wrong spelling in PDF
+    PackagingRequirement[PackagingRequirement["No Requirements"] = 1] = "No Requirements";
+    PackagingRequirement[PackagingRequirement["Fragile"] = 2] = "Fragile";
+    PackagingRequirement[PackagingRequirement["Is Foldable"] = 3] = "Is Foldable";
+    PackagingRequirement[PackagingRequirement["Is Media (Media mail)"] = 4] = "Is Media (Media mail)";
+    PackagingRequirement[PackagingRequirement["Is Book"] = 5] = "Is Book";
+    PackagingRequirement[PackagingRequirement["Is Poster"] = 6] = "Is Poster";
+    PackagingRequirement[PackagingRequirement["Is Apparel"] = 7] = "Is Apparel";
+    PackagingRequirement[PackagingRequirement["Is Packaging Material (for custom boxes, marketing inserts, etc)"] = 8] = "Is Packaging Material (for custom boxes, marketing inserts, etc)";
+    PackagingRequirement[PackagingRequirement["Ship In Own Container"] = 9] = "Ship In Own Container";
+})(PackagingRequirement || (exports.PackagingRequirement = PackagingRequirement = {}));
+var PackagingMaterial;
+(function (PackagingMaterial) {
+    PackagingMaterial[PackagingMaterial["Box"] = 1] = "Box";
+    PackagingMaterial[PackagingMaterial["Bubble Mailer"] = 2] = "Bubble Mailer";
+    PackagingMaterial[PackagingMaterial["Poly Mailer"] = 3] = "Poly Mailer";
+    // no 4 in PDF
+    PackagingMaterial[PackagingMaterial["Poster Tube"] = 5] = "Poster Tube";
+    PackagingMaterial[PackagingMaterial["Custom Box"] = 6] = "Custom Box";
+    PackagingMaterial[PackagingMaterial["Bookfold"] = 7] = "Bookfold";
+    PackagingMaterial[PackagingMaterial["Ship In Own Container"] = 8] = "Ship In Own Container";
+    PackagingMaterial[PackagingMaterial["Custom Bubble Mailer"] = 9] = "Custom Bubble Mailer";
+    PackagingMaterial[PackagingMaterial["Custom Poly Mailer"] = 10] = "Custom Poly Mailer";
+})(PackagingMaterial || (exports.PackagingMaterial = PackagingMaterial = {}));
+/**
+ * Restock (1)
+ * Quarantine (2)
+ * Dispose (3)
+ */
+var ReturnAction;
+(function (ReturnAction) {
+    /**
+     * Restock (1)
+     */
+    ReturnAction[ReturnAction["Restock"] = 1] = "Restock";
+    /**
+     * Quarantine (2)
+     */
+    ReturnAction[ReturnAction["Quarantine"] = 2] = "Quarantine";
+    /**
+     * Dispose (3)
+     */
+    ReturnAction[ReturnAction["Dispose"] = 3] = "Dispose";
+})(ReturnAction || (exports.ReturnAction = ReturnAction = {}));
+/**
+ * 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
+ */
+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) => {
+        const url = new node_url_1.URL(`https://${apiBaseUrl}${path}`);
+        if (query) {
+            for (const param of Object.keys(query)) {
+                // the number[] is probably wrong
+                const val = typeof query[param] === 'string' ? query[param] : query[param].toString();
+                url.searchParams.set(param, val);
+            }
+        }
+        const res = await fetch(url.href, {
+            method: 'GET',
+            headers: {
+                Authorization: `Bearer ${credentials.token}`,
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+                'User-Agent': 'shipbob-node-sdk',
+            },
+            // signal: AbortSignal.timeout(60 * 1000) Node 20 only
+        });
+        if (res.ok) {
+            return {
+                success: true,
+                statusCode: res.status,
+                data: (await res.json()),
+            };
+        }
+        else {
+            switch (res.status) {
+                case 400:
+                case 422:
+                    return {
+                        success: false,
+                        statusCode: res.status,
+                        data: await res.json(),
+                    };
+                default:
+                    return {
+                        success: false,
+                        statusCode: res.status,
+                        data: await res.text(),
+                    };
+            }
+        }
+    };
+    /**
+     * Will default POST to Shipbob a request as JSON.  Can be used for any type of request
+     */
+    const httpData = async (credentials, data, path, method = 'POST') => {
+        if (credentials.channelId === undefined) {
+            throw new Error('Channel ID missing');
+        }
+        const url = new node_url_1.URL(`https://${apiBaseUrl}${path}`);
+        const res = await fetch(url.href, {
+            method,
+            headers: {
+                Authorization: `Bearer ${credentials.token}`,
+                'Content-Type': 'application/json',
+                Accept: 'application/json',
+                'User-Agent': 'shipbob-node-sdk',
+            },
+            body: data !== undefined ? JSON.stringify(data) : undefined,
+            // signal: AbortSignal.timeout(60 * 1000) Node 20 only
+        });
+        if (res.ok) {
+            // NOTE: should check content-type of response
+            return {
+                success: true,
+                statusCode: res.status,
+                data: (await res.json()),
+            };
+        }
+        else {
+            switch (res.status) {
+                case 400:
+                case 422:
+                    return {
+                        success: false,
+                        statusCode: res.status,
+                        data: await res.json(),
+                    };
+                default:
+                    return {
+                        success: false,
+                        statusCode: res.status,
+                        data: await res.text(),
+                    };
+            }
+        }
+    };
+    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;
+        },
+        getProducts1_0: async (query) => {
+            const getProductResult = await httpGet(credentials, PATH_1_0_PRODUCT, query);
+            console.log('get product 1.0:', getProductResult.success, getProductResult.success === false ? getProductResult.statusCode : 'found');
+            return getProductResult;
+        },
+        /**
+         * NOTE: we can probably pass more than "variants" prop.  We could on the /1.0/product endpoint
+         * NOTE: This PATCH functionality will be available in the next version available in ShipBob next large release January 2025, it may require extra scope.
+         */
+        updateProducts2_0: async (productId, variants) => {
+            console.log('variants', variants);
+            const updateProduct2Response = await httpData(credentials, {
+                variants,
+            }, `${PATH_2_0_PRODUCT}/${productId}`, 'PATCH');
+            return updateProduct2Response;
+        },
+        /**
+         * Not supported here, but:
+         * Some search filters allow for operators (equals, not equals, starts with, ends with, contains, etc) to get more exact values. When filtering with an operator, the query string will look like the below:
+         * Example: /product?{filter}={operator}:{value}
+         * Example: /product?sku=any:shirt-a,shirt-b,shirt-c Find products that match any of these SKUs
+         * Example: /product?onHandQuantity=gt:0 Find products where OnHandQty greater than 0
+         */
+        getProducts2_0: async (query) => {
+            const getProductResult = await httpGet(credentials, PATH_2_0_PRODUCT, query);
+            console.log('get product 2.0:', getProductResult.success, getProductResult.success === false ? getProductResult.statusCode : 'found');
+            return getProductResult;
+        },
+        createProduct1_0: async (product) => {
+            const createProductResponse = await httpData(credentials, product, PATH_1_0_PRODUCT);
+            console.log(' > Created product:', createProductResponse.success ? createProductResponse.data.reference_id : 'failed');
+            return createProductResponse;
+        },
+        /**
+         * The request part for variant is not accurate.  This is just for testing - there are no official docs.
+         */
+        createProduct2_0: async (product) => {
+            const createProductResponse = await httpData(credentials, product, PATH_2_0_PRODUCT);
+            console.log(' > Created product:', createProductResponse.success ? createProductResponse.data.reference_id : 'failed');
+            return createProductResponse;
+        },
+        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;
+        },
+        /**
+         * NOTE: should verify that response matches 1.0 product endpoint
+         */
+        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;
+        },
+        /**
+         * NOTE: should verify the response type matches the product 1.0 endpoint
+         */
+        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;
+        },
+    };
+};
+exports.createShipBobApi = createShipBobApi;
+//# 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,uCAA+B,CAAC,SAAS;AAIzC,IAAY,YAMX;AAND,WAAY,YAAY;IACtB,8CAA8B,CAAA;IAC9B,wDAAwC,CAAA;IACxC,wDAAwC,CAAA;IACxC,kDAAkC,CAAA;IAClC,wDAAwC,CAAA;AAC1C,CAAC,EANW,YAAY,4BAAZ,YAAY,QAMvB;AA6BD,gDAAgD;AAChD,6CAA6C;AAE7C,MAAM,gBAAgB,GAAG,cAAc,CAAC;AACxC,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;AAk2B1C,IAAY,oBAWX;AAXD,WAAY,oBAAoB;IAC9B,wBAAwB;IACxB,qFAAqB,CAAA;IACrB,qEAAW,CAAA;IACX,6EAAiB,CAAA;IACjB,iGAA2B,CAAA;IAC3B,qEAAa,CAAA;IACb,yEAAe,CAAA;IACf,2EAAgB,CAAA;IAChB,uLAAsE,CAAA;IACtE,iGAA2B,CAAA;AAC7B,CAAC,EAXW,oBAAoB,oCAApB,oBAAoB,QAW/B;AAED,IAAY,iBAWX;AAXD,WAAY,iBAAiB;IAC3B,uDAAS,CAAA;IACT,2EAAmB,CAAA;IACnB,uEAAiB,CAAA;IACjB,cAAc;IACd,uEAAiB,CAAA;IACjB,qEAAgB,CAAA;IAChB,iEAAc,CAAA;IACd,2FAA2B,CAAA;IAC3B,yFAA0B,CAAA;IAC1B,sFAAyB,CAAA;AAC3B,CAAC,EAXW,iBAAiB,iCAAjB,iBAAiB,QAW5B;AAED;;;;GAIG;AACH,IAAY,YAaX;AAbD,WAAY,YAAY;IACtB;;OAEG;IACH,qDAAW,CAAA;IACX;;OAEG;IACH,2DAAc,CAAA;IACd;;OAEG;IACH,qDAAW,CAAA;AACb,CAAC,EAbW,YAAY,4BAAZ,YAAY,QAavB;AA2DD;;;;;;;;;;;GAWG;AACI,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,KAA4D,EAClC,EAAE;QAC5B,MAAM,GAAG,GAAG,IAAI,cAAG,CAAC,WAAW,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;QACpD,IAAI,KAAK,EAAE,CAAC;YACV,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC;gBACvC,iCAAiC;gBACjC,MAAM,GAAG,GAAG,OAAO,KAAK,CAAC,KAAK,CAAC,KAAK,QAAQ,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,QAAQ,EAAE,CAAC;gBACtF,GAAG,CAAC,YAAY,CAAC,GAAG,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC;YACnC,CAAC;QACH,CAAC;QAED,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE;YAChC,MAAM,EAAE,KAAK;YACb,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,WAAW,CAAC,KAAK,EAAE;gBAC5C,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,YAAY,EAAE,kBAAkB;aACjC;YACD,sDAAsD;SACvD,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;YACX,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG,CAAC,MAAM;gBACtB,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAM;aAC9B,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC;gBACnB,KAAK,GAAG,CAAC;gBACT,KAAK,GAAG;oBACN,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,UAAU,EAAE,GAAG,CAAC,MAAM;wBACtB,IAAI,EAAE,MAAM,GAAG,CAAC,IAAI,EAAE;qBACvB,CAAC;gBACJ;oBACE,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,UAAU,EAAE,GAAG,CAAC,MAAM;wBACtB,IAAI,EAAE,MAAM,GAAG,CAAC,IAAI,EAAE;qBACvB,CAAC;YACN,CAAC;QACH,CAAC;IACH,CAAC,CAAC;IAEF;;OAEG;IACH,MAAM,QAAQ,GAAG,KAAK,EACpB,WAAwB,EACxB,IAAwB,EACxB,IAAY,EACZ,SAA2B,MAAM,EACP,EAAE;QAC5B,IAAI,WAAW,CAAC,SAAS,KAAK,SAAS,EAAE,CAAC;YACxC,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;QACxC,CAAC;QAED,MAAM,GAAG,GAAG,IAAI,cAAG,CAAC,WAAW,UAAU,GAAG,IAAI,EAAE,CAAC,CAAC;QACpD,MAAM,GAAG,GAAG,MAAM,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE;YAChC,MAAM;YACN,OAAO,EAAE;gBACP,aAAa,EAAE,UAAU,WAAW,CAAC,KAAK,EAAE;gBAC5C,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,YAAY,EAAE,kBAAkB;aACjC;YACD,IAAI,EAAE,IAAI,KAAK,SAAS,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,SAAS;YAC3D,sDAAsD;SACvD,CAAC,CAAC;QAEH,IAAI,GAAG,CAAC,EAAE,EAAE,CAAC;YACX,8CAA8C;YAC9C,OAAO;gBACL,OAAO,EAAE,IAAI;gBACb,UAAU,EAAE,GAAG,CAAC,MAAM;gBACtB,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,IAAI,EAAE,CAAM;aAC9B,CAAC;QACJ,CAAC;aAAM,CAAC;YACN,QAAQ,GAAG,CAAC,MAAM,EAAE,CAAC;gBACnB,KAAK,GAAG,CAAC;gBACT,KAAK,GAAG;oBACN,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,UAAU,EAAE,GAAG,CAAC,MAAM;wBACtB,IAAI,EAAE,MAAM,GAAG,CAAC,IAAI,EAAE;qBACvB,CAAC;gBACJ;oBACE,OAAO;wBACL,OAAO,EAAE,KAAK;wBACd,UAAU,EAAE,GAAG,CAAC,MAAM;wBACtB,IAAI,EAAE,MAAM,GAAG,CAAC,IAAI,EAAE;qBACvB,CAAC;YACN,CAAC;QACH,CAAC;IACH,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,CAAsB,WAAW,EAAE,GAAG,gBAAgB,IAAI,SAAS,EAAE,CAAC,CAAC;YAC7G,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,cAAc,EAAE,KAAK,EACnB,KAQE,EACF,EAAE;YACF,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAwB,WAAW,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACpG,OAAO,CAAC,GAAG,CACT,kBAAkB,EAClB,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;;;WAGG;QACH,iBAAiB,EAAE,KAAK,EAAE,SAAiB,EAAE,QAAiC,EAAE,EAAE;YAChF,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC;YAClC,MAAM,sBAAsB,GAAG,MAAM,QAAQ,CAC3C,WAAW,EACX;gBACE,QAAQ;aACT,EACD,GAAG,gBAAgB,IAAI,SAAS,EAAE,EAClC,OAAO,CACR,CAAC;YACF,OAAO,sBAAsB,CAAC;QAChC,CAAC;QACD;;;;;;WAMG;QACH,cAAc,EAAE,KAAK,EACnB,KAiDE,EACF,EAAE;YACF,MAAM,gBAAgB,GAAG,MAAM,OAAO,CAAwB,WAAW,EAAE,gBAAgB,EAAE,KAAK,CAAC,CAAC;YACpG,OAAO,CAAC,GAAG,CACT,kBAAkB,EAClB,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,gBAAgB,EAAE,KAAK,EAAE,OAA6E,EAAE,EAAE;YACxG,MAAM,qBAAqB,GAAG,MAAM,QAAQ,CAAqB,WAAW,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;YACzG,OAAO,CAAC,GAAG,CACT,qBAAqB,EACrB,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CACnF,CAAC;YACF,OAAO,qBAAqB,CAAC;QAC/B,CAAC;QACD;;WAEG;QACH,gBAAgB,EAAE,KAAK,EAAE,OAMxB,EAAE,EAAE;YACH,MAAM,qBAAqB,GAAG,MAAM,QAAQ,CAAqB,WAAW,EAAE,OAAO,EAAE,gBAAgB,CAAC,CAAC;YACzG,OAAO,CAAC,GAAG,CACT,qBAAqB,EACrB,qBAAqB,CAAC,OAAO,CAAC,CAAC,CAAC,qBAAqB,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CACnF,CAAC;YACF,OAAO,qBAAqB,CAAC;QAC/B,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;;WAEG;QACH,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;;WAEG;QACH,aAAa,EAAE,KAAK,EAClB,KA+BE,EACF,EAAE;YACF,MAAM,kBAAkB,GAAG,MAAM,OAAO,CAAwB,WAAW,EAAE,kBAAkB,EAAE,KAAK,CAAC,CAAC;YACxG,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;AAlbW,QAAA,gBAAgB,oBAkb3B"}

package/package.json

@@ -1,13 +1,14 @@
 {
   "name": "shipbob-node-sdk",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "ShipBob API node SDK",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",
+  "type": "commonjs",
   "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"

package/.prettierignore

@@ -1,3 +0,0 @@
-/dist
-/generated
-/.vscode

package/.prettierrc

@@ -1,9 +0,0 @@
-{
-  "printWidth": 120,
-  "bracketSameLine": false,
-  "singleQuote": true,
-  "tabWidth": 2,
-  "trailingComma": "es5",
-  "semi": true,
-  "endOfLine": "lf"
-}

package/eslint.config.mjs

@@ -1,13 +0,0 @@
-import eslint from "@eslint/js";
-import tseslint from "typescript-eslint";
-
-export default tseslint.config(
-  eslint.configs.recommended,
-  ...tseslint.configs.recommended,
-  ...tseslint.configs.stylistic,
-  {
-    rules: {
-      "@typescript-eslint/consistent-type-definitions": "warn"
-    }
-  }
-);