@pipedream/zoom 0.3.6 → 0.5.0

package/README.md

@@ -1,79 +1,36 @@
-# Zoom API Integrations
+# Overview
+The Zoom API lets you tap into a rich set of functionalities to enhance the video conferencing experience within your own app or workflow. With the Zoom API on Pipedream, you can automatically create meetings, manage users, send meeting notifications, and more, orchestrating these actions within a broader automation. This allows for seamless integration with other services, enabling both data collection and action triggers based on Zoom events.
 
-### Integrate Zoom and thousands of applications with Pipedream. Free for developers.
+**Pipedream [workflows](/workflows/) allow you to run any Node.js code that connects to the Zoom API**. Just [create a new workflow](https://pipedream.com/new), then add prebuilt Zoom [actions](/components#actions) (create a meeting, send a chat message, etc.) or [write your own code](/code/). These workflows can be triggered by HTTP requests, timers, email, or on any app-based event (new tweets, a Github PR, Zoom events, etc). 
 
----
+# Getting Started
 
-Pipedream is a serverless integration and compute platform. We provide a free, hosted platform that makes it easy to connect apps and develop, execute and maintain event-driven workflows.
+1. First, sign up for Pipedream at [https://pipedream.com](https://pipedream.com).
+2. Visit [https://pipedream.com/accounts](https://pipedream.com/accounts).
+3. Click the button labeled **Click Here to Connect an App**.
+4. Search for "Zoom" and select either **Zoom** or **Zoom Admin** ([see the differences below](#zoom-vs-zoom-admin-app)):
 
-**Key Features**:
+This will open up a new window prompting you to authorize Pipedream's access to your Zoom account. Once you authorize access, you should see your Zoom account listed among your apps.
 
-- [Zoom API Event Sources](#github-api-event-sources) - Open source [components](https://github.com/PipedreamHQ/pipedream/tree/master/components) that emit events from Zoom
-- [Workflows](#workflows) - A sequence of linear steps - just Node.js code - triggered by a Zoom event
-- Serverless - No server or cloud resources to manage
-- [Free](#pricing) - No fees for individual developers (see [limits](https://docs.pipedream.com/limits/))
+1. [Create a new workflow](https://pipedream.com/new), [add a new step](/workflows/steps/), search for "Zoom" or "Zoom Admin". Once you've selected either app, you can choose to either "Run Node.js code" or select one of the prebuilt actions for performing common API operations.
+2. At this stage, you'll be asked to link the Zoom account you connected above, authorizing the request to the Zoom API with your credentials.
 
-<a href="https://pipedream.com/sources/new?app=zoom"><img src="https://i.ibb.co/m0bBsSL/deploy-clean.png" height="35"></a>
+## Zoom vs Zoom Admin app
 
-## Zoom API Event Sources
+Zoom users can be classified into two groups: non-admins and admins. Admins have account-level permissions that users do not, and Zoom has corresponding admin-level scopes that aren't relevant for normal users. Therefore, Pipedream exposes two apps — **Zoom** and **Zoom Admin** — to serve the two groups.
 
-- [Custom Events](https://pipedream.com/sources/new?app=zoom) - Build your own event source using one or multiple events ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/custom-event.js))
-- [Meeting Created](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a meeting is created where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/meeting-created.js))
-- [Meeting Deleted](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a meeting is deleted where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/meeting-deleted.js))
-- [Meeting Ended](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a meeting ends where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/meeting-ended.js))
-- [Meeting Started](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a meeting starts where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/meeting-started.js))
-- [Meeting Updated](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a meeting is updated where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/meeting-updated.js))
-- [Meeting Recording Completed](https://pipedream.com/sources?action=create&key=zoom-recording-completed&utm_source=github.com&utm_medium=referral&utm_campaign=zoom) - Emits an event each time a new recording completes for a meeting or webinar where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/recording-completed.js))
-- [Webinar Created](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a webinar is created where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/webinar-created.js))
-- [Webinar Deleted](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a webinar is deleted where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/webinar-deleted.js))
-- [Webinar Ended](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a webinar ends where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/webinar-ended.js))
-- [Webinar Started](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a webinar starts where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/webinar-started.js))
-- [Webinar Updated](https://pipedream.com/sources/new?app=zoom) - Emits an event each time a webinar is updated where you're the host ([code](https://github.com/PipedreamHQ/pipedream/blob/master/components/zoom/webinar-updated.js))
+In the Zoom Marketplace, these apps are named [Pipedream](https://marketplace.zoom.us/apps/jGaV-kRrT3igAYnn-J5v2g), and [Pipedream for Zoom Admins](https://marketplace.zoom.us/apps/tZvUsiucR96SqtvfBsemXg), respectively.
 
-Event sources can also be deployed via the [Pipedream CLI](https://docs.pipedream.com/cli/reference/). Once installed, you can deploy an event source by running:
+Non-admins have [permissions](https://marketplace.zoom.us/docs/guides/authorization/permissions#user-managed-scopes) to manage standard Zoom resources in their account: meetings, webinars, recordings, and more. **If you're a non-admin, you'll want to use the Zoom app**.
 
-```bash
-pd deploy   # prompts you to select a component and pass required options
-```
+Zoom admins have [permissions](https://marketplace.zoom.us/docs/guides/authorization/permissions#account-level-scopes) to manage account-level resources, like users and reports. They can also manage webinars and meetings across their organization. **If you're an admin and need to manage these resources via API, you'll want to use the Zoom Admin app**.
 
-## Workflows
+The [Zoom API docs on permissions](https://marketplace.zoom.us/docs/guides/authorization/permissions) provide detailed information on these permissions and their associated OAuth scopes.
 
-Workflows are a sequence of linear [steps](https://docs.pipedream.com/workflows/steps) - just Node.js code - triggered by an event (via event source, HTTP endpoint, or timer). Workflows make it easy to transform data and integrate with 300+ APIs from various apps and services.
+# Example Use Cases
 
-- Trigger your workflow on any [Zoom event](https://pipedream.com/sources/new?app=github), a different event (e.g. [HTTP requests](https://docs.pipedream.com/workflows/steps/triggers/#http) or a [schedule](https://docs.pipedream.com/workflows/steps/triggers/#cron-scheduler)).
-- Add steps to run [Node.js code](https://docs.pipedream.com/workflows/steps/code/) (using virtually any npm package) and [pre-built actions](https://docs.pipedream.com/workflows/steps/actions/).
-- Steps are executed in the order they appear in your workflow.
-- Data is shared between steps via [step exports](https://docs.pipedream.com/workflows/steps/#step-exports).
+- **Automated Meeting Scheduling and Notifications**: With Pipedream, you can create a workflow that listens for upcoming calendar events in Google Calendar. Once it detects a new event labeled "Zoom Meeting," it can trigger the Zoom API to create a meeting and then automatically send custom email notifications with the meeting details to all the attendees using SendGrid.
 
-Workflow code is [public by default](https://docs.pipedream.com/public-workflows/) so the community can discover and [copy them](https://docs.pipedream.com/workflows/copy/). Your workflow execution and event data is private.
+- **Zoom Webinar Attendee Management**: Build a workflow where new sign-ups from an event management platform like Eventbrite trigger the addition of these attendees to a Zoom webinar. Post-webinar, send a follow-up email via Mailgun with a link to the webinar recording, which you can upload to a cloud storage platform like Dropbox.
 
-You can copy [this example workflow](https://pipedream.com/@tod/use-http-requests-to-trigger-a-workflow-p_6lCy5y/readme) to get started, or review some [community-developed workflows](https://pipedream.com/explore) to see what others are building.
-
-**Example Zoom Workflows**
-
-- [Save Zoom recordings to Amazon S3, then delete Zoom recording](https://pipedream.com/@dylburger/save-zoom-recordings-to-amazon-s3-p_PACKJG/readme)
-
-For a deeper introduction to Pipedream and event sources, see the [root `README` in this repo](/README.md), the [component API](/COMPONENT-API.md), or the [docs](https://docs.pipedream.com/apps/zoom/).
-
-## Other Popular API Integrations
-
-- [Airtable](https://github.com/PipedreamHQ/pipedream/tree/master/components/airtable) ([deploy](https://pipedream.com/sources/new?app=airtable))
-- [AWS](https://github.com/PipedreamHQ/pipedream/tree/master/components/aws) ([deploy](https://pipedream.com/sources/new?app=aws))
-- [Dropbox](https://github.com/PipedreamHQ/pipedream/tree/master/components/dropbox) ([deploy](https://pipedream.com/sources/new?app=dropbox))
-- [Github](https://github.com/PipedreamHQ/pipedream/tree/master/components/github) ([deploy](https://pipedream.com/sources/new?app=github))
-- [Google Calendar](https://github.com/PipedreamHQ/pipedream/tree/master/components/google-calendar) ([deploy](https://pipedream.com/sources/new?app=google-calendar))
-- [Google Drive](https://github.com/PipedreamHQ/pipedream/tree/master/components/google-drive) ([deploy](https://pipedream.com/sources/new?app=google-drive))
-- [RSS](https://github.com/PipedreamHQ/pipedream/tree/master/components/rss) ([deploy](https://pipedream.com/sources/new?app=rss))
-- [Twitter](https://github.com/PipedreamHQ/pipedream/tree/master/components/twitter) ([deploy](https://pipedream.com/sources/new?app=twitter))
-
-## Pricing
-
-Pipedream is currently free, subject to the [limits noted below](https://docs.pipedream.com/limits/). Paid tiers for higher volumes are coming soon.
-
-If you exceed any of these limits, please [reach out](https://docs.pipedream.com/support/).
-
-## Found a Bug? Have a Feature to suggest?
-
-Before adding an issue, please search the [existing issues](https://github.com/PipedreamHQ/pipedream/issues) or [reach out to our team](https://docs.pipedream.com/support/) to see if a similar request already exists.
-
-If an issue exists, please [add a reaction](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-conversations-on-github) or comment on your specific use case.
+- **Meeting Analytics and Reporting**: Combine Zoom's meeting ended webhook with Pipedream's capabilities to create a workflow that captures meeting details upon conclusion. With this data, you can send a summary email to the host, update a Google Sheet with attendance information, and even push the data to a BI tool like Tableau for more in-depth analysis.

package/actions/add-meeting-registrant/add-meeting-registrant.mjs

@@ -1,143 +1,192 @@
-// legacy_hash_id: a_zNiweO
-import { axios } from "@pipedream/platform";
+import app from "../../zoom.app.mjs";
 
 export default {
   key: "zoom-add-meeting-registrant",
   name: "Add Meeting Registrant",
-  description: "Registers a participant for a meeting.",
-  version: "0.2.1",
+  description: "Registers a participant for a meeting. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/meetingRegistrantCreate)",
+  version: "0.3.1",
   type: "action",
   props: {
-    zoom: {
-      type: "app",
-      app: "zoom",
-    },
-    meeting_id: {
-      type: "string",
-      description: "The meeting ID.",
-    },
-    occurrence_ids: {
-      type: "string",
-      description: "Occurrence IDs. You can find these with the meeting get API. Multiple values separated by comma.",
-      optional: true,
+    app,
+    meetingId: {
+      propDefinition: [
+        app,
+        "meetingId",
+      ],
+    },
+    occurrenceIds: {
+      propDefinition: [
+        app,
+        "occurrenceIds",
+      ],
     },
     email: {
-      type: "string",
-      description: "A valid email address of the registrant.",
-    },
-    first_name: {
-      type: "string",
-      description: "Registrant's first name.",
-    },
-    last_name: {
-      type: "string",
-      description: "Registrant's last name.",
+      propDefinition: [
+        app,
+        "email",
+      ],
+    },
+    firstName: {
+      propDefinition: [
+        app,
+        "firstName",
+      ],
+    },
+    lastName: {
+      propDefinition: [
+        app,
+        "lastName",
+      ],
     },
     address: {
-      type: "string",
-      description: "Registrant's address.",
-      optional: true,
+      propDefinition: [
+        app,
+        "address",
+      ],
     },
     city: {
-      type: "string",
-      description: "Registrant's city.",
-      optional: true,
+      propDefinition: [
+        app,
+        "city",
+      ],
     },
     country: {
-      type: "string",
-      description: "Registrant's country.",
-      optional: true,
+      propDefinition: [
+        app,
+        "country",
+      ],
     },
     zip: {
-      type: "string",
-      description: "Registrant's Zip/Postal code.",
-      optional: true,
+      propDefinition: [
+        app,
+        "zip",
+      ],
     },
     state: {
-      type: "string",
-      description: "Registrant's State/Province.",
-      optional: true,
+      propDefinition: [
+        app,
+        "state",
+      ],
     },
     phone: {
-      type: "string",
-      description: "Registrant's Phone number.",
-      optional: true,
+      propDefinition: [
+        app,
+        "phone",
+      ],
     },
     industry: {
-      type: "string",
-      description: "Registrant's industry.",
-      optional: true,
+      propDefinition: [
+        app,
+        "industry",
+      ],
     },
     org: {
-      type: "string",
-      description: "Registrant's Organization.",
-      optional: true,
-    },
-    job_title: {
-      type: "string",
-      description: "Registrant's job title.",
-      optional: true,
-    },
-    purchasing_time_frame: {
-      type: "string",
-      description: "This field can be included to gauge interest of webinar attendees towards buying your product or service.",
-      optional: true,
-    },
-    role_in_purchase_process: {
-      type: "string",
-      description: "Role in Purchase Process.",
-      optional: true,
-    },
-    no_of_employees: {
-      type: "string",
-      description: "Number of Employees.",
-      optional: true,
+      propDefinition: [
+        app,
+        "org",
+      ],
+    },
+    jobTitle: {
+      propDefinition: [
+        app,
+        "jobTitle",
+      ],
+    },
+    purchasingTimeFrame: {
+      propDefinition: [
+        app,
+        "purchasingTimeFrame",
+      ],
+    },
+    roleInPurchaseProcess: {
+      propDefinition: [
+        app,
+        "roleInPurchaseProcess",
+      ],
+    },
+    noOfEmployees: {
+      propDefinition: [
+        app,
+        "noOfEmployees",
+      ],
     },
     comments: {
-      type: "string",
-      description: "A field that allows registrants to provide any questions or comments that they might have.",
-      optional: true,
+      propDefinition: [
+        app,
+        "comments",
+      ],
+    },
+    customQuestions: {
+      propDefinition: [
+        app,
+        "customQuestions",
+      ],
     },
-    custom_questions: {
-      type: "any",
-      description: "Custom questions.",
-      optional: true,
+  },
+  methods: {
+    addMeetingRegistrant({
+      meetingId, ...args
+    } = {}) {
+      return this.app.create({
+        path: `/meetings/${meetingId}/registrants`,
+        ...args,
+      });
     },
   },
-  async run({ $ }) {
-  //See the API docs here: https://marketplace.zoom.us/docs/api-reference/zoom-api/meetings/meetingregistrantcreate
-    const config = {
-      method: "post",
-      url: `https://api.zoom.us/v2/meetings/${this.meeting_id}/registrants`,
+  async run({ $: step }) {
+    const {
+      meetingId,
+      occurrenceIds,
+      email,
+      firstName,
+      lastName,
+      address,
+      city,
+      country,
+      zip,
+      state,
+      phone,
+      industry,
+      org,
+      jobTitle,
+      purchasingTimeFrame,
+      roleInPurchaseProcess,
+      noOfEmployees,
+      comments,
+      customQuestions,
+    } = this;
+
+    const response = await this.addMeetingRegistrant({
+      step,
+      meetingId,
       params: {
-        occurrence_ids: this.occurrence_ids,
+        occurrence_ids: occurrenceIds,
       },
       data: {
-        email: this.email,
-        first_name: this.first_name,
-        last_name: this.last_name,
-        address: this.address,
-        city: this.city,
-        country: this.country,
-        zip: this.zip,
-        state: this.state,
-        phone: this.phone,
-        industry: this.industry,
-        org: this.org,
-        job_title: this.job_title,
-        purchasing_time_frame: this.purchasing_time_frame,
-        role_in_purchase_process: this.role_in_purchase_process,
-        no_of_employees: this.no_of_employees,
-        comments: this.comments,
-        custom_questions: typeof this.custom_questions == "undefined"
-          ? this.custom_questions
-          : JSON.parse(this.custom_questions),
-      },
-      headers: {
-        "Authorization": `Bearer ${this.zoom.$auth.oauth_access_token}`,
-        "Content-Type": "application/json",
+        email,
+        first_name: firstName,
+        last_name: lastName,
+        address,
+        city,
+        country,
+        zip,
+        state,
+        phone,
+        industry,
+        org,
+        job_title: jobTitle,
+        purchasing_time_frame: purchasingTimeFrame,
+        role_in_purchase_process: roleInPurchaseProcess,
+        no_of_employees: noOfEmployees,
+        comments,
+        custom_questions: typeof(customQuestions) === "undefined"
+          ? customQuestions
+          : JSON.parse(customQuestions),
       },
-    };
-    return await axios($, config);
+    });
+
+    step.export("$summary", `Successfully added registrant to meeting with ID \`${response.id}\``);
+
+    return response;
   },
 };