stickers.clj

(ns telegrambot-lib.api.stickers
  "Telegram Stickers - function implementations.
   - <https://core.telegram.org/bots/api#stickers>

   Most functions are multi-arity with the following options:
   - Send all parameters in a 'content' map.
   - Send only the required parameters as simple values.
   - Send the required paraemters as simple values and then 'optional' parameters in a map."
  (:gen-class)
  (:require [telegrambot-lib.http :as http]
            [telegrambot-lib.predicates :refer [content-map?]]))

(defn send-sticker
  "Use this method to send static .WEBP or animated .TGS stickers.
   On success, the sent Message is returned.

   Required
   - this ; a bot instance
   - chat_id ; target chat or username (@user)
   - sticker ; sticker to send, file_id for existing on Telegram servers

   Optional
   - message_thread_id ; id of the target thread of the forum.
   - emoji ; Emoji associated with the recently uploaded sticker.
   - disable_notification ; true to send message silently
   - protect_content ; protect content from forwarding/saving
   - reply_parameters ; Description of the message to reply to
   - reply_markup ; additional interface options"
  {:changed "2.12.0"}

  ([this content]
   (http/request this "sendSticker" content))

  ([this chat_id sticker]
   (let [content {:chat_id chat_id
                  :sticker sticker}]
     (send-sticker this content)))

  ([this chat_id sticker & optional]
   (let [content (merge (first optional)
                        {:chat_id chat_id
                         :sticker sticker})]
     (send-sticker this content))))

(defmulti get-sticker-set
  "Use this method to get a sticker set.
   On success, a StickerSet object is returned.

   Required
   - this ; a bot instance
   - name ; name of the sticker set"
  {:changed "0.2.0"}
  content-map?)

(defmethod get-sticker-set true
  [this content]
  (http/request this "getStickerSet" content))

(defmethod get-sticker-set false
  [this name]
  (let [content {:name name}]
    (get-sticker-set this content)))

(defmulti get-custom-emoji-stickers
  "Use this method to get information about custom emoji stickers by their identifiers.
   Returns an Array of Sticker objects.

   Required
   - this ; a bot instance
   - custom_emoji_ids ; a list of emoji identifiers"
  {:added "2.2.0"}
  content-map?)

(defmethod get-custom-emoji-stickers true
  [this content]
  (http/request this "getCustomEmojiStickers" content))

(defmethod get-custom-emoji-stickers false
  [this custom_emoji_ids]
  (let [content {:custom_emoji_ids custom_emoji_ids}]
    (get-custom-emoji-stickers this content)))

(defn upload-sticker-file
  "Use this method to upload a .PNG file with a sticker for later use
   in create-new-sticker-set and add-sticker-to-set methods (can be used multiple times).
   Returns the uploaded File on success.

   Required
   - this ; a bot instance
   - user_id ; id of sticker file owner
   - sticker ; A file with the sticker in .WEBP, .PNG, .TGS, or .WEBM format.
               See https://core.telegram.org/stickers for technical requirements.
   - sticker_format ; Format of sticker, 'static', 'animated', or 'video'."
  {:changed "2.6.0"}

  ([this content]
   (http/request this "uploadStickerFile" content))

  ([this user_id sticker sticker_format]
   (let [content {:user_id user_id
                  :sticker sticker
                  :sticker_format sticker_format}]
     (upload-sticker-file this content))))

(defn create-new-sticker-set
  "Use this method to create a new sticker set owned by a user. The bot will
   be able to edit the sticker set thus created.
   Returns True on success.

   Required
   - this ; a bot instance
   - user_id ; id of created sticker set owner
   - name ; short name of sticker set for use in URLs
   - title ; sticker set title
   - stickers ; A JSON-serialized list of 1-50 stickers to be added to the set.
   - sticker_format ; Format of stickers, 'static', 'animated', or 'video'.

   Optional
   - sticker_type ; Type of stickers, 'regular' (default), 'mask', 'custom_emoji'.
   - needs_repainting ; True if stickers must be repainted to color of text in messages. (custom emoji sets only)"
  {:changed "2.6.0"}

  ([this content]
   (http/request this "createNewStickerSet" content))

  ([this user_id name title stickers sticker_format]
   (let [content {:user_id user_id
                  :name name
                  :title title
                  :stickers stickers
                  :sticker_format sticker_format}]
     (create-new-sticker-set this content)))

  ([this user_id name title stickers sticker_format & optional]
   (let [content (merge (first optional)
                        {:user_id user_id
                         :name name
                         :title title
                         :stickers stickers
                         :sticker_format sticker_format})]
     (create-new-sticker-set this content))))

