@pipedream/voilanorbert 0.0.1 → 0.0.3

package/LICENSE

@@ -1,7 +1,41 @@
-Copyright 2020 Pipedream, Inc.
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+Pipedream Source Available License Version 1.0
+ 
+This Pipedream Source Available License Agreement Version 1.0 (this “Agreement”) sets forth the terms on which Pipedream, Inc., a Delaware corporation (“Pipedream”) makes available certain software (the “Software”). By installing, downloading, accessing, using or distributing the Software, you agree to the terms of this Agreement. If you do not agree to such terms, you must not use the Software. If you are receiving the Software on behalf of a legal entity, you represent and warrant that you have the actual authority to agree to the terms and conditions of this Agreement on behalf of such entity. “Licensee” means you, an individual, or the entity on whose behalf you are receiving the Software.
+ 
+LICENSE GRANT AND CONDITIONS.
+ 
+1.1  License. Subject to the terms and conditions of this Agreement, Pipedream hereby grants to Licensee a non-exclusive, royalty-free, worldwide, non-transferable, non-sublicenseable license during the term of this Agreement to use, prepare modifications and derivative works, distribute (including without limitation in source code or object code form) and reproduce copies of the Software (the “License”). Licensee is not granted the right to, and Licensee shall not, exercise the License for an Excluded Purpose. For purposes of this Agreement, “Excluded Purpose” means any commercial use of the software including, but not limited to, making available any software-as-a-service, platform-as-a-service, infrastructure-as-a-service or other online service that competes with the Software or any other Pipedream products or services.
+ 
+1.2  Conditions. In consideration of the License, Licensee’s distribution of the Software is subject to the following conditions:
+ 
+a. Licensee must cause any Software modified by Licensee to carry prominent notices stating that Licensee modified the Software.
+ 
+b. On each Software copy, Licensee shall reproduce and not remove or alter all Pipedream or third party copyright or other proprietary notices contained in the Software, and Licensee must provide this with each copy: “This software is made available by Pipedream, Inc., under the terms of the Pipedream Source Available License, Version 1.0 located at https://github.com/PipedreamHQ/pipedream/blob/master/LICENSE. By installing, downloading, accessing, using or distributing the Software, you agree to the terms of such License Agreement.”
+ 
+1.3  Modifications. Licensee may add its own copyright notices to modifications made by Licensee and may provide additional or different license terms and conditions for use, reproduction, or distribution of Licensee’s modifications. While redistributing the Software or modifications thereof, Licensee may choose to offer, for a fee or free of charge, support, warranty, indemnity, or other obligations. Licensee, and not Pipedream, will be responsible for any such obligations.
+ 
+1.4  No Sublicensing. The License does not include the right to sublicense the Software; provided, however, that any recipient to which Licensee provides the Software may exercise the License so long as such recipient agrees to the terms and conditions of this Agreement.
+ 
+TERM AND TERMINATION.
+ 
+This Agreement will continue unless and until earlier terminated as set forth herein. If Licensee breaches any of its conditions or obligations under this Agreement, this Agreement will terminate automatically and the License will terminate automatically and permanently.
+ 
+INTELLECTUAL PROPERTY.
+ 
+As between the parties, Pipedream retains all right, title, and interest in the Software, and all intellectual property rights therein. Pipedream hereby reserves all rights not expressly granted to Licensee in this Agreement. Pipedream reserves all rights in its trademarks and service marks, and no licenses thereto are granted by this Agreement.
+ 
+DISCLAIMER.
+ 
+PIPEDREAM HEREBY DISCLAIMS ANY AND ALL WARRANTIES AND CONDITIONS, EXPRESS, IMPLIED, STATUTORY, OR OTHERWISE, AND SPECIFICALLY DISCLAIMS ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE, WITH RESPECT TO THE SOFTWARE.
+ 
+LIMITATION OF LIABILITY.
+ 
+PIPEDREAM WILL NOT BE LIABLE FOR ANY DAMAGES OF ANY KIND, INCLUDING BUT NOT LIMITED TO, LOST PROFITS OR ANY CONSEQUENTIAL, SPECIAL, INCIDENTAL, INDIRECT, OR DIRECT DAMAGES, HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, ARISING OUT OF THIS AGREEMENT. THE FOREGOING SHALL APPLY TO THE MAXIMUM EXTENT PERMITTED BY APPLICABLE LAW.
+ 
+GENERAL.
+ 
+6.1  Governing Law. This Agreement will be governed by and interpreted in accordance with the laws of the state of California, without reference to its conflict of laws principles. If Licensee is located outside of the United States, any dispute, controversy or claim arising out of or relating to this Agreement will be referred to and finally determined by arbitration in accordance with the JAMS International Arbitration Rules. The tribunal will consist of one arbitrator. Judgment upon the award rendered by the arbitrator may be entered in any court having jurisdiction thereof. All disputes including arbitrations shall take place in Santa Clara County, California. The language to be used in any such proceedings shall be English.
+ 
+6.2.  Assignment. Licensee is not authorized to assign its rights under this Agreement to any third party. Pipedream may freely assign its rights under this Agreement to any third party.
+ 
+6.3.  Other. This Agreement is the entire agreement between the parties regarding the subject matter hereof. No amendment or modification of this Agreement will be valid or binding upon the parties unless made in writing and signed by the duly authorized representatives of both parties. In the event that any provision, including without limitation any condition, of this Agreement is held to be unenforceable, this Agreement and all licenses and rights granted hereunder will immediately terminate. Waiver by Pipedream of a breach of any provision of this Agreement or the failure by Pipedream to exercise any right hereunder will not be construed as a waiver of any subsequent breach of that right or as a waiver of any other right.

