Merge pull request #32 from smontiu/master

Feature direct debits and standing orders

Author: kovacss

README.md

@@ -155,6 +155,8 @@ This client library consists of two core pieces of functionality, each represent
 
     * `getAccounts` - call to the */accounts* endpoint
     * `getAccount` - call to the */accounts/{account_id}* endpoint
+    * `getDirectDebits` - call to the */accounts/{account_id}/direct_debits* endpoint
+    * `getStandingOrders` - call to the */accounts/{account_id}/standing_orders* endpoint
     * `getTransactions` - call to the */accounts/{account_id}/transactions* endpoint
     * `getPendingTransactions` - call to the */accounts/{account_id}/transactions/pending* endpoint
     * `getBalance` - call to the */accounts/{account_id}/balance* endpoint

index.ts

@@ -4,6 +4,8 @@ export { StatusAPIClient } from "./src/v1/StatusAPIClient";
 export { Constants } from "./src/v1/Constants";
 export { IAccount } from "./src/v1/interfaces/data/IAccount";
 export { IBalance } from "./src/v1/interfaces/data/IBalance";
+export { IDirectDebit } from "./src/v1/interfaces/data/IDirectDebit";
+export { IStandingOrder } from "./src/v1/interfaces/data/IStandingOrder";
 export { IInfo } from "./src/v1/interfaces/data/IInfo";
 export { IMe } from "./src/v1/interfaces/data/IMe";
 export { IOptions } from "./src/v1/interfaces/auth/IOptions";

src/v1/AuthAPIClient.ts

