Skip to content

Objects

user

UserModel dataclass

Bases: DataModel


              flowchart TD
              scurrypy.api.user.UserModel[UserModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.user.UserModel
                


              click scurrypy.api.user.UserModel href "" "scurrypy.api.user.UserModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Represents the User object.

id: Snowflake instance-attribute

ID of the user.

username: str instance-attribute

Username of the user.

discriminator: str instance-attribute

Discriminator of the user (#XXXX)

global_name: str instance-attribute

Global name of the user.

avatar: str instance-attribute

Image hash of the user's avatar.

bot: bool | None instance-attribute

If the user is a bot.

banner: str | None instance-attribute

Image hash of the user's banner.

accent_color: int | None instance-attribute

Color of user's banner represented as an integer.

locale: str | None instance-attribute

Chosen language option of the user.

GuildMemberModel dataclass

Bases: DataModel


              flowchart TD
              scurrypy.api.user.GuildMemberModel[GuildMemberModel]
              scurrypy.core.model.DataModel[DataModel]

                              scurrypy.core.model.DataModel --> scurrypy.api.user.GuildMemberModel
                


              click scurrypy.api.user.GuildMemberModel href "" "scurrypy.api.user.GuildMemberModel"
              click scurrypy.core.model.DataModel href "" "scurrypy.core.model.DataModel"

Represents a guild member.

roles: list[Snowflake] instance-attribute

List of roles registered to the guild member.

user: UserModel instance-attribute

User data associated with the guild member.

nick: str instance-attribute

Server nickname of the guild member.

avatar: str instance-attribute

Server avatar hash of the guild mmeber.

joined_at: str instance-attribute

ISO8601 timestamp of when the guild member joined server.

permissions: Permissions | None instance-attribute

Total permissions of the member in the channel, including overwrites, returned when in the interaction object. [INT_LIMIT]