@pipedream/addressfinder 0.0.1 → 0.1.0

package/actions/verify-address-au/verify-address-au.mjs

@@ -0,0 +1,77 @@
+import addressfinder from "../../addressfinder.app.mjs";
+
+export default {
+  key: "addressfinder-verify-address-au",
+  name: "Verify Australian Address",
+  description: "Validates an Australian address. [See the documentation](https://addressfinder.com.au/api/au/address/verification/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    addressfinder,
+    address: {
+      type: "string",
+      label: "Address",
+      description: "The Australian address to be verified, e.g. `30 Hoipo Road, SOMERSBY NSW`",
+    },
+    database: {
+      type: "string[]",
+      label: "Database(s)",
+      description: "Which database(s) to return data from",
+      options: [
+        {
+          value: "gnaf",
+          label: "Return physical addresses from the GNAF database.",
+        },
+        {
+          value: "paf",
+          label: "Return postal addresses from the PAF database.",
+        },
+      ],
+    },
+    gps: {
+      type: "boolean",
+      label: "GPS Coordinates",
+      description: "Return GPS coordinates from the datasource specified (when available)",
+      optional: true,
+    },
+    extended: {
+      type: "boolean",
+      label: "Extended",
+      description: "Returns extended information from the GNAF database",
+      optional: true,
+    },
+    domain: {
+      propDefinition: [
+        addressfinder,
+        "domain",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      address, database, domain,
+    } = this;
+    const response = await this.addressfinder.verifyAustralianAddress({
+      $,
+      params: {
+        q: address,
+        ...(database?.includes?.("gnaf") && {
+          gnaf: 1,
+        }),
+        ...(database?.includes?.("paf") && {
+          paf: 1,
+        }),
+        ...(this.gps && {
+          gps: 1,
+        }),
+        ...(this.extended && {
+          extended: 1,
+        }),
+        domain,
+      },
+    });
+
+    $.export("$summary", `Successfully verified AU address "${address}"`);
+    return response;
+  },
+};

package/actions/verify-address-nz/verify-address-nz.mjs

@@ -0,0 +1,35 @@
+import addressfinder from "../../addressfinder.app.mjs";
+
+export default {
+  key: "addressfinder-verify-address-nz",
+  name: "Verify New Zealand Address",
+  description: "Validates a New Zealand address. [See the documentation](https://addressfinder.com.au/api/nz/address/verification/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    addressfinder,
+    address: {
+      type: "string",
+      label: "New Zealand Address",
+      description: "The New Zealand address to be verified, e.g. `186 Willis St, Te Aro`",
+    },
+    domain: {
+      propDefinition: [
+        addressfinder,
+        "domain",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const { address } = this;
+    const response = await this.addressfinder.verifyNewZealandAddress({
+      $,
+      params: {
+        q: address,
+        domain: this.domain,
+      },
+    });
+    $.export("$summary", `Successfully verified NZ address "${address}"`);
+    return response;
+  },
+};

package/actions/verify-email/verify-email.mjs

@@ -0,0 +1,59 @@
+import addressfinder from "../../addressfinder.app.mjs";
+
+export default {
+  key: "addressfinder-verify-email",
+  name: "Verify Email",
+  description: "Validates the input email. [See the documentation](https://addressfinder.com.au/api/email/verification/)",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    addressfinder,
+    email: {
+      type: "string",
+      label: "Email Address",
+      description: "The email address to be verified",
+    },
+    domain: {
+      propDefinition: [
+        addressfinder,
+        "domain",
+      ],
+    },
+    features: {
+      type: "string[]",
+      label: "Features",
+      description: "The methods of verification to be completed. This will impact the query processing time and data returned in the response.",
+      optional: true,
+      options: [
+        {
+          label: "Domain - a check to verify that the domain of the email address is configured to receive emails.",
+          value: "domain",
+        },
+        {
+          label: "Connection - a check to verify that the email account exists at the provided domain.",
+          value: "connection",
+        },
+        {
+          label: "Email provider - a check that determines the underlaying provider of the email service.",
+          value: "provider",
+        },
+      ],
+    },
+  },
+  async run({ $ }) {
+    const {
+      email, domain,
+    } = this;
+    const response = await this.addressfinder.verifyEmailAddress({
+      $,
+      params: {
+        email,
+        domain,
+        features: this.features?.join?.(),
+      },
+    });
+
+    $.export("$summary", `Successfully verified email ${email}`);
+    return response;
+  },
+};

package/addressfinder.app.mjs

@@ -1,11 +1,55 @@
+import { axios } from "@pipedream/platform";
+
 export default {
   type: "app",
   app: "addressfinder",
-  propDefinitions: {},
+  propDefinitions: {
+    domain: {
+      type: "string",
+      label: "Domain",
+      description:
+        "Used to identify which of your services is calling the API for activity monitoring purposes. [See the documentation](https://addressfinder.com/r/faq/what-is-the-domain-option-used-for/) for more information.",
+      optional: true,
+    },
+  },
   methods: {
-    // this.$auth contains connected account data
-    authKeys() {
-      console.log(Object.keys(this.$auth));
+    _baseUrl() {
+      return "https://api.addressfinder.io/api";
+    },
+    async _makeRequest({
+      $ = this, headers, params, ...args
+    }) {
+      return axios($, {
+        baseURL: this._baseUrl(),
+        headers: {
+          ...headers,
+          Authorization: this.$auth.secret,
+        },
+        params: {
+          ...params,
+          format: "json",
+          key: this.$auth.key,
+        },
+        ...args,
+      });
+    },
+    async verifyAustralianAddress(args) {
+      return this._makeRequest({
+        url: "/au/address/v2/verification",
+        ...args,
+      });
+    },
+    async verifyEmailAddress(args) {
+      return this._makeRequest({
+        url: "/email/v1/verification",
+        ...args,
+      });
+    },
+    async verifyNewZealandAddress(args) {
+      return this._makeRequest({
+        url: "/nz/address/verification",
+        ...args,
+      });
     },
   },
-};
+};

package/package.json

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