@pipedream/samsara 0.0.1 → 0.1.0

package/actions/create-address/create-address.mjs

@@ -0,0 +1,109 @@
+import { ConfigurationError } from "@pipedream/platform";
+import {
+  cleanObject,
+  parseObject,
+} from "../../common/utils.mjs";
+import samsara from "../../samsara.app.mjs";
+
+export default {
+  key: "samsara-create-address",
+  name: "Create Address",
+  description: "Adds a new address to the organization. The user must provide the necessary props such as formatted address, geofence, and name. [See the documentation](https://developers.samsara.com/reference/createaddress)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    samsara,
+    addressTypes: {
+      type: "string[]",
+      label: "Address Types",
+      description: "Reporting location type associated with the address (used for ELD reporting purposes).",
+      options: [
+        "yard",
+        "shortHaul",
+        "workforceSite",
+        "riskZone",
+        "industrialSite",
+        "alertsOnly",
+      ],
+      optional: true,
+    },
+    contactIds: {
+      propDefinition: [
+        samsara,
+        "contactIds",
+      ],
+      optional: true,
+    },
+    externalIds: {
+      propDefinition: [
+        samsara,
+        "externalIds",
+      ],
+      optional: true,
+    },
+    formattedAddress: {
+      type: "string",
+      label: "Formatted Address",
+      description: "The full street address for this address/geofence, as it might be recognized by Google Maps.",
+    },
+    geofence: {
+      type: "object",
+      label: "Geofence",
+      description: "The geofence that defines this address and its bounds. This can either be a circle or a polygon, but not both. [See the documentation](https://developers.samsara.com/reference/createaddress)",
+    },
+    latitude: {
+      type: "string",
+      label: "Latitude",
+      description: "Latitude of the address. Will be geocoded from **Formatted Address** if not provided.",
+      optional: true,
+    },
+    longitude: {
+      type: "string",
+      label: "Longitude",
+      description: "Longitude of the address. Will be geocoded from **Formatted Address** if not provided.",
+      optional: true,
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name of the address.",
+    },
+    notes: {
+      type: "string",
+      label: "Notes",
+      description: "Notes about the address.",
+    },
+    tagIds: {
+      propDefinition: [
+        samsara,
+        "tagIds",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    try {
+      const response = await this.samsara.createAddress({
+        $,
+        data: cleanObject({
+          addressTypes: parseObject(this.addressTypes),
+          contactIds: parseObject(this.contactIds),
+          externalIds: parseObject(this.externalIds),
+          formattedAddress: this.formattedAddress,
+          geofence: parseObject(this.geofence),
+          latitude: this.latitude,
+          longitude: this.longitude,
+          name: this.name,
+          notes: this.notes,
+          tagIds: parseObject(this.tagIds),
+        }),
+      });
+
+      $.export("$summary", `Successfully created address with name Id: ${response.data?.id}`);
+      return response;
+
+    } catch (error) {
+      throw new ConfigurationError(JSON.parse(error.message).message);
+    }
+  },
+};

package/actions/create-contact/create-contact.mjs

@@ -0,0 +1,54 @@
+import { ConfigurationError } from "@pipedream/platform";
+import samsara from "../../samsara.app.mjs";
+
+export default {
+  key: "samsara-create-contact",
+  name: "Create Contact",
+  description: "Adds a new contact to the organization. [See the documentation](https://developers.samsara.com/reference/createcontact)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    samsara,
+    firstName: {
+      type: "string",
+      label: "First Name",
+      description: "First name of the contact.",
+      optional: true,
+    },
+    lastName: {
+      type: "string",
+      label: "Last Name",
+      description: "Last name of the contact.",
+      optional: true,
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "Email address of the contact.",
+      optional: true,
+    },
+    phone: {
+      type: "string",
+      label: "Phone Number",
+      description: "Phone number of the contact.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    if (!this.email && !this.phone) {
+      throw new ConfigurationError("Either Email or Phone Number must be provided.");
+    }
+
+    const response = await this.samsara.createContact({
+      $,
+      data: {
+        firstName: this.firstName,
+        lastName: this.lastName,
+        email: this.email,
+        phone: this.phone,
+      },
+    });
+    $.export("$summary", `Successfully created contact ${this.firstName} ${this.lastName}`);
+    return response;
+  },
+};