(defn add-sticker-to-set
  "Use this method to add a new sticker to a set created by the bot.
   The format of the added sticker must match the format of the other stickers in the set.
   Emoji sticker sets can have up to 200 stickers.
   Animated and video sticker sets can have up to 50 stickers.
   Static sticker sets can have up to 120 stickers.
   Returns True on success.

   Required
   - this ; a bot instance
   - user_id ; id of sticker set owner
   - name ; sticker set name
   - sticker ; A JSON-serialized object(InputSticker) with info about the added sticker."
  {:changed "2.6.0"}

  ([this content]
   (http/request this "addStickerToSet" content))

  ([this user_id name sticker]
   (let [content {:user_id user_id
                  :name name
                  :sticker sticker}]
     (add-sticker-to-set this content))))

(defn set-sticker-position-in-set
  "Use this method to move a sticker in a set created by the bot to
   a specific position.
   Returns True on success.

   Required
   - this ; a bot instance
   - sticker ; file id of the sticker
   - position ; new sticker position in the set"
  {:changed "0.2.0"}

  ([this content]
   (http/request this "setStickerPositionInSet" content))

  ([this sticker position]
   (let [content {:sticker sticker
                  :position position}]
     (set-sticker-position-in-set this content))))

(defmulti delete-sticker-from-set
  "Use this method to delete a sticker from a set created by the bot.
   Returns True on success.

   Required
   - this ; a bot instance
   - sticker ; file id of the sticker"
  {:changed "0.2.0"}
  content-map?)

(defmethod delete-sticker-from-set true
  [this content]
  (http/request this "deleteStickerFromSet" content))

(defmethod delete-sticker-from-set false
  [this sticker]
  (let [content {:sticker sticker}]
    (delete-sticker-from-set this content)))

(defn set-sticker-emoji-list
  "Use this method to change the list of emoji assigned to a regular or custom emoji sticker.
   The sticker must belong to a sticker set created by the bot.
   Returns True on success.

   Required
   - this ; a bot instance
   - sticker ; File id of the sticker.
   - emoji_list ; A JSON-serialized list of 1-20 emoji associated with the sticker."
  {:added "2.6.0"}

  ([this content]
   (http/request this "setStickerEmojiList" content))

  ([this sticker emoji_list]
   (let [content {:sticker sticker
                  :emoji_list emoji_list}]
     (set-sticker-emoji-list this content))))

(defmulti set-sticker-keywords
  "Use this method to change search keywords assigned to a regular or custom emoji sticker.
   The sticker must belong to a sticker set created by the bot.
   Returns True on success.

   Required
   - this ; a bot instance
   - sticker ; File id of the sticker.

   Optional
   - keywords ; A JSON-serialized list of 0-20 search keywords for the sticker."
  {:added "2.6.0"}
  content-map?)

(defmethod set-sticker-keywords true
  [this content]
  (http/request this "setStickerKeywords" content))

(defmethod set-sticker-keywords false
  ([this sticker]
   (let [content {:sticker sticker}]
     (set-sticker-keywords this content)))

  ([this sticker & optional]
   (let [content (merge (first optional)
                        {:sticker sticker})]
     (set-sticker-keywords this content))))

(defmulti set-sticker-mask-position
  "Use this method to change the mask position of a mask sticker.
   The sticker must belong to a sticker set that was created by the bot.
   Returns True on success.

   Required
   - this ; a bot instance
   - sticker ; File id of the sticker.

   Optional
   - mask_position ; A JSON-serialized object with the position where the mask should be placed on faces.
                     Omit the parameter to remove the mask position."
  {:added "2.6.0"}
  content-map?)

