Resource - Documentation

Constructor

new Resource(session)

Instantiate a resource.

Source:

resources.js, line 2

Parameters:

Name	Type	Description
`session`	`APISession`	Belvo API session.

Methods

(async) delete(id) → {boolean}

Delete specific record.

Source:

resources.js, line 45

Parameters:

Name	Type	Description
`id`	`string`	UUID4 representation of the resource Id.

Returns:

Type:: boolean

When the record is successfuly deleted returns true, otherwise false.

(async) detail(id) → {object}

Get specific record details.

Source:

resources.js, line 34

Parameters:

Name	Type	Description
`id`	`string`	UUID4 representation of the resource Id.

Throws:

RequestError

Returns:

Type:: object

(async) list(params) → {array}

Get a list of resources.

Source:

resources.js, line 22

Parameters:

Name Type Description

params

Object

Receives two parameters.

Name	Type	Attributes	Default	Description
`limit`	`number`	<optional>	100	Maximum number of results.
`filters`	`Object`	<optional>	{}	Filters to get custom results.

Throws:

RequestError

Returns:

Type:: array

List of results.

(async) resume(session, token, link) → {object}

Resume a "pending" session that requires an OTP token. Use this function to resume sessions that returned HTTP 428 status code.

Source:

resources.js, line 60

Parameters:

Name	Type	Description
`session`	`string`	UUID4 representation of a "pending" session.
`token`	`string`	OTP token.
`link`	`string`	UUID4 representation of the link being used.

Throws:

RequestError

Returns:

Type:: object

Response.