@pipedream/telegram_bot_api 0.3.3

package/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2020 Pipedream, Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/actions/create-chat-invite-link/create-chat-invite-link.mjs

@@ -0,0 +1,52 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-create-chat-invite-link",
+  name: "Create Chat Invite Link",
+  description: "Create an additional invite link for a chat, [See the docs](https://core.telegram.org/bots/api#createchatinvitelink) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    name: {
+      propDefinition: [
+        telegramBotApi,
+        "link_name",
+      ],
+    },
+    expire_date: {
+      propDefinition: [
+        telegramBotApi,
+        "expire_date",
+      ],
+    },
+    member_limit: {
+      propDefinition: [
+        telegramBotApi,
+        "member_limit",
+      ],
+    },
+    creates_join_request: {
+      propDefinition: [
+        telegramBotApi,
+        "creates_join_request",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.createChatInviteLink(this.chatId, {
+      name: this.name,
+      expire_date: this.expire_date,
+      member_limit: this.member_limit,
+      creates_join_request: this.creates_join_request,
+    });
+    $.export("$summary", `Successfully created chat invite link, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/delete-message/delete-message.mjs

@@ -0,0 +1,29 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-delete-message",
+  name: "Delete a Message",
+  description: "Deletes a message. [See the docs](https://core.telegram.org/bots/api#deletemessage) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    messageId: {
+      propDefinition: [
+        telegramBotApi,
+        "messageId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.deleteMessage(this.chatId, this.messageId);
+    $.export("$summary", `Successfully deleted the message from chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/edit-media-message/edit-media-message.mjs

@@ -0,0 +1,89 @@
+import {
+  TELEGRAM_BOT_API_MEDIA_PHOTO,
+  TELEGRAM_BOT_API_MEDIA_VIDEO,
+} from "../../constants.mjs";
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-edit-media-message",
+  name: "Edit a Media Message",
+  description: "Edits photo or video messages. [See the docs](https://core.telegram.org/bots/api#editmessagemedia) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    messageId: {
+      propDefinition: [
+        telegramBotApi,
+        "messageId",
+      ],
+    },
+    type: {
+      propDefinition: [
+        telegramBotApi,
+        "type",
+      ],
+      options: [
+        {
+          label: "Photo",
+          value: TELEGRAM_BOT_API_MEDIA_PHOTO,
+        },
+        {
+          label: "Video",
+          value: TELEGRAM_BOT_API_MEDIA_VIDEO,
+        },
+      ],
+    },
+    caption: {
+      propDefinition: [
+        telegramBotApi,
+        "caption",
+      ],
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    media: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Media",
+    },
+    parse_mode: {
+      propDefinition: [
+        telegramBotApi,
+        "parse_mode",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.editMessageMedia({
+      type: this.type,
+      media: this.media,
+      caption: this.caption,
+      parse_mode: this.parse_mode,
+    }, {
+      chatId: this.chatId,
+      messageId: this.messageId,
+      reply_markup: this.reply_markup,
+    });
+    $.export("$summary", `Successfully edited the ${this.type || "media"} message in chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/edit-text-message/edit-text-message.mjs

@@ -0,0 +1,45 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-edit-text-message",
+  name: "Edit a Text Message",
+  description: "Edits text or game messages. [See the docs](https://core.telegram.org/bots/api#editmessagetext) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    messageId: {
+      propDefinition: [
+        telegramBotApi,
+        "messageId",
+      ],
+    },
+    text: {
+      propDefinition: [
+        telegramBotApi,
+        "text",
+      ],
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.editMessageText(this.text, {
+      chatId: this.chatId,
+      messageId: this.messageId,
+      disable_notification: this.disable_notification,
+    });
+    $.export("$summary", `Successfully edited the message in chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/export-chat-invite-link/export-chat-invite-link.mjs

@@ -0,0 +1,23 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-export-chat-invite-link",
+  name: "Export Chat Invite Link",
+  description: "Generate a new primary invite link for a chat, [See the docs](https://core.telegram.org/bots/api#createchatinvitelink) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.exportChatInviteLink(this.chatId);
+    $.export("$summary", `Successfully exported chat invite link, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/forward-message/forward-message.mjs

@@ -0,0 +1,48 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-forward-message",
+  name: "Forward a Message",
+  description: "Forwards messages of any kind. [See the docs](https://core.telegram.org/bots/api#forwardmessage) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    fromChatId: {
+      propDefinition: [
+        telegramBotApi,
+        "fromChatId",
+      ],
+    },
+    messageId: {
+      propDefinition: [
+        telegramBotApi,
+        "messageId",
+      ],
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.forwardMessage(
+      this.chatId,
+      this.fromChatId,
+      this.messageId,
+      {
+        disable_notification: this.disable_notification,
+      },
+    );
+    $.export("$summary", `Successfully forwarded the message from chat, "${this.fromChatId}", to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/get-num-members-in-chat/get-num-members-in-chat.mjs

@@ -0,0 +1,23 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-get-num-members-in-chat",
+  name: "Get the Number of Members in a Chat",
+  description: "Use this module to get the number of members in a chat. [See the docs](https://core.telegram.org/bots/api#getchatmembercount) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.getChatMemberCount(this.chatId);
+    $.export("$summary", `Successfully fetched the number of members in chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/kick-chat-member/kick-chat-member.mjs

@@ -0,0 +1,38 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-kick-chat-member",
+  name: "Kick a Chat Member",
+  description: "Use this method to kick a user from a group, a supergroup or channel. [See the docs](https://core.telegram.org/bots/api#banchatmember) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        telegramBotApi,
+        "userId",
+      ],
+    },
+    until_date: {
+      propDefinition: [
+        telegramBotApi,
+        "until_date",
+      ],
+      description: "Enter the date when the user will be unbanned, in [unix time](https://en.wikipedia.org/wiki/Unix_time) (e.g. `1567780450`).",
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.banChatMember(this.chatId, this.userId, {
+      until_date: this.until_date,
+    });
+    $.export("$summary", `Successfully kicked user, "${this.userId}", from the chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/list-administrators-in-chat/list-administrators-in-chat.mjs

@@ -0,0 +1,25 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-list-administrators-in-chat",
+  name: "List Administrators In Chat",
+  description: "Use this module to get a list of administrators in a chat. [See the docs](https://core.telegram.org/bots/api#getchatadministrators) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.getChatAdministrators(this.chatId);
+    $.export("$summary", `Successfully fetched ${resp.length} administrator${resp.length === 1
+      ? ""
+      : "s"} in the chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/list-chats/list-chats.mjs

@@ -0,0 +1,73 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-list-chats",
+  name: "List Chats",
+  description: "List available Telegram chats. [See the docs](https://core.telegram.org/bots/api#getupdates) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    offset: {
+      propDefinition: [
+        telegramBotApi,
+        "offset",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        telegramBotApi,
+        "limit",
+      ],
+    },
+    autoPaging: {
+      propDefinition: [
+        telegramBotApi,
+        "autoPaging",
+      ],
+    },
+  },
+  methods: {
+    /**
+     * Uses an Update object to generate a result object containing chat
+     * metadata, representing the source of the update and chat in which the
+     * update was made
+     *
+     * @param {Object} update - an Update to use to generate a result
+     * @returns a result representing a chat
+     */
+    generateResultFromUpdate(update) {
+      return {
+        update_id: update.update_id,
+        ...Object.keys(update).reduce((resultPart, key) => {
+          return (resultPart.chat
+            ? resultPart
+            : {
+              chat: update[key].chat,
+              from: update[key].from,
+              forward_from_chat: update[key].forward_from_chat,
+            });
+        }, {}),
+      };
+    },
+  },
+  async run({ $ }) {
+    const updates = await this.telegramBotApi.getUpdates({
+      offset: this.offset,
+      limit: this.limit,
+    });
+    if (this.autoPaging && updates.length > 0) {
+      const lastUpdateId = updates[updates.length - 1].update_id;
+      // "Confirm" updates by calling API to get updates using an offset of the
+      // last `update_id + 1` See [documentation for getUpdates in the Telegram
+      // Bot API reference](https://core.telegram.org/bots/api#getupdates)
+      await this.telegramBotApi.getUpdates({
+        offset: lastUpdateId + 1,
+        limit: 1,
+      });
+    }
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully fetched ${updates.length} available Telegram chat${updates.length === 1 ? "" : "s"}`);
+    return updates.map(this.generateResultFromUpdate);
+  },
+};

package/actions/list-updates/list-updates.mjs

@@ -0,0 +1,49 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-list-updates",
+  name: "List Updates",
+  description: "Retrieves a list of updates from the Telegram server. [See the docs](https://core.telegram.org/bots/api#getupdates) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    offset: {
+      propDefinition: [
+        telegramBotApi,
+        "offset",
+      ],
+    },
+    limit: {
+      propDefinition: [
+        telegramBotApi,
+        "limit",
+      ],
+    },
+    autoPaging: {
+      propDefinition: [
+        telegramBotApi,
+        "autoPaging",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const updates = await this.telegramBotApi.getUpdates({
+      offset: this.offset,
+      limit: this.limit,
+    });
+    if (this.autoPaging && updates.length > 0) {
+      const lastUpdateId = updates[updates.length - 1].update_id;
+      // "Confirm" updates by calling API to get updates using an offset of the
+      // last `update_id + 1` See [documentation for getUpdates in the Telegram
+      // Bot API reference](https://core.telegram.org/bots/api#getupdates)
+      await this.telegramBotApi.getUpdates({
+        offset: lastUpdateId + 1,
+        limit: 1,
+      });
+    }
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully fetched ${updates.length} update${updates.length === 1 ? "" : "s"}`);
+    return updates;
+  },
+};

package/actions/pin-message/pin-message.mjs

@@ -0,0 +1,37 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-pin-message",
+  name: "Pin a Message",
+  description: "Pins a message. [See the docs](https://core.telegram.org/bots/api#pinchatmessage) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    messageId: {
+      propDefinition: [
+        telegramBotApi,
+        "messageId",
+      ],
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.pinChatMessage(this.chatId, this.messageId, {
+      disable_notification: this.disable_notification,
+    });
+    $.export("$summary", `Successfully pinned the message in chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/promote-chat-member/promote-chat-member.mjs

@@ -0,0 +1,86 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-promote-chat-member",
+  name: "Promote a Chat Member",
+  description: "Use this method to promote or demote a user in a supergroup or a channel. [See the docs](https://core.telegram.org/bots/api#promotechatmember) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    userId: {
+      propDefinition: [
+        telegramBotApi,
+        "userId",
+      ],
+    },
+    can_change_info: {
+      type: "boolean",
+      label: "Set if the Administrator Can Change Info",
+      description: "Pass True, if the administrator can change chat title, photo and other settings.",
+      optional: true,
+    },
+    can_post_messages: {
+      type: "boolean",
+      label: "Set if the Administrator Can Create Channel Posts",
+      description: "Pass True, if the administrator can create channel posts [channels only].",
+      optional: true,
+    },
+    can_edit_messages: {
+      type: "boolean",
+      label: "Set if the Administrator Can Edit Messages",
+      description: "Pass True, if the administrator can edit messages of other users and can pin messages [channels only].",
+      optional: true,
+    },
+    can_delete_messages: {
+      type: "boolean",
+      label: "Set if the Administrator Can Delete Messages",
+      description: "Pass True, if the administrator can delete messages of other users [channels only].",
+      optional: true,
+    },
+    can_invite_users: {
+      type: "boolean",
+      label: "Set if the Administrator Can Invite Users",
+      description: "Pass True, if the administrator can invite new users to the chat.",
+      optional: true,
+    },
+    can_restrict_members: {
+      type: "boolean",
+      label: "Set if the Administrator Can Restrict Members",
+      description: "Pass True, if the administrator can restrict, ban or unban chat members.",
+      optional: true,
+    },
+    can_pin_messages: {
+      type: "boolean",
+      label: "Set if the Administrator Can Pin Messages",
+      description: "Pass True, if the administrator can pin messages [supergroups only].",
+      optional: true,
+    },
+    can_promote_members: {
+      type: "boolean",
+      label: "Set if the Administrator Can Promote Members",
+      description: "Pass True, if the administrator can add new administrators with a subset of their own privileges or demote administrators that they have promoted, directly or indirectly (promoted by administrators that were appointed by them).",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.promoteChatMember(this.chatId, this.userId, {
+      can_change_info: this.can_change_info,
+      can_post_messages: this.can_post_messages,
+      can_edit_messages: this.can_edit_messages,
+      can_delete_messages: this.can_delete_messages,
+      can_invite_users: this.can_invite_users,
+      can_restrict_members: this.can_restrict_members,
+      can_pin_messages: this.can_pin_messages,
+      can_promote_members: this.can_promote_members,
+    });
+    $.export("$summary", `Successfully promoted the user, "${this.userId}", in chat, "${this.chatId}"`);
+    return resp;
+  },
+};