package/README.md

@@ -0,0 +1,11 @@
+# Overview
+
+VoilaNorbert is a potent tool for finding and verifying email addresses. With its API, you can automate processes like enriching leads with verified contact information, streamlining your email outreach, and maintaining the health of your email lists. The API's main features include searching for email addresses based on names and domains, verifying email deliverability, and managing your contacts. When used within Pipedream, you can leverage these capabilities to create workflows that respond to events, integrate with other services, and process data in real time.
+
+# Example Use Cases
+
+- **Lead Enrichment Workflow**: Triggered by a new entry on a Google Sheet (containing names and companies), this workflow uses VoilaNorbert to find corresponding email addresses, verifies them to ensure deliverability, and then updates the Google Sheet with the new data. This automation keeps your lead database fresh and actionable.
+
+- **Email Verification on Signup**: When a new user signs up through a website form, VoilaNorbert is employed to verify the email address provided. If verified, the user's information is added to a CRM like Salesforce, and a welcome email is sent via SendGrid. This process ensures that you're capturing genuine leads without manual vetting.
+
+- **Periodic Email List Cleaning**: A scheduled workflow runs monthly, fetching email addresses from an email marketing platform like Mailchimp. It uses VoilaNorbert to verify and clean the list, removing invalid emails automatically. The cleaned list is then re-uploaded to Mailchimp, optimizing your email campaign's deliverability and engagement rates.

package/actions/common/base.mjs

@@ -0,0 +1,15 @@
+import voilanorbert from "../../voilanorbert.app.mjs";
+
+export default {
+  type: "action",
+  props: {
+    voilanorbert,
+  },
+  async run({ $ }) {
+    const response = await this.processEvent({
+      $,
+    });
+
+    $.export("$summary", this.getSummary(response));
+  },
+};

package/actions/find-contact/find-contact.mjs

@@ -0,0 +1,32 @@
+import common from "../common/base.mjs";
+
+export default {
+  ...common,
+  key: "voilanorbert-find-contact",
+  name: "Find Contact",
+  description: "This action returns a specific contact. The object email is either null when the email is not found, or contains an object with at least email (the email string) and the score. [See the docs here](https://api.voilanorbert.com/2018-01-08/#contacts-get-1)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    ...common.props,
+    contactId: {
+      propDefinition: [
+        common.props.voilanorbert,
+        "contactId",
+      ],
+    },
+  },
+  methods: {
+    async processEvent() {
+      const { contactId } = this;
+      return this.voilanorbert.getContact({
+        contactId,
+      });
+    },
+    getSummary({
+      name, email,
+    }) {
+      return `Contact '${name ?? email.email}' Successfully fetched!`;
+    },
+  },
+};

