node-flinks - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

build/client.d.ts

 import { AuthorizeOptions, AuthorizeResponse } from './commands/authorize';
-import { GetAccountsDetailOptions, GetAccountsDetailResponse, GetAccountsDetailAsyncResponse } from './commands/accounts';
+import { GetAccountsDetailOptions, GetAccountsDetailResponse, GetAccountsDetailAsyncResponse, GetAccountsDetailAsyncOptions } from './commands/accounts-detail';
+import { GetAccountsSummaryOptions, GetAccountsSummaryResponse, GetAccountsSummaryAsyncOptions, GetAccountsSummaryAsyncResponse } from './commands/accounts-summary';
+import { GetStatementsOptions, GetStatementsResponse, GetStatementsAsyncOptions, GetStatementsAsyncResponse } from './commands/statements';
 declare class FlinksClient {
@@ -8,3 +10,8 @@ private client;
     getAccountsDetail(options: GetAccountsDetailOptions): Promise<GetAccountsDetailResponse | GetAccountsDetailAsyncResponse>;
+    getAccountsDetailAsync(options: GetAccountsDetailAsyncOptions): Promise<GetAccountsDetailResponse | GetAccountsDetailAsyncResponse>;
+    getAccountsSummary(options: GetAccountsSummaryOptions): Promise<GetAccountsSummaryResponse | GetAccountsSummaryAsyncResponse>;
+    getAccountsSummaryAsync(options: GetAccountsSummaryAsyncOptions): Promise<GetAccountsSummaryResponse | GetAccountsSummaryAsyncResponse>;
+    getStatements(options: GetStatementsOptions): Promise<GetStatementsResponse | GetStatementsAsyncResponse>;
+    getStatementsAsync(options: GetStatementsAsyncOptions): Promise<GetStatementsResponse | GetStatementsAsyncResponse>;
 }
 export default FlinksClient;

build/client.js

@@ -8,3 +8,5 @@ "use strict";
 const authorize_1 = require("./commands/authorize");
