[Components] beekeeper #13273

Sources
 - New Chat Message (Instant)
 - New User Created (Instant)
 - New Comment Added (Instant)

Actions
 - Send Message Group Chat
 - Create Post
 - Get Profile

Author: luancazarine

components/beekeeper/actions/create-post/create-post.mjs

@@ -1,5 +1,5 @@
 import beekeeper from "../../beekeeper.app.mjs";
-import { axios } from "@pipedream/platform";
+import { parseObject } from "../../common/utils.mjs";
 
 export default {
   key: "beekeeper-create-post",
@@ -15,10 +15,15 @@ export default {
         "streamId",
       ],
     },
+    text: {
+      type: "string",
+      label: "Text",
+      description: "The text content of the post",
+    },
     files: {
       type: "string[]",
       label: "Files",
-      description: "Array of files to be attached to the post",
+      description: "List of file objects to be attached. E.g. [{\"name\": \"fair_play_rules.pdf\", \"url\": \"https://mytenant.beekeeper.io/file/665987/original/fair_play_rules.pdf\", \"userid\": \"5cb9v45d-8i78-4v65-b5fd-81cgfac3ef17\", \"height\": 619, \"width\": 700, \"key\": \"f4fdaab0-d198-49b4-b1cc-dd85572d72f1\", \"media_type\": \"image/png\", \"usage_type\": \"attachment_image\" }]. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/18408b41927b9-creates-a-new-post) for further details.",
       optional: true,
     },
     locked: {
@@ -34,71 +39,63 @@ export default {
       optional: true,
     },
     media: {
-      type: "string",
+      type: "string[]",
       label: "Media",
-      description: "Media attachment for the post",
+      description: "List of Photo or Video objects. E.g. [{\"name\": \"fair_play_rules.pdf\", \"url\": \"https://mytenant.beekeeper.io/file/665987/original/fair_play_rules.pdf\", \"userid\": \"5cb9v45d-8i78-4v65-b5fd-81cgfac3ef17\", \"height\": 619, \"width\": 700, \"key\": \"f4fdaab0-d198-49b4-b1cc-dd85572d72f1\", \"media_type\": \"image/png\", \"usage_type\": \"attachment_image\" }]. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/18408b41927b9-creates-a-new-post) for further details.",
       optional: true,
     },
     labels: {
       type: "string[]",
       label: "Labels",
-      description: "Array of labels for the post",
+      description: "List of labels attached to the post",
       optional: true,
     },
     sticky: {
       type: "boolean",
       label: "Sticky",
-      description: "Make the post sticky",
-      optional: true,
-    },
-    photos: {
-      type: "string[]",
-      label: "Photos",
-      description: "Array of photos to be attached to the post",
+      description: "Flag that pins a post to the top of the stream",
       optional: true,
     },
     reactionsDisabled: {
       type: "boolean",
       label: "Reactions Disabled",
-      description: "Disable reactions for the post",
-      optional: true,
-    },
-    text: {
-      type: "string",
-      label: "Text",
-      description: "The text content of the post",
+      description: "Flag that disables the ability to add reaction to the post and to see reactions that have been added",
       optional: true,
     },
     options: {
       type: "object",
       label: "Options",
-      description: "Additional options for the post",
+      description: "List of poll options in a post. E.g. [\"This Friday\", \"Monday next week\"]",
       optional: true,
     },
     scheduledAt: {
       type: "string",
       label: "Scheduled At",
-      description: "The scheduled time for the post in the format (UTC, yyyy-mm-ddTHH:MM:SS)",
+      description: "Date and time when the post is scheduled to be published (UTC timezone, yyyy-mm-ddTHH:MM:SS format)",
       optional: true,
     },
   },
   async run({ $ }) {
     const response = await this.beekeeper.createPost({
-      streamId: this.streamId,
-      files: this.files,
-      locked: this.locked,
-      title: this.title,
-      media: this.media,
-      labels: this.labels,
-      sticky: this.sticky,
-      photos: this.photos,
-      reactionsDisabled: this.reactionsDisabled,
-      text: this.text,
-      options: this.options,
-      scheduledAt: this.scheduledAt,
+      $,
+      data: {
+        streamid: this.streamId,
+        files: parseObject(this.files),
+        locked: this.locked,
+        title: this.title,
+        media: parseObject(this.media),
+        labels: parseObject(this.labels),
+        sticky: this.sticky,
+        reactions_disabled: this.reactionsDisabled,
+        text: this.text,
+        options: parseObject(this.options)?.map((item) => ({
+          text: item,
+        })),
+        scheduled_at: this.scheduledAt,
+      },
     });
 
-    $.export("$summary", `Successfully created post with title: ${this.title || "Untitled"}`);
+    $.export("$summary", `Successfully created post with UUID: ${response.uuid}`);
     return response;
   },
 };

