Resources

---

user

User dataclass

Bases: BaseResource

              flowchart TD
              scurrypy.resources.user.User[User]
              scurrypy.resources.base_resource.BaseResource[BaseResource]

                              scurrypy.resources.base_resource.BaseResource --> scurrypy.resources.user.User
                


              click scurrypy.resources.user.User href "" "scurrypy.resources.user.User"
              click scurrypy.resources.base_resource.BaseResource href "" "scurrypy.resources.base_resource.BaseResource"
            

A Discord user.

fetch async

Fetch this user by ID.

Parameters:

• user_id (Snowflake) –

  ID of user to fetch

Returns:

• UserModel –

  queried user

fetch_guild_member async

Fetch this user's guild member data.

Parameters:

• guild_id (Snowflake) –

  ID of guild to fetch data from

• user_id (Snowflake) –

  ID of user to fetch

Returns:

• GuildMemberModel –

  queried guild member for the user

modify_current_user async

Modify the bot's account settings. Fires UserUpdateEvent.

Parameters:

• options (EditUserParams, default: {} ) –

  fields to edit

Returns:

• UserModel –

  edited user

leave_guild async

Make the bot leave a guild. Fires GuildDeleteEvent and GuildMemberRemoveEvent.

Parameters:

• guild_id (Snowflake) –

  ID of the guild to leave

create_dm async

Create a DM between the bot and this user.

Parameters:

• user_id (Snowflake) –

  ID of user to create DM with

Returns:

• ChannelModel –

  created or existing DM channel