package/actions/create-route/create-route.mjs

@@ -0,0 +1,95 @@
+import { ConfigurationError } from "@pipedream/platform";
+import { parseObject } from "../../common/utils.mjs";
+import samsara from "../../samsara.app.mjs";
+
+export default {
+  key: "samsara-create-route",
+  name: "Create Route",
+  description: "Generates a new route to an existing address. As a prerequisite, the user must create an address using the 'create-address' action if the location is not already available in the address book. The user must provide the necessary props such as destination address.",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    samsara,
+    driverId: {
+      propDefinition: [
+        samsara,
+        "driverId",
+      ],
+      optional: true,
+    },
+    externalIds: {
+      propDefinition: [
+        samsara,
+        "externalIds",
+      ],
+      optional: true,
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Name for the route",
+    },
+    notes: {
+      type: "string",
+      label: "Notes",
+      description: "Notes about the route.",
+      optional: true,
+    },
+    routeCompletionCondition: {
+      type: "string",
+      label: "Route Completion Condition",
+      description: "Defaults to 'arriveLastStop' which ends the route upon arriving at the final stop. The condition 'departLastStop' ends the route upon departing the last stop. If 'arriveLastStop' is set, then the departure time of the final stop should not be set.",
+      options: [
+        "arriveLastStop",
+        "departLastStop",
+      ],
+      optional: true,
+    },
+    routeStartingCondition: {
+      type: "string",
+      label: "Route Starting Condition",
+      description: "Defaults to 'departFirstStop' which starts the route upon departing the first stop in the route. The condition 'arriveFirstStop' starts the route upon arriving at the first stop in the route. If 'departFirstStop' is set, the arrival time of the first stop should not be set.",
+      options: [
+        "departFirstStop",
+        "arriveFirstStop",
+      ],
+      optional: true,
+    },
+    stops: {
+      type: "object",
+      label: "Stops",
+      description: "List of objects of stops along the route. For each stop, exactly one of addressId and singleUseLocation are required. Depending on the settings on your route, either a scheduledArrivalTime or scheduledDepartureTime must be specified for the first job. [See further information](https://developers.samsara.com/reference/createroute)",
+    },
+    vehicleId: {
+      propDefinition: [
+        samsara,
+        "vehicleId",
+      ],
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    try {
+      const response = await this.samsara.createRoute({
+        $,
+        data: {
+          driverId: this.driverId,
+          externalIds: parseObject(this.externalIds),
+          name: this.name,
+          notes: this.notes,
+          settings: {
+            routeCompletionCondition: this.routeCompletionCondition,
+            routeStartingCondition: this.routeStartingCondition,
+          },
+          stops: parseObject(this.stops),
+          vehicleId: this.vehicleId,
+        },
+      });
+
+      $.export("$summary", `Successfully created a new route with Id: ${response.data?.id}`);
+      return response;
+    } catch ({ message }) {
+      throw new ConfigurationError(JSON.parse(message).message);
+    }
+  },
+};

package/common/utils.mjs

@@ -0,0 +1,33 @@
+export const parseObject = (obj) => {
+  if (!obj) return undefined;
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => {
+      if (typeof item === "string") {
+        try {
+          return JSON.parse(item);
+        } catch (e) {
+          return item;
+        }
+      }
+      return item;
+    });
+  }
+  if (typeof obj === "string") {
+    try {
+      return JSON.parse(obj);
+    } catch (e) {
+      return obj;
+    }
+  }
+  return obj;
+};
+
+export const cleanObject = (o) => {
+  for (let k in o || {}) {
+    if (typeof o[k] === "undefined") {
+      delete o[k];
+    }
+  }
+  return o;
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/samsara",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Samsara Components",
   "main": "samsara.app.mjs",
   "keywords": [
@@ -11,5 +11,8 @@
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^2.0.0"
   }
 }

