@vqnguyen1/piece-narmi 0.0.1 → 0.0.6

package/README.md

@@ -0,0 +1,117 @@
+# Narmi Account Opening API
+
+This piece integrates with the Narmi Account Opening API to manage account applications.
+
+## Authentication
+
+The Narmi piece uses custom authentication with the following properties:
+
+- **Base URL**: The base URL for the Narmi API (e.g., `https://api.sandbox.narmi.dev`)
+- **API Key**: Your Narmi API Key (OAuth2 token) - Optional, only required for certain endpoints
+
+## Available Actions
+
+### Get CSRF Token
+Get a CSRF token for making authenticated requests to the Narmi API.
+
+**Inputs:**
+- Has Applicant Token (optional): Whether you have an applicant_token cookie
+
+**Returns:** CSRF token and response body
+
+### Get Products
+Get the list of available Account Opening products.
+
+**Returns:** List of products with details like category, name, description, minimum balance, etc.
+
+### Create Account Application
+Create a new account application.
+
+**Inputs:**
+- CSRF Token (required)
+- Email (required)
+- First Name (optional)
+- Last Name (optional)
+- Phone (optional)
+- Selected Products (optional): Array of product IDs
+- Additional Data (optional): Additional application data as JSON
+
+**Returns:** Created application with token
+
+### Get Account Application
+Retrieve an account application by UUID.
+
+**Inputs:**
+- Application UUID (required)
+- CSRF Token (optional)
+
+**Returns:** Application details
+
+### Update Account Application
+Update an existing account application.
+
+**Inputs:**
+- Application UUID (required)
+- CSRF Token (required)
+- Update Data (required): JSON object with fields to update
+
+**Returns:** Updated application details
+
+### Submit Application
+Submit an account application for processing.
+
+**Inputs:**
+- Application UUID (required)
+- CSRF Token (required)
+- Selected Products (required): Array of product objects
+- Device ID (optional)
+- UTM Source (optional)
+
+**Returns:** Submission response with application state
+
+### Run KYC
+Initiate KYC (Know Your Customer) execution for an account application.
+
+**Inputs:**
+- Application UUID (required)
+- CSRF Token (optional)
+
+**Returns:** KYC execution response
+
+### Custom API Call
+Make a custom API call to any Narmi endpoint.
+
+**Inputs:**
+- URL (required): Full URL or relative path to the base URL (e.g., `/v1/account_opening/`)
+- Method (required): HTTP method (GET, POST, PUT, DELETE, PATCH)
+- Headers (optional): Custom headers to include
+- Query Parameters (optional): URL query parameters
+- Body (optional): Request body as JSON
+- Response is Binary (optional): Enable for file responses like PDFs
+- No Error on Failure (optional): Return error message instead of throwing
+- Timeout (optional): Request timeout in seconds
+
+**Returns:** API response
+
+**Note:** Authorization headers are automatically injected if an API key is configured.
+
+## Usage Example
+
+1. First, get a CSRF token using the "Get CSRF Token" action
+2. Create a new account application using the CSRF token
+3. Update the application with applicant information
+4. Submit the application for processing
+5. Optionally run KYC verification
+
+## API Documentation
+
+For more information about the Narmi Account Opening API, visit:
+https://narmi.stoplight.io/docs/narmi-developer-docs/
+
+## Version
+
+Current version: 0.0.2
+
+## Author
+
+vqnguyen1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vqnguyen1/piece-narmi",
-  "version": "0.0.1",
+  "version": "0.0.6",
   "license": "MIT",
   "type": "commonjs",
   "main": "./src/index.js",
@@ -8,6 +8,11 @@
   "exports": {
     ".": "./src/index.js"
   },
+  "tags": [
+    "narmi",
+    "banking",
+    "account-opening"
+  ],
   "dependencies": {
     "tslib": "^2.3.0"
   },

package/src/index.js

@@ -1,8 +1,10 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.narmi = exports.narmiAuth = void 0;
+const tslib_1 = require("tslib");
 const pieces_framework_1 = require("@activepieces/pieces-framework");
 const shared_1 = require("@activepieces/shared");
+const pieces_common_1 = require("@activepieces/pieces-common");
 const create_account_application_1 = require("./lib/actions/create-account-application");
 const get_account_application_1 = require("./lib/actions/get-account-application");
 const update_account_application_1 = require("./lib/actions/update-account-application");