package/actions/start-contact-search/start-contact-search.mjs

@@ -0,0 +1,88 @@
+import common from "../common/base.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  ...common,
+  key: "voilanorbert-start-contact-search",
+  name: "Start Contact Search",
+  description: `Search emails are based on the full name plus the domain or company name.
+  When your account does not have sufficient credits an HTTP status code of 402 is returned.
+  Also, take into consideration that we check the domain for its validity. So even if you provide a correct name+domain set, we may return a HTTP status code of 400 for the domain if we can't locate it.
+  [See the docs here](https://api.voilanorbert.com/2018-01-08/#search-endpoint-post)`,
+  version: "0.0.2",
+  type: "action",
+  props: {
+    ...common.props,
+    name: {
+      propDefinition: [
+        common.props.voilanorbert,
+        "name",
+      ],
+    },
+    domain: {
+      propDefinition: [
+        common.props.voilanorbert,
+        "domain",
+      ],
+      optional: true,
+    },
+    company: {
+      propDefinition: [
+        common.props.voilanorbert,
+        "company",
+      ],
+      optional: true,
+    },
+    listId: {
+      propDefinition: [
+        common.props.voilanorbert,
+        "listId",
+      ],
+      optional: true,
+    },
+    webhookUrl: {
+      type: "string",
+      label: "Webhook URL",
+      description: "The URL to send the webhook to. Required for Pipedream Connect. If not specified, the workflow will be suspended until verification results are returned.",
+      optional: true,
+    },
+  },
+  methods: {
+    async processEvent({ $ }) {
+      if (!this.domain && !this.company) {
+        throw new ConfigurationError("Either domain or company is required.");
+      }
+
+      const { resume_url } = this.webhookUrl
+        ? {
+          resume_url: this.webhookUrl,
+        }
+        : $.flow
+          ? $.flow.suspend()
+          : {
+            resume_url: undefined,
+          };
+      if (!resume_url) {
+        throw new ConfigurationError("Webhook URL is required for Pipedream Connect.");
+      }
+
+      const {
+        name,
+        domain,
+        company,
+        listId,
+      } = this;
+
+      return this.voilanorbert.startContactSearch({
+        name,
+        domain,
+        company,
+        webhook: resume_url,
+        list_id: listId,
+      });
+    },
+    getSummary() {
+      return "Contact Search Successfully fetched!";
+    },
+  },
+};

package/actions/verifiy-email/verifiy-email.mjs

@@ -0,0 +1,52 @@
+import common from "../common/base.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+
+export default {
+  ...common,
+  key: "voilanorbert-verifiy-email",
+  name: "Verify Email",
+  description: `Verifies the given list of emails.
+  In case your account does not have a sufficient Verify API balance the service will try to auto refill the balance by charging using the billing details of the account. If it fails to charge, an HTTP status code of 402 will be returned.
+  [See the docs here](https://api.voilanorbert.com/2018-01-08/#verify-endpoint-post)`,
+  version: "0.0.2",
+  type: "action",
+  props: {
+    ...common.props,
+    emails: {
+      propDefinition: [
+        common.props.voilanorbert,
+        "emails",
+      ],
+    },
+    webhookUrl: {
+      type: "string",
+      label: "Webhook URL",
+      description: "The URL to send the webhook to. Required for Pipedream Connect. If not specified, the workflow will be suspended until verification results are returned.",
+      optional: true,
+    },
+  },
+  methods: {
+    async processEvent({ $ }) {
+      const { resume_url } = this.webhookUrl
+        ? {
+          resume_url: this.webhookUrl,
+        }
+        : $.flow
+          ? $.flow.suspend()
+          : {
+            resume_url: undefined,
+          };
+      if (!resume_url) {
+        throw new ConfigurationError("Webhook URL is required for Pipedream Connect.");
+      }
+
+      return this.voilanorbert.verifyEmails({
+        emails: this.emails.toString(),
+        webhook: resume_url,
+      });
+    },
+    getSummary() {
+      return "Emails Successfully sent for verification!";
+    },
+  },
+};