package/samsara.app.mjs

@@ -1,11 +1,164 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "samsara",
-  propDefinitions: {},
+  propDefinitions: {
+    contactIds: {
+      type: "string[]",
+      label: "Contact Ids",
+      description: "An array of Contact IDs associated with this Address.",
+      async options({ page }) {
+        const { data } = await this.listContacts({
+          params: {
+            page,
+          },
+        });
+
+        return data.map((contact) => ({
+          label: `${contact.firstName} ${contact.lastName}` || contact.email || contact.phone,
+          value: contact.id,
+        }));
+      },
+    },
+    driverId: {
+      type: "string",
+      label: "Driver Id",
+      description: "ID of the driver.",
+      async options({ page }) {
+        const { data } = await this.listDrivers({
+          params: {
+            page,
+          },
+        });
+
+        return data.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    tagIds: {
+      type: "string[]",
+      label: "Tag Ids",
+      description: "An array of IDs of tags to associate with this address.",
+      async options({ page }) {
+        const { data } = await this.listTags({
+          params: {
+            page,
+          },
+        });
+
+        return data.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    vehicleId: {
+      type: "string",
+      label: "Vehicle Id",
+      description: "ID of the vehicle.",
+      async options({ page }) {
+        const { data } = await this.listVehicles({
+          params: {
+            page,
+          },
+        });
+
+        return data.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    externalIds: {
+      type: "object",
+      label: "External Ids",
+      description: "The external IDs for the given object.",
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.samsara.com";
+    },
+    _headers() {
+      return {
+        Authorization: `Bearer ${this.$auth.api_token}`,
+      };
+    },
+    _makeRequest({
+      $ = this, path, ...opts
+    }) {
+      return axios($, {
+        url: this._baseUrl() + path,
+        headers: this._headers(),
+        ...opts,
+      });
+    },
+    createContact(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/contacts",
+        ...opts,
+      });
+    },
+    listContacts(opts = {}) {
+      return this._makeRequest({
+        path: "/contacts",
+        ...opts,
+      });
+    },
+    listDrivers(opts = {}) {
+      return this._makeRequest({
+        path: "/fleet/drivers",
+        ...opts,
+      });
+    },
+    listTags(opts = {}) {
+      return this._makeRequest({
+        path: "/tags",
+        ...opts,
+      });
+    },
+    listVehicles(opts = {}) {
+      return this._makeRequest({
+        path: "/fleet/vehicles",
+        ...opts,
+      });
+    },
+    createAddress(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/addresses",
+        ...opts,
+      });
+    },
+    createRoute(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/fleet/routes",
+        ...opts,
+      });
+    },
+    createWebhook(opts = {}) {
+      return this._makeRequest({
+        method: "POST",
+        path: "/webhooks",
+        ...opts,
+      });
+    },
+    deleteWebhook(webhookId) {
+      return this._makeRequest({
+        method: "DELETE",
+        path: `/webhooks/${webhookId}`,
+      });
     },
   },
-};
+};

package/sources/common/base.mjs

