Invites

The following section documents everything related to invites.

Models

BaseInvite

Attributes
Methods
class stoat.BaseInvite(*, state, code)[source]

Represents an invite on Stoat.

state

State that controls this invite.

Type:

State

code

The invite’s code.

Type:

str

await accept(*, http_overrides=None)[source]

This function is a coroutine.

Accepts an invite.

Fires either PrivateChannelCreateEvent or ServerCreateEvent for the current user, and fires either GroupRecipientAddEvent or ServerMemberJoinEvent, and MessageCreateEvent (optional in server context), both for all group recipients/server members.

Note

This can only be used by non-bot accounts.

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • HTTPException – Possible values for type:

    Value

    Reason

    IsBot

    The current token belongs to bot account.

    TooManyServers

    You’re participating in too many servers.

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    Banned

    You’re banned from server.

    GroupTooLarge

    The group exceeded maximum count of recipients.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite/channel/server was not found.

  • Conflict – Possible values for type:

    Value

    Reason

    AlreadyInGroup

    The user is already in group.

    AlreadyInServer

    The user is already in server.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
Returns:

The joined server or group.

Return type:

Union[Server, GroupChannel]

await delete(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

There is an alias for this called revoke().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
await revoke(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

This is an alias of delete().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation

ServerPublicInvite

Attributes
Methods
class stoat.ServerPublicInvite(*, state, code, server_id, server_name, internal_server_icon, internal_server_banner, raw_server_flags, channel_id, channel_name, channel_description, user_name, internal_user_avatar, member_count)[source]

Represents a public invite to server channel.

This inherits from BaseInvite.

server_id

The server’s ID this invite points to.

Type:

str

server_name

The server’s name.

Type:

str

internal_server_icon

The server’s stateless icon.

Type:

Optional[StatelessAsset]

internal_server_banner

The server’s stateless banner..

Type:

Optional[StatelessAsset]

raw_server_flags

The server’s flags raw value.

Type:

int

channel_id

The destination channel’s ID.

Type:

str

channel_name

The destination channel’s name.

Type:

str

channel_description

The destination channel’s description.

Type:

Optional[str]

user_name

The user’s name who created this invite.

Type:

str

internal_user_avatar

The user’s stateless avatar who created this invite.

Type:

Optional[StatelessAsset]

member_count

The count of members in target server.

Type:

int

get_server()[source]

Optional[Server]: The server this invite points to.

get_channel()[source]

Optional[ServerChannel]: The destination channel.

get_user()[source]

Optional[User]: The (guessed) user who created this invite.

This always will return accurate user if user has avatar, but might incorrectly find user if avatar is missing.

property server[source]

The server this invite points to.

Type:

Server

property server_flags[source]

The server’s flags.

Type:

ServerFlags

property server_icon[source]

The icon of the server.

Type:

Optional[Asset]

property server_banner[source]

The banner of the server.

Type:

Optional[Asset]

property channel[source]

The destination channel.

Type:

ServerChannel

property user[source]

The (guessed) user who created this invite.

This always will return accurate user if user has avatar, but might incorrectly find user if avatar is missing.

Type:

User

property user_avatar[source]

The user’s avatar who created this invite.

Type:

Optional[Asset]

await accept(*, http_overrides=None)[source]

This function is a coroutine.

Accepts an invite.

Fires ServerCreateEvent for the current user, ServerMemberJoinEvent and optionally MessageCreateEvent, both for all server members.

Note

This can only be used by non-bot accounts.

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • HTTPException – Possible values for type:

    Value

    Reason

    IsBot

    The current token belongs to bot account.

    TooManyServers

    You’re participating in too many servers.

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    Banned

    You’re banned from server.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite/channel/server was not found.

  • Conflict – Possible values for type:

    Value

    Reason

    AlreadyInServer

    The user is already in server.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
Returns:

The joined server.

Return type:

Server

code

The invite’s code.

Type:

str

await delete(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

There is an alias for this called revoke().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
await revoke(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

This is an alias of delete().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
state

State that controls this invite.

Type:

State

GroupPublicInvite

Attributes
Methods
class stoat.GroupPublicInvite(*, state, code, channel_id, channel_name, channel_description, user_name, internal_user_avatar)[source]

Represents a public invite to group channel.

This inherits from BaseInvite.

channel_id

The destination channel’s ID.

Type:

str

channel_name

The destination channel’s name.

Type:

str

channel_description

The destination channel’s description.

Type:

Optional[str]

user_name

The user’s name who created this invite.

Type:

str

internal_user_avatar

The user’s stateless avatar who created this invite.

Type:

Optional[StatelessAsset]

get_channel()[source]

Optional[GroupChannel]: The destination channel.

get_user()[source]

Optional[User]: The (guessed) user who created this invite.

This always will return accurate user if user has avatar, but might incorrectly find user if avatar is missing.

property channel[source]

The destination channel.

Type:

GroupChannel

property user[source]

The (guessed) user who created this invite.

This always will return accurate user if user has avatar, but might incorrectly find user if avatar is missing.

Type:

User

property user_avatar[source]

The user’s avatar who created this invite.

Type:

Optional[Asset]

await accept(*, http_overrides=None)[source]

This function is a coroutine.

Accepts an invite.

Fires PrivateChannelCreateEvent for the current user, GroupRecipientAddEvent and MessageCreateEvent, both for all group recipients.

Note

This can only be used by non-bot accounts.

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • HTTPException – Possible values for type:

    Value

    Reason

    IsBot

    The current token belongs to bot account.

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    GroupTooLarge

    The group exceeded maximum count of recipients.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite/channel was not found.

  • Conflict – Possible values for type:

    Value

    Reason

    AlreadyInGroup

    The user is already in group.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
Returns:

The joined group.

Return type:

GroupChannel

code

The invite’s code.

Type:

str

await delete(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

There is an alias for this called revoke().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
await revoke(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

This is an alias of delete().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
state

State that controls this invite.

Type:

State

UnknownPublicInvite

Attributes
Methods
class stoat.UnknownPublicInvite(*, state, code, payload)[source]

Represents a public invite that is not recognized by library yet.

This inherits from BaseInvite.

payload

The raw invite data.

Type:

Dict[str, Any]

await accept(*, http_overrides=None)[source]

This function is a coroutine.

Accepts an invite.

Fires either PrivateChannelCreateEvent or ServerCreateEvent for the current user, and fires either GroupRecipientAddEvent or ServerMemberJoinEvent, and MessageCreateEvent (optional in server context), both for all group recipients/server members.

Note

This can only be used by non-bot accounts.

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • HTTPException – Possible values for type:

    Value

    Reason

    IsBot

    The current token belongs to bot account.

    TooManyServers

    You’re participating in too many servers.

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    Banned

    You’re banned from server.

    GroupTooLarge

    The group exceeded maximum count of recipients.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite/channel/server was not found.

  • Conflict – Possible values for type:

    Value

    Reason

    AlreadyInGroup

    The user is already in group.

    AlreadyInServer

    The user is already in server.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
Returns:

The joined server or group.

Return type:

Union[Server, GroupChannel]

code

The invite’s code.

Type:

str

await delete(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

There is an alias for this called revoke().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
await revoke(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

This is an alias of delete().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
state

State that controls this invite.

Type:

State

PublicInvite

class stoat.PublicInvite

An union of all public invites.

The following classes are included in this union:

PrivateBaseInvite

Attributes
Methods
class stoat.PrivateBaseInvite(*, state, code, creator_id)[source]

Represents a private invite on Stoat.

This inherits from BaseInvite.

creator_id

The user’s ID who created this invite.

Type:

str

await accept(*, http_overrides=None)[source]

This function is a coroutine.

Accepts an invite.

Fires either PrivateChannelCreateEvent or ServerCreateEvent for the current user, and fires either GroupRecipientAddEvent or ServerMemberJoinEvent, and MessageCreateEvent (optional in server context), both for all group recipients/server members.

Note

This can only be used by non-bot accounts.

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • HTTPException – Possible values for type:

    Value

    Reason

    IsBot

    The current token belongs to bot account.

    TooManyServers

    You’re participating in too many servers.

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    Banned

    You’re banned from server.

    GroupTooLarge

    The group exceeded maximum count of recipients.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite/channel/server was not found.

  • Conflict – Possible values for type:

    Value

    Reason

    AlreadyInGroup

    The user is already in group.

    AlreadyInServer

    The user is already in server.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
Returns:

The joined server or group.

Return type:

Union[Server, GroupChannel]

code

The invite’s code.

Type:

str

await delete(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

There is an alias for this called revoke().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
await revoke(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

This is an alias of delete().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
state

State that controls this invite.

Type:

State

GroupInvite

Attributes
Methods
class stoat.GroupInvite(*, state, code, creator_id, channel_id)[source]

Represents a group invite on Stoat.

This inherits from PrivateBaseInvite.

channel_id

The group channel’s ID this invite points to.

Type:

str

code

The invite’s code.

Type:

str

creator_id

The user’s ID who created this invite.

Type:

str

await delete(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

There is an alias for this called revoke().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
get_channel()[source]

Optional[GroupChannel]: The group channel this invite points to.

await revoke(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

This is an alias of delete().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
state

State that controls this invite.

Type:

State

get_creator()[source]

Optional[User]: The user who created this invite.

property channel[source]

The group channel this invite points to.

Type:

GroupChannel

property creator[source]

The user who created this invite.

Type:

User

await accept(*, http_overrides=None)[source]

This function is a coroutine.

Accepts an invite.

Fires PrivateChannelCreateEvent for the current user, GroupRecipientAddEvent and MessageCreateEvent, both for all group recipients.

Note

This can only be used by non-bot accounts.

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • HTTPException – Possible values for type:

    Value

    Reason

    IsBot

    The current token belongs to bot account.

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    GroupTooLarge

    The group exceeded maximum count of recipients.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite/channel was not found.

  • Conflict – Possible values for type:

    Value

    Reason

    AlreadyInGroup

    The user is already in group.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
Returns:

The joined group.

Return type:

GroupChannel

ServerInvite

Attributes
Methods
class stoat.ServerInvite(*, state, code, creator_id, server_id, channel_id)[source]

Represents a server invite on Stoat.

This inherits from PrivateBaseInvite.

code

The invite’s code.

Type:

str

creator_id

The user’s ID who created this invite.

Type:

str

await delete(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

There is an alias for this called revoke().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
await revoke(*, http_overrides=None)[source]

This function is a coroutine.

Deletes the invite.

You must have manage_server if deleting server invite.

This is an alias of delete().

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    MissingPermission

    You do not have the proper permissions to delete this invite.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite was not found.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
state

State that controls this invite.

Type:

State

server_id

The server’s ID this invite points to.

Type:

str

channel_id

The server channel’s ID this invite points to.

Type:

str

get_server()[source]

Optional[Server]: The server this invite points to.

get_channel()[source]

Optional[ServerChannel]: The server channel this invite points to.

get_creator()[source]

Optional[Union[Member, User]]: The user who created this invite.

get_creator_as_member()[source]

Optional[Member]: The user who created this invite.

get_creator_as_user()[source]

Optional[User]: The user who created this invite.

property server[source]

The server this invite points to.

Type:

Server

property channel[source]

The server channel this invite points to.

Type:

ServerChannel

property creator[source]

The user who created this invite.

Type:

Union[Member, User]

property creator_as_member[source]

The user who created this invite.

Type:

Member

property creator_as_user[source]

The user who created this invite.

Type:

User

await accept(*, http_overrides=None)[source]

This function is a coroutine.

Accepts an invite.

Fires ServerCreateEvent for the current user, ServerMemberJoinEvent and optionally MessageCreateEvent, both for all server members.

Note

This can only be used by non-bot accounts.

Parameters:

http_overrides (Optional[HTTPOverrideOptions]) – The HTTP request overrides.

Raises:

  • HTTPException – Possible values for type:

    Value

    Reason

    IsBot

    The current token belongs to bot account.

    TooManyServers

    You’re participating in too many servers.

  • Unauthorized – Possible values for type:

    Value

    Reason

    InvalidSession

    The current bot/user token is invalid.

  • Forbidden – Possible values for type:

    Value

    Reason

    Banned

    You’re banned from server.

  • NotFound – Possible values for type:

    Value

    Reason

    NotFound

    The invite/channel/server was not found.

  • Conflict – Possible values for type:

    Value

    Reason

    AlreadyInServer

    The user is already in server.

  • InternalServerError – Possible values for type:

    Value

    Reason

    Populated attributes

    DatabaseError

    Something went wrong during querying database.

    collection, operation
Returns:

The joined server.

Return type:

Server

Invite

stoat.Invite

alias of GroupInvite | ServerInvite