@pipedream/microsoft_outlook_calendar 0.2.0 → 0.3.1

package/README.md

@@ -1,5 +1,11 @@
 # Overview
 
-With the Microsoft Outlook API, you can build a wide range of applications and
-services that work with Outlook. The Microsoft Outlook Calendar app helps you
-manage your calendar and schedule appointments.
+The Microsoft Outlook Calendar API provides programmatic access to a user's calendar events, allowing for the creation, retrieval, update, and deletion of events within Outlook calendars. With Pipedream, you can integrate these calendar operations into workflows that automate tasks involving scheduling, event management, and coordination with other services. Whether it's triggering actions when new events are created, syncing calendar events with other scheduling tools, or managing attendees, Pipedream's serverless platform enables you to build custom automations with minimal overhead.
+
+# Example Use Cases
+
+- **Automated Event Reminder Emails**: Trigger a Pipedream workflow whenever a new event is added to an Outlook Calendar. The workflow could send a reminder email via a service like SendGrid or Gmail to all the attendees a day before the event occurs, ensuring everyone is prepped and on time.
+
+- **Cross-Platform Calendar Sync**: Sync events between Microsoft Outlook Calendar and Google Calendar. When an event is created or updated in Outlook, a Pipedream workflow can create or update a corresponding event in Google Calendar. This ensures that users who operate across different platforms have unified schedules.
+
+- **Meeting Room Availability Checker**: Monitor your Outlook Calendar for new meetings and automatically check the availability of meeting rooms using a service like Google's G Suite Admin SDK. If a room is available, the workflow reserves it and updates the event with the room's details. If not, it could notify the organizer to select a different room or time.

package/actions/get-schedule/get-schedule.mjs

@@ -0,0 +1,71 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  key: "microsoft_outlook_calendar-get-schedule",
+  name: "Get Free/Busy Schedule",
+  description: "Get the free/busy availability information for a collection of users, distributions lists, or resources (rooms or equipment) for a specified time period. [See the documentation](https://learn.microsoft.com/en-us/graph/api/calendar-getschedule)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    microsoftOutlook,
+    schedules: {
+      type: "string[]",
+      label: "Emails",
+      description: "A list of emails of users, distribution lists, or resources. For example: `[ \"adelev@contoso.com\" , \"meganb@contoso.com\" ]`",
+    },
+    start: {
+      propDefinition: [
+        microsoftOutlook,
+        "start",
+      ],
+    },
+    end: {
+      propDefinition: [
+        microsoftOutlook,
+        "end",
+      ],
+    },
+    timeZone: {
+      propDefinition: [
+        microsoftOutlook,
+        "timeZone",
+      ],
+    },
+    availabilityViewInterval: {
+      type: "integer",
+      label: "Availability View Interval",
+      description: "Represents the duration of a time slot in minutes in an availabilityView in the response. The default is 30 minutes, minimum is 5, maximum is 1440.",
+      optional: true,
+    },
+  },
+  methods: {
+    getSchedule(opts = {}) {
+      return this.microsoftOutlook._makeRequest({
+        method: "POST",
+        path: "/me/calendar/getSchedule",
+        ...opts,
+      });
+    },
+  },
+  async run({ $ }) {
+    const { value } = await this.getSchedule({
+      $,
+      data: {
+        schedules: this.schedules,
+        startTime: {
+          dateTime: this.start,
+          timeZone: this.timeZone,
+        },
+        endTime: {
+          dateTime: this.end,
+          timeZone: this.timeZone,
+        },
+        availabilityViewInterval: this.availabilityViewInterval,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved schedules for \`${this.schedules.join("`, `")}\``);
+
+    return value;
+  },
+};

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

@@ -0,0 +1,47 @@
+import microsoftOutlook from "../../microsoft_outlook_calendar.app.mjs";
+
+export default {
+  key: "microsoft_outlook_calendar-list-events",
+  name: "List Events",
+  description: "Get a list of event objects in the user's mailbox. [See the documentation](https://learn.microsoft.com/en-us/graph/api/user-list-events)",
+  version: "0.0.2",
+  type: "action",
+  props: {
+    microsoftOutlook,
+    filter: {
+      type: "string",
+      label: "Filter",
+      description: "Filters results. For example, `contains(subject, 'meet for lunch?')` will include events whose title contains ‘meet for lunch?’. [See documentation](https://learn.microsoft.com/en-us/graph/filter-query-parameter) for the full list of operations.",
+      optional: true,
+    },
+    orderBy: {
+      type: "string",
+      label: "Order By",
+      description: "Orders results. For example, `displayName desc` will sort the results by Display Name in decending order.",
+      default: "createdDateTime desc",
+      optional: true,
+    },
+    maxResults: {
+      type: "integer",
+      label: "Max Results",
+      description: "The maximum number of results to return",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const { value = [] } = await this.microsoftOutlook.listCalendarEvents({
+      $,
+      params: {
+        "$orderby": this.orderBy,
+        "$filter": this.filter,
+        "$top": this.maxResults,
+      },
+    });
+
+    $.export("$summary", `Successfully retrieved ${value.length} event${value.length === 1
+      ? ""
+      : "s"}`);
+
+    return value;
+  },
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pipedream/microsoft_outlook_calendar",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Pipedream Microsoft Outlook Calendar Components",
   "main": "microsoft_outlook_calendar.app.mjs",
   "keywords": [
@@ -11,10 +11,10 @@
   ],
   "homepage": "https://pipedream.com/apps/microsoft_outlook_calendar",
   "author": "Pipedream <support@pipedream.com> (https://pipedream.com/)",
-  "dependencies": {
-    "@pipedream/platform": "^1.5.1"
-  },
   "publishConfig": {
     "access": "public"
+  },
+  "dependencies": {
+    "@pipedream/platform": "^3.0.3"
   }
 }