@@ -115,17 +115,7 @@ export class AuthAPIClient {
      * @returns {boolean}
      */
     private static isValidScope(grant: string): boolean {
-        switch (grant) {
-            case "offline_access":
-            case "info":
-            case "accounts":
-            case "transactions":
-            case "balance":
-            case "cards":
-                return true;
-            default:
-                return false;
-        }
+        return Constants.AVAILABLE_SCOPES.includes(grant);
     }
 
     /**

src/v1/Constants.ts

@@ -8,4 +8,5 @@ export class Constants {
     public static readonly API_URL: string = "https://api.truelayer.com";
     public static readonly STATUS_URL: string = "https://status-api.truelayer.com";
     public static readonly API_TIMEOUT: number = 60000;
+    public static readonly AVAILABLE_SCOPES: Array<string> = ["offline_access", "info", "accounts", "transactions", "balance", "cards", "direct_debits", "standing_orders"];
 }

src/v1/DataAPIClient.ts

@@ -2,6 +2,8 @@ import { ApiError } from "./APIError";
 import { Constants } from "./Constants";
 import { IAccount } from "./interfaces/data/IAccount";
 import { IBalance } from "./interfaces/data/IBalance";
+import { IDirectDebit } from "./interfaces/data/IDirectDebit";
+import { IStandingOrder } from "./interfaces/data/IStandingOrder";
 import { IInfo } from "./interfaces/data/IInfo";
 import { IJWT } from "./interfaces/auth/IJWT";
 import { IMe } from "./interfaces/data/IMe";
@@ -158,6 +160,28 @@ export class DataAPIClient {
         return await DataAPIClient.callAPI<IBalance>(accessToken, `${Constants.API_URL}/data/v1/accounts/${accountId}/balance`);
     }
 
+    /**
+     * Call to /accounts/account_id/direct_debits API
+     *
+     * @param accessToken
+     * @param accountId
+     * @returns {Promise<IResult<IDirectDebit>>}
+     */
+    public static async getDirectDebits(accessToken: string, accountId: string): Promise<IResult<IDirectDebit>> {
+        return await DataAPIClient.callAPI<IDirectDebit>(accessToken, `${Constants.API_URL}/data/v1/accounts/${accountId}/direct_debits`);
+    }
+
+    /**
+     * Call to /accounts/account_id/standing_orders API
+     *
+     * @param accessToken
+     * @param accountId
+     * @returns {Promise<IResult<IStandingOrder>>}
+     */
+    public static async getStandingOrders(accessToken: string, accountId: string): Promise<IResult<IStandingOrder>> {
+        return await DataAPIClient.callAPI<IStandingOrder>(accessToken, `${Constants.API_URL}/data/v1/accounts/${accountId}/standing_orders`);
+    }
+
     /**
      * Call to /cards API.
      *

src/v1/README.md

@@ -84,6 +84,8 @@ Class responsible for calling to the Data endpoints
     * [.getInfo(accessToken)](#DataAPIClient.getInfo) ⇒ <code>Promise.&lt;IResponse.&lt;IInfo&gt;&gt;</code>
     * [.getAccounts(accessToken)](#DataAPIClient.getAccounts) ⇒ <code>Promise.&lt;IResponse.&lt;IAccount&gt;&gt;</code>
     * [.getAccount(accessToken, accountId)](#DataAPIClient.getAccount) ⇒ <code>Promise.&lt;IResponse.&lt;IAccount&gt;&gt;</code>
+    * [.getDirectDebits(accessToken, accountId)](#DataAPIClient.getDirectDebits) ⇒ <code>Promise.&lt;IResponse.&lt;IDirectDebit&gt;&gt;</code>
+    * [.getStandingOrders(accessToken, accountId)](#DataAPIClient.getStandingOrders) ⇒ <code>Promise.&lt;IResponse.&lt;IStandingOrder&gt;&gt;</code>
     * [.getTransactions(accessToken, accountId, from, to)](#DataAPIClient.getTransactions) ⇒ <code>Promise.&lt;IResponse.&lt;ITransaction&gt;&gt;</code>
     * [.getBalance(accessToken, accountId)](#DataAPIClient.getBalance) ⇒ <code>Promise.&lt;IResponse.&lt;IBalance&gt;&gt;</code>
     * [.validateToken(accessToken)](#DataAPIClient.isTokenExpired) ⇒ <code>boolean</code>
@@ -147,6 +149,26 @@ Call to /accounts/account_id API.
 | accessToken | <code>string</code> | 
 | accountId | <code>string</code> |
 
+### DataAPIClient.getDirectDebits(accessToken, accountId) ⇒ <code>Promise.&lt;IResponse.&lt;IDirectDebit&gt;&gt;</code>
+Call to /accounts/account_id/direct_debits API.
+
+**Kind**: static method of [<code>DataAPIClient</code>](#DataAPIClient)  
+
+| Param | Type |
+| --- | --- |
+| accessToken | <code>string</code> | 
+| accountId | <code>string</code> |
+
+### DataAPIClient.getStandingOrders(accessToken, accountId) ⇒ <code>Promise.&lt;IResponse.&lt;IStandingOrder&gt;&gt;</code>
+Call to /accounts/account_id/standing_orders API.
+
+**Kind**: static method of [<code>DataAPIClient</code>](#DataAPIClient)  
+
+| Param | Type |
+| --- | --- |
+| accessToken | <code>string</code> | 
+| accountId | <code>string</code> |
+
 <a name="DataAPIClient.getTransactions"></a>
 
 ### DataAPIClient.getTransactions(accessToken, accountId, from, to) ⇒ <code>Promise.&lt;IResponse.&lt;ITransaction&gt;&gt;</code>

src/v1/interfaces/data/IDirectDebit.ts

@@ -0,0 +1,36 @@
+/**
+ * Customer's direct debits and associated data - for use with /accounts endpoint
+ * Docs: https://docs.truelayer.com/#retrieve-direct-debits
+ *
+ * @interface IDirectDebit
+ */
+export interface IDirectDebit {
+    /** Unique identifier of the direct debit in a request. It may change between requests. */
+    direct_debit_id: string;
+    /** Name of the service or user returned by the Provider */
+    name: string;
+    /** This can either be Active or Inactive */
+    status: string;
+    /** Date of the latest payment */
+    previous_payment_timestamp: string;
+    /** Amount of the latest paymentt */
+    previous_payment_amount: number;
+    /** ISO 4217 alpha-3 currency code */
+    currency: string;
+    /** A collection of additional Provider specific transaction metadata * @type {IMeta} */
+    meta?: IMeta;
+    /** Date and time the request was made */
+    timestamp: string;
+}
+
+/**
+ * Direct debit meta
+ *
+ * @interface IMeta
+ */
+export interface IMeta {
+    /** Provider mandate identification */
+    provider_mandate_identification: string;
+    /** Provider account identifier */
+    provider_account_id: string;
+}

src/v1/interfaces/data/IStandingOrder.ts

@@ -0,0 +1,54 @@
+/**
+ * Customer's standing orders - for use with /accounts endpoint
+ * Docs: https://docs.truelayer.com/#retrieve-standing-orders
+ *
+ * @interface IStandingOrder
+ */
+export interface IStandingOrder {
+    /** Frequency of the standing order.
+     * Possible values:
+     *      EvryDay - every day
+     *      EvryWorkgDay - every working day
+     *      IntrvlDay:XX - every XX calendar day
+     *      IntrvlMnthDay:XX:YY - every XXth month on the YYth day of the month
+     *      IntrvlWkDay:XX:YY - every XXth week, on the YYth day of the week
+     *      QtrDay - quarterly -
+     *      WkInMnthDay:XX:YY - every month, on the XXth week of the month and on the YYth day of the week. */
+    frequency: string;
+    /** This can either be Active or Inactive */
+    status: string;
+    /** Date and time the request was made */
+    timestamp: string;
+    /** ISO 4217 alpha-3 currency code */
+    currency: string;
+    /** A collection of additional Provider specific transaction metadata * @type {IMeta} */
+    meta?: IMeta;
+    /** The date on which the next payment for the standing order schedule will be made */
+    next_payment_date: string;
+    /** Amount of the next payment for the standing order **/
+    next_payment_amount: number;
+    /** The date on which the first payment for the standing order schedule will be or was made */
+    first_payment_date: string;
+    /** Amount of the first payment for the standing order */
+    first_payment_amount: number;
+    /** The date on which the next payment for a Standing Order schedule will be made */
+    final_payment_date: string;
+    /** Amount of the last payment for the standing order */
+    final_payment_amount: number;
+    /** Reference of the standing order set by the user */
+    reference: string;
+    /** Date of the latest payment */
+    previous_payment_timestamp: string;
+    /** Amount of the latest payment */
+    previous_payment_amount: number;
+}
+
+/**
+ * Direct debit meta
+ *
+ * @interface IMeta
+ */
+export interface IMeta {
+    /** Provider account identifier */
+    provider_account_id: string;
+}

test/unit/data.spec.ts

@@ -44,6 +44,7 @@ test("buildRequestOptions() - returns well formed request options - all params",
 // Get access token from environment variable
 const access_token: string = (process.env.access_token as string);
 
+
 // Only run the below stubbed tests with a valid access token
 if (DataAPIClient.validateToken(access_token)) {
 
@@ -101,6 +102,22 @@ if (DataAPIClient.validateToken(access_token)) {
         t.deepEqual(actual, expected);
     });
 
+    test.serial("stubbed request body for /Accounts/{id}/DirectDebits endpoint is correctly parsed", async (t) => {
+        const expected = fixtures.accountDirectDebitResponse;
+        mock.stub(request, "get").returns(JSON.stringify(expected));
+        const actual = await DataAPIClient.getDirectDebits(access_token, "test_account_id");
+        t.plan(1);
+        t.deepEqual(actual, expected);
+    });
+
+    test.serial("stubbed request body for /Accounts/{id}/StandingOrders endpoint is correctly parsed", async (t) => {
+        const expected = fixtures.accountStandingOrderResponse;
+        mock.stub(request, "get").returns(JSON.stringify(expected));
+        const actual = await DataAPIClient.getStandingOrders(access_token, "test_account_id");
+        t.plan(1);
+        t.deepEqual(actual, expected);
+    });
+
     test.serial("stubbed request body for /Cards endpoint is correctly parsed", async (t) => {
         const expected = fixtures.cardsResponse;
         mock.stub(request, "get").returns(JSON.stringify(expected));

test/unit/fixtures.ts

@@ -11,6 +11,8 @@ import { ICardBalance } from "../../src/v1/interfaces/data/ICardBalance";
 import { ICardTransaction } from "../../src/v1/interfaces/data/ICardTransaction";
 import { IProviderInfo } from '../../src/v1/interfaces/auth/IProviderInfo';
 import { IStatusInfo } from "../../src/v1/interfaces/status/IStatusInfo";
+import { IStandingOrder } from "../../src/v1/interfaces/data/IStandingOrder";
+import { IDirectDebit } from "../../src/v1/interfaces/data/IDirectDebit";
 
 export class Fixtures {
 
@@ -386,6 +388,52 @@ export class Fixtures {
             ]
         };
 
+    // Expected  /Accounts/{id}/StandingOrders json response
+    public readonly accountStandingOrderResponse: IResult<IStandingOrder> =
+        {
+            results: [
+                {
+                    currency: "GBP",
+                    frequency: "DD",
+                    next_payment_date: "2017-10-12T07:17:54.8144949Z",
+                    next_payment_amount: 123,
+                    first_payment_date: "2017-10-12T07:17:54.8144949Z",
+                    status: "Active",
+                    first_payment_amount: 123,
+                    final_payment_date: "2017-10-12T07:17:54.8144949Z",
+                    final_payment_amount: 123,
+                    timestamp: "2017-10-12T07:17:54.8144949Z",
+                    reference: "Savings",
+                    previous_payment_timestamp: "2017-10-12T07:17:54.8144949Z",
+                    previous_payment_amount: 123,
+                    meta: {
+                        provider_account_id: "234234-123"
+                    }
+                }
+            ]
+        };
+
+    // Expected  /Accounts/{id}/DirectDebits json response
+    public readonly accountDirectDebitResponse: IResult<IDirectDebit> =
+        {
+            results: [
+                {
+                    direct_debit_id: "123",
+                    name: "Netflic",
+                    status: "Active",
+                    previous_payment_timestamp: "2017-10-12T07:17:54.8144949Z",
+                    previous_payment_amount: 123,
+                    currency: "GBP",
+                    timestamp: "2017-10-12T07:17:54.8144949Z",
+                    meta: {
+                        provider_mandate_identification: "Lacsitos",
+                        provider_account_id: "234234-123"
+                    }
+                }
+            ]
+        };
+
+    // Expected /Cards/{id}/Transactions json response
     public readonly cardTransactionsResponse: IResult<ICardTransaction> =
         {
             results: [