Variable APIRoutesConst

Type declaration

• authLogin:function

  • authLogin(): "/auth/login"

  • Route for:

    • POST /auth/login

    Returns "/auth/login"

• authRegister:function

  • authRegister(): "/auth/register"

  • Route for:

    • POST /auth/register

    Returns "/auth/register"

• authResendEmail:function

  • authResendEmail(): "/auth/email/resend"

  • Route for:

    • POST /auth/email/resend

    Returns "/auth/email/resend"

• authResetPassword:function

  • authResetPassword(): "/auth/reset-password"

  • Route for:

    • POST /auth/reset-password

    Returns "/auth/reset-password"

• authResetPasswordConfirm:function

  • authResetPasswordConfirm(): "/auth/reset-password/confirm"

  • Route for:

    • POST /auth/reset-password/confirm

    Returns "/auth/reset-password/confirm"

• authVerifyEmail:function

  • authVerifyEmail(): "/auth/email/verify"

  • Route for:

    • POST /auth/email/verify

    Returns "/auth/email/verify"

• channel:function

  • channel(channelId: number): `/channels/${number}`

  • Route for:

    • GET /channels/{channelId}
    • PATCH /channels/{channelId}
    • DELETE /channels/{channelId}

    Parameters

    • channelId: number

    Returns `/channels/${number}`

• channels:function

  • channels(): "/channels"

  • Route for:

    • POST /channels/

    Returns "/channels"

• member:function

  • member(
        channelId: number,
        memberKey: MemberKey,
    ):
        | `/channels/${number}/members/${number}`
        | `/channels/${number}/members/@me`

  • Route for:

    • GET /channels/{channelId}/members/{memberId}
    • PUT /channels/{channelId}/members/@me
    • DELETE /channels/{channelId}/members/@me

    Parameters

    • channelId: number
    • memberKey: MemberKey

    Returns `/channels/${number}/members/${number}` | `/channels/${number}/members/@me`

• members:function

  • members(channelId: number): `/channels/${number}/members`

  • Route for:

    • GET /channels/{channelId}/members

    Parameters

    • channelId: number

    Returns `/channels/${number}/members`

• message:function

  • message(
        channelId: number,
        messageId: number,
    ): `/messages/channel/${number}/${number}`

  • Route for:

    • GET /messages/channel/{channelId}/{messageId}
    • PATCH /messages/channel/{channelId}/{messageId}
    • DELETE /messages/channel/{channelId}/{messageId}

    Parameters

    • channelId: number
    • messageId: number

    Returns `/messages/channel/${number}/${number}`

• messages:function

  • messages(channelId: number): `/messages/channel/${number}`

  • Route for:

    • GET /messages/channel/{channelId}
    • POST /messages/channel/{channelId}

    Parameters

    • channelId: number

    Returns `/messages/channel/${number}`

• user:function

  • user(userKey?: UserKey): `/users/${number}` | "/users/@me"

  • Route for:

    • GET /users/{userid}
    • PATCH /users/@me
    • DELETE /users/@me

    Parameters

    • userKey: UserKey = UserMe

    Returns `/users/${number}` | "/users/@me"

• userChannels:function

  • userChannels(): "/users/@me/channels"

  • Route for:

    • GET /users/@me/channels

    Returns "/users/@me/channels"

• userConfirmDelete:function

  • userConfirmDelete(): "/users/@me/delete-confirm"

  • Route for:

    • POST /users/@me/delete-confirm

    Returns "/users/@me/delete-confirm"