Objects

---

invite

InvitePart dataclass

Bases: Part

              flowchart TD
              scurrypy.api.invite.InvitePart[InvitePart]
              scurrypy.core.part.Part[Part]

                              scurrypy.core.part.Part --> scurrypy.api.invite.InvitePart
                


              click scurrypy.api.invite.InvitePart href "" "scurrypy.api.invite.InvitePart"
              click scurrypy.core.part.Part href "" "scurrypy.core.part.Part"
            

Represents fields for creating an invite.

max_age: OptionalPartField[int] = None class-attribute instance-attribute

Duration of invite (in seconds) before it expires. 0 for never or up to 604800 (max 7 days). Discord defaults to 86400 (24 hours).

max_uses: OptionalPartField[int] = None class-attribute instance-attribute

Max number of uses for this invite. 0 for unlimited or up to 100. Discord defaults to 0.

temporary: OptionalPartField[bool] = None class-attribute instance-attribute

Whether this invite grants temporary membership. Discord defaults to False.

unique: OptionalPartField[bool] = None class-attribute instance-attribute

Whether to reuse similar invite codes. Discord defaults to False.

role_ids: OptionalPartField[list[Snowflake]] = None class-attribute instance-attribute

Role IDs to be given when the user accept this invite.

Permissions

Requires MANAGE_ROLES and cannot assign roles with higher permissions than the sender.

target_user_ids: OptionalPartField[list[Snowflake]] = None class-attribute instance-attribute

IDs of all users able to see and accept this invite.