@pipedream/telegram_bot_api 0.3.3

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

@@ -0,0 +1,66 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-restrict-chat-member",
+  name: "Restrict a Chat Member",
+  description: "Use this method to restrict a user in a supergroup. [See the docs](https://core.telegram.org/bots/api#restrictchatmember) 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 restrictions will be lifted for the user, in [unix time](https://en.wikipedia.org/wiki/Unix_time) (e.g. `1567780450`).",
+    },
+    can_send_messages: {
+      type: "boolean",
+      label: "Set if the User Can Send Messages",
+      description: "Pass True, if the user can send text messages, contacts, locations and venues.",
+      optional: true,
+    },
+    can_send_media_messages: {
+      type: "boolean",
+      label: "Set if the User Can Send Media Messages",
+      description: "Pass True, if the user can send audios, documents, photos, videos, video notes and voice notes, implies can_send_messages.",
+      optional: true,
+    },
+    can_send_other_messages: {
+      type: "boolean",
+      label: "Set if the User Can send Other Messages",
+      description: "Pass True, if the user can send animations, games, stickers and use inline bots, implies can_send_media_messages.",
+      optional: true,
+    },
+    can_add_web_page_previews: {
+      type: "boolean",
+      label: "Set if the User Can Add Web Page Previews",
+      description: "Pass True, if the user may add web page previews to their messages, implies can_send_media_messages.",
+      optional: true,
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.restrictChatMember(this.chatId, this.userId, {
+      until_date: this.until_date,
+      can_send_messages: this.can_send_messages,
+      can_send_media_messages: this.can_send_media_messages,
+      can_send_other_messages: this.can_send_other_messages,
+      can_add_web_page_previews: this.can_add_web_page_previews,
+    });
+    $.export("$summary", `Successfully restricted the user, "${this.userId}", in supergroup, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-album/send-album.mjs

@@ -0,0 +1,53 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import { toSingleLineString } from "../../utils.mjs";
+
+export default {
+  key: "telegram_bot_api-send-album",
+  name: "Send an Album (Media Group)",
+  description: "Sends a group of photos or videos as an album. [See the docs](https://core.telegram.org/bots/api#sendmediagroup) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    media: {
+      type: "any",
+      label: "Media",
+      description: toSingleLineString(`
+        A JSON-serialized array describing photos and videos to be sent, must include 2–10 items
+        (e.g.,
+        \`[{"type":"photo","media":"https://example.com/myImage.jpeg"},{"type":"video","media":"/tmp/myVideo.mp4"}]\`).
+        [See the docs](https://core.telegram.org/bots/api#inputmedia) for more information about the
+        input media object.
+      `),
+      optional: false,
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+  },
+  async run({ $ }) {
+    let media = this.media;
+    if (typeof media === "string") {
+      try {
+        media = JSON.parse(media);
+      } catch (err) {
+        throw new Error("media must be deserializable to JSON");
+      }
+    }
+    const resp = await this.telegramBotApi.sendMediaGroup(this.chatId, media, {
+      disable_notification: this.disable_notification,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully sent an album of ${resp.length} media file${resp.length === 1 ? "" : "s"} to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-audio-file/send-audio-file.mjs

@@ -0,0 +1,98 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import contentTypes from "../../content-types.mjs";
+
+export default {
+  key: "telegram_bot_api-send-audio-file",
+  name: "Send an Audio File",
+  description: "Sends an audio file to your Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#sendaudio) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    caption: {
+      propDefinition: [
+        telegramBotApi,
+        "caption",
+      ],
+      description: "Enter the audio caption.",
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    audio: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Audio",
+    },
+    parse_mode: {
+      propDefinition: [
+        telegramBotApi,
+        "parse_mode",
+      ],
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+    duration: {
+      propDefinition: [
+        telegramBotApi,
+        "duration",
+      ],
+      description: "Enter duration of sent audio in seconds.",
+    },
+    performer: {
+      propDefinition: [
+        telegramBotApi,
+        "performer",
+      ],
+    },
+    title: {
+      propDefinition: [
+        telegramBotApi,
+        "title",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+    contentType: {
+      propDefinition: [
+        telegramBotApi,
+        "contentType",
+      ],
+      options: contentTypes.audio,
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendAudio(this.chatId, this.audio, {
+      caption: this.caption,
+      parse_mode: this.parse_mode,
+      disable_notification: this.disable_notification,
+      duration: this.duration,
+      performer: this.performer,
+      title: this.title,
+      reply_markup: this.reply_markup,
+      filename: this.filename,
+      contentType: this.contentType,
+    });
+    $.export("$summary", `Successfully sent the audio file "${resp.audio?.file_name}" to chat, "${this.chatId}""`);
+    return resp;
+  },
+};

package/actions/send-document-or-image/send-document-or-image.mjs

@@ -0,0 +1,83 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import contentTypes from "../../content-types.mjs";
+
+export default {
+  key: "telegram_bot_api-send-document-or-image",
+  name: "Send a Document/Image",
+  description: "Sends a document or an image to your Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#senddocument) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    caption: {
+      propDefinition: [
+        telegramBotApi,
+        "caption",
+      ],
+      description: "Enter the file caption.",
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    doc: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Document or Image",
+    },
+    parse_mode: {
+      propDefinition: [
+        telegramBotApi,
+        "parse_mode",
+      ],
+    },
+    contentType: {
+      propDefinition: [
+        telegramBotApi,
+        "contentType",
+      ],
+      options: contentTypes.all,
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+    reply_to_message_id: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_to_message_id",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendDocument(this.chatId, this.doc, {
+      caption: this.caption,
+      parse_mode: this.parse_mode,
+      disable_notification: this.disable_notification,
+      reply_to_message_id: this.reply_to_message_id,
+      reply_markup: this.reply_markup,
+      filename: this.filename,
+      contentType: this.contentType,
+    });
+    $.export("$summary", `Successfully sent the document "${resp.document?.file_name}" to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-media-by-url-or-id/send-media-by-url-or-id.mjs

@@ -0,0 +1,73 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import { TELEGRAM_BOT_API_UI_MEDIA_TYPES } from "../../constants.mjs";
+
+export default {
+  key: "telegram_bot_api-send-media-by-url-or-id",
+  name: "Send Media by URL or ID",
+  description: "Sends a file (document, photo, video, audio, ...) by HTTP URL or by ID that exists on the Telegram servers. [See the docs](https://core.telegram.org/bots/api#inputmedia) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    caption: {
+      propDefinition: [
+        telegramBotApi,
+        "caption",
+      ],
+    },
+    mediaType: {
+      propDefinition: [
+        telegramBotApi,
+        "type",
+      ],
+      options: TELEGRAM_BOT_API_UI_MEDIA_TYPES,
+    },
+    media: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Media",
+      description: "Pass a file_id to send a file that exists on the Telegram servers or pass an HTTP URL for Telegram to get a file from the Internet. File must meet Telegram's [requirements](https://core.telegram.org/bots/api#sending-files) for MIME type and size.",
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+    reply_to_message_id: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_to_message_id",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendMediaByType(
+      this.mediaType,
+      this.chatId,
+      this.media,
+      {
+        caption: this.caption,
+        disable_notification: this.disable_notification,
+        reply_to_message_id: this.reply_to_message_id,
+        reply_markup: this.reply_markup,
+      },
+    );
+    $.export("$summary", `Successfully sent the media file to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-photo/send-photo.mjs

@@ -0,0 +1,84 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import contentTypes from "../../content-types.mjs";
+
+export default {
+  key: "telegram_bot_api-send-photo",
+  name: "Send a Photo",
+  description: "Sends a photo to your Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#sendphoto) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    caption: {
+      propDefinition: [
+        telegramBotApi,
+        "caption",
+      ],
+      description: "Enter the photo caption.",
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    photo: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Photo",
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+    parse_mode: {
+      propDefinition: [
+        telegramBotApi,
+        "parse_mode",
+      ],
+    },
+    reply_to_message_id: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_to_message_id",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+    contentType: {
+      propDefinition: [
+        telegramBotApi,
+        "contentType",
+      ],
+      options: contentTypes.image,
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendPhoto(this.chatId, this.photo, {
+      caption: this.caption,
+      disable_notification: this.disable_notification,
+      parse_mode: this.parse_mode,
+      reply_to_message_id: this.reply_to_message_id,
+      reply_markup: this.reply_markup,
+      filename: this.filename,
+      contentType: this.contentType,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully sent the photo${this.fileName ? ` "${this.filename}"` : ""} to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-sticker/send-sticker.mjs

@@ -0,0 +1,53 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-send-sticker",
+  name: "Send a Sticker",
+  description: "Sends a .webp sticker to you Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#sendsticker) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    sticker: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Sticker",
+    },
+    reply_to_message_id: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_to_message_id",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendSticker(this.chatId, this.sticker, {
+      reply_to_message_id: this.reply_to_message_id,
+      reply_markup: this.reply_markup,
+      filename: this.filename,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully sent the sticker${this.fileName ? ` "${this.filename}"` : ""} to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-text-message-or-reply/send-text-message-or-reply.mjs

@@ -0,0 +1,66 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+
+export default {
+  key: "telegram_bot_api-send-text-message-or-reply",
+  name: "Send a Text Message or Reply",
+  description: "Sends a text message or a reply to your Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#sendmessage) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    text: {
+      propDefinition: [
+        telegramBotApi,
+        "text",
+      ],
+    },
+    parse_mode: {
+      propDefinition: [
+        telegramBotApi,
+        "parse_mode",
+      ],
+    },
+    disable_notification: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_notification",
+      ],
+    },
+    disable_web_page_preview: {
+      propDefinition: [
+        telegramBotApi,
+        "disable_web_page_preview",
+      ],
+    },
+    reply_to_message_id: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_to_message_id",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendMessage(this.chatId, this.text, {
+      parse_mode: this.parse_mode,
+      disable_notification: this.disable_notification,
+      disable_web_page_preview: this.disable_web_page_preview,
+      reply_to_message_id: this.reply_to_message_id,
+      reply_markup: this.reply_markup,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully sent a ${this.reply_to_message_id ? "reply" : "text message"} to chat, "${this.chatId}"`);
+    return resp;
+  },
+};

package/actions/send-video/send-video.mjs

@@ -0,0 +1,86 @@
+import telegramBotApi from "../../telegram_bot_api.app.mjs";
+import contentTypes from "../../content-types.mjs";
+
+export default {
+  key: "telegram_bot_api-send-video",
+  name: "Send a Video",
+  description: "Sends a video file to your Telegram Desktop application. [See the docs](https://core.telegram.org/bots/api#sendvideo) for more information",
+  version: "0.0.1",
+  type: "action",
+  props: {
+    telegramBotApi,
+    chatId: {
+      propDefinition: [
+        telegramBotApi,
+        "chatId",
+      ],
+    },
+    caption: {
+      propDefinition: [
+        telegramBotApi,
+        "caption",
+      ],
+      description: "Enter the video caption.",
+    },
+    filename: {
+      propDefinition: [
+        telegramBotApi,
+        "filename",
+      ],
+    },
+    video: {
+      propDefinition: [
+        telegramBotApi,
+        "media",
+      ],
+      label: "Video",
+    },
+    contentType: {
+      propDefinition: [
+        telegramBotApi,
+        "contentType",
+      ],
+      options: contentTypes.video,
+    },
+    duration: {
+      propDefinition: [
+        telegramBotApi,
+        "duration",
+      ],
+    },
+    width: {
+      propDefinition: [
+        telegramBotApi,
+        "width",
+      ],
+    },
+    height: {
+      propDefinition: [
+        telegramBotApi,
+        "height",
+      ],
+    },
+    reply_markup: {
+      propDefinition: [
+        telegramBotApi,
+        "reply_markup",
+      ],
+    },
+  },
+  async run({ $ }) {
+    const resp = await this.telegramBotApi.sendVideo(this.chatId, this.video, {
+      caption: this.caption,
+      parse_mode: this.parse_mode,
+      disable_notification: this.disable_notification,
+      duration: this.duration,
+      width: this.width,
+      height: this.height,
+      reply_markup: this.reply_markup,
+      filename: this.filename,
+      contentType: this.contentType,
+    });
+    // eslint-disable-next-line multiline-ternary
+    $.export("$summary", `Successfully sent the video${this.fileName ? ` "${this.filename}"` : ""} to chat, "${this.chatId}"`);
+    return resp;
+  },
+};