Class AuthAPI

A wrapper for the Foxogram authentication API.

Index

Constructors

Methods

login register resendEmail resetPassword resetPasswordConfirm verifyEmail

Constructors

constructor

new AuthAPI(rest: REST): AuthAPI
Parameters
- rest: REST
Returns AuthAPI
- Defined in AuthAPI.ts:21

Methods

login

login(body: RESTPostAPIAuthLoginBody): Promise<APIToken>
Logs into the user's account.
Parameters
- body: RESTPostAPIAuthLoginBody
Returns Promise<APIToken>
- Defined in AuthAPI.ts:26

register

register(body: RESTPostAPIAuthRegisterBody): Promise<APIToken>
Registers a new user.
Parameters
- body: RESTPostAPIAuthRegisterBody
Returns Promise<APIToken>
- Defined in AuthAPI.ts:36

resendEmail

resendEmail(): Promise<APIOk>
Resends the confirmation email.

Returns Promise<APIOk>
- Defined in AuthAPI.ts:56

resetPassword

resetPassword(body: RESTPostAPIAuthResetPasswordBody): Promise<APIOk>
Resets user's password.
Parameters
- body: RESTPostAPIAuthResetPasswordBody
Returns Promise<APIOk>
- Defined in AuthAPI.ts:65

resetPasswordConfirm

resetPasswordConfirm(
body: RESTPostAPIAuthResetPasswordConfirmBody,
): Promise<APIOk>
Confirms resetting user password.
Parameters
- body: RESTPostAPIAuthResetPasswordConfirmBody
Returns Promise<APIOk>
- Defined in AuthAPI.ts:75

verifyEmail

verifyEmail(body: RESTPostAPIAuthVerifyEmailBody): Promise<APIOk>
Confirms the user's email.
Parameters
- body: RESTPostAPIAuthVerifyEmailBody
Returns Promise<APIOk>
- Defined in AuthAPI.ts:46