-const accounts_1 = require("./commands/accounts");
+const accounts_detail_1 = require("./commands/accounts-detail");
+const accounts_summary_1 = require("./commands/accounts-summary");
+const statements_1 = require("./commands/statements");
 class FlinksClient {
@@ -20,6 +22,21 @@ constructor(instanceName, customerId) {
     getAccountsDetail(options) {
-        return accounts_1.getAccountsDetail(this.client, options);
+        return accounts_detail_1.getAccountsDetail(this.client, options);
     }
+    getAccountsDetailAsync(options) {
+        return accounts_detail_1.getAccountsDetailAsync(this.client, options);
+    }
+    getAccountsSummary(options) {
+        return accounts_summary_1.getAccountsSummary(this.client, options);
+    }
+    getAccountsSummaryAsync(options) {
+        return accounts_summary_1.getAccountsSummaryAsync(this.client, options);
+    }
+    getStatements(options) {
+        return statements_1.getStatements(this.client, options);
+    }
+    getStatementsAsync(options) {
+        return statements_1.getStatementsAsync(this.client, options);
+    }
 }
 exports.default = FlinksClient;
 //# sourceMappingURL=client.js.map

build/commands/authorize.d.ts

 import { Got } from 'got';
 import { FlinksLoginResponse, LoginResponse, FlinksResponseBase, ResponseBase } from '../types';
-export interface FlinksAuthorizeOptions {
-    Institution?: string;
-    Username?: string;
-    Password?: string;
-    Save: boolean;
-    MostRecentCached: boolean;
-    LoginId: string;
-    SecurityResponses?: Record<string, any>;
-    Tag?: string;
-}
 export interface AuthorizeOptions {
@@ -14,0 +4,0 @@ institution?: string;

build/commands/authorize.js

@@ -18,2 +18,3 @@ "use strict";
 const debug_1 = __importDefault(require("debug"));
+const flinks_error_1 = __importDefault(require("../lib/flinks-error"));
 const transform_keys_1 = require("../lib/transform-keys");
@@ -40,6 +41,7 @@ const debug = debug_1.default('node-flinks:commands:authorize');
         if ((_a = error.response) === null || _a === void 0 ? void 0 : _a.body) {
-            debug('flinks authorize response', error.response.body);
-            return transform_keys_1.transformResponse(error.response.body);
+            debug('flinks authorize error response', error.response.body);
+            throw new flinks_error_1.default('authorize', Object.assign({}, error.response.body));
         }
         else {
+            debug('flinks authorize error', error);
             throw error;
@@ -46,0 +48,0 @@ }

build/index.d.ts

 import FlinksClient from './client';
+export { AuthorizeOptions, FlinksAuthorizeResponse, AuthorizeResponse } from './commands/authorize';
+export { GetAccountsDetailOptions, GetAccountsDetailAsyncOptions, FlinksGetAccountsDetailResponse, FlinksGetAccountsDetailAsyncResponse, GetAccountsDetailResponse, GetAccountsDetailAsyncResponse } from './commands/accounts-detail';
+export { GetAccountsSummaryOptions, GetAccountsSummaryAsyncOptions, FlinksGetAccountsSummaryResponse, FlinksGetAccountsSummaryAsyncResponse, GetAccountsSummaryResponse, GetAccountsSummaryAsyncResponse } from './commands/accounts-summary';
+export { GetStatementsOptions, GetStatementsAsyncOptions, FlinksGetStatementsResponse, FlinksGetStatementsAsyncResponse, GetStatementsResponse, GetStatementsAsyncResponse } from './commands/statements';
 export * from './lib/authenticity';
 export default FlinksClient;

build/types.d.ts

@@ -59,2 +59,25 @@ export interface FlinksResponseLink {
 }
+export interface FlinksSummaryAccountResponse {
+    TransitNumber: string;
+    InstitutionNumber: string;
+    OverdraftLimit: number;
+    Title: string;
+    AccountNumber: string;
+    Balance: FlinksBalanceResponse;
+    Category: string;
+    Type: string;
+    Currency: string;
+    Holder: FlinksHolderResponse;
+    EftEligibleRatio: number;
+    Id: string;
+}
+export interface FlinksStatementsResponse {
+    AccountNumber: string;
+    Statements: FlinksStatementResponse[];
+}
+export interface FlinksStatementResponse {
+    UniqueId: string;
+    FileType: string;
+    Base64Bytes: string;
+}
 export interface ResponseBase {
@@ -113,1 +136,10 @@ httpStatusCode: number;
 }
+export interface StatementsResponse {
+    accountNumber: string;
+    statements: StatementResponse[];
+}
+export interface StatementResponse {
+    uniqueId: string;
+    fileType: string;
+    base64Bytes: string;
+}

CHANGELOG.md

@@ -1,3 +0,12 @@
-# Neo Flinks Changelog
+# Node Flinks Changelog
 
+## 0.2.0 (November 2, 2020)
+
+- Throw `FlinksError` when receiving an error response
+- Add `getAccountsDetailAsync` command
+- Add `getAccountsSummary` command
+- Add `getAccountsSummaryAsync` command
+- Add `getStatements` command
+- Add `getStatementsAsync` command
+
 ## 0.1.1 (October 18, 2020)
@@ -4,0 +13,0 @@

package.json

 {
   "name": "node-flinks",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Flinks API wrapper for Node.js",
@@ -5,0 +5,0 @@ "author": "Neo Financial Engineering <[e-mail]>",

README.md

@@ -11,3 +11,3 @@ # Node Flinks
 
-`yarn add @neofinancial/node-flinks`
+`yarn add node-flinks`
 
@@ -49,8 +49,23 @@ ### Creating a client
 
-We have not yet implemented all the endpoints in the Flinks REST API. The endpoints that are implemented are:
+Here is a list of all the Flinks API endpoints along with the corresponding library method. We have not yet implemented all the endpoints in the Flinks REST API. If an endpoint you need is missing please consider submitting a pull request.
 
-| Endpoint                             | Client Method       | Docs                                                                          |
-| ------------------------------------ | ------------------- | ----------------------------------------------------------------------------- |
-| `/Authorize`                         | `authorize`         | https://docs.flinks.io/reference/authorize-token#authorize-with-token         |
-| `/BankingServices/GetAccountsDetail` | `getAccountsDetail` | https://docs.flinks.io/reference/accounts-information#step-2-calling-for-data |
+| Endpoint                     | Client Method             | Reference                                                                                     |
+| ---------------------------- | ------------------------- | --------------------------------------------------------------------------------------------- |
+| `/AnswerMFAQuestions`        | Not implemented           | [Docs](https://docs.flinks.io/reference/accounts-information#answermfaquestions)              |
+| `/Attributes`                | Not implemented           | [Docs](https://docs.flinks.io/reference/attributes#attributes-api)                            |
+| `/Authorize`                 | `authorize`               | [Docs](https://docs.flinks.io/reference/authorize-token#authorize-with-token)                 |
+| `/DeleteCard`                | Not implemented           | [Docs](https://docs.flinks.io/reference/accounts-information#deletecard)                      |
+| `/GenerateAuthorizeToken`    | Not implemented           | [Docs](https://docs.flinks.io/reference/authorize-token#generateauthorizetoken)               |
+| `/GetAccountsDetail`         | `getAccountsDetail`       | [Docs](https://docs.flinks.io/reference/accounts-information#step-2-calling-for-data)         |
+| `/GetAccountsDetailAsync`    | `getAccountsDetailAsync`  | [Docs](https://docs.flinks.io/reference/accounts-information#step-3-calling-for-pending-data) |
+| `/GetAccountsSummary`        | `getAccountsSummary`      | [Docs](https://docs.flinks.io/reference/accounts-information#getaccountssummary)              |
+| `/GetAccountsSummaryAsync`   | `getAccountsSummaryAsync` | [Docs](https://docs.flinks.io/reference/accounts-information#getaccountssummaryasync)         |
+| `/GetAllAttributes`          | Not implemented           | [Docs](https://docs.flinks.io/reference/attributes#getallattributes)                          |
+| `/GetCreditRiskAttributes`   | Not implemented           | [Docs](https://docs.flinks.io/reference/attributes#getcreditriskattributes)                   |
+| `/GetIncomeAttributes`       | Not implemented           | [Docs](https://docs.flinks.io/reference/attributes#getincomeattributes)                       |
+| `/GetMFAQuestions`           | Not implemented           | [Docs](https://docs.flinks.io/reference/accounts-information#getmfaquestions)                 |
+| `/GetStatements`             | `getStatements`           | [Docs](https://docs.flinks.io/reference/accounts-information#getstatements-1)                 |
+| `/GetUserAnalysisAttributes` | Not implemented           | [Docs](https://docs.flinks.io/reference/attributes#getuseranalysisattributes)                 |
+| `/Investments`               | Not implemented           | [Docs](https://docs.flinks.io/reference/investments#investments-1)                            |
+| `/SetScheduledRefresh`       | Not implemented           | [Docs](https://docs.flinks.io/reference/accounts-information#setscheduledrefresh)             |
 
@@ -57,0 +72,0 @@ ## Contributing

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

54968

increased by102.04%

Number of package files

37

increased by32.14%

Lines of code

792

increased by89.02%

Number of lines in readme file

97

increased by18.29%

Worsened metrics

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes