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(
        channelKey: PublicChannelKey,
    ): `/channels/${number}` | `/channels/@${string}`

    Route for:

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

    Parameters

    • channelKey: PublicChannelKey

    Returns `/channels/${number}` | `/channels/@${string}`

• channelIcon: function

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

    Route for:

    • PUT /channels/{channelId}/icon

    Parameters

    • channelId: number

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

• channelMember: function

  • channelMember(
        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 = UserMe

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

• channelMembers: function

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

    Route for:

    • GET /channels/{channelId}/members
    • PUT /channels/{channelId}/members

    Parameters

    • channelId: number

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

• channels: function

  • channels(): "/channels/"

    Route for:

    • POST /channels/

    Returns "/channels/"

• info: function

  • info(): "/info"

    Route for:

    • GET /info

    Returns "/info"

• message: function

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

    Route for:

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

    Parameters

    • channelId: number
    • messageId: number

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

• messageAttachments: function

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

    Route for:

    • PUT /channels/{channelId}/attachments

    Parameters

    • channelId: number

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

• messages: function

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

    Route for:

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

    Parameters

    • channelId: number

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

• user: function

  • user(userKey?: PublicUserKey): `/users/${number}` | `/users/@${string}`

    Route for:

    • GET /users/{userKey}
    • PATCH /users/@me
    • DELETE /users/@me
    • POST /users/{id}
    • DELETE /users/{id}

    Parameters

    • userKey: PublicUserKey = UserMe

    Returns `/users/${number}` | `/users/@${string}`

• userAvatar: function

  • userAvatar(): "/users/@me/avatar"

    Route for:

    • PUT /users/@me/avatar

    Returns "/users/@me/avatar"

• userBanner: function

  • userBanner(): "/users/@me/banner"

    Route for:

    • PUT /users/@me/banner

    Returns "/users/@me/banner"

• 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"

• userContacts: function

  • userContacts(): "/users/@me/contacts"

    Route for:

    • GET /users/@me/contacts

    Returns "/users/@me/contacts"