@pipedream/google_calendar 0.5.2 → 0.5.3

package/README.md

@@ -1,20 +1,11 @@
 # Overview
 
-The Google Calendar API gives developers access to Google Calendar data,
-allowing them to create their own applications that can read, write, and update
-calendar data. With the API, users can integrate their own calendar
-applications with Google Calendar, giving them the ability to manage their
-calendars in one place. The API also provides the ability to search for events
-and create new events.
+The Google Calendar API lets you dip into the powerhouse of scheduling, allowing for the reading, creation, and manipulation of events and calendars directly from your applications. Through Pipedream, you can seamlessly integrate Google Calendar into a myriad of workflows, automating event management, syncing with other services, setting up custom reminders, or even collating data for reporting. The key here is to streamline your calendar-related processes, ensuring that your time management is as efficient and automated as possible.
 
-Possible applications that could be built using the Google Calendar API
-include:
+# Example Use Cases
 
-- A calendar application that integrates with Google Calendar, allowing users
-  to manage their calendars in one place.
-- A calendar application that allows users to search for events and create new
-  events.
-- A to-do list application that integrates with Google Calendar, allowing users
-  to see their tasks and events in one place.
-- A reminder application that uses Google Calendar data to remind users of
-  upcoming events.
+- **Event Synchronization Across Platforms**: Create a workflow that listens for new events on Google Calendar and replicates them on other platforms like Outlook or Apple Calendar. This ensures your schedule remains in sync across different services.
+
+- **Automated Meeting Prep**: Set up a Pipedream workflow that triggers a sequence of events whenever a new meeting is scheduled on Google Calendar. This could send out reminder emails with attached agendas to participants, book conference rooms through your office management system, or check the attendees' LinkedIn profiles to provide you with recent updates about them before the meeting.
+
+- **Dynamic Event Response**: Implement a workflow that reacts to updated or canceled events on Google Calendar. On event cancellation, it could trigger a message on Slack to inform team members and update project management tools to reschedule associated tasks. When an event is updated, it can automatically adjust reminders or send out new invites if the attendee list changes.

package/actions/{update-event-attendees/update-event-attendees.mjs → add-attendees-to-event/add-attendees-to-event.mjs}

@@ -1,10 +1,11 @@
 import googleCalendar from "../../google_calendar.app.mjs";
