g-ten-security-sdk 1.0.1 → 1.0.2

package/README.md

@@ -2,31 +2,49 @@
 
 A clean, developer-friendly TypeScript SDK for the **G-TEN Fraud Intelligence Platform**.
 
-This SDK provides type-safe wrappers around the G-TEN backend API, allowing you to easily integrate advanced fraud detection, graph analytics, and AI narrative explainability into any frontend or backend application.
+## What is this SDK?
+The G-TEN Security SDK provides a seamless way for frontend applications, backend services, and third-party integrations to communicate with the G-TEN Core API. 
 
-## Installation
+Instead of manually writing HTTP requests and handling complex authentication flows, this SDK gives developers a fully typed, object-oriented interface to interact with G-TEN's advanced anti-money laundering (AML) and fraud detection systems.
 
-```bash
-npm install g-ten-security-sdk
-```
+## What is it used for?
+This SDK is primarily used by developers building tools for Financial Intelligence Units (FIUs) or banking compliance teams. You can use it to:
+
+1. **Perform Graph-Based Fraud Analytics:** Detect complex money laundering patterns like *Layering* (rapid multi-hop transfers), *Smurfing* (structuring deposits), and *Round-Tripping* directly from Neo4j data.
+2. **Access AI-Powered Investigation Narratives:** Query the G-TEN Intelligence Chatbot or generate automated, plain-English investigator briefings for suspicious accounts using Gemini and Gemma 4 AI models.
+3. **Manage Alert Workflows:** Retrieve high-risk alerts, update their statuses, and assign them to investigators.
+4. **Interact with Core Banking Data:** Fetch branch information, account details, and live transaction streams securely.
 
 ## Features
 
-- **Fraud Analytics:** Access Neo4j graph algorithms to detect Layering, Smurfing, and Round-Trip patterns.
-- **Narrative Explainability:** Use AI to generate human-readable investigation briefings (powered by Gemini & Gemma 4 31B).
 - **Type-Safe:** Fully typed with TypeScript interfaces automatically generated from the FastAPI backend.
-- **Easy Authentication:** Built-in interceptors to handle JWT tokens automatically.
+- **Easy Authentication:** Built-in interceptors to automatically attach JWT tokens and handle session states.
+- **Modular APIs:** Divided into logical clients (`FraudApi`, `ChatApi`, `AuthApi`, `DataApi`) so you only import what you need.
 
-## Usage Example
+## Installation
+
+```bash
+npm install g-ten-security-sdk
+```
+
+## Quick Start Example
 
 ```typescript
-import { FraudApi } from 'g-ten-security-sdk';
+import { FraudApi, ChatApi } from 'g-ten-security-sdk';
 
 const fraudClient = new FraudApi();
+const chatClient = new ChatApi();
+
+// 1. Fetch recent critical alerts
+const alerts = await fraudClient.getAlerts({ limit: 10 });
+
+// 2. Ask the AI Copilot to analyze a specific account's graph structure
+const analysis = await chatClient.sendChatMessage({
+  message: "Find all the accounts linked to smurfing that interacted with ACC_00025",
+  history: []
+});
 
-// Get recent high-risk alerts
-const alerts = await fraudClient.getAlerts();
-console.log(alerts);
+console.log(analysis.response);
 ```
 
 ## License

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "g-ten-security-sdk",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "G-TEN Fraud Intelligence SDK — A clean, developer-friendly TypeScript SDK for the G-TEN platform.",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",