components/beekeeper/actions/get-profile/get-profile.mjs

@@ -1,11 +1,10 @@
 import beekeeper from "../../beekeeper.app.mjs";
-import { axios } from "@pipedream/platform";
 
 export default {
   key: "beekeeper-get-profile",
   name: "Get User Profile",
   description: "Retrieve the profile details of a specific user. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/05bcd13b38a67-get-profile-of-the-given-user)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     beekeeper,
@@ -18,23 +17,24 @@ export default {
     includeActivities: {
       type: "boolean",
       label: "Include Activities",
-      description: "Whether to include the user's activities. True by default.",
-      optional: true,
+      description: "Whether to include the user's activities.",
       default: true,
     },
     includeTotals: {
       type: "boolean",
       label: "Include Totals",
-      description: "Whether to include the user's total number of posts, comments, and likes received. True by default.",
-      optional: true,
+      description: "Whether to include the user's total number of posts, comments, and likes received.",
       default: true,
     },
   },
   async run({ $ }) {
     const response = await this.beekeeper.getUserProfile({
+      $,
       userId: this.userId,
-      includeActivities: this.includeActivities,
-      includeTotals: this.includeTotals,
+      params: {
+        include_activities: this.includeActivities,
+        include_totals: this.includeTotals,
+      },
     });
 
     $.export("$summary", `Successfully retrieved profile for user ID ${this.userId}`);

components/beekeeper/actions/send-message-group-chat/send-message-group-chat.mjs

@@ -1,11 +1,12 @@
+import { ConfigurationError } from "@pipedream/platform";
 import beekeeper from "../../beekeeper.app.mjs";
-import { axios } from "@pipedream/platform";
+import { parseObject } from "../../common/utils.mjs";
 
 export default {
   key: "beekeeper-send-message-group-chat",
   name: "Send Message to Group Chat",
   description: "Send a precomposed message to a defined group chat. [See the documentation](https://beekeeper.stoplight.io/docs/beekeeper-api/9075b32d36db4-send-a-message-to-a-group-chat)",
-  version: "0.0.{{ts}}",
+  version: "0.0.1",
   type: "action",
   props: {
     beekeeper,
@@ -45,35 +46,38 @@ export default {
       description: "Array of objects containing type and data fields for message addons.",
       optional: true,
     },
-    refersTo: {
-      type: "string",
-      label: "Refers To",
-      description: "Field used by message deletion event. Marks the ID of the message the deletion message refers to.",
-      optional: true,
-    },
     mentions: {
-      type: "string[]",
-      label: "Mentions",
-      description: "IDs of the users mentioned in the message body. Can also have value of 'all', which means all the chat members were mentioned.",
+      propDefinition: [
+        beekeeper,
+        "mentions",
+        ({ chatId }) => ({
+          chatId,
+        }),
+      ],
       optional: true,
     },
   },
   async run({ $ }) {
-    const data = {
-      body: this.body,
-      attachment: this.attachment,
-      event: {
-        type: this.eventType,
-      },
-      chat_state_addons: this.chatStateAddons?.map(JSON.parse),
-      message_addons: this.messageAddons?.map(JSON.parse),
-      refers_to: this.refersTo,
-      mentions: this.mentions,
-    };
-
+    if (!this.body && !this.event && !this.attachment && !this.chatStateAddons) {
+      throw new ConfigurationError("You must provide at least **Body**, **Event**, **Attachment** or **Chat State Addons**");
+    }
     const response = await this.beekeeper.sendMessage({
+      $,
       chatId: this.chatId,
-      ...data,
+      data: {
+        body: this.body,
+        attachment: parseObject(this.attachment),
+        ...this.eventType
+          ? {
+            event: {
+              type: this.eventType,
+            },
+          }
+          : {},
+        chat_state_addons: parseObject(this.chatStateAddons),
+        message_addons: parseObject(this.messageAddons),
+        mentions: parseObject(this.mentions),
+      },
     });
 
     $.export("$summary", `Message sent successfully to chat ID: ${this.chatId}`);