Invite

class discord_limits.paths.InvitePaths(client)

Parameters:

client (discord_limits.DiscordClient) – The DiscordClient instance to use.

async get_invite(invite_id, *, with_counts=True, with_expiration=True, guild_scheduled_event_id=None)

Get an invite.

Parameters:

• invite_id (str) – The ID of the invite to get.

• with_counts (bool, optional) – Whether the invite should contain approximate member counts, by default True

• with_expiration (bool, optional) – Whether the invite should contain the expiration date, by default True

• guild_scheduled_event_id (int, optional) – The guild scheduled event to include with the invite, by default None

Returns:

An invite object.

Return type:

ClientResponse

async delete_invite(invite_id, reason=None)

Delete an invite.

Parameters:

• invite_id (str) – The ID of the invite to delete.

• reason (str, optional) – A reason for this action that will be displayed in the audit log, by default None

Returns:

An invite object.

Return type:

ClientResponse