Class default

Index

Constructors

Methods

forgotPasswordWithEmail loginWithEmail loginWithUsername oneTimeLogin register resetPassword

Constructors

constructor

new default(): default
Returns default

Methods

`Static` forgotPasswordWithEmail

forgotPasswordWithEmail<T>(email): AxiosPromise<default<T>>
Execute the password reset process using a user's email address.
Type Parameters
- T
Parameters
- email: string
  The email address
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Authentication%20Route/authForgotPassword
- Defined in api/Auth.ts:69

`Static` loginWithEmail

loginWithEmail<T>(email, password): AxiosPromise<default<T>>
Attempts to authenticate a user using their email address.
Type Parameters
- T
Parameters
- email: string
  The email address of the user
- password: string
  The password of the user
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
- Defined in api/Auth.ts:18

`Static` loginWithUsername

loginWithUsername<T>(username, password): AxiosPromise<default<T>>
Attempts to authenticate a user using their username.
Type Parameters
- T
Parameters
- username: string
  The username of the user
- password: string
  The password of the user
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Authentication%20Route/authLogin
- Defined in api/Auth.ts:32

`Static` oneTimeLogin

oneTimeLogin<T>(token): AxiosPromise<default<T>>
Request an authentication token to faciliate a one time login of an user.
Type Parameters
- T
Parameters
- token: string
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
- Defined in api/Auth.ts:56

`Static` register

register<T>(data): AxiosPromise<default<T>>
Attempts to register a user.
Type Parameters
- T
Parameters
- data: object
  The data the user can register with.
Returns AxiosPromise<default<T>>
A promise

See
https://api.glitch.fun/api/documentation#/Authentication%20Route/oneTimeLoginToken
- Defined in api/Auth.ts:45

`Static` resetPassword

resetPassword<T>(data): AxiosPromise<default<T>>
Resets the users password after the forgot password has been executed.
Type Parameters
- T
Parameters
- data: object
  The parameters required to reset the password.
Returns AxiosPromise<default<T>>
promise

See
https://api.glitch.fun/api/documentation#/Authentication%20Route/authResetPassword
- Defined in api/Auth.ts:82

Generated using TypeDoc