dimscord/restapi/user

Search:
Group by:
Source   Edit  

Procs

proc `%`(o: set[UserFlags]): JsonNode {....raises: [], tags: [], forbids: [].}
Source   Edit   
proc addGuildMemberRole(api: RestApi; guild_id, user_id, role_id: string;
                        reason = ""): owned(Future[void]) {....stackTrace: false,
    raises: [Exception], tags: [RootEffect, TimeEffect, ReadDirEffect,
                                ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Assigns a member's role. Source   Edit   
proc bulkOverwriteApplicationCommands(api: RestApi; application_id: string;
                                      commands: seq[ApplicationCommand];
                                      guild_id = ""): Future[
    seq[ApplicationCommand]] {....stackTrace: false,
                               raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Overwrites existing commands slash command that were registered in guild or application. This means that only the commands you send in this request will be available globally or in a specific guild
  • guild_id is optional.
Source   Edit   
proc createGroupDm(api: RestApi; access_tokens: seq[string];
                   nicks: Table[string, string]): Future[DMChannel] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Creates a Group DM Channel.
  • nicks Example: {"2123450": "MrDude"}.toTable
Source   Edit   
proc createInteractionResponse(api: RestApi;
                               interaction_id, interaction_token: string;
                               response: InteractionResponse): owned(
    Future[void]) {....stackTrace: false, raises: [Exception], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
                    forbids: [].}
Create an interaction response. response.kind is required. Source   Edit   
proc createUserDm(api: RestApi; user_id: string): Future[DMChannel] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Create user dm. Source   Edit   
proc deleteApplicationCommand(api: RestApi; application_id, command_id: string;
                              guild_id = ""): owned(Future[void]) {.
    ...stackTrace: false, raises: [Exception], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Delete slash command for a specific application, guild_id is optional. Source   Edit   
proc editApplicationCommand(api: RestApi; application_id, command_id: string;
                            guild_id, name, description = "";
    name_localizations, description_localizations = none Table[string, string];
                            default_member_permissions = none PermissionFlags;
                            nsfw = false;
                            options: seq[ApplicationCommandOption] = @[]): Future[
    ApplicationCommand] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Modify slash command for a specific application.
  • guild_id - Optional
  • name - Optional Character length (3 - 32)
  • descripton - Optional Character length (1 - 100)
Source   Edit   
proc editCurrentMember(api: RestApi; guild_id: string; nick = none string;
                       reason = ""): owned(Future[void]) {....stackTrace: false,
    raises: [Exception], tags: [RootEffect, TimeEffect, ReadDirEffect,
                                ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Modify current member. nick - some "" to reset nick. Source   Edit   
proc editCurrentUser(api: RestApi; username, avatar = none string): Future[User] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Modifies the bot's username or avatar. Source   Edit   
proc getApplicationCommand(api: RestApi; application_id: string; guild_id = "";
                           command_id: string): Future[ApplicationCommand] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Get slash command for a specific application, guild_id is optional. Source   Edit   
proc getApplicationCommands(api: RestApi; application_id: string; guild_id = "";
                            with_localizations = false): Future[
    seq[ApplicationCommand]] {....stackTrace: false,
                               raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Get slash commands for a specific application, guild_id is optional. Source   Edit   
proc getApplicationRoleConnectionMetadataRecords(api: RestApi;
    application_id: string): Future[seq[ApplicationRoleConnectionMetadata]] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Source   Edit   
proc getCurrentApplication(api: RestApi): Future[Application] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Gets the current application for the current user (bot user). Source   Edit   
proc getCurrentGuildMember(api: RestApi; guild_id: string): Future[Member] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Get guild member as the current user aka you. Source   Edit   
proc getCurrentUser(api: RestApi): Future[User] {....stackTrace: false,
    raises: [Exception, ValueError], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Gets the current user. Source   Edit   
proc getCurrentUserGuilds(api: RestApi; before, after = none string;
                          with_counts = false; limit: range[1 .. 200] = 200): Future[
    seq[Guild]] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Gets current user guilds. Source   Edit   
proc getGateway(api: RestApi): Future[string] {....stackTrace: false,
    raises: [Exception, ValueError], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Get Discord gateway URL. Source   Edit   
proc getGatewayBot(api: RestApi): Future[GatewayBot] {....stackTrace: false,
    raises: [Exception, ValueError], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Get gateway bot with authentication. Source   Edit   
proc getGuildMember(api: RestApi; guild_id, user_id: string): Future[Member] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Gets a guild member. Source   Edit   
proc getGuildMembers(api: RestApi; guild_id: string;
                     limit: range[1 .. 1000] = 1; after = "0"): Future[
    seq[Member]] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Gets a list of a guild's members. Source   Edit   
proc getInvite(api: RestApi; code: string; with_counts, with_expiration = false;
               auth = false; guild_scheduled_event_id = none string): Future[
    Invite] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Gets a discord invite, it can be a vanity code.
  • auth Whether you should get the invite while authenticated.
Source   Edit   
proc getUser(api: RestApi; user_id: string): Future[User] {....stackTrace: false,
    raises: [Exception, ValueError], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Gets a user. Source   Edit   
proc getUserApplicationRoleConnection(api: RestApi; application_id: string): Future[
    ApplicationRoleConnection] {....stackTrace: false,
                                 raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Source   Edit   
proc interactionResponseAutocomplete(api: RestApi;
                                     interaction_id, interaction_token: string;
    response: InteractionCallbackDataAutocomplete): owned(Future[void]) {.
    ...stackTrace: false, raises: [Exception], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Create an interaction response which is an autocomplete response. Source   Edit   
proc interactionResponseMessage(api: RestApi;
                                interaction_id, interaction_token: string;
                                kind: InteractionResponseType;
                                response: InteractionCallbackDataMessage): owned(
    Future[void]) {....stackTrace: false, raises: [Exception], tags: [RootEffect,
    ReadIOEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, WriteIOEffect],
                    forbids: [].}
Create an interaction response. response.kind is required. Source   Edit   
proc interactionResponseModal(api: RestApi;
                              interaction_id, interaction_token: string;
                              response: InteractionCallbackDataModal): owned(
    Future[void]) {....stackTrace: false, raises: [Exception], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
                    forbids: [].}
Create an interaction response which is a modal. Source   Edit   
proc leaveGuild(api: RestApi; guild_id: string): owned(Future[void]) {.
    ...stackTrace: false, raises: [Exception], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Leaves a guild. Source   Edit   
proc registerApplicationCommand(api: RestApi; application_id: string;
                                name: string; description, guild_id = "";
    name_localizations, description_localizations = none Table[string, string];
                                kind = atSlash; dm_permission = true;
                                nsfw = false; default_member_permissions = none
    PermissionFlags; options: seq[ApplicationCommandOption] = @[]): Future[
    ApplicationCommand] {....stackTrace: false, raises: [Exception, ValueError], tags: [
    RootEffect, TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect,
    WriteIOEffect], forbids: [].}
Create a global or guild only slash command.
  • guild_id - Optional
  • name - Character length (3 - 32)
  • descripton - Character length (1 - 100)

NOTE: Creating a command with the same name as an existing command for your application will overwrite the old command.

Source   Edit   
proc removeGuildMemberRole(api: RestApi; guild_id, user_id, role_id: string;
                           reason = ""): owned(Future[void]) {.
    ...stackTrace: false, raises: [Exception], tags: [RootEffect, TimeEffect,
    ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect], forbids: [].}
Removes a member's role. Source   Edit   
proc setGuildNick(api: RestApi; guild_id: string; nick, reason = ""): owned(
    Future[void]) {....stackTrace: false, raises: [Exception], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
                    forbids: [].}
Sets the current user's guild nickname, defaults to "" if no nick is set. Source   Edit   
proc updateApplicationRoleConnectionMetadataRecords(api: RestApi;
    application_id: string): Future[seq[ApplicationRoleConnectionMetadata]] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Source   Edit   
proc updateUserApplicationRoleConnection(api: RestApi; application_id: string;
    platform_name, platform_username = none string;
    metadata = none Table[string, string]): Future[ApplicationRoleConnection] {.
    ...stackTrace: false, raises: [Exception, ValueError], tags: [RootEffect,
    TimeEffect, ReadDirEffect, ReadEnvEffect, ReadIOEffect, WriteIOEffect],
    forbids: [].}
Source   Edit  

Made with Nim. Generated: 2023-08-24 17:26:35 UTC