@pipedream/vero 0.0.1 → 0.1.0

package/actions/create-or-update-user/create-or-update-user.mjs

@@ -0,0 +1,74 @@
+import { ConfigurationError } from "@pipedream/platform";
+import app from "../../vero.app.mjs";
+
+export default {
+  type: "action",
+  key: "vero-create-or-update-user",
+  name: "Create or Update User",
+  version: "0.0.1",
+  description: "This endpoint creates a new user profile if the user doesn't exist yet. Otherwise, the user profile is updated based on the properties provided. [See the documentation](https://developers.getvero.com/track-api-reference/#/operations/identify)",
+  props: {
+    app,
+    id: {
+      propDefinition: [
+        app,
+        "id",
+      ],
+    },
+    email: {
+      propDefinition: [
+        app,
+        "email",
+      ],
+    },
+    channels: {
+      type: "string[]",
+      label: "Channels",
+      description: "A valid JSON array containing hashes of key/value pairs that represent the user's device token. Each hash should represent a single device token and include the fields type, address, and platform.",
+      optional: true,
+    },
+    data: {
+      type: "object",
+      label: "Data",
+      description: "A valid JSON hash containing key value pairs that represent the custom user properties you want to update. The locale, timezone and userAgent attributes are reserved properties that may be updated automatically by our SDKs. You can use these properties but bear in mind they may be overwritten if using our SDKs or integrations. All other keys are freeform and can be defined by you. Ex: `{\"first_name\":\"Damien\",\"last_name\":\"Brzoska\",\"timezone\":-10}`",
+      optional: true,
+    },
+  },
+  methods: {
+    parseChannels(data) {
+      if (!data) {
+        return null;
+      }
+      const parsed = [];
+      for (let i = 0; i < data.length; i++) {
+        let item;
+        try {
+          item = JSON.parse(data[i]);
+        } catch (err) {
+          throw new ConfigurationError(`Invalid JSON in channels property at index ${i}: ${err.message}`);
+        }
+
+        if (Array.isArray(item)) {
+          throw new ConfigurationError(`Invalid JSON in channels property at index ${i}: Expected an object, but received an array. If you want to send multiple items, please create a new child`);
+        }
+
+        parsed.push(item);
+      }
+
+      return parsed;
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      parseChannels,
+      ...rest
+    } = this;
+    const res = await app.createOrUpdateUser({
+      ...rest,
+      channels: parseChannels(rest.channels),
+    });
+    $.export("summary", `User with id "${rest.id}" created or updated successfully`);
+    return res;
+  },
+};

package/actions/track-event-for-user/track-event-for-user.mjs

@@ -0,0 +1,63 @@
+import { ConfigurationError } from "@pipedream/platform";
+import app from "../../vero.app.mjs";
+
+export default {
+  type: "action",
+  key: "vero-track-event-for-user",
+  name: "Track Event for User",
+  version: "0.0.1",
+  description: "This endpoint tracks an event for a specific user. If the user profile doesn't exist Vero will create it. [See the documentation](https://developers.getvero.com/track-api-reference/#/operations/track)",
+  props: {
+    app,
+    id: {
+      propDefinition: [
+        app,
+        "id",
+      ],
+      description: "The unique identifier of the customer. You must provider either `id` or `email`.",
+      optional: true,
+    },
+    email: {
+      propDefinition: [
+        app,
+        "email",
+      ],
+      description: "The email address of the customer. You must provider either `id` or `email`.",
+      optional: true,
+    },
+    eventName: {
+      type: "string",
+      label: "Event Name",
+      description: "The name of the event tracked.",
+    },
+    data: {
+      type: "object",
+      label: "Data",
+      description: "A valid JSON hash containing key value pairs that represent the custom user properties you want to track with the event. All keys are freeform and can be defined by you.",
+      optional: true,
+    },
+    extras: {
+      type: "object",
+      label: "Extras",
+      description: "A valid JSON hash containing key/value pairs that represent the reserved, Vero-specific `created_at` and `source` properties.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    if (!this.id && !this.email) {
+      throw new ConfigurationError("You must provide either an `id` or an `email` to create or update a user");
+    }
+
+    const res = await this.app.trackEventForUser({
+      identity: {
+        id: this.id,
+        email: this.email,
+      },
+      event_name: this.eventName,
+      data: this.data,
+      extras: this.extras,
+    });
+    $.export("summary", `Track successfully create for user ${this.id || this.email}`);
+    return res;
+  },
+};

package/package.json

@@ -1,15 +1,12 @@
 {
   "name": "@pipedream/vero",
-  "version": "0.0.1",
+  "version": "0.1.0",
   "description": "Pipedream Vero Components",
   "main": "dist/app/vero.app.mjs",
   "keywords": [
     "pipedream",
     "vero"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/vero",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
   "publishConfig": {

package/vero.app.mjs

@@ -0,0 +1,51 @@
+import { axios } from "@pipedream/platform";
+
+export default {
+  type: "app",
+  app: "vero",
+  propDefinitions: {
+    id: {
+      type: "string",
+      label: "ID",
+      description: "The unique identifier of the customer.",
+    },
+    email: {
+      type: "string",
+      label: "Email",
+      description: "The email address of the customer.",
+    },
+  },
+  methods: {
+    _getAuthToken() {
+      return this.$auth.auth_token;
+    },
+    _getBaseUrl() {
+      return "https://api.getvero.com/api/v2";
+    },
+    async _makeHttpRequest(opts = {}, ctx = this) {
+      const axiosOpts = {
+        ...opts,
+        url: this._getBaseUrl() + opts.path,
+        params: {
+          ...opts.params,
+          auth_token: this._getAuthToken(),
+        },
+      };
+      return axios(ctx, axiosOpts);
+    },
+    async createOrUpdateUser(data) {
+      return this._makeHttpRequest({
+        method: "POST",
+        path: "/users/track",
+        data,
+      });
+    },
+    async trackEventForUser(data) {
+      return this._makeHttpRequest({
+        method: "POST",
+        path: "/events/track",
+        data,
+      });
+    },
+  },
+};