Skip to content

Latest commit

 

History

History
76 lines (43 loc) · 1.58 KB

ConnectionsResource.md

File metadata and controls

76 lines (43 loc) · 1.58 KB

akahu - v1.15.3 / ConnectionsResource

Class: ConnectionsResource

Utilities to view connections that are available to your app, and refresh accounts under a given connection.

Hierarchy

  • BaseResource

    ConnectionsResource

Table of contents

Methods

Methods

list

list(): Promise<Connection[]>

List all connections that the app has access to.

https://developers.akahu.nz/reference/get_connections

Returns

Promise<Connection[]>


get

get(connectionId): Promise<Connection>

Get an individual connection detail.

https://developers.akahu.nz/reference/get_connections-id

Parameters

Name Type
connectionId string

Returns

Promise<Connection>


refresh

refresh(token, connectionId): Promise<void>

Refresh all accounts that are made using the given connection and have been connected by the user associated with the specified token.

https://developers.akahu.nz/reference/post_refresh-id

Parameters

Name Type
token string
connectionId string

Returns

Promise<void>