@@ -0,0 +1,61 @@
+import samsara from "../../samsara.app.mjs";
+
+export default {
+  props: {
+    samsara,
+    db: "$.service.db",
+    http: {
+      type: "$.interface.http",
+      customResponse: true,
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "The name of the webhook. This will appear in both Samsara's cloud dashboard and the API. It can be set or updated through the Samsara Dashboard or through the API at any time.",
+    },
+  },
+  methods: {
+    getWebhookProps() {
+      return {};
+    },
+    _setHookId(hookId) {
+      this.db.set("hookId", hookId);
+    },
+    _getHookId() {
+      return this.db.get("hookId");
+    },
+    checkEvent() {
+      return true;
+    },
+  },
+  hooks: {
+    async activate() {
+      const webhook = await this.samsara.createWebhook({
+        data: {
+          name: this.name,
+          url: this.http.endpoint,
+          eventTypes: this.getEventTypes(),
+        },
+      });
+      this._setHookId(webhook.id);
+    },
+    async deactivate() {
+      const hookId = this._getHookId();
+      return await this.samsara.deleteWebhook(hookId);
+    },
+  },
+  async run({ body }) {
+    this.http.respond({
+      status: 200,
+    });
+
+    if (this.checkEvent(body)) {
+      this.$emit(body, {
+        id: body.eventId,
+        summary: this.getSummary(body),
+        ts: body.eventTime,
+      });
+    }
+
+  },
+};

package/sources/new-document-submitted-instant/new-document-submitted-instant.mjs

@@ -0,0 +1,27 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "samsara-new-document-submitted-instant",
+  name: "New Document Submitted (Instant)",
+  description: "Emit new event when a document is submitted.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+  },
+  methods: {
+    ...common.methods,
+    getEventTypes() {
+      return [
+        "DocumentSubmitted",
+      ];
+    },
+    getSummary({ data }) {
+      return `New document with Id: ${data.document.id} successfully submitted!`;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-document-submitted-instant/test-event.mjs

@@ -0,0 +1,224 @@
+export default {
+  "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
+  "eventTime": "1970-01-20T06:39:05.683Z",
+  "eventType": "DocumentSubmitted",
+  "orgId": 20936,
+  "webhookId": "1411751028848270",
+  "data": {
+      "document": {
+          "conditionalFieldSections": [
+              {
+                  "conditionalFieldFirstIndex": 5083143870897228000,
+                  "conditionalFieldLastIndex": 2770896918544835600,
+                  "triggeringFieldIndex": 8389989517472915000,
+                  "triggeringFieldValue": "Optiona 1"
+              },
+              {
+                  "conditionalFieldFirstIndex": 5083143870897228000,
+                  "conditionalFieldLastIndex": 2770896918544835600,
+                  "triggeringFieldIndex": 8389989517472915000,
+                  "triggeringFieldValue": "Optiona 1"
+              },
+              {
+                  "conditionalFieldFirstIndex": 5083143870897228000,
+                  "conditionalFieldLastIndex": 2770896918544835600,
+                  "triggeringFieldIndex": 8389989517472915000,
+                  "triggeringFieldValue": "Optiona 1"
+              }
+          ],
+          "createdAtTime": "1976-03-06T08:22:53Z",
+          "documentType": {
+              "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
+              "name": "Fleet Truck List"
+          },
+          "fields": [
+              {
+                  "label": "Load weight",
+                  "type": "photo",
+                  "value": {
+                      "barcodeValue": [
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          },
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          },
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          },
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          }
+                      ],
+                      "dateTimeValue": {
+                          "dateTime": "1984-10-23T07:14:29Z"
+                      },
+                      "multipleChoiceValue": [
+                          {
+                              "selected": false,
+                              "value": "Yes"
+                          },
+                          {
+                              "selected": false,
+                              "value": "Yes"
+                          },
+                          {
+                              "selected": false,
+                              "value": "Yes"
+                          }
+                      ],
+                      "numberValue": 123.456,
+                      "photoValue": [
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          },
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          }
+                      ],
+                      "scannedDocumentValue": [
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          },
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          },
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          }
+                      ],
+                      "signatureValue": {
+                          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
+                          "name": "John Smith",
+                          "signedAtTime": "1996-01-30T06:14:20Z",
+                          "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                      },
+                      "stringValue": "Red Truck"
+                  }
+              },
+              {
+                  "label": "Load weight",
+                  "type": "photo",
+                  "value": {
+                      "barcodeValue": [
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          },
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          },
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          },
+                          {
+                              "barcodeType": "org.gs1.EAN-13",
+                              "barcodeValue": "0853883003114"
+                          }
+                      ],
+                      "dateTimeValue": {
+                          "dateTime": "1984-10-23T07:14:29Z"
+                      },
+                      "multipleChoiceValue": [
+                          {
+                              "selected": false,
+                              "value": "Yes"
+                          },
+                          {
+                              "selected": false,
+                              "value": "Yes"
+                          },
+                          {
+                              "selected": false,
+                              "value": "Yes"
+                          }
+                      ],
+                      "numberValue": 123.456,
+                      "photoValue": [
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          },
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          }
+                      ],
+                      "scannedDocumentValue": [
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          },
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          },
+                          {
+                              "id": "f5271458-21f9-4a9f-a290-780c6d8840ff",
+                              "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                          }
+                      ],
+                      "signatureValue": {
+                          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
+                          "name": "John Smith",
+                          "signedAtTime": "1996-01-30T06:14:20Z",
+                          "url": "https://samsara-driver-media-upload.s3.us-west-2.amazonaws.com/123456"
+                      },
+                      "stringValue": "Red Truck"
+                  }
+              }
+          ],
+          "id": "9814a1fa-f0c6-408b-bf85-51dc3bc71ac7",
+          "name": "Dropoff Slip 123",
+          "notes": "Missing a crate",
+          "route": {
+              "externalIds": {
+                  "myRouteId": "abc"
+              },
+              "id": "131313",
+              "name": "Pineapple delivery"
+          },
+          "routeStop": {
+              "externalIds": {
+                  "siteId": "54"
+              },
+              "id": "494123",
+              "name": "Company Warehouse #1"
+          },
+          "state": "submitted",
+          "updatedAtTime": "2009-01-10T02:28:18Z"
+      },
+      "driver": {
+          "externalIds": {
+              "payrollId": "ABFS18600"
+          },
+          "id": "45646",
+          "name": "Driver Bob"
+      },
+      "vehicle": {
+          "assetType": "vehicle",
+          "externalIds": {
+              "maintenanceId": "250020"
+          },
+          "gateway": {
+              "model": "VG34",
+              "serial": "GFRV-43N-VGX"
+          },
+          "id": "494123",
+          "licensePlate": "6SAM123",
+          "name": "Fleet Truck #1",
+          "vin": "1GBJ6P1B2HV112765"
+      }
+  }
+}

