UPS - new-tracking-event source (#19124)

* new-tracking-event source

* update baseUrl for production

Author: michelle0927

components/ups/actions/create-shipment/create-shipment.mjs

@@ -5,7 +5,7 @@ export default {
   key: "ups-create-shipment",
   name: "Create Shipment",
   description: "Create a new shipment. [See the documentation](https://developer.ups.com/tag/Shipping?loc=en_US#operation/Shipment)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

components/ups/actions/get-tracking-info/get-tracking-info.mjs

@@ -4,7 +4,7 @@ export default {
   key: "ups-get-tracking-info",
   name: "Get Tracking Info",
   description: "Get tracking information for a UPS tracking number. [See the documentation](https://developer.ups.com/tag/Tracking?loc=en_US#operation/getSingleTrackResponseUsingGET)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

components/ups/actions/recover-label/recover-label.mjs

@@ -4,7 +4,7 @@ export default {
   key: "ups-recover-label",
   name: "Recover Label",
   description: "Recover a label. [See the documentation](https://developer.ups.com/tag/Shipping?loc=en_US#operation/LabelRecovery)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: false,

components/ups/actions/void-shipment/void-shipment.mjs

@@ -4,7 +4,7 @@ export default {
   key: "ups-void-shipment",
   name: "Void Shipment",
   description: "Void a shipment. [See the documentation](https://developer.ups.com/tag/Shipping?loc=en_US#operation/VoidShipment)",
-  version: "0.0.1",
+  version: "0.0.2",
   type: "action",
   annotations: {
     destructiveHint: true,

components/ups/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/ups",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Pipedream UPS Components",
   "main": "ups.app.mjs",
   "keywords": [

components/ups/sources/new-tracking-event/new-tracking-event.mjs

@@ -0,0 +1,71 @@
+import ups from "../../ups.app.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  key: "ups-new-tracking-event",
+  name: "New Tracking Event (Instant)",
+  description: "Emit new event when new tracking activity is detected. [See the documentation](https://developer.ups.com/tag/UPS-Track-Alert?loc=en_US#operation/processSubscriptionTypeForTrackingNumber)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ups,
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    trackingNumbers: {
+      type: "string[]",
+      label: "Tracking Numbers",
+      description: "The tracking numbers of the shipments to track",
+    },
+  },
+  hooks: {
+    async activate() {
+      const response = await this.ups.createSubscription({
+        data: {
+          locale: "en_US",
+          trackingNumberList: this.trackingNumbers,
+          destination: {
+            url: this.http.endpoint,
+            credentialType: "N/A",
+            credential: "N/A",
+          },
+        },
+      });
+
+      if (response?.validTrackingNumbers?.length) {
+        console.log(`Valid tracking numbers: ${response.validTrackingNumbers.join(", ")}`);
+      } else {
+        console.log("No valid tracking numbers");
+      }
+
+      if (response?.invalidTrackingNumbers?.length) {
+        console.log(`Invalid tracking numbers: ${response.invalidTrackingNumbers.join(", ")}`);
+      }
+    },
+  },
+  methods: {
+    generateMeta(event) {
+      return {
+        id: `${event.trackingNumber}${event.gmtActivityDate}${event.gmtActivityTime}`,
+        summary: `New tracking event for ${event.trackingNumber}`,
+        ts: Date.now(),
+      };
+    },
+  },
+  async run(event) {
+    const { body } = event;
+    if (!body) {
+      return;
+    }
+
+    this.http.respond({
+      status: 200,
+    });
+
+    const meta = this.generateMeta(body);
+    this.$emit(body, meta);
+  },
+  sampleEmit,
+};

components/ups/sources/new-tracking-event/test-event.mjs

@@ -0,0 +1,22 @@
+export default {
+  "trackingNumber": "1ZCIETST0111111114",
+  "localActivityDate": "20251118",
+  "localActivityTime": "181553",
+  "activityLocation": {
+    "city": "Nottingham",
+    "stateProvince": "MD",
+    "postalCode": "21236",
+    "country": "US"
+  },
+  "activityStatus": {
+    "type": "D",
+    "code": "FS",
+    "description": "Delivered",
+    "descriptionCode": "011"
+  },
+  "scheduledDeliveryDate": "",
+  "actualDeliveryDate": "20251118",
+  "actualDeliveryTime": "181553",
+  "gmtActivityDate": "20251118",
+  "gmtActivityTime": "231553"
+}

components/ups/ups.app.mjs

@@ -16,6 +16,7 @@ export default {
   methods: {
     _baseUrl() {
       return "https://onlinetools.ups.com/api";
+      //return "https://wwwcie.ups.com/api"; // sandbox URL for testing
     },
     _makeRequest({
       $ = this, path, ...opts
@@ -30,6 +31,13 @@ export default {
         ...opts,
       });
     },
+    createSubscription(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/track/v1/subscription/standard/package",
+        ...opts,
+      });
+    },
     getTrackingInfo({
       trackingNumber, ...opts
     }) {