@@ -31,7 +33,7 @@ exports.narmi = (0, pieces_framework_1.createPiece)({
     displayName: 'Narmi',
     auth: exports.narmiAuth,
     minimumSupportedRelease: '0.20.0',
-    logoUrl: 'https://www.narmi.com/favicon.ico',
+    logoUrl: 'https://cdn.prod.website-files.com/6155dc277c0e691a95412e1f/69679d62d5080aa68d936d0c_Narmi%20Guard_Thumbnail.jpg',
     authors: ['vqnguyen1'],
     categories: [shared_1.PieceCategory.BUSINESS_INTELLIGENCE],
     actions: [
@@ -42,6 +44,19 @@ exports.narmi = (0, pieces_framework_1.createPiece)({
         submit_application_1.submitApplication,
         run_kyc_1.runKyc,
         get_products_1.getProducts,
+        (0, pieces_common_1.createCustomApiCallAction)({
+            baseUrl: (auth) => auth.baseUrl || 'https://api.sandbox.narmi.dev',
+            auth: exports.narmiAuth,
+            authMapping: (auth) => tslib_1.__awaiter(void 0, void 0, void 0, function* () {
+                const apiKey = auth.apiKey;
+                if (apiKey) {
+                    return {
+                        Authorization: `Bearer ${apiKey}`,
+                    };
+                }
+                return {};
+            }),
+        }),
     ],
     triggers: [],
 });

package/src/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/pieces/custom/narmi/src/index.ts"],"names":[],"mappings":";;;AAAA,qEAAkF;AAClF,iDAAqD;AACrD,yFAAoF;AACpF,mFAA8E;AAC9E,yFAAoF;AACpF,yEAAqE;AACrE,mDAA+C;AAC/C,6DAAyD;AACzD,iEAA4D;AAE/C,QAAA,SAAS,GAAG,4BAAS,CAAC,UAAU,CAAC;IAC5C,WAAW,EAAE,uCAAuC;IACpD,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE;QACL,OAAO,EAAE,2BAAQ,CAAC,SAAS,CAAC;YAC1B,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,sEAAsE;YACnF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,+BAA+B;SAC9C,CAAC;QACF,MAAM,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACzB,WAAW,EAAE,SAAS;YACtB,WAAW,EAAE,mCAAmC;YAChD,QAAQ,EAAE,KAAK;SAChB,CAAC;KACH;CACF,CAAC,CAAC;AAEU,QAAA,KAAK,GAAG,IAAA,8BAAW,EAAC;IAC/B,WAAW,EAAE,OAAO;IACpB,IAAI,EAAE,iBAAS;IACf,uBAAuB,EAAE,QAAQ;IACjC,OAAO,EAAE,mCAAmC;IAC5C,OAAO,EAAE,CAAC,WAAW,CAAC;IACtB,UAAU,EAAE,CAAC,sBAAa,CAAC,qBAAqB,CAAC;IACjD,OAAO,EAAE;QACP,6BAAY;QACZ,qDAAwB;QACxB,+CAAqB;QACrB,qDAAwB;QACxB,sCAAiB;QACjB,gBAAM;QACN,0BAAW;KACZ;IACD,QAAQ,EAAE,EAAE;CACb,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../../packages/pieces/custom/narmi/src/index.ts"],"names":[],"mappings":";;;;AAAA,qEAAkF;AAClF,iDAAqD;AACrD,+DAAwE;AACxE,yFAAoF;AACpF,mFAA8E;AAC9E,yFAAoF;AACpF,yEAAqE;AACrE,mDAA+C;AAC/C,6DAAyD;AACzD,iEAA4D;AAE/C,QAAA,SAAS,GAAG,4BAAS,CAAC,UAAU,CAAC;IAC5C,WAAW,EAAE,uCAAuC;IACpD,QAAQ,EAAE,IAAI;IACd,KAAK,EAAE;QACL,OAAO,EAAE,2BAAQ,CAAC,SAAS,CAAC;YAC1B,WAAW,EAAE,UAAU;YACvB,WAAW,EAAE,sEAAsE;YACnF,QAAQ,EAAE,IAAI;YACd,YAAY,EAAE,+BAA+B;SAC9C,CAAC;QACF,MAAM,EAAE,2BAAQ,CAAC,SAAS,CAAC;YACzB,WAAW,EAAE,SAAS;YACtB,WAAW,EAAE,mCAAmC;YAChD,QAAQ,EAAE,KAAK;SAChB,CAAC;KACH;CACF,CAAC,CAAC;AAEU,QAAA,KAAK,GAAG,IAAA,8BAAW,EAAC;IAC/B,WAAW,EAAE,OAAO;IACpB,IAAI,EAAE,iBAAS;IACf,uBAAuB,EAAE,QAAQ;IACjC,OAAO,EAAE,kHAAkH;IAC3H,OAAO,EAAE,CAAC,WAAW,CAAC;IACtB,UAAU,EAAE,CAAC,sBAAa,CAAC,qBAAqB,CAAC;IACjD,OAAO,EAAE;QACP,6BAAY;QACZ,qDAAwB;QACxB,+CAAqB;QACrB,qDAAwB;QACxB,sCAAiB;QACjB,gBAAM;QACN,0BAAW;QACX,IAAA,yCAAyB,EAAC;YACxB,OAAO,EAAE,CAAC,IAAI,EAAE,EAAE,CAAE,IAAY,CAAC,OAAO,IAAI,+BAA+B;YAC3E,IAAI,EAAE,iBAAS;YACf,WAAW,EAAE,CAAO,IAAI,EAAE,EAAE;gBAC1B,MAAM,MAAM,GAAI,IAAY,CAAC,MAAM,CAAC;gBACpC,IAAI,MAAM,EAAE,CAAC;oBACX,OAAO;wBACL,aAAa,EAAE,UAAU,MAAM,EAAE;qBAClC,CAAC;gBACJ,CAAC;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC,CAAA;SACF,CAAC;KACH;IACD,QAAQ,EAAE,EAAE;CACb,CAAC,CAAC"}