package/sources/new-route-job-completion-instant/new-route-job-completion-instant.mjs

@@ -0,0 +1,35 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "samsara-new-route-job-completion-instant",
+  name: "New Route Job Completion (Instant)",
+  description: "Emit new event when a job is completed on a Samsara route.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+  },
+  methods: {
+    ...common.methods,
+    getEventTypes() {
+      return [
+        "RouteStopDeparture",
+        "RouteStopArrival",
+      ];
+    },
+    getSummary({ data }) {
+      return `Route ${data.route.name} successfully completed.`;
+    },
+    checkEvent({ data }) {
+      const filteredStops = data.route.stops.filter((stop) => {
+        return stop.state != "departed";
+      });
+
+      return !filteredStops.length;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-route-job-completion-instant/test-event.mjs

@@ -0,0 +1,217 @@
+export default {
+    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
+    "eventTime": "1970-01-20T06:39:05.683Z",
+    "eventType": "RouteStopArrival",
+    "orgId": 20936,
+    "webhookId": "1411751028848270",
+    "data": {
+        "driver": {
+            "externalIds": {
+                "payrollId": "ABFS18600"
+            },
+            "id": "45646",
+            "name": "Driver Bob"
+        },
+        "operation": "stop arrived",
+        "route": {
+            "actualRouteEndTime": "2019-06-13T19:08:25Z",
+            "actualRouteStartTime": "2019-06-13T19:08:25Z",
+            "externalIds": {
+                "myRouteId": "abc"
+            },
+            "id": "342341",
+            "name": "Bid 123",
+            "notes": "These are my notes",
+            "scheduledRouteEndTime": "2019-06-13T19:08:25Z",
+            "scheduledRouteStartTime": "2019-06-13T19:08:25Z",
+            "settings": {
+                "routeCompletionCondition": "arriveLastStop",
+                "routeStartingCondition": "departFirstStop"
+            },
+            "stops": [
+                {
+                    "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+                    "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+                    "address": {
+                        "externalIds": {
+                            "siteId": "54"
+                        },
+                        "id": "494123",
+                        "name": "Company Office #1"
+                    },
+                    "documents": [
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        },
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        }
+                    ],
+                    "enRouteTime": "2006-01-02T15:04:05+07:00",
+                    "eta": "2006-01-02T15:04:05+07:00",
+                    "externalIds": {
+                        "siteId": "54"
+                    },
+                    "id": "324231",
+                    "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+                    "locationLiveSharingLinks": [
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        },
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        }
+                    ],
+                    "name": "Stop #1",
+                    "notes": "These are my notes",
+                    "scheduledArrivalTime": "2019-06-13T19:08:25Z",
+                    "scheduledDepartureTime": "2019-06-13T19:08:25Z",
+                    "singleUseLocation": {
+                        "address": "1234 Main St, San Jose, CA",
+                        "latitude": 123.456,
+                        "longitude": 37.459
+                    },
+                    "skippedTime": "2006-01-02T15:04:05+07:00",
+                    "state": "scheduled"
+                },
+                {
+                    "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+                    "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+                    "address": {
+                        "externalIds": {
+                            "siteId": "54"
+                        },
+                        "id": "494123",
+                        "name": "Company Office #1"
+                    },
+                    "documents": [
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        },
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        }
+                    ],
+                    "enRouteTime": "2006-01-02T15:04:05+07:00",
+                    "eta": "2006-01-02T15:04:05+07:00",
+                    "externalIds": {
+                        "siteId": "54"
+                    },
+                    "id": "324231",
+                    "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+                    "locationLiveSharingLinks": [
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        },
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        }
+                    ],
+                    "name": "Stop #1",
+                    "notes": "These are my notes",
+                    "scheduledArrivalTime": "2019-06-13T19:08:25Z",
+                    "scheduledDepartureTime": "2019-06-13T19:08:25Z",
+                    "singleUseLocation": {
+                        "address": "1234 Main St, San Jose, CA",
+                        "latitude": 123.456,
+                        "longitude": 37.459
+                    },
+                    "skippedTime": "2006-01-02T15:04:05+07:00",
+                    "state": "scheduled"
+                },
+                {
+                    "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+                    "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+                    "address": {
+                        "externalIds": {
+                            "siteId": "54"
+                        },
+                        "id": "494123",
+                        "name": "Company Office #1"
+                    },
+                    "documents": [
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        },
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        }
+                    ],
+                    "enRouteTime": "2006-01-02T15:04:05+07:00",
+                    "eta": "2006-01-02T15:04:05+07:00",
+                    "externalIds": {
+                        "siteId": "54"
+                    },
+                    "id": "324231",
+                    "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+                    "locationLiveSharingLinks": [
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        },
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        }
+                    ],
+                    "name": "Stop #1",
+                    "notes": "These are my notes",
+                    "scheduledArrivalTime": "2019-06-13T19:08:25Z",
+                    "scheduledDepartureTime": "2019-06-13T19:08:25Z",
+                    "singleUseLocation": {
+                        "address": "1234 Main St, San Jose, CA",
+                        "latitude": 123.456,
+                        "longitude": 37.459
+                    },
+                    "skippedTime": "2006-01-02T15:04:05+07:00",
+                    "state": "scheduled"
+                }
+            ]
+        },
+        "routeStopDetails": {
+            "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+            "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+            "enRouteTime": "2006-01-02T15:04:05+07:00",
+            "eta": "2006-01-02T15:04:05+07:00",
+            "externalIds": {
+                "siteId": "54"
+            },
+            "id": "141414",
+            "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+            "skippedTime": "2006-01-02T15:04:05+07:00",
+            "state": "scheduled"
+        },
+        "time": "2020-01-27T07:06:25Z",
+        "type": "route tracking",
+        "vehicle": {
+            "assetType": "vehicle",
+            "externalIds": {
+                "maintenanceId": "250020"
+            },
+            "gateway": {
+                "model": "VG34",
+                "serial": "GFRV-43N-VGX"
+            },
+            "id": "494123",
+            "licensePlate": "6SAM123",
+            "name": "Fleet Truck #1",
+            "vin": "1GBJ6P1B2HV112765"
+        }
+    }
+}

