@pipedream/zoom 0.3.6 → 0.5.0

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

@@ -1,143 +1,192 @@
-// legacy_hash_id: a_YEiPgP
-import { axios } from "@pipedream/platform";
+import app from "../../zoom.app.mjs";
 
 export default {
   key: "zoom-add-webinar-registrant",
   name: "Add Webinar Registrant",
-  description: "Registers a participant for a webinar.",
-  version: "0.2.1",
+  description: "Registers a participant for a webinar. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrantcreate).",
+  version: "0.3.1",
   type: "action",
   props: {
-    zoom: {
-      type: "app",
-      app: "zoom",
-    },
-    webinar_id: {
-      type: "string",
-      description: "The webinar 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,
+    webinarId: {
+      propDefinition: [
+        app,
+        "webinarId",
+      ],
+    },
+    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: {
+    addWebinarRegistrant({
+      webinarId, ...args
+    } = {}) {
+      return this.app.create({
+        path: `/webinars/${webinarId}/registrants`,
+        ...args,
+      });
     },
   },
-  async run({ $ }) {
-  //See the API docs here: https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinarregistrantcreate
-    const config = {
-      method: "post",
-      url: `https://api.zoom.us/v2/webinars/${this.webinar_id}/registrants`,
+  async run({ $: step }) {
+    const {
+      webinarId,
+      occurrenceIds,
+      email,
+      firstName,
+      lastName,
+      address,
+      city,
+      country,
+      zip,
+      state,
+      phone,
+      industry,
+      org,
+      jobTitle,
+      purchasingTimeFrame,
+      roleInPurchaseProcess,
+      noOfEmployees,
+      comments,
+      customQuestions,
+    } = this;
+
+    const response = await this.addWebinarRegistrant({
+      step,
+      webinarId,
       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 webinar with ID \`${response.id}\``);
+
+    return response;
   },
 };

package/actions/create-meeting/create-meeting.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-create-meeting",
   name: "Create Meeting",
   description: "Creates a meeting for a user. A maximum of 100 meetings can be created for a user in a day.",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   props: {
     zoom: {

package/actions/create-user/create-user.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-create-user",
   name: "Create User",
   description: "Creates a new user in your account.",
-  version: "0.2.1",
+  version: "0.2.2",
   type: "action",
   props: {
     zoom: {

package/actions/delete-user/delete-user.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-delete-user",
   name: "Delete User",
   description: "Disassociates (unlinks) a user from the associated account or permanently deletes a user.",
-  version: "0.2.1",
+  version: "0.2.2",
   type: "action",
   props: {
     zoom: {

package/actions/get-meeting-details/get-meeting-details.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-get-meeting-details",
   name: "Get Meeting Details",
   description: "Retrieves the details of a meeting.",
-  version: "0.3.1",
+  version: "0.3.2",
   type: "action",
   props: {
     zoom: {

package/actions/get-webinar-details/get-webinar-details.mjs

@@ -1,38 +1,52 @@
-// legacy_hash_id: a_WYie0m
-import { axios } from "@pipedream/platform";
+import app from "../../zoom.app.mjs";
 
 export default {
   key: "zoom-get-webinar-details",
   name: "Get Webinar Details",
-  description: "Gets details of a scheduled webinar.",
-  version: "0.2.1",
+  description: "Gets details of a scheduled webinar. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/webinar).",
+  version: "0.3.1",
   type: "action",
   props: {
-    zoom: {
-      type: "app",
-      app: "zoom",
+    app,
+    webinarId: {
+      propDefinition: [
+        app,
+        "webinarId",
+      ],
     },
-    webinar_id: {
-      type: "integer",
-      description: "The webinar ID.",
-    },
-    occurrence_id: {
+    occurrenceId: {
       type: "string",
+      label: "Occurrence ID",
       description: "Unique Identifier that identifies an occurrence of a recurring webinar.  Recurring webinars can have a maximum of 50 occurrences.",
       optional: true,
     },
   },
-  async run({ $ }) {
-  //See the API docs here: https://marketplace.zoom.us/docs/api-reference/zoom-api/webinars/webinar
-    const config = {
-      url: `https://api.zoom.us/v2/webinars/${this.webinar_id}`,
+  methods: {
+    getWebinarDetails({
+      webinarId, ...args
+    } = {}) {
+      return this.app._makeRequest({
+        path: `/webinars/${webinarId}`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      webinarId,
+      occurrenceId,
+    } = this;
+
+    const response = await this.getWebinarDetails({
+      step,
+      webinarId,
       params: {
-        occurrence_id: this.occurrence_id,
+        occurrence_id: occurrenceId,
       },
-      headers: {
-        Authorization: `Bearer ${this.zoom.$auth.oauth_access_token}`,
-      },
-    };
-    return await axios($, config);
+    });
+
+    step.export("$summary", `Successfully retrieved webinar details with ID \`${response.id}\``);
+
+    return response;
   },
 };

package/actions/list-channels/list-channels.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-list-channels",
   name: "List Channels",
   description: "List a user's chat channels.",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   props: {
     zoom: {

package/actions/list-past-meeting-participants/list-past-meeting-participants.mjs

@@ -1,36 +1,38 @@
-// legacy_hash_id: a_YEik5g
-import { axios } from "@pipedream/platform";
+import app from "../../zoom.app.mjs";
 
 export default {
   key: "zoom-list-past-meeting-participants",
   name: "List Past Meeting Participants",
-  description: "Retrieve information on participants from a past meeting.",
-  version: "0.1.1",
+  description: "Retrieve information on participants from a past meeting. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/pastMeetingParticipants).",
+  version: "0.2.1",
   type: "action",
   props: {
-    zoom: {
-      type: "app",
-      app: "zoom",
+    app,
+    meetingId: {
+      propDefinition: [
+        app,
+        "meetingId",
+      ],
     },
-    meeting_id: {
-      type: "string",
+  },
+  methods: {
+    listPastMeetingParticipants({
+      meetingId, ...args
+    } = {}) {
+      return this.app._makeRequest({
+        path: `/past_meetings/${meetingId}/participants`,
+        ...args,
+      });
     },
   },
-  async run({ $ }) {
-    const config = {
-      url: `https://api.zoom.us/v2/past_meetings/${this.meeting_id}/participants`,
-      headers: {
-        Authorization: `Bearer ${this.zoom.$auth.oauth_access_token}`,
-      },
-    };
+  async run({ $: step }) {
+    const { participants } = await this.listPastMeetingParticipants({
+      step,
+      meetingId: this.meetingId,
+    });
 
-    const results = await axios($, config);
+    step.export("$summary", `Successfully retrieved ${participants.length} past meeting participants`);
 
-    return results.participants.filter((element, index) => {
-      const _element = JSON.stringify(element);
-      return index === results.participants.findIndex((obj) => {
-        return JSON.stringify(obj) === _element;
-      });
-    });
+    return participants;
   },
 };

package/actions/list-past-webinar-qa/list-past-webinar-qa.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-list-past-webinar-qa",
   name: "List Past Webinar Q&A",
   description: "The  feature for Webinars allows attendees to ask questions during the Webinar and for the panelists, co-hosts and host to answer their questions. Use this API to list Q&A of a specific Webinar.",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   props: {
     zoom: {

package/actions/list-user-call-logs/list-user-call-logs.mjs

@@ -0,0 +1,31 @@
+import zoom from "../../zoom.app.mjs";
+
+export default {
+  name: "List User's Call Logs",
+  description: "Gets a user's Zoom phone call logs. [See the documentation](https://developers.zoom.us/docs/zoom-phone/apis/#operation/phoneUserCallLogs)",
+  key: "zoom-list-user-call-logs",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    zoom,
+    userId: {
+      propDefinition: [
+        zoom,
+        "userId",
+      ],
+    },
+  },
+  async run ({ $ }) {
+    const data = await this.zoom.getResourcesStream({
+      resourceFn: this.zoom.listCallLogs,
+      resourceFnArgs: {
+        userId: this.userId,
+      },
+      resourceName: "call_logs",
+    });
+
+    $.export("$summary", `Successfully fetched ${data.length} call log(s)`);
+
+    return data;
+  },
+};

package/actions/list-webinar-participants-report/list-webinar-participants-report.mjs

@@ -0,0 +1,68 @@
+import utils from "../../common/utils.mjs";
+import app from "../../zoom.app.mjs";
+
+export default {
+  key: "zoom-list-webinar-participants-report",
+  name: "List Webinar Participants Report",
+  description: "Retrieves detailed report on each webinar attendee. You can get webinar participant reports for the last 6 months. [See the docs here](https://marketplace.zoom.us/docs/api-reference/zoom-api/methods/#operation/reportWebinarParticipants).",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    app,
+    webinarId: {
+      propDefinition: [
+        app,
+        "webinarId",
+      ],
+    },
+    nextPageToken: {
+      propDefinition: [
+        app,
+        "nextPageToken",
+      ],
+    },
+    max: {
+      propDefinition: [
+        app,
+        "max",
+      ],
+    },
+  },
+  methods: {
+    async listWebinarParticipantsReport({
+      webinarId, ...args
+    } = {}) {
+      return this.app._makeRequest({
+        path: `/report/webinars/${webinarId}/participants`,
+        ...args,
+      });
+    },
+  },
+  async run({ $: step }) {
+    const {
+      webinarId,
+      nextPageToken,
+      max,
+    } = this;
+
+    const stream = await this.app.getResourcesStream({
+      resourceFn: this.listWebinarParticipantsReport,
+      resourceFnArgs: {
+        step,
+        webinarId,
+        params: {
+          page_size: 300,
+          next_page_token: nextPageToken,
+        },
+      },
+      resourceName: "participants",
+      max,
+    });
+
+    const participants = await utils.streamIterator(stream);
+
+    step.export("$summary", `Successfully retrieved ${utils.summaryEnd(participants.length, "participant")}.`);
+
+    return participants;
+  },
+};

package/actions/send-chat-message/send-chat-message.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-send-chat-message",
   name: "Send Chat Message",
   description: "Send chat messages on Zoom to either an individual user who is in your contact list or to a  of which you are a member.",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   props: {
     zoom: {

package/actions/update-meeting/update-meeting.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-update-meeting",
   name: "Update Meeting",
   description: "Updates an existing Zoom meeting",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   props: {
     zoom: {

package/actions/update-webinar/update-webinar.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-update-webinar",
   name: "Update Webinar",
   description: "Update a webinar's topic, start time, or other settings",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   props: {
     zoom: {

package/actions/view-user/view-user.mjs

@@ -5,7 +5,7 @@ export default {
   key: "zoom-view-user",
   name: "View User",
   description: "View your user information",
-  version: "0.1.1",
+  version: "0.1.2",
   type: "action",
   props: {
     zoom: {

package/common/constants.mjs

@@ -0,0 +1,9 @@
+const BASE_URL = "https://api.zoom.us";
+const VERSION_PATH = "/v2";
+const MAX_RESOURCES = 300;
+
+export default {
+  BASE_URL,
+  VERSION_PATH,
+  MAX_RESOURCES,
+};

package/common/utils.mjs

@@ -0,0 +1,20 @@
+async function streamIterator(stream) {
+  const resources = [];
+  for await (const resource of stream) {
+    resources.push(resource);
+  }
+  return resources;
+}
+
+function summaryEnd(count, singular, plural) {
+  if (!plural) {
+    plural = singular + "s";
+  }
+  const noun = count === 1 && singular || plural;
+  return `${count} ${noun}`;
+}
+
+export default {
+  streamIterator,
+  summaryEnd,
+};