@pipedream/spondyr 0.0.3 → 0.1.0

package/README.md

@@ -1,31 +1,11 @@
 # Overview
 
-With the Spondyr API, you can build powerful digital experiences in less time.
-It is an API that connects multiple services, databases, and resources in one
-place, enabling developers to quickly build serverless applications with
-enterprise-grade security, scalability, and performance.
+The Spondyr API, known as MailboxValidator, is a tool designed to clean and verify email lists, ensuring that businesses can keep their email marketing databases free of invalid, inactive, or disposable email addresses. By integrating Spondyr with Pipedream, you can automate the process of maintaining a high-quality email list, triggering email validation workflows, and integrating with other services to enhance user management, campaign effectiveness, and overall data hygiene.
 
-The Spondyr API can help developers reduce the complexity of creating
-applications by providing the tools to connect multiple services, eliminate
-excess code, and rapidly develop user experiences. Here are a few examples of
-the experiences you can create with Spondyr API:
+# Example Use Cases
 
-- ECommerce Applications – Spondyr API allows developers to create secure and
-  reliable eCommerce applications with integration to multiple payment
-  providers.
-- Cloud Storage Systems – Build cloud-based storage systems that are flawless,
-  fast, and secure.
-- Enterprise Dashboards – Create interactive dashboards with insights that your
-  customers need to make the right decisions.
-- Mobile Applications – Build mobile apps with real-time data updates and
-  secure authentication.
-- Chatbots – Create interactive and AI-powered chatbots to provide instant
-  customer support.
-- Social Networks – Create powerful and secure social networks with the
-  flexibility to add and modify features.
-- Data Visualization – Leverage Spondyr API and create stunning data
-  visualization applications.
+- **Email Verification on User Sign-up**: Trigger a workflow in Pipedream when a new user signs up via your app's API. Use the Spondyr API to validate the email address. If it's valid, continue the sign-up process; if not, reject the sign-up and notify the user to provide a valid email.
 
-With Spondyr API, the possibilities of what you can create are endless. So the
-next time you need to build a digital experience, give Spondyr API a try and
-see what you can create.
+- **Scheduled Email List Cleaning**: Set up a Pipedream cron job to periodically trigger a workflow that sends batches of email addresses from your database to the Spondyr API for validation. After cleaning, update your database by removing invalid emails, and use Pipedream's built-in integrations to log the results to a Google Sheets spreadsheet for record-keeping and further analysis.
+
+- **Real-time Lead Validation in Marketing Campaigns**: Integrate the Spondyr API with your marketing platform via Pipedream. When a lead is captured through a landing page form, instantly validate their email with Spondyr. Based on the validation result, you could route the lead to different nurturing tracks or notify your sales team about high-quality leads with valid email addresses.

package/actions/create-spondyr/create-spondyr.mjs

@@ -3,7 +3,12 @@ import spondyr from "../../spondyr.app.mjs";
 export default {
   key: "spondyr-create-spondyr",
   name: "Create Spondyr",
-  version: "0.0.2",
+  version: "0.0.3",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: false,
+  },
   description: "Generate and optionally deliver correspondence. [See the docs here](https://client.spondyr.io/#/Public/Public/Documentation?Section=send-api)",
   type: "action",
   props: {

package/actions/list-transaction-type-options/list-transaction-type-options.mjs

@@ -0,0 +1,33 @@
+import spondyr from "../../spondyr.app.mjs";
+
+export default {
+  key: "spondyr-list-transaction-type-options",
+  name: "List Transaction Type Options",
+  description: "Retrieves available options for the Transaction Type field.",
+  version: "0.0.1",
+  type: "action",
+  annotations: {
+    destructiveHint: false,
+    openWorldHint: true,
+    readOnlyHint: true,
+  },
+  props: {
+    spondyr,
+    page: {
+      type: "integer",
+      label: "Page",
+      description: "The page of results to retrieve.",
+      min: 0,
+      default: 0,
+    },
+  },
+  async run({ $ }) {
+    const options = await spondyr.propDefinitions.transactionType.options.call(this.spondyr, {
+      page: this.page,
+    });
+    $.export("$summary", `Successfully retrieved ${options.length} option${options.length === 1
+      ? ""
+      : "s"}`);
+    return options;
+  },
+};

package/package.json

@@ -1,8 +1,8 @@
 {
   "name": "@pipedream/spondyr",
-  "version": "0.0.3",
+  "version": "0.1.0",
   "description": "Pipedream Spondyr Components",
-  "main": "spondyr.app.js",
+  "main": "spondyr.app.mjs",
   "keywords": [
     "pipedream",
     "spondyr"
@@ -13,6 +13,6 @@
     "access": "public"
   },
   "dependencies": {
-    "@pipedream/platform": "^1.2.1"
+    "@pipedream/platform": "^1.6.8"
   }
 }