package/sources/new-route-started-instant/new-route-started-instant.mjs

@@ -0,0 +1,34 @@
+import common from "../common/base.mjs";
+import sampleEmit from "./test-event.mjs";
+
+export default {
+  ...common,
+  key: "samsara-new-route-started-instant",
+  name: "New Route Started (Instant)",
+  description: "Emit new event when a new route is stated.",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+  },
+  methods: {
+    ...common.methods,
+    getEventTypes() {
+      return [
+        "RouteStopDeparture",
+      ];
+    },
+    getSummary({ data }) {
+      return `New route with Id: ${data.route.id} successfully started!`;
+    },
+    checkEvent({ data }) {
+      const filteredStops = data.route.stops.filter((stop) => {
+        return stop.state === "departed";
+      });
+
+      return filteredStops.length === 1;
+    },
+  },
+  sampleEmit,
+};

package/sources/new-route-started-instant/test-event.mjs

@@ -0,0 +1,217 @@
+export default {
+    "eventId": "017db07f-6e95-470e-8cc0-a371f9deed2b",
+    "eventTime": "1970-01-20T06:39:05.683Z",
+    "eventType": "RouteStopDeparture",
+    "orgId": 20936,
+    "webhookId": "1411751028848270",
+    "data": {
+        "driver": {
+            "externalIds": {
+                "payrollId": "ABFS18600"
+            },
+            "id": "45646",
+            "name": "Driver Bob"
+        },
+        "operation": "stop arrived",
+        "route": {
+            "actualRouteEndTime": "2019-06-13T19:08:25Z",
+            "actualRouteStartTime": "2019-06-13T19:08:25Z",
+            "externalIds": {
+                "myRouteId": "abc"
+            },
+            "id": "342341",
+            "name": "Bid 123",
+            "notes": "These are my notes",
+            "scheduledRouteEndTime": "2019-06-13T19:08:25Z",
+            "scheduledRouteStartTime": "2019-06-13T19:08:25Z",
+            "settings": {
+                "routeCompletionCondition": "arriveLastStop",
+                "routeStartingCondition": "departFirstStop"
+            },
+            "stops": [
+                {
+                    "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+                    "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+                    "address": {
+                        "externalIds": {
+                            "siteId": "54"
+                        },
+                        "id": "494123",
+                        "name": "Company Office #1"
+                    },
+                    "documents": [
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        },
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        }
+                    ],
+                    "enRouteTime": "2006-01-02T15:04:05+07:00",
+                    "eta": "2006-01-02T15:04:05+07:00",
+                    "externalIds": {
+                        "siteId": "54"
+                    },
+                    "id": "324231",
+                    "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+                    "locationLiveSharingLinks": [
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        },
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        }
+                    ],
+                    "name": "Stop #1",
+                    "notes": "These are my notes",
+                    "scheduledArrivalTime": "2019-06-13T19:08:25Z",
+                    "scheduledDepartureTime": "2019-06-13T19:08:25Z",
+                    "singleUseLocation": {
+                        "address": "1234 Main St, San Jose, CA",
+                        "latitude": 123.456,
+                        "longitude": 37.459
+                    },
+                    "skippedTime": "2006-01-02T15:04:05+07:00",
+                    "state": "scheduled"
+                },
+                {
+                    "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+                    "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+                    "address": {
+                        "externalIds": {
+                            "siteId": "54"
+                        },
+                        "id": "494123",
+                        "name": "Company Office #1"
+                    },
+                    "documents": [
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        },
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        }
+                    ],
+                    "enRouteTime": "2006-01-02T15:04:05+07:00",
+                    "eta": "2006-01-02T15:04:05+07:00",
+                    "externalIds": {
+                        "siteId": "54"
+                    },
+                    "id": "324231",
+                    "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+                    "locationLiveSharingLinks": [
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        },
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        }
+                    ],
+                    "name": "Stop #1",
+                    "notes": "These are my notes",
+                    "scheduledArrivalTime": "2019-06-13T19:08:25Z",
+                    "scheduledDepartureTime": "2019-06-13T19:08:25Z",
+                    "singleUseLocation": {
+                        "address": "1234 Main St, San Jose, CA",
+                        "latitude": 123.456,
+                        "longitude": 37.459
+                    },
+                    "skippedTime": "2006-01-02T15:04:05+07:00",
+                    "state": "scheduled"
+                },
+                {
+                    "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+                    "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+                    "address": {
+                        "externalIds": {
+                            "siteId": "54"
+                        },
+                        "id": "494123",
+                        "name": "Company Office #1"
+                    },
+                    "documents": [
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        },
+                        {
+                            "id": "494123",
+                            "name": "Fuel Receipt Wichita"
+                        }
+                    ],
+                    "enRouteTime": "2006-01-02T15:04:05+07:00",
+                    "eta": "2006-01-02T15:04:05+07:00",
+                    "externalIds": {
+                        "siteId": "54"
+                    },
+                    "id": "324231",
+                    "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+                    "locationLiveSharingLinks": [
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        },
+                        {
+                            "expiresAtTime": "2020-01-27T07:06:25Z",
+                            "liveSharingUrl": "https://cloud.samsara.com/o/123456/fleet/viewer/address/gEAitEnnOwcv92cuPzcU",
+                            "name": "Name"
+                        }
+                    ],
+                    "name": "Stop #1",
+                    "notes": "These are my notes",
+                    "scheduledArrivalTime": "2019-06-13T19:08:25Z",
+                    "scheduledDepartureTime": "2019-06-13T19:08:25Z",
+                    "singleUseLocation": {
+                        "address": "1234 Main St, San Jose, CA",
+                        "latitude": 123.456,
+                        "longitude": 37.459
+                    },
+                    "skippedTime": "2006-01-02T15:04:05+07:00",
+                    "state": "scheduled"
+                }
+            ]
+        },
+        "routeStopDetails": {
+            "actualArrivalTime": "2006-01-02T15:04:05+07:00",
+            "actualDepartureTime": "2006-01-02T15:04:05+07:00",
+            "enRouteTime": "2006-01-02T15:04:05+07:00",
+            "eta": "2006-01-02T15:04:05+07:00",
+            "externalIds": {
+                "siteId": "54"
+            },
+            "id": "141414",
+            "liveSharingUrl": "https://cloud.samsara.com/fleet/viewer/job/fleet_viewer_token",
+            "skippedTime": "2006-01-02T15:04:05+07:00",
+            "state": "scheduled"
+        },
+        "time": "2020-01-27T07:06:25Z",
+        "type": "route tracking",
+        "vehicle": {
+            "assetType": "vehicle",
+            "externalIds": {
+                "maintenanceId": "250020"
+            },
+            "gateway": {
+                "model": "VG34",
+                "serial": "GFRV-43N-VGX"
+            },
+            "id": "494123",
+            "licensePlate": "6SAM123",
+            "name": "Fleet Truck #1",
+            "vin": "1GBJ6P1B2HV112765"
+        }
+    }
+}