shipbob-node-sdk 0.0.4 → 0.0.6

package/dist/types.js

@@ -0,0 +1,87 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebhookTopic = exports.ReturnAction = exports.PackagingMaterial = exports.PackagingRequirement = void 0;
+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 = {}));
+/**
+ * The Topic and SubsciptionId are passed in the HTTP header of the webhook notification, with the names:
+ * - shipbob-topic
+ * - shipbob-subscription-id
+ */
+var WebhookTopic;
+(function (WebhookTopic) {
+    /**
+     * Sends the full order payload when the label is purchased, printed, and placed on box for carrier pickup.
+     * While the tracking # will be available, there may be a delay while carriers scan in the package.
+     * If the order is split into multiple shipments, this will fire for each shipment that is part of the order.
+     */
+    WebhookTopic["OrderShipped"] = "order_shipped";
+    /**
+     * Sends the full shipment payload when a shipment is delivered by the carrier to the customer.
+     * If the order is split into multiple shipments, this will fire for each shipment.
+     */
+    WebhookTopic["ShipmentDelivered"] = "shipment_delivered";
+    /**
+     * Sends the full shipment payload when a shipment moves to exception status.
+     * Shipments are moved into exception because ShipBob is unable to fulfill the shipment.
+     * Shipments are moved into exception status largely because one or more items in the shipment is out of stock.
+     */
+    WebhookTopic["ShipmentException"] = "shipment_exception";
+    /**
+     * Sends the full shipment payload when a shipment moves to On-Hold status.
+     * Shipments are moved into On-Hold status by ShipBob when we are missing key information like Address or Packaging preferences.
+     * Shipments can also be moved to On-Hold in the Merchant Dashboard. On-Hold Shipments will not be fulfilled.
+     */
+    WebhookTopic["ShipmentOnHold"] = "shipment_onhold";
+    /**
+     * Sends the full shipment payload when a shipment moves to cancelled status.
+     * This webhook subcription will NOT notify you of cancelled split, copied, manual, and excel imported orders.
+     * This functionality will be available on this webhook at a later point.
+     */
+    WebhookTopic["ShipmentCancelled"] = "shipment_cancelled";
+})(WebhookTopic || (exports.WebhookTopic = WebhookTopic = {}));
+//# sourceMappingURL=types.js.map

package/dist/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":";;;AA2lCA,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;AA4TD;;;;GAIG;AACH,IAAY,YA8BX;AA9BD,WAAY,YAAY;IACtB;;;;OAIG;IACH,8CAA8B,CAAA;IAC9B;;;OAGG;IACH,wDAAwC,CAAA;IACxC;;;;OAIG;IACH,wDAAwC,CAAA;IACxC;;;;OAIG;IACH,kDAAkC,CAAA;IAClC;;;;OAIG;IACH,wDAAwC,CAAA;AAC1C,CAAC,EA9BW,YAAY,4BAAZ,YAAY,QA8BvB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shipbob-node-sdk",
-  "version": "0.0.4",
+  "version": "0.0.6",
   "description": "ShipBob API node SDK",
   "types": "dist/index.d.ts",
   "main": "dist/index.js",