Invite Models¶
Note
The following classes come from the scurrypy.models.invite module.
InviteModel
dataclass
¶
Bases: DataModel
Represents a code that adds a user to guild or group DM channel.
type: int
instance-attribute
¶
Type of invite. See InviteTypes.
code: str
instance-attribute
¶
Invite code (unique ID).
guild: Optional[GuildModel]
instance-attribute
¶
Guild the invite is for.
channel: ChannelModel
instance-attribute
¶
Channel this invite is for.
inviter: Optional[UserModel]
instance-attribute
¶
User who created invite.
approximate_member_count: Optional[int]
instance-attribute
¶
Approximate count of total members.
expires_at: str
instance-attribute
¶
ISO8601 timestamp for expiration date.
roles: Optional[list[RoleModel]]
instance-attribute
¶
Roles assigned to the user upon accepting the invite.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss
InviteWithMetadataModel
dataclass
¶
Bases: InviteModel
Represents the invite model with extra information.
uses: int
instance-attribute
¶
Number of times this invite was used.
max_uses: int
instance-attribute
¶
Max number of times this invite can be used.
max_age: int
instance-attribute
¶
Duration (in seconds) after which this invite expires.
temporary: bool
instance-attribute
¶
Whether this invite only grants temporary membership.
created_at: str
instance-attribute
¶
ISO8601 timestamp for when this invite was created.
type: int
instance-attribute
¶
Type of invite. See InviteTypes.
code: str
instance-attribute
¶
Invite code (unique ID).
guild: Optional[GuildModel]
instance-attribute
¶
Guild the invite is for.
channel: ChannelModel
instance-attribute
¶
Channel this invite is for.
inviter: Optional[UserModel]
instance-attribute
¶
User who created invite.
approximate_member_count: Optional[int]
instance-attribute
¶
Approximate count of total members.
expires_at: str
instance-attribute
¶
ISO8601 timestamp for expiration date.
roles: Optional[list[RoleModel]]
instance-attribute
¶
Roles assigned to the user upon accepting the invite.
to_dict
¶
Recursively turns the dataclass into a dictionary and drops empty fields.
Returns:
-
dict–serialized dataclasss