@pipedream/proofly 0.0.1 → 0.2.0

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+The Proofly API enables you to create, manage, and deploy social proof notifications on your website to boost conversions. It provides various endpoints that allow you to automate the process of updating notifications based on specific triggers or events. Using Pipedream, you can create workflows that integrate with the Proofly API to dynamically control these notifications, respond to analytics, and sync with your marketing or sales tools to optimize user engagement.
+
+# Example Use Cases
+
+- **Automate Notification Updates Based on User Behavior**: Using Pipedream, you can design a workflow that listens for webhooks from your analytics platform, then triggers Proofly API to update notifications when a user performs a specific action like signing up or completing a purchase.
+
+- **Sync Proofly Campaigns with Email Marketing**: Craft a workflow that ties Proofly notifications with your email campaigns. When a new email subscriber is added to your Mailchimp list, for instance, trigger a Proofly notification on your site to welcome the new subscriber and incentivize further engagement.
+
+- **Aggregate Feedback for A/B Testing**: Assemble a workflow that utilizes Proofly API to switch between different notification designs or messages based on user interaction data piped in from your A/B testing platform. Use this data to determine which notifications are most effective at converting visitors.

package/actions/get-notification-data/get-notification-data.mjs

@@ -0,0 +1,46 @@
+import app from "../../proofly.app.mjs";
+
+export default {
+  key: "proofly-get-notification-data",
+  name: "Get Notification Data",
+  description: "Get data for a notification. [See the documentation here](https://proofly.io/developers)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  type: "action",
+  props: {
+    app,
+    campaignId: {
+      propDefinition: [
+        app,
+        "campaignId",
+      ],
+    },
+    notificationId: {
+      propDefinition: [
+        app,
+        "notificationId",
+        ({ campaignId }) => ({
+          campaignId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      app,
+      notificationId,
+    } = this;
+
+    const response = await app.listData({
+      $,
+      notificationId,
+    });
+
+    $.export("$summary", `Successfully retrieved notification with status \`${response.status}\``);
+    return response;
+  },
+};

package/actions/list-campaign-id-options/list-campaign-id-options.mjs

@@ -0,0 +1,26 @@
+import proofly from "../../proofly.app.mjs";
+
+export default {
+  key: "proofly-list-campaign-id-options",
+  name: "List Campaign ID Options",
+  description: "Retrieves available options for the Campaign ID field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    proofly,
+  },
+  async run({ $ }) {
+    const options = await proofly.propDefinitions.campaignId.options.call(this.proofly, {});
+    $.export("$summary", `Successfully retrieved ${options.length} option${
+      options.length === 1
+        ? ""
+        : "s"
+    }`);
+    return options;
+  },
+};

package/actions/toggle-campaign/toggle-campaign.mjs

@@ -0,0 +1,48 @@
+import app from "../../proofly.app.mjs";
+
+export default {
+  key: "proofly-toggle-campaign",
+  name: "Toggle Campaign Status",
+  description: "Switch a campaign's status between active and inactive. [See the documentation](https://proofly.io/developers)",
+  version: "0.0.2",
+  annotations: {
+    destructiveHint: true,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
+  type: "action",
+  props: {
+    app,
+    campaignId: {
+      propDefinition: [
+        app,
+        "campaignId",
+      ],
+    },
+  },
+  methods: {
+    switchCampaignStatus({
+      campaignId, ...args
+    }) {
+      return this.app.put({
+        path: `/campaign/${campaignId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $ }) {
+    const {
+      campaignId,
+      switchCampaignStatus,
+    } = this;
+
+    const response = await switchCampaignStatus({
+      $,
+      campaignId,
+    });
+
+    $.export("$summary", `Successfully toggled campaign with status \`${response.status}\` and message \`${response.data}\``);
+
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,7 @@
+const BASE_URL = "https://proofly.io";
+const VERSION_PATH = "/api";
+
+export default {
+  BASE_URL,
+  VERSION_PATH,
+};

package/package.json

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

package/proofly.app.mjs

@@ -1,11 +1,95 @@
+import { axios } from "@pipedream/platform";
+import constants from "./common/constants.mjs";
+
 export default {
   type: "app",
   app: "proofly",
-  propDefinitions: {},
+  propDefinitions: {
+    campaignId: {
+      type: "string",
+      label: "Campaign ID",
+      description: "The unique identifier for the campaign",
+      async options() {
+        const { data } = await this.listCampaigns();
+        return data.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+    notificationId: {
+      type: "string",
+      label: "Notification ID",
+      description: "The unique identifier for the notification",
+      async options({ campaignId }) {
+        const { data } = await this.listNotifications({
+          campaignId,
+        });
+        return data.map(({
+          id: value, name: label,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    getUrl(path) {
+      return `${constants.BASE_URL}${constants.VERSION_PATH}${path}`;
+    },
+    getHeaders(headers) {
+      return {
+        ...headers,
+        "X-Api-Key": this.$auth.api_key,
+      };
+    },
+    async _makeRequest({
+      $ = this, path, headers, ...args
+    } = {}) {
+      const config = {
+        ...args,
+        url: this.getUrl(path),
+        headers: this.getHeaders(headers),
+      };
+
+      const response = await axios($, config);
+
+      if (response?.ok !== true) {
+        throw new Error(`Response Error: ${JSON.stringify(response)}`);
+      }
+
+      return response;
+    },
+    put(args = {}) {
+      return this._makeRequest({
+        method: "put",
+        ...args,
+      });
+    },
+    listCampaigns(args = {}) {
+      return this._makeRequest({
+        path: "/campaigns",
+        ...args,
+      });
+    },
+    listNotifications({
+      campaignId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/campaign/${campaignId}`,
+        ...args,
+      });
+    },
+    listData({
+      notificationId, ...args
+    }) {
+      return this._makeRequest({
+        path: `/data/${notificationId}`,
+        ...args,
+      });
     },
   },
-};
+};

package/sources/common/polling.mjs

@@ -0,0 +1,53 @@
+import {
+  ConfigurationError,
+  DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+} from "@pipedream/platform";
+import app from "../../proofly.app.mjs";
+
+export default {
+  props: {
+    app,
+    timer: {
+      type: "$.interface.timer",
+      label: "Polling Schedule",
+      description: "How often to poll the API",
+      default: {
+        intervalSeconds: DEFAULT_POLLING_SOURCE_TIMER_INTERVAL,
+      },
+    },
+  },
+  methods: {
+    generateMeta() {
+      throw new ConfigurationError("generateMeta is not implemented");
+    },
+    getResourceName() {
+      throw new ConfigurationError("getResourceName is not implemented");
+    },
+    getResourcesFn() {
+      throw new ConfigurationError("getResourcesFn is not implemented");
+    },
+    getResourcesFnArgs() {
+      throw new ConfigurationError("getResourcesFnArgs is not implemented");
+    },
+    processResource(resource) {
+      const meta = this.generateMeta(resource);
+      this.$emit(resource, meta);
+    },
+  },
+  async run() {
+    const {
+      getResourcesFn,
+      getResourceName,
+      getResourcesFnArgs,
+      processResource,
+    } = this;
+
+    const resourcesFn = getResourcesFn();
+    const { [getResourceName()]: resources } =
+      await resourcesFn(getResourcesFnArgs());
+
+    Array.from(resources)
+      .reverse()
+      .forEach(processResource);
+  },
+};

package/sources/new-notification-data-created/new-notification-data-created.mjs

@@ -0,0 +1,52 @@
+import common from "../common/polling.mjs";
+
+export default {
+  ...common,
+  key: "proofly-new-notification-data-created",
+  name: "New Notification Data Created",
+  description: "Emit new event when notification data is received. [See the documentation](https://proofly.io/developers)",
+  version: "0.0.1",
+  type: "source",
+  dedupe: "unique",
+  props: {
+    ...common.props,
+    campaignId: {
+      propDefinition: [
+        common.props.app,
+        "campaignId",
+      ],
+    },
+    notificationId: {
+      propDefinition: [
+        common.props.app,
+        "notificationId",
+        ({ campaignId }) => ({
+          campaignId,
+        }),
+      ],
+    },
+  },
+  methods: {
+    ...common.methods,
+    getResourceName() {
+      return "data";
+    },
+    getResourcesFn() {
+      return this.app.listData;
+    },
+    getResourcesFnArgs() {
+      return {
+        debug: true,
+        notificationId: this.notificationId,
+      };
+    },
+    generateMeta(resource) {
+      const ts = Date.parse(resource.date);
+      return {
+        id: ts,
+        summary: "New Notification Data",
+        ts,
+      };
+    },
+  },
+};