package/common/utils.mjs

@@ -0,0 +1,8 @@
+export const objectToString = (data) => {
+  return Object.keys(data).reduce((prev, key) => {
+    if (data[key] === undefined) return prev;
+    return `${prev
+      ? `${prev}&`
+      : ""}${key}=${data[key]}`;
+  }, "");
+};

package/package.json

@@ -1,22 +1,18 @@
 {
   "name": "@pipedream/voilanorbert",
-  "version": "0.0.1",
+  "version": "0.0.3",
   "description": "Pipedream VoilaNorbert Components",
-  "main": "dist/app/voilanorbert.app.mjs",
+  "main": "voilanorbert.app.mjs",
   "keywords": [
     "pipedream",
     "voilanorbert"
   ],
-  "files": [
-    "dist"
-  ],
   "homepage": "https://pipedream.com/apps/voilanorbert",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "license": "MIT",
-  "dependencies": {
-    "@pipedream/platform": "^1.1.1"
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.1.0"
   }
 }

package/voilanorbert.app.mjs

@@ -0,0 +1,124 @@
+import { axios } from "@pipedream/platform";
+import { objectToString } from "./common/utils.mjs";
+
+export default {
+  type: "app",
+  app: "voilanorbert",
+  propDefinitions: {
+    contactId: {
+      type: "integer",
+      label: "Contact Id",
+      description: "The contact's id.",
+      async options({ page }) {
+        const { result } = await this.getContacts(page + 1);
+
+        return result?.map(({
+          name, email, id,
+        }) => ({
+          label: `${name} - ${email?.email}`,
+          value: id,
+        })) ?? [];
+      },
+    },
+    name: {
+      type: "string",
+      label: "Name",
+      description: "Full name of the person to search.",
+    },
+    domain: {
+      type: "string",
+      label: "Domain",
+      description: "The domain of the company. (Either `domain` or `company` is required).",
+    },
+    company: {
+      type: "string",
+      label: "Company",
+      description: "The name of the company. (Either `domain` or `company` is required).",
+    },
+    emails: {
+      type: "string[]",
+      label: "Emails",
+      description: "A list of emails",
+    },
+    listId: {
+      type: "integer",
+      label: "List ID",
+      description: "A List ID the contact will affected to.",
+      async options() {
+        const { result } = await this.getLists();
+
+        return result.map(({
+          name: label, id: value,
+        }) => ({
+          label,
+          value,
+        }));
+      },
+    },
+  },
+  methods: {
+    _accessToken() {
+      return this.$auth.api_key;
+    },
+    _auth() {
+      return {
+        username: "",
+        password: this._accessToken(),
+      };
+    },
+    _apiUrl() {
+      return "https://api.voilanorbert.com/2018-01-08";
+    },
+    async _makeRequest({
+      $ = this, path, ...options
+    }) {
+      const config = {
+        url: `${this._apiUrl()}/${path}`,
+        ...options,
+        auth: this._auth(),
+        headers: {
+          "Content-Type": "application/x-www-form-urlencoded",
+        },
+      };
+      return axios($, config);
+    },
+    async getContacts(page) {
+      try {
+        return await this._makeRequest({
+          path: "contacts/",
+          params: {
+            page,
+          },
+        });
+      } catch (e) {
+        return [];
+      }
+    },
+    async getContact({ contactId }) {
+      return await this._makeRequest({
+        path: `contacts/${contactId}`,
+      });
+    },
+    async getLists() {
+      return await this._makeRequest({
+        path: "lists/",
+      });
+    },
+    async startContactSearch(data) {
+      const bodyFormData = objectToString(data);
+      return await this._makeRequest({
+        method: "POST",
+        path: "search/name",
+        data: bodyFormData,
+      });
+    },
+    async verifyEmails(data) {
+      const bodyFormData = objectToString(data);
+      return await this._makeRequest({
+        method: "POST",
+        path: "verifier/upload",
+        data: bodyFormData,
+      });
+    },
+  },
+};