+import createEventCommon from "../common/create-event-common.mjs";
 
 export default {
-  key: "google_calendar-update-event-attendees",
-  name: "Update attendees of an event",
-  description: "Update attendees of an existing event. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#update)",
-  version: "0.1.4",
+  key: "google_calendar-add-attendees-to-event",
+  name: "Add Attendees To Event",
+  description: "Add attendees to an existing event. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#update)",
+  version: "0.0.1",
   type: "action",
   props: {
     googleCalendar,
@@ -25,8 +26,8 @@ export default {
     },
     attendees: {
       label: "Attendees",
-      type: "string[]",
-      description: "Enter an array of email addresses for any attendees",
+      type: "string",
+      description: "Enter either an array or a comma separated list of email addresses of attendees",
     },
     sendUpdates: {
       propDefinition: [
@@ -34,35 +35,20 @@ export default {
         "sendUpdates",
       ],
     },
-    sendNotifications: {
-      propDefinition: [
-        googleCalendar,
-        "sendNotifications",
-      ],
-    },
-  },
-  methods: {
-    formatAttendees(selectedAttendees) {
-      let attendees = [];
-      if (selectedAttendees && Array.isArray(selectedAttendees)) {
-        attendees = selectedAttendees.map((email) => ({
-          email,
-        }));
-      }
-      return attendees;
-    },
   },
   async run({ $ }) {
-    const updatedAttendees = this.formatAttendees(this.attendees);
+    const updatedAttendees = createEventCommon.methods.formatAttendees(this.attendees);
     const currentEvent = await this.googleCalendar.getEvent({
       eventId: this.eventId,
       calendarId: this.calendarId,
     });
+    if (currentEvent?.attendees && currentEvent.attendees.length) {
+      updatedAttendees.push(...currentEvent.attendees);
+    }
     const response = await this.googleCalendar.updateEvent({
       calendarId: this.calendarId,
       eventId: this.eventId,
       sendUpdates: this.sendUpdates,
-      sendNotifications: this.sendNotifications,
       requestBody: {
         ...currentEvent,
         attendees: updatedAttendees,

package/actions/common/create-event-common.mjs

@@ -1,4 +1,5 @@
-import googleCalendar from "../../google_calendar.app.mjs";
+import { ConfigurationError } from "@pipedream/platform";
+import constants from "../../common/constants.mjs";
 
 export default {
   props: ({ isUpdate }) => (
@@ -9,6 +10,18 @@ export default {
         description: "Enter a title for the event, (e.g., `My event`)",
         optional: true,
       },
+      eventStartDate: {
+        label: "Event Start Date",
+        type: "string",
+        description: "For all-day events, enter the Event day in the format `yyyy-mm-dd`. For events with time, format according to [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-1): `yyyy-mm-ddThh:mm:ss+01:00`. A time zone offset is required unless a time zone is explicitly specified in timeZone.",
+        optional: isUpdate,
+      },
+      eventEndDate: {
+        label: "Event End Date",
+        type: "string",
+        description: "For all-day events, enter the Event day in the format `yyyy-mm-dd`. For events with time, format according to [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-1): `yyyy-mm-ddThh:mm:ss+01:00`. A time zone offset is required unless a time zone is explicitly specified in timeZone.",
+        optional: isUpdate,
+      },
       location: {
         label: "Event Location",
         type: "string",
@@ -23,45 +36,38 @@ export default {
       },
       attendees: {
         label: "Attendees",
-        type: "string[]",
-        description: "Enter an array of email addresses for any attendees",
+        type: "string",
+        description: "Enter either an array or a comma separated list of email addresses of attendees",
         optional: true,
       },
-      eventStartDate: {
-        label: "Event Start Date",
+      repeatFrequency: {
         type: "string",
-        description: "For all-day events, enter the Event day in the format `yyyy-mm-dd`. For events with time, format according to [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-1): `yyyy-mm-ddThh:mm:ss+01:00`. A time zone offset is required unless a time zone is explicitly specified in timeZone.",
-        optional: isUpdate,
-      },
-      eventEndDate: {
-        label: "Event End Date",
-        type: "string",
-        description: "For all-day events, enter the Event day in the format `yyyy-mm-dd`. For events with time, format according to [RFC3339](https://www.rfc-editor.org/rfc/rfc3339.html#section-1): `yyyy-mm-ddThh:mm:ss+01:00`. A time zone offset is required unless a time zone is explicitly specified in timeZone.",
-        optional: isUpdate,
-      },
-      recurrence: {
-        label: "Recurrence",
-        type: "string[]",
-        description: "Recurrence rule(s) for the event. For example, `RRULE:FREQ=DAILY;INTERVAL=2` means once every two days, `RRULE:FREQ=YEARLY` means annually.\nYou can combine multiple recurrence rules. [See the documentation](https://developers.google.com/calendar/api/concepts/events-calendars#recurrence_rule)",
+        label: "Repeat Frequency",
+        description: "Select a frequency to make this event repeating",
         optional: true,
+        options: Object.keys(constants.REPEAT_FREQUENCIES),
+        reloadProps: true,
       },
-      timeZone: {
-        propDefinition: [
-          googleCalendar,
-          "timeZone",
-        ],
+      repeatInterval: {
+        type: "integer",
+        label: "Repeat Interval",
+        description: "Enter 1 to \"repeat every day\", enter 2 to \"repeat every other day\", etc. Defaults to 1.",
+        optional: true,
+        hidden: true,
       },
-      sendUpdates: {
-        propDefinition: [
-          googleCalendar,
-          "sendUpdates",
-        ],
+      repeatUntil: {
+        type: "string",
+        label: "Repeat Until",
+        description: "The event will repeat only until this date, if set",
+        optional: true,
+        hidden: true,
       },
-      sendNotifications: {
-        propDefinition: [
-          googleCalendar,
-          "sendNotifications",
-        ],
+      repeatTimes: {
+        type: "integer",
+        label: "Repeat How Many Times?",
+        description: "Limit the number of times this event will occur",
+        optional: true,
+        hidden: true,
       },
     }
   ),
@@ -86,6 +92,11 @@ export default {
       * ]
       */
       let attendees = [];
+      if (typeof selectedAttendees === "string") {
+        selectedAttendees = selectedAttendees.includes("[") && selectedAttendees.includes("]")
+          ? JSON.parse(selectedAttendees)
+          : selectedAttendees.replaceAll(" ", "").split(",");
+      }
       if (selectedAttendees && Array.isArray(selectedAttendees)) {
         attendees = selectedAttendees.map((email) => ({
           email,
@@ -119,5 +130,37 @@ export default {
         timeZone,
       };
     },
+    /**
+    * Format recurrence prop
+    * https://developers.google.com/calendar/api/concepts/events-calendars#recurrence_rule
+    */
+    formatRecurrence({
+      repeatFrequency,
+      repeatInterval,
+      repeatTimes,
+      repeatUntil,
+    }) {
+      if (!repeatFrequency) {
+        return;
+      }
+      if (repeatTimes && repeatUntil) {
+        throw new ConfigurationError("Only one of `Repeat Until` or Repeat `How Many Times` may be entered");
+      }
+
+      let recurrence = `RRULE:FREQ=${repeatFrequency}`;
+      if (repeatInterval) {
+        recurrence = `${recurrence};INTERVAL=${repeatInterval}`;
+      }
+      if (repeatTimes) {
+        recurrence = `${recurrence};COUNT=${repeatTimes}`;
+      }
+      if (repeatUntil) {
+        const date = repeatUntil.slice(0, 10).replaceAll("-", "");
+        recurrence = `${recurrence};UNTIL=${date}`;
+      }
+      return [
+        recurrence,
+      ];
+    },
   },
 };

package/actions/create-event/create-event.mjs

@@ -1,48 +1,145 @@
 import googleCalendar from "../../google_calendar.app.mjs";
 import createEventCommon from "../common/create-event-common.mjs";
 import { v4 as uuidv4 } from "uuid";
+import constants from "../../common/constants.mjs";
 
 export default {
   key: "google_calendar-create-event",
   name: "Create Event",
-  description: "Create an event to the Google Calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/insert)",
-  version: "0.2.2",
+  description: "Create an event in a Google Calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/insert)",
+  version: "0.2.3",
   type: "action",
   props: {
     googleCalendar,
+    addType: {
+      type: "string",
+      label: "Type of Add",
+      description: "Whether to perform a quick add or a detailed event",
+      options: [
+        {
+          label: "Add Detailed Event",
+          value: "detailed",
+        },
+        {
+          label: "Add Quick Event using Natural Language",
+          value: "quick",
+        },
+      ],
+      reloadProps: true,
+    },
     calendarId: {
       propDefinition: [
         googleCalendar,
         "calendarId",
       ],
     },
-    createMeetRoom: {
-      label: "Create Meet Room",
-      description: "Create a Google Meet room for this event.",
-      type: "boolean",
+    text: {
+      type: "string",
+      label: "Describe Event",
+      description: "Write a plain text description of event, and Google will parse this string to create the event. eg. 'Meet with Michael 10am 7/22/2024' or 'Call Sarah at 1:30PM on Friday'",
+      hidden: true,
+    },
+    summary: {
+      label: "Event Title",
+      type: "string",
+      description: "Enter a title for the event, (e.g., `My event`)",
       optional: true,
+      hidden: true,
     },
-    ...createEventCommon.props({
-      isUpdate: false,
-    }),
     colorId: {
       propDefinition: [
         googleCalendar,
         "colorId",
       ],
+      hidden: true,
+    },
+    timeZone: {
+      propDefinition: [
+        googleCalendar,
+        "timeZone",
+      ],
+      hidden: true,
+    },
+    sendUpdates: {
+      propDefinition: [
+        googleCalendar,
+        "sendUpdates",
+      ],
+      hidden: true,
+    },
+    createMeetRoom: {
+      type: "boolean",
+      label: "Create Meet Room",
+      description: "Whether to create a Google Meet room for this event.",
+      optional: true,
+      hidden: true,
+    },
+    visibility: {
+      type: "string",
+      label: "Visibility",
+      description: "Visibility of the event",
+      options: [
+        "default",
+        "public",
+        "private",
+        "confidential",
+      ],
+      optional: true,
+      hidden: true,
     },
   },
+  async additionalProps(props) {
+    const isDetailed = this.addType === "detailed";
+
+    props.text.hidden = isDetailed;
+
+    props.summary.hidden = !isDetailed;
+    props.colorId.hidden = !isDetailed;
+    props.timeZone.hidden = !isDetailed;
+    props.sendUpdates.hidden = !isDetailed;
+    props.createMeetRoom.hidden = !isDetailed;
+    props.visibility.hidden = !isDetailed;
+
+    if (isDetailed) {
+      const commonProps = createEventCommon.props({
+        isUpdate: false,
+      });
+      if (this.repeatFrequency) {
+        const frequency = constants.REPEAT_FREQUENCIES[this.repeatFrequency];
+        commonProps.repeatInterval.description = `Enter 1 to "repeat every ${frequency}", enter 2 to "repeat every other ${frequency}", etc. Defaults to 1.`;
+        commonProps.repeatInterval.hidden = !this.repeatFrequency;
+        commonProps.repeatUntil.hidden = !this.repeatFrequency;
+        commonProps.repeatTimes.hidden = !this.repeatFrequency;
+      }
+      return commonProps;
+    }
+    return {};
+  },
   methods: {
     ...createEventCommon.methods,
   },
   async run({ $ }) {
+    if (this.addType === "quick") {
+      const quickResponse = await this.googleCalendar.quickAddEvent({
+        calendarId: this.calendarId,
+        text: this.text,
+      });
+      $.export("$summary", `Successfully added a quick event: "${quickResponse.id}"`);
+      return quickResponse;
+    }
+
     const timeZone = await this.getTimeZone(this.timeZone);
     const attendees = this.formatAttendees(this.attendees);
+    const recurrence = this.formatRecurrence({
+      repeatFrequency: this.repeatFrequency,
+      repeatInterval: this.repeatInterval,
+      repeatTimes: this.repeatTimes,
+      repeatUntil: this.repeatUntil,
+    });
 
     const data = {
       calendarId: this.calendarId,
       sendUpdates: this.sendUpdates,
-      sendNotifications: this.sendNotifications,
       resource: {
         summary: this.summary,
         location: this.location,
@@ -55,9 +152,10 @@ export default {
           date: this.eventEndDate,
           timeZone,
         }),
-        recurrence: this.recurrence,
+        recurrence,
         attendees,
         colorId: this.colorId,
+        visibility: this.visibility,
       },
     };
 
@@ -75,7 +173,7 @@ export default {
 
     const response = await this.googleCalendar.createEvent(data);
 
-    $.export("$summary", `Successfully created event: "${response.id}"`);
+    $.export("$summary", `Successfully created event with ID: "${response.id}"`);
 
     return response;
   },

package/actions/delete-event/delete-event.mjs

@@ -3,8 +3,8 @@ import googleCalendar from "../../google_calendar.app.mjs";
 export default {
   key: "google_calendar-delete-event",
   name: "Delete an Event",
-  description: "Delete an event to the Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#delete)",
-  version: "0.1.4",
+  description: "Delete an event from a Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#delete)",
+  version: "0.1.5",
   type: "action",
   props: {
     googleCalendar,

package/actions/get-calendar/get-calendar.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_calendar-get-calendar",
   name: "Retrieve Calendar Details",
   description: "Retrieve calendar details of a Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Calendars.html#get)",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleCalendar,

package/actions/get-event/get-event.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_calendar-get-event",
   name: "Retrieve Event Details",
   description: "Retrieve event details from Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#get)",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleCalendar,

package/actions/list-calendars/list-calendars.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_calendar-list-calendars",
   name: "List Calendars",
   description: "Retrieve a list of calendars from Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Calendarlist.html#list)",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleCalendar,
@@ -12,7 +12,9 @@ export default {
   async run({ $ }) {
     const { items: calendars } = await this.googleCalendar.listCalendars();
 
-    $.export("$summary", `Successfully retrieved ${calendars.length} calendar(s)`);
+    $.export("$summary", `Successfully retrieved ${calendars.length} calendar${calendars.length === 1
+      ? ""
+      : "s"}`);
 
     return calendars;
   },

package/actions/list-events/list-events.mjs

@@ -1,11 +1,12 @@
 import googleCalendar from "../../google_calendar.app.mjs";
 import utils from "../../common/utils.mjs";
+import { ConfigurationError } from "@pipedream/platform";
 
 export default {
   key: "google_calendar-list-events",
   name: "List Events",
   description: "Retrieve a list of event from the Google Calendar. [See the documentation](https://developers.google.com/calendar/api/v3/reference/events/list)",
-  version: "0.0.5",
+  version: "0.0.6",
   type: "action",
   props: {
     googleCalendar,
@@ -40,12 +41,6 @@ export default {
       ],
       default: "",
     },
-    pageToken: {
-      propDefinition: [
-        googleCalendar,
-        "pageToken",
-      ],
-    },
     privateExtendedProperty: {
       propDefinition: [
         googleCalendar,
@@ -82,12 +77,6 @@ export default {
         "singleEvents",
       ],
     },
-    syncToken: {
-      propDefinition: [
-        googleCalendar,
-        "syncToken",
-      ],
-    },
     timeMax: {
       propDefinition: [
         googleCalendar,
@@ -120,30 +109,44 @@ export default {
     },
   },
   async run({ $ }) {
+    if (this.orderBy === "startTime" && !this.singleEvents) {
+      throw new ConfigurationError("Single Events must be `true` to order by `startTime`");
+    }
+
     const args = utils.filterEmptyValues({
       calendarId: this.calendarId,
       iCalUID: this.iCalUID,
       maxAttendees: this.maxAttendees,
-      maxResults: this.maxResults,
       orderBy: this.orderBy || undefined,
-      pageToken: this.pageToken,
       privateExtendedProperty: this.privateExtendedProperty,
       q: this.q,
       sharedExtendedProperty: this.sharedExtendedProperty,
       showDeleted: this.showDeleted,
       showHiddenInvitations: this.showHiddenInvitations,
       singleEvents: this.singleEvents,
-      syncToken: this.syncToken,
       timeMax: this.timeMax,
       timeMin: this.timeMin,
       timeZone: this.timeZone,
       updatedMin: this.updatedMin,
       eventTypes: this.eventTypes,
     });
-    const response = await this.googleCalendar.listEvents(args);
 
-    $.export("$summary", `Successfully retrieved ${response.items.length} event(s)`);
+    const events = [];
+    do {
+      const {
+        items, nextPageToken,
+      } = await this.googleCalendar.listEvents(args);
+      events.push(...items);
+      args.pageToken = nextPageToken;
+    } while (args.pageToken && (!this.maxResults || events.length < this.maxResults));
+    if (events.length > this.maxResults) {
+      events.length = this.maxResults;
+    }
+
+    $.export("$summary", `Successfully retrieved ${events.length} event${events.length === 1
+      ? ""
+      : "s"}`);
 
-    return response;
+    return events;
   },
 };

package/actions/query-free-busy-calendars/query-free-busy-calendars.mjs

@@ -4,7 +4,7 @@ export default {
   key: "google_calendar-query-free-busy-calendars",
   name: "Retrieve Free/Busy Calendar Details",
   description: "Retrieve free/busy calendar details from Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Freebusy.html#query)",
-  version: "0.1.5",
+  version: "0.1.6",
   type: "action",
   props: {
     googleCalendar,

package/actions/quick-add-event/quick-add-event.mjs

@@ -1,10 +1,11 @@
 import googleCalendar from "../../google_calendar.app.mjs";
+import createEventCommon from "../common/create-event-common.mjs";
 
 export default {
   key: "google_calendar-quick-add-event",
   name: "Add Quick Event",
   description: "Create a quick event to the Google Calendar. [See the documentation](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#quickAdd)",
-  version: "0.1.4",
+  version: "0.1.5",
   type: "action",
   props: {
     googleCalendar,
@@ -15,9 +16,15 @@ export default {
       ],
     },
     text: {
-      label: "Event Title",
       type: "string",
-      description: "Enter a title for the event, (e.g., `My event`)",
+      label: "Describe Event",
+      description: "Write a plain text description of event, and Google will parse this string to create the event. eg. 'Meet with Michael 10am 7/22/2024' or 'Call Sarah at 1:30PM on Friday'",
+    },
+    attendees: {
+      label: "Attendees",
+      type: "string",
+      description: "Enter either an array or a comma separated list of email addresses of attendees",
+      optional: true,
     },
   },
   async run({ $ }) {
@@ -26,6 +33,18 @@ export default {
       text: this.text,
     });
 
+    if (this.attendees) {
+      const update = await this.googleCalendar.updateEvent({
+        calendarId: this.calendarId,
+        eventId: response.id,
+        requestBody: {
+          ...response,
+          attendees: createEventCommon.methods.formatAttendees(this.attendees),
+        },
+      });
+      response.attendees = update.attendees;
+    }
+
     $.export("$summary", `Successfully added a quick event: "${response.id}"`);
 
     return response;