Helpers fix (continued) (#133)

* helpers/channel: fix overloading & template instantiation + more
descriptive names

* helpers/guild: fix template overloading

* helpers/message: fix template overloading and instantiation issue

* helpers/user: template instantiation fix

* restapi/message: support `bulkDelete` helper

* update examples/helpers.nim

* macros: fix getClient "client not found" error (docs needed); mainClient
is now a no-op.

* WIP: reimplement getClient/mainClient properly

* explicit discard in helpers example

* helpers/message: use proper arguments & functions

* restapi/message: fix variable typo

* helpers/channel: fix missing argument

* helpers/guild: pass value instead of option in `editEmoji`

* some updates

* WIP: helpers test suite

* helpers/guild: pass reason argument to `editGuild` call

* helpers/channel: fix template overloading confusion

* include restapi and some new fields in interaction

* helpers/channel: topic argument for `editStageInstance` from Option(int)
to int

* helpers/guild: `tuple` to `TriggerMetadata` for `getIntegrations`
argument; use `when` instead of `if` in `removeBan`; `tuple` return type
instead of `void`

* helper/message: Add missing channel ID and with_member params to thread
templates

* Fix wrong parameter order in `followup` guild_id usage, missing NSFW
flag in `registerCommand`, bad `guild_id` usage in `getCommand`

* tests/testHelpers: add missing tests

---------

Co-authored-by: krisppurg <mineharderytps801@gmail.com>

Author: swrge

dimscord/helpers/channel.nim

@@ -1,11 +1,12 @@
 import asyncdispatch, options, json
+import ../restapi
 import ../objects, ../constants
 
 template pin*(m: Message, reason = ""): Future[void] =
     ## Add pinned message.
     getClient.api.addChannelMessagePin(m.channel_id, m.id, reason)
-        
-template removePin*(m: Message, reason = ""): Future[void]  =
+
+template unpin*(m: Message, reason = ""): Future[void] =
     ## Remove pinned message.
     getClient.api.deleteChannelMessagePin(m.channel_id, m.id, reason)
 
@@ -28,7 +29,7 @@ template edit*(ch: GuildChannel;
 ): Future[GuildChannel] =
     ## Modify a guild channel.
     getClient.api.editGuildChannel(
-        ch.id, name, parent_id, name, parent_id, topic, rtc_region,
+        ch.id, name, parent_id, topic, rtc_region,
         default_auto_archive_duration, video_quality_mode, flags, available_tags,
         default_reaction_emoji, default_sort_order, default_forum_layout,
         rate_limit_per_user, default_thread_rate_limit_per_user,
@@ -41,6 +42,7 @@ template createChannel*(g: Guild;
     parent_id, topic, rtc_region = none string; nsfw = none bool;
     position, video_quality_mode = none int;
     default_sort_order, default_forum_layout = none int;
+    default_thread_rate_limit_per_user = none int;
     available_tags = none seq[ForumTag];
     default_reaction_emoji = none DefaultForumReaction;
     rate_limit_per_user = none range[0..21600];
@@ -53,6 +55,7 @@ template createChannel*(g: Guild;
         g.id, name, kind, parent_id, topic,
         rtc_region, nsfw, position, video_quality_mode,
         default_sort_order, default_forum_layout,
+        default_thread_rate_limit_per_user,
         available_tags, default_reaction_emoji,
         rate_limit_per_user, bitrate, user_limit,
         permission_overwrites, reason
@@ -77,10 +80,9 @@ template createInvite*(ch: GuildChannel;
         target_type, reason
     )
 
-template delete*(inv: Invite | string, reason = ""): Future[void] =
+template delete*(inv: Invite, reason = ""): Future[void] =
     ## Delete a guild invite.
-    let code = when inv is Invite: inv.code else: inv
-    getClient.api.deleteInvite(code, reason)
+    getClient.api.deleteInvite(inv.code, reason)
 
 template getInvites*(ch: GuildChannel): Future[seq[Invite]] =
     ## Gets a list of a channel's invites.
@@ -90,19 +92,14 @@ template getWebhooks*(ch: GuildChannel): Future[seq[Webhook]] =
     ## Gets a list of a channel's webhooks.
     getClient.api.getChannelWebhooks(ch.id)
 
-template deleteWebhook*(w: Webhook | string, reason = ""): Future[void] =
+template delete*(w: Webhook, reason = ""): Future[void] =
     ## Deletes a webhook.
-    let wid = when w is Webhook: w.id else: w
-    getClient.api.deleteWebhook(wid, reason)
+    getClient.api.deleteWebhook(w.id, reason)
 
 template edit*(w: Webhook,
-        name, avatar = none string;
+        name, avatar, channel_id = none string;
         reason = ""): Future[void] =
-    let chan = w.channel_id
-    if chan.isSome:
-        getClient.api.editWebhook(w.id, name, avatar, w.channel_id, reason)
-    else:
-        raise newException(CatchableError, "Webhook is not in a channel")
+    getClient.api.editWebhook(w.id, name, avatar, channel_id, reason)
 
 template newThread*(ch: GuildChannel;
     name: string;
@@ -123,7 +120,7 @@ template createStageInstance*(ch: GuildChannel;
     getClient.api.createStageInstance(ch.id, topic, privacy, reason)
 
 template editStageInstance*(si: StageInstance | string,
-        topic = none string;
+        topic: string;
         privacy = none int; reason = ""): Future[StageInstance] =
     ## Modify a stage instance.
     let st = when si is StageInstance: si.channel_id else: si
@@ -133,4 +130,4 @@ template deleteStageInstance*(si: StageInstance | string,
         reason = ""): Future[void] =
     ## Delete the stage instance.
     let st = when si is StageInstance: si.channel_id else: si
-    getClient.api.deleteStageInstance(st, reason)
+    getClient.api.deleteStageInstance(st, reason)

dimscord/helpers/guild.nim

@@ -8,11 +8,11 @@ template beginPrune*(g: Guild;
     ## Begins a guild prune.
     getClient.api.beginGuildPrune(g.id, days, include_roles, compute_prune_count)
 
-template getPruneCount*(g: Guild, days: int): Future[int] =
+template getPruneCount*(g: Guild; days: int): Future[int] =
     ## Gets the prune count.
     getClient.api.getGuildPruneCount(g.id, days)
 
-template edit*(g: Guild, lvl: MFALevel; reason = ""): Future[MFALevel] =
+template editMFA*(g: Guild; lvl: MFALevel; reason = ""): Future[MFALevel] =
     ## Modify Guild MFA Level, requiring guild ownership.
     getClient.api.editGuildMFALevel(g.id, lvl, reason)
 
@@ -35,33 +35,33 @@ template edit*(g: Guild;
     ## Modifies a guild.
     ## Icon needs to be a base64 image.
     ## (See: https://nim-lang.org/docs/base64.html)
-    ## 
-    ## 
-    ## Read more at: 
+    ##
+    ##
+    ## Read more at:
     ## https://discord.com/developers/docs/resources/guild#modify-guild
-    getClient.api.editGuild(    
+    getClient.api.editGuild(
         g.id, name, description, region, afk_channel_id, icon,
         discovery_splash, owner_id, splash, banner,
         system_channel_id, rules_channel_id,
         preferred_locale, public_updates_channel_id,
         verification_level, default_message_notifications,
         system_channel_flags,
         explicit_content_filter, afk_timeout,
-        features, premium_progress_bar_enabled
+        features, premium_progress_bar_enabled, reason
     )
 
-template getAuditLogs*(g: Guild; 
-        user_id, before = "", action_type = -1;
+template getAuditLogs*(g: Guild;
+        user_id, before = ""; action_type = -1;
         limit: range[1..100] = 50
 ): Future[AuditLog] =
     ## Get guild audit logs. The maximum limit is 100.
     getClient.api.getGuildAuditLogs(g.id, user_id, before, action_type, limit)
 
-template deleteRole*(g: Guild, r: Role): Future[void] =
-   ## Deletes a guild role.
-   getClient.api.deleteGuildRole(g.id, r.id)
+template deleteRole*(g: Guild; r: Role): Future[void] =
+    ## Deletes a guild role.
+    getClient.api.deleteGuildRole(g.id, r.id)
 
-template editRole*(g: Guild, r: Role;
+template editRole*(g: Guild; r: Role;
         name = none string;
         icon, unicode_emoji = none string;
         permissions = none PermObj; color = none int;
@@ -81,17 +81,17 @@ template getInvites*(g: Guild): Future[seq[InviteMetadata]] =
     ## Gets guild invites.
     getClient.api.getGuildInvites(g.id)
 
-template getVanity*(g: Guild): Future[tuple[code: Option[string], uses: int]] =
-    ## Get the guild vanity url. Requires the MANAGE_GUILD permission. 
+template getVanity*(g: Guild): Future[tuple[code: Option[string]; uses: int]] =
+    ## Get the guild vanity url. Requires the MANAGE_GUILD permission.
     ## `code` will be null if a vanity url for the guild is not set.
     getClient.api.getGuildVanityUrl(g.id)
 
-template editMember*(g: Guild, m: Member;
+template editMember*(g: Guild; m: Member;
         nick, channel_id, communication_disabled_until = none string;
         roles = none seq[string];
         mute, deaf = none bool;
         reason = ""
-): Future[void] = 
+): Future[void] =
     ## Modifies a guild member
     ## Note:
     ## - `communication_disabled_until` - ISO8601 timestamp :: [<=28 days]
@@ -100,26 +100,33 @@ template editMember*(g: Guild, m: Member;
         roles, mute, deaf, reason
     )
 
-template removeMember*(g: Guild, m: Member, reason = ""): Future[void] =
+template removeMember*(g: Guild; m: Member; reason = ""): Future[void] =
     ## Removes a guild member.
     getClient.api.removeGuildMember(g.id, m.user.id, reason)
 
-template getBan*(g: Guild, user_id: string): Future[GuildBan] =
+template getBan*(g: Guild; m: Member | string): Future[GuildBan] =
     ## Gets guild ban.
-    getClient.api.getGuildBan(g.id, mb.user.id)
+    getClient.api.getGuildBan(g.id, (when m is Member: m.user.id else: m))
 
 template getBans*(g: Guild): Future[seq[GuildBan]] =
     ## Gets all the guild bans.
     getClient.api.getGuildBans(g.id)
 
-template ban*(g: Guild, m: Member, deletemsgdays: range[0..7] = 0;
+template ban*(g: Guild; m: Member; delete_msg_days: range[0..7] = 0;
         reason = ""): Future[void] =
     ## Creates a guild ban.
-    getClient.api.createGuildBan(g.id, m.user.id, deletemsgdays, reason)
+    getClient.api.createGuildBan(g.id, m.user.id, delete_msg_days, reason)
 
-template removeBan*(g: Guild, mb: Member, reason = ""): Future[void] =
+template bulkBan*(g: Guild;
+        user_ids: seq[string];
+        delete_message_seconds = 0;
+        reason = ""): Future[tuple[banned_users, failed_users: seq[string]]] =
+    ## Creates a guild bulk ban.
+    getClient.api.bulkGuildBan(g.id, user_ids, delete_message_seconds, reason)
+
+template removeBan*(g: Guild; u: User | string; reason = ""): Future[void] =
     ## Removes a guild ban.
-    getClient.api.removeGuildBan(mb.guild_id, mb.user.id, reason)
+    getClient.api.removeGuildBan(g.id, (when u is User: u.id else: u), reason)
 
 template getIntegrations*(g: Guild): Future[seq[Integration]] =
     ## Gets a list of guild integrations.
@@ -129,47 +136,50 @@ template getWebhooks*(g: Guild): Future[seq[Webhook]] =
     ## Gets a list of a channel's webhooks.
     getClient.api.getGuildWebhooks(g.id)
 
-template deleteIntegration*(integ: Integration, reason = ""): Future[void] =
+template deleteIntegration*(integ: Integration; reason = ""): Future[void] =
     ## Deletes a guild integration.
     getClient.api.deleteGuildIntegration(integ.id, reason)
 
 template preview*(g: Guild): Future[GuildPreview] =
     ## Gets guild preview.
     getClient.api.getGuildPreview(g.id)
 
-template searchMembers*(g: Guild, query = "";
+template searchMembers*(g: Guild; query = "";
         limit: range[1..1000] = 1): Future[seq[Member]] =
     ## Search for guild members.
     getClient.api.searchGuildMembers(g.id, query, limit)
 
-template editEmoji*(g: Guild, e: Emoji, name = none string;
+template editEmoji*(g: Guild; e: Emoji; name = none string;
         roles = none seq[string];
         reason = ""
 ): Future[Emoji] =
     ## Modifies a guild emoji.
-    getClient.api.editGuildEmoji(g.id, e.id, name, roles, reason)
+    assert e.id.isSome, "Cannot edit Emoji: the emoji might not be custom"
+    getClient.api.editGuildEmoji(g.id, e.id.unsafeGet(), name, roles, reason)
 
-template deleteEmoji*(g: Guild, e: Emoji, reason = ""): Future[void] =
+template deleteEmoji*(g: Guild; e: Emoji; reason = ""): Future[void] =
     ## Deletes a guild emoji.
-    getClient.api.deleteGuildEmoji(g.id, e.id, reason)
+    assert e.id.isSome, "Cannot delete Emoji: the emoji might not be custom"
+    getClient.api.deleteGuildEmoji(g.id, e.id.unsafeGet(), reason)
 
 template getRegions*(g: Guild): Future[seq[VoiceRegion]] =
     ## Gets a guild's voice regions.
     getClient.api.getGuildVoiceRegions(g.id)
 
-template editSticker*(g: Guild, s: Sticker;
+template editSticker*(g: Guild; s: Sticker;
         name, desc, tags = none string;
         reason = ""
 ): Future[Sticker] =
     ## Modify a guild sticker.
     getClient.api.editGuildSticker(g.id, s.id, name, desc, tags, reason)
 
-template deleteSticker*(g: Guild, sk: Sticker, reason = ""): Future[Sticker] =
+template deleteSticker*(g: Guild; sk: Sticker; reason = ""): Future[Sticker] =
     ## Deletes a guild sticker.
-    getClient.api.deleteGuildSticker(sk.guild_id.get, sk.id, reason)
+    getClient.api.deleteGuildSticker(sk.guild_id.get, sk.id,
+            reason) # TODO: assert sk.guild_id.isSome, "Cannot delete Sticker: the bot is probably not in the sticker's owning guild."
 
 template getScheduledEvent*(g: Guild;
-        event_id: string, with_user_count = false
+        event_id: string; with_user_count = false
 ): Future[GuildScheduledEvent] =
     ## Get a scheduled event in a guild.
     getClient.api.getScheduledEvent(g.id, event_id, with_user_count)
@@ -178,7 +188,7 @@ template getScheduledEvents*(g: Guild): Future[seq[GuildScheduledEvent]] =
     ## Get all scheduled events in a guild.
     getClient.api.getScheduledEvents(g.id)
 
-template edit*(g: Guild, gse: GuildScheduledEvent;
+template editEvent*(g: Guild; gse: GuildScheduledEvent;
         name, start_time, image = none string;
         channel_id, end_time, desc = none string;
         privacy_level = none GuildScheduledEventPrivacyLevel;
@@ -198,49 +208,45 @@ template edit*(g: Guild, gse: GuildScheduledEvent;
         reason
     )
 
-template delete*(gse: GuildScheduledEvent, reason = ""): Future[void] =
-   ## Delete a scheduled event in guild.
-   getClient.api.deleteScheduledEvent(gse.guild_id, gse.id, reason)
+template delete*(gse: GuildScheduledEvent; reason = ""): Future[void] =
+    ## Delete a scheduled event in guild.
+    getClient.api.deleteScheduledEvent(gse.guild_id, gse.id, reason)
 
 template getEventUsers*(gse: GuildScheduledEvent;
-        limit = 100, with_member = false;
+        limit = 100; with_member = false;
         before, after = ""
 ): Future[seq[GuildScheduledEventUser]] =
     ## Gets the users and/or members that were subscribed to the scheduled event.
     getClient.api.getScheduledEventUsers(
-        gse.guild_id, gse.id,
-        limit, with_member, before, after
+      gse.guild_id, gse.id, limit, with_member, before, after
     )
 
 template getRules*(g: Guild): Future[seq[AutoModerationRule]] =
     ## Get a Guild's current AutoMod Rules
     getClient.api.getAutoModerationRules(g.id)
 
-template getRule*(g: Guild, rule_id: string): Future[AutoModerationRule] =
+template getRule*(g: Guild; rule_id: string): Future[AutoModerationRule] =
     ## Get a Guild's specific AutoMod Rule
     getClient.api.getAutoModerationRule(g.id, rule_id)
 
-template deleteRule*(g: Guild, amr: AutoModerationRule): Future[void] =
+template deleteRule*(g: Guild; amr: AutoModerationRule): Future[void] =
     ## deletes automod rule
     getClient.api.deleteAutoModerationRule(g.id, amr.id)
 
-template editRule*(g: Guild, amr: AutoModerationRule;
-    event_type = none int, name = none string; 
+template editRule*(g: Guild; amr: AutoModerationRule;
+    event_type = none int; name = none string;
     trigger_type = none ModerationTriggerType;
-    trigger_metadata = none tuple[
-        keyword_filter: seq[string],
-        presets: seq[int]
-    ];
+    trigger_metadata = none TriggerMetadata;
     actions = none seq[ModerationAction]; enabled = none bool;
     exempt_roles, exempt_channels = none seq[string];
-    reason = ""
+    reason = "";
 ): Future[AutoModerationRule] =
     ## Edits an automod rule.
     ## `event_type` is gonna be 1 for SEND_MESSAGE
     getClient.api.editAutoModerationRule(
-        g.id, amr.id, event_type, 
+        g.id, amr.id, event_type,
         name, trigger_type,
-        trigger_metadata, actions, 
-        enabled, exempt_roles, exempt_channels, 
-        reason 
-    )
+        trigger_metadata, actions,
+        enabled, exempt_roles, exempt_channels,
+        reason
+    )