feat: add identity recovery

Author: Gabrielpanga

example/package-lock.json

@@ -21,7 +21,7 @@
   "repository": "https://github.com/pluggyai/pluggy-sdk-node",
   "dependencies": {
     "dotenv": "^8.2.0",
-    "pluggy-sdk": "^0.3.0",
+    "pluggy-sdk": "^0.4.0",
     "ts-node": "^8.10.2",
     "typescript": "^3.9.7"
   },

example/package.json

@@ -58,6 +58,10 @@ void (async function(): Promise<void> {
     })
   }
 
+  console.log(`Retrieving identity for item # ${item.id}`)
+  const identity = await client.fetchIdentityByItemId(item.id)
+  console.log(`Identity of the account name is ${identity.fullName}`)
+
   console.log(`Deleting retrieved data for item #${item.id}`)
   await client.deleteItem(item.id)
   console.log(`Item deleted succesfully`)

example/src/index.ts

@@ -1,6 +1,6 @@
 {
   "name": "pluggy-sdk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "main": "dist/index.js",
   "typings": "dist/index.d.ts",
   "files": [

lib/package-lock.json

@@ -3,10 +3,10 @@ import fetch from 'node-fetch'
 type QueryParameters = { [key: string]: number | number[] | string | string[] | boolean }
 
 export type ClientParams = {
-  clientId: string;
-  clientSecret: string;
-  baseUrl?: string;
-  showUrls?: boolean;
+  clientId: string
+  clientSecret: string
+  baseUrl?: string
+  showUrls?: boolean
 }
 
 export class BaseApi {

lib/package.json

@@ -13,6 +13,7 @@ import {
   PageResponse,
   Webhook,
   WebhookEvent,
+  IdentityResponse,
 } from './types'
 
 /**
@@ -88,7 +89,10 @@ export class PluggyClient extends BaseApi {
    * @param parameters A map of name and value for the mfa requested
    * @returns {Item} a item object
    */
-  async updateItemMFA(id: string, parameters: { [key: string]: string } = undefined): Promise<Item> {
+  async updateItemMFA(
+    id: string,
+    parameters: { [key: string]: string } = undefined
+  ): Promise<Item> {
     return this.createPostRequest(`items/${id}/mfa`, null, parameters)
   }
 
@@ -154,6 +158,22 @@ export class PluggyClient extends BaseApi {
     return this.createGetRequest(`investments/${id}`)
   }
 
+  /**
+   * Fetch the identity resource
+   * @returns {IdentityResponse} an identity object
+   */
+  async fetchIdentity(id: string): Promise<IdentityResponse> {
+    return this.createGetRequest(`identity/${id}`)
+  }
+
+  /**
+   * Fetch the identity resource by it's Item ID
+   * @returns {IdentityResponse} an identity object
+   */
+  async fetchIdentityByItemId(itemId: string): Promise<IdentityResponse> {
+    return this.createGetRequest(`identity?itemId=${itemId}`)
+  }
+
   /**
    * Fetch all available categories
    * @returns {Categories[]} an paging response of categories