Skip to content
This repository was archived by the owner on Apr 23, 2021. It is now read-only.

Commit 002864e

Browse files
author
Santiago Montiu
committed
[docs] update README and API readme. Include missing interfaces
1 parent 7a6e916 commit 002864e

File tree

3 files changed

+26
-0
lines changed

3 files changed

+26
-0
lines changed

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ This client library consists of two core pieces of functionality, each represent
155155

156156
* `getAccounts` - call to the */accounts* endpoint
157157
* `getAccount` - call to the */accounts/{account_id}* endpoint
158+
* `getDirectDebits` - call to the */accounts/{account_id}/direct_debits* endpoint
159+
* `getStandingOrders` - call to the */accounts/{account_id}/standing_orders* endpoint
158160
* `getTransactions` - call to the */accounts/{account_id}/transactions* endpoint
159161
* `getPendingTransactions` - call to the */accounts/{account_id}/transactions/pending* endpoint
160162
* `getBalance` - call to the */accounts/{account_id}/balance* endpoint

index.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ export { StatusAPIClient } from "./src/v1/StatusAPIClient";
44
export { Constants } from "./src/v1/Constants";
55
export { IAccount } from "./src/v1/interfaces/data/IAccount";
66
export { IBalance } from "./src/v1/interfaces/data/IBalance";
7+
export { IDirectDebit } from "./src/v1/interfaces/data/IDirectDebit";
8+
export { IStandingOrder } from "./src/v1/interfaces/data/IStandingOrder";
79
export { IInfo } from "./src/v1/interfaces/data/IInfo";
810
export { IMe } from "./src/v1/interfaces/data/IMe";
911
export { IOptions } from "./src/v1/interfaces/auth/IOptions";

src/v1/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,8 @@ Class responsible for calling to the Data endpoints
8484
* [.getInfo(accessToken)](#DataAPIClient.getInfo) ⇒ <code>Promise.&lt;IResponse.&lt;IInfo&gt;&gt;</code>
8585
* [.getAccounts(accessToken)](#DataAPIClient.getAccounts) ⇒ <code>Promise.&lt;IResponse.&lt;IAccount&gt;&gt;</code>
8686
* [.getAccount(accessToken, accountId)](#DataAPIClient.getAccount) ⇒ <code>Promise.&lt;IResponse.&lt;IAccount&gt;&gt;</code>
87+
* [.getDirectDebits(accessToken, accountId)](#DataAPIClient.getDirectDebits) ⇒ <code>Promise.&lt;IResponse.&lt;IDirectDebit&gt;&gt;</code>
88+
* [.getStandingOrders(accessToken, accountId)](#DataAPIClient.getStandingOrders) ⇒ <code>Promise.&lt;IResponse.&lt;IStandingOrder&gt;&gt;</code>
8789
* [.getTransactions(accessToken, accountId, from, to)](#DataAPIClient.getTransactions) ⇒ <code>Promise.&lt;IResponse.&lt;ITransaction&gt;&gt;</code>
8890
* [.getBalance(accessToken, accountId)](#DataAPIClient.getBalance) ⇒ <code>Promise.&lt;IResponse.&lt;IBalance&gt;&gt;</code>
8991
* [.validateToken(accessToken)](#DataAPIClient.isTokenExpired) ⇒ <code>boolean</code>
@@ -147,6 +149,26 @@ Call to /accounts/account_id API.
147149
| accessToken | <code>string</code> |
148150
| accountId | <code>string</code> |
149151

152+
### DataAPIClient.getDirectDebits(accessToken, accountId) ⇒ <code>Promise.&lt;IResponse.&lt;IDirectDebit&gt;&gt;</code>
153+
Call to /accounts/account_id/direct_debits API.
154+
155+
**Kind**: static method of [<code>DataAPIClient</code>](#DataAPIClient)
156+
157+
| Param | Type |
158+
| --- | --- |
159+
| accessToken | <code>string</code> |
160+
| accountId | <code>string</code> |
161+
162+
### DataAPIClient.getStandingOrders(accessToken, accountId) ⇒ <code>Promise.&lt;IResponse.&lt;IStandingOrder&gt;&gt;</code>
163+
Call to /accounts/account_id/standing_orders API.
164+
165+
**Kind**: static method of [<code>DataAPIClient</code>](#DataAPIClient)
166+
167+
| Param | Type |
168+
| --- | --- |
169+
| accessToken | <code>string</code> |
170+
| accountId | <code>string</code> |
171+
150172
<a name="DataAPIClient.getTransactions"></a>
151173

152174
### DataAPIClient.getTransactions(accessToken, accountId, from, to) ⇒ <code>Promise.&lt;IResponse.&lt;ITransaction&gt;&gt;</code>

0 commit comments

Comments
 (0)