@pipedream/google_calendar 0.3.3 → 0.3.5

package/README.md

@@ -0,0 +1,20 @@
+# 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.
+
+Possible applications that could be built using the Google Calendar API
+include:
+
+- 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.

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

@@ -0,0 +1,128 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-create-event",
+  name: "Create Event",
+  description: "Create an event to the Google Calendar. [See the docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#insert)",
+  version: "0.1.4",
+  type: "action",
+  props: {
+    googleCalendar,
+    calendarId: {
+      propDefinition: [
+        googleCalendar,
+        "calendarId",
+      ],
+    },
+    summary: {
+      label: "Event Title",
+      type: "string",
+      description: "Enter static text (e.g., `hello world`) for the event name",
+      optional: true,
+    },
+    location: {
+      label: "Event Venue",
+      type: "string",
+      description: "Enter static text (e.g., `hello world`) for the event venue",
+      optional: true,
+    },
+    description: {
+      label: "Event Description",
+      type: "string",
+      description: "Enter detailed event description",
+      optional: true,
+    },
+    attendees: {
+      label: "Attendees",
+      type: "string[]",
+      description: "Enter the EmailId of the attendees",
+      optional: true,
+    },
+    eventStartDate: {
+      label: "Event 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.",
+    },
+    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.",
+    },
+    sendUpdates: {
+      label: "Send Updates",
+      type: "string",
+      description: "Whether to send notifications about the creation of the new event.",
+      optional: true,
+      options: [
+        "all",
+        "externalOnly",
+        "none",
+      ],
+    },
+    timeZone: {
+      propDefinition: [
+        googleCalendar,
+        "timeZone",
+      ],
+    },
+  },
+  async run({ $ }) {
+    /**
+     * Based on the IINA Time Zone DB
+     * http://www.iana.org/time-zones
+     */
+    const { value: timeZone } = this.timeZone ?? await this.googleCalendar.getSettings({
+      setting: "timezone",
+    });
+
+    /**
+     * Format for the attendees
+     *
+     * [
+     *   { "email": "lpage@example.com",},
+     *   { "email": "sbrin@example.com",},
+     * ]
+     */
+
+    let attendees = [];
+
+    if (this.attendees && Array.isArray(this.attendees)) {
+      attendees = this.attendees.map((email) => ({
+        email,
+      }));
+    }
+
+    const response = await this.googleCalendar.createEvent({
+      calendarId: this.calendarId,
+      sendUpdates: this.sendUpdates,
+      resource: {
+        summary: this.summary,
+        location: this.location,
+        description: this.description,
+        start: {
+          date: this.eventStartDate.length <= 10
+            ? this.eventStartDate
+            : undefined,
+          dateTime: this.eventStartDate.length > 10
+            ? this.eventStartDate
+            : undefined,
+          timeZone,
+        },
+        end: {
+          date: this.eventEndDate.length <= 10
+            ? this.eventEndDate
+            : undefined,
+          dateTime: this.eventEndDate.length > 10
+            ? this.eventEndDate
+            : undefined,
+          timeZone,
+        },
+        attendees,
+      },
+    });
+
+    $.export("$summary", `Successfully created event ${response.id}`);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,37 @@
+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 docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#delete)",
+  version: "0.1.0",
+  type: "action",
+  props: {
+    googleCalendar,
+    calendarId: {
+      propDefinition: [
+        googleCalendar,
+        "calendarId",
+      ],
+    },
+    eventId: {
+      propDefinition: [
+        googleCalendar,
+        "eventId",
+        (c) => ({
+          calendarId: c.calendarId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.googleCalendar.deleteEvent({
+      calendarId: this.calendarId,
+      eventId: this.eventId,
+    });
+
+    $.export("$summary", `Successfully deleted event ${response}`);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,27 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-get-calendar",
+  name: "Retrieve Calendar Details",
+  description: "Retrieve Calendar details of a Google Calendar. [See the docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Calendars.html#get)",
+  version: "0.1.1",
+  type: "action",
+  props: {
+    googleCalendar,
+    calendarId: {
+      propDefinition: [
+        googleCalendar,
+        "calendarId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.googleCalendar.getCalendar({
+      calendarId: this.calendarId,
+    });
+
+    $.export("$summary", `Successfully retrieved calendar ${response.id}`);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,37 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-get-event",
+  name: "Retrieve Event Details",
+  description: "Retrieve event details from the Google Calendar. [See the docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#get)",
+  version: "0.1.1",
+  type: "action",
+  props: {
+    googleCalendar,
+    calendarId: {
+      propDefinition: [
+        googleCalendar,
+        "calendarId",
+      ],
+    },
+    eventId: {
+      propDefinition: [
+        googleCalendar,
+        "eventId",
+        (c) => ({
+          calendarId: c.calendarId,
+        }),
+      ],
+    },
+  },
+  async run({ $ }) {
+    const response = await this.googleCalendar.getEvent({
+      calendarId: this.calendarId,
+      eventId: this.eventId,
+    });
+
+    $.export("$summary", `Successfully retrieved event ${response.id}`);
+
+    return response;
+  },
+};

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

@@ -0,0 +1,19 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-list-calendar",
+  name: "List calendars from user account",
+  description: "Retrieve calendars from the user account. [See the docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Calendarlist.html#list)",
+  version: "0.1.1",
+  type: "action",
+  props: {
+    googleCalendar,
+  },
+  async run({ $ }) {
+    const { items: calendars } = await this.googleCalendar.listCalendars();
+
+    $.export("$summary", `Successfully listed ${calendars.length} calendars`);
+
+    return calendars;
+  },
+};

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

@@ -0,0 +1,34 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-query-free-busy-calendars",
+  name: "Retrieve Free/Busy Calendar Details",
+  description: "Retrieve Free/Busy Calendar Details from the user account. [See the docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Freebusy.html#query)",
+  version: "0.1.1",
+  type: "action",
+  props: {
+    googleCalendar,
+    timeMin: {
+      type: "string",
+      label: "Time Min",
+      description: "The start of the interval for the query formatted as per RFC3339. (eg. `2022-02-20T19:27:40Z`)",
+    },
+    timeMax: {
+      type: "string",
+      label: "Time Max",
+      description: "The end of the interval for the query formatted as per RFC3339. (eg. `2022-04-20T19:27:40Z`)",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.googleCalendar.queryFreebusy({
+      requestBody: {
+        timeMin: this.timeMin,
+        timeMax: this.timeMax,
+      },
+    });
+
+    $.export("$summary", "Successfully retrieved free/busy calendar info");
+
+    return response;
+  },
+};

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

@@ -0,0 +1,33 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-quick-add-event",
+  name: "Add Quick Event",
+  description: "Create an event to the Google Calendar. [See the docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#quickAdd)",
+  version: "0.1.0",
+  type: "action",
+  props: {
+    googleCalendar,
+    calendarId: {
+      propDefinition: [
+        googleCalendar,
+        "calendarId",
+      ],
+    },
+    text: {
+      label: "Event Title",
+      type: "string",
+      description: "Enter static text (e.g., `hello world`) for the event name",
+    },
+  },
+  async run({ $ }) {
+    const response = await this.googleCalendar.quickAddEvent({
+      calendarId: this.calendarId,
+      text: this.text,
+    });
+
+    $.export("$summary", `Successfully quick added event ${response.id}`);
+
+    return response;
+  },
+};

package/actions/update-event-attendees/update-event-attendees.mjs

@@ -0,0 +1,74 @@
+import googleCalendar from "../../google_calendar.app.mjs";
+
+export default {
+  key: "google_calendar-update-event-attendees",
+  name: "Update attendees of an event",
+  description: "Update attendees of an existing event. [See the docs here](https://googleapis.dev/nodejs/googleapis/latest/calendar/classes/Resource$Events.html#update)",
+  version: "0.1.0",
+  type: "action",
+  props: {
+    googleCalendar,
+    calendarId: {
+      propDefinition: [
+        googleCalendar,
+        "calendarId",
+      ],
+    },
+    eventId: {
+      propDefinition: [
+        googleCalendar,
+        "eventId",
+        (c) => ({
+          calendarId: c.calendarId,
+        }),
+      ],
+    },
+    attendees: {
+      type: "string[]",
+      label: "Attendees",
+      description: "Array of selected email addresses or a comma separated list of email addresses of attendees. (eg. `a@domain.com,b@domain.com`)",
+      async options() {
+        const { attendees = [] } =
+          await this.googleCalendar.getEvent({
+            eventId: this.eventId,
+            calendarId: this.calendarId,
+          });
+        return attendees.map(({ email }) => ({
+          label: email,
+          value: email,
+        }));
+      },
+    },
+  },
+  async run({ $ }) {
+    const { attendees = [] } = this;
+    const {
+      // eslint-disable-next-line no-unused-vars
+      attendees: ignored,
+      ...body
+    } = await this.googleCalendar.getEvent({
+      eventId: this.eventId,
+      calendarId: this.calendarId,
+    });
+
+    const updatedAttendees =
+      Array.isArray(this.attendees)
+        ? attendees
+        : attendees.split(",");
+
+    const response = await this.googleCalendar.updateEvent({
+      calendarId: this.calendarId,
+      eventId: this.eventId,
+      requestBody: {
+        ...body,
+        attendees: updatedAttendees.map((email) => ({
+          email: email.trim(),
+        })),
+      },
+    });
+
+    $.export("$summary", `Successfully updated event attendees ${response.id}`);
+
+    return response;
+  },
+};

package/common/constants.mjs

@@ -0,0 +1,83 @@
+const API = {
+  ACL: {
+    NAME: "acl",
+    METHOD: {
+      DELETE: "delete",
+      GET: "get",
+      INSERT: "insert",
+      LIST: "list",
+      PATCH: "patch",
+      UPDATE: "update",
+      WATCH: "watch",
+    },
+  },
+  CALENDARS: {
+    NAME: "calendars",
+    METHOD: {
+      CLEAR: "clear",
+      DELETE: "delete",
+      GET: "get",
+      INSERT: "insert",
+      PATCH: "patch",
+      UPDATE: "update",
+    },
+  },
+  CALENDAR_LIST: {
+    NAME: "calendarList",
+    METHOD: {
+      DELETE: "delete",
+      GET: "get",
+      INSERT: "insert",
+      LIST: "list",
+      PATCH: "patch",
+      UPDATE: "update",
+      WATCH: "watch",
+    },
+  },
+  CHANNELS: {
+    NAME: "channels",
+    METHOD: {
+      STOP: "stop",
+    },
+  },
+  COLORS: {
+    NAME: "colors",
+    METHOD: {
+      GET: "get",
+    },
+  },
+  EVENTS: {
+    NAME: "events",
+    METHOD: {
+      DELETE: "delete",
+      GET: "get",
+      IMPORT: "import",
+      INSERT: "insert",
+      INSTANCES: "instances",
+      LIST: "list",
+      MOVE: "move",
+      PATCH: "patch",
+      QUICK_ADD: "quickAdd",
+      UPDATE: "update",
+      WATCH: "watch",
+    },
+  },
+  FREEBUSY: {
+    NAME: "freebusy",
+    METHOD: {
+      QUERY: "query",
+    },
+  },
+  SETTINGS: {
+    NAME: "settings",
+    METHOD: {
+      GET: "get",
+      LIST: "list",
+      WATCH: "watch",
+    },
+  },
+};
+
+export default {
+  API,
+};