Home Reference Source Repository
import {ApiRecover} from 'ingresse-sdk/src/apis/api.recover.js'
public class | source

ApiRecover

Extends:

RequestHandler → ApiRecover

Ingresse Recover Password API

Method Summary

Public Methods
public

Recover the user password

public

Update the user password

public

validateHash(data: object, query: object): Promise

Validate the hash sent for user

Inherited Summary

From class RequestHandler
public

auth: *

public
public

delete(path: string, query: object, data: object, headers: object): Promise

Delete resource

public

get(path: string, query: object, headers: object): Promise

Get resource

public

post(path: string, data: object, query: object, headers: object): Promise

Post resource

public

put(path: string, data: object, query: object, headers: object): Promise

Put resource

public

request(options: object): Promise

Create new request promise

public

setEnv(env: string)

Set Environment

public

setUrl(url: string)

Set API url

public

upload(path: string, formData: object, query: object, headers: object): Promise

Upload files

Public Methods

public recoverPassword(data: object, query: object): Promise source

Recover the user password

Params:

NameTypeAttributeDescription
data object

The user data to recover password.

query object
  • optional

Optional request parameters.

Return:

Promise

public updatePassword(data: object, query: object): Promise source

Update the user password

Params:

NameTypeAttributeDescription
data object

The user data to validate password.

query object
  • optional

Optional request parameters.

Return:

Promise

public validateHash(data: object, query: object): Promise source

Validate the hash sent for user

Params:

NameTypeAttributeDescription
data object

The user data to validate password.

query object
  • optional

Optional request parameters.

Return:

Promise