(defmethod set-sticker-mask-position true
  [this content]
  (http/request this "setStickerMaskPosition" content))

(defmethod set-sticker-mask-position false
  ([this sticker]
   (let [content {:sticker sticker}]
     (set-sticker-mask-position this content)))

  ([this sticker & optional]
   (let [content (merge (first optional)
                        {:sticker sticker})]
     (set-sticker-mask-position this content))))

(defn set-sticker-set-title
  "Use this method to set the title of a created sticker set.
   Returns True on success.

   Required
   - this ; a bot instance
   - name ; Sticker set name.
   - title ; Sticker set title."
  {:added "2.6.0"}

  ([this content]
   (http/request this "setStickerSetTitle" content))

  ([this name title]
   (let [content {:name name
                  :title title}]
     (set-sticker-set-title this content))))

(defn set-sticker-set-thumb
  "DEPRECATED: Use this method to set the thumbnail of a regular or mask sticker set.
   The format of the thumbnail file must match the format of the stickers in the set.
   Returns True on success.

   Required
   - this ; a bot instance
   - name ; sticker set name
   - user_id ; id of the sticker set owner

   Optional
   - thumbnail ; A .WEBP or .PNG image with the thumbnail, or .TGS animation, or WEBM video.
                 More information: https://core.telegram.org/bots/api#sending-files"
  {:deprecated "2.6.0"
   :use-instead (symbol 'set-sticker-set-thumbnail)}

  ([this content]
   (http/request this "setStickerSetThumbnail" content))

  ([this name user_id]
   (let [content {:name name
                  :user_id user_id}]
     (set-sticker-set-thumb this content)))

  ([this name user_id & optional]
   (let [content (merge (first optional)
                        {:name name
                         :user_id user_id})]
     (set-sticker-set-thumb this content))))

(defn set-sticker-set-thumbnail
  "Use this method to set the thumbnail of a regular or mask sticker set.
   The format of the thumbnail file must match the format of the stickers in the set.
   Returns True on success.

   Required
   - this ; a bot instance
   - name ; sticker set name
   - user_id ; id of the sticker set owner

   Optional
   - thumbnail ; A .WEBP or .PNG image with the thumbnail, or .TGS animation, or WEBM video.
                 More information: https://core.telegram.org/bots/api#sending-files"
  {:added "2.6.0"}

  ([this content]
   (http/request this "setStickerSetThumbnail" content))

  ([this name user_id]
   (let [content {:name name
                  :user_id user_id}]
     (set-sticker-set-thumbnail this content)))

  ([this name user_id & optional]
   (let [content (merge (first optional)
                        {:name name
                         :user_id user_id})]
     (set-sticker-set-thumbnail this content))))

(defmulti set-custom-emoji-sticker-set-thumbnail
  "Use this method to set the thumbnail of a custom emoji sticker set.
   Returns True on success.

   Required
   - this ; a bot instance
   - name ; Sticker set name.

   Optional
   - custom_emoji_id ; Emoji ID of a sticker from the sticker set. Empty string to drop the thumbnail
                       and use the first sticker as the thumbnail."
  {:added "2.6.0"}
  content-map?)

(defmethod set-custom-emoji-sticker-set-thumbnail true
  [this content]
  (http/request this "setCustomEmojiStickerSetThumbnail" content))

(defmethod set-custom-emoji-sticker-set-thumbnail false
  ([this name]
   (let [content {:name name}]
     (set-custom-emoji-sticker-set-thumbnail this content)))

  ([this name & optional]
   (let [content (merge (first optional)
                        {:name name})]
     (set-custom-emoji-sticker-set-thumbnail this content))))

(defmulti delete-sticker-set
  "Use this method to delete a sticker set that was created by the bot.
   Returns True on success.

   Required
   - this ; a bot instance
   - name ; Sticker set name."
  {:added "2.6.0"}
  content-map?)

(defmethod delete-sticker-set true
  [this content]
  (http/request this "deleteStickerSet" content))

(defmethod delete-sticker-set false
  [this name]
  (let [content {:name name}]
    (delete-sticker-set this content)))