cas-parser-node 1.9.0 → 1.10.0

package/src/resources/credits.ts

@@ -4,6 +4,10 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for checking API quota and credits usage.
+ * These endpoints help you monitor your API usage and remaining quota.
+ */
 export class Credits extends APIResource {
   /**
    * Check your remaining API credits and usage for the current billing period.

package/src/resources/inbound-email.ts

@@ -5,6 +5,28 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { path } from '../internal/utils/path';
 
+/**
+ * Create dedicated inbound email addresses for investors to forward their CAS statements.
+ *
+ * **Use Case:** Your app wants to collect CAS statements from users without requiring OAuth or file upload.
+ *
+ * **How it works:**
+ * 1. Call `POST /v4/inbound-email` to create a unique inbound email address
+ * 2. Display this email to your user: "Forward your CAS statement to ie_xxx@import.casparser.in"
+ * 3. When user forwards a CAS email, we verify sender authenticity (SPF/DKIM) and call your webhook
+ * 4. Your webhook receives email metadata + attachment download URLs
+ *
+ * **Sender Validation:**
+ * - Only emails from verified CAS authorities are processed:
+ *   - CDSL: `eCAS@cdslstatement.com`
+ *   - NSDL: `NSDL-CAS@nsdl.co.in`
+ *   - CAMS: `donotreply@camsonline.com`
+ *   - KFintech: `samfS@kfintech.com`
+ * - Emails failing SPF/DKIM/DMARC are rejected
+ * - Forwarded emails must contain the original sender in headers
+ *
+ * **Billing:** 0.2 credits per successfully processed valid email
+ */
 export class InboundEmail extends APIResource {
   /**
    * Create a dedicated inbound email address for collecting CAS statements via email

package/src/resources/inbox.ts

@@ -5,6 +5,23 @@ import { APIPromise } from '../core/api-promise';
 import { buildHeaders } from '../internal/headers';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for importing CAS files directly from user email inboxes.
+ *
+ * **Supported Providers:** Gmail (more coming soon)
+ *
+ * **How it works:**
+ * 1. Call `POST /v4/inbox/connect` to get an OAuth URL
+ * 2. Redirect user to the OAuth URL for consent
+ * 3. User is redirected back to your `redirect_uri` with an encrypted `inbox_token`
+ * 4. Use the token to list/fetch CAS files from their inbox (`/v4/inbox/cas`)
+ * 5. Files are uploaded to temporary cloud storage (URLs expire in 24 hours)
+ *
+ * **Security:**
+ * - Read-only access (we cannot send emails)
+ * - Tokens are encrypted with server-side secret
+ * - User can revoke access anytime via `/v4/inbox/disconnect`
+ */
 export class Inbox extends APIResource {
   /**
    * Verify if an `inbox_token` is still valid and check connection status.

package/src/resources/kfintech.ts

@@ -4,6 +4,9 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for generating new CAS documents via email mailback (KFintech).
+ */
 export class Kfintech extends APIResource {
   /**
    * Generate CAS via KFintech mailback. The CAS PDF will be sent to the investor's

package/src/resources/logs.ts

@@ -4,6 +4,10 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for checking API quota and credits usage.
+ * These endpoints help you monitor your API usage and remaining quota.
+ */
 export class Logs extends APIResource {
   /**
    * Retrieve detailed API usage logs for your account.

package/src/resources/nsdl.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../internal/uploads';
 
+/**
+ * Endpoints for parsing CAS PDF files from different sources.
+ */
 export class Nsdl extends APIResource {
   /**
    * This endpoint specifically parses NSDL CAS (Consolidated Account Statement) PDF

package/src/resources/smart.ts

@@ -6,6 +6,9 @@ import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 import { maybeMultipartFormRequestOptions } from '../internal/uploads';
 
+/**
+ * Endpoints for parsing CAS PDF files from different sources.
+ */
 export class Smart extends APIResource {
   /**
    * This endpoint parses CAS (Consolidated Account Statement) PDF files from NSDL,

package/src/resources/verify-token.ts

@@ -4,6 +4,11 @@ import { APIResource } from '../core/resource';
 import { APIPromise } from '../core/api-promise';
 import { RequestOptions } from '../internal/request-options';
 
+/**
+ * Endpoints for managing access tokens for the Portfolio Connect SDK.
+ * Use these to generate short-lived `at_` prefixed tokens that can be safely passed to frontend applications.
+ * Access tokens can be used in place of API keys on all v4 endpoints.
+ */
 export class VerifyToken extends APIResource {
   /**
    * Verify an access token and check if it's still valid. Useful for debugging token

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.9.0'; // x-release-please-version
+export const VERSION = '1.10.0'; // x-release-please-version

package/version.d.mts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.9.0";
+export declare const VERSION = "1.10.0";
 //# sourceMappingURL=version.d.mts.map

package/version.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.mts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "1.9.0";
+export declare const VERSION = "1.10.0";
 //# sourceMappingURL=version.d.ts.map

package/version.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,UAAU,CAAC"}
+{"version":3,"file":"version.d.ts","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,OAAO,WAAW,CAAC"}

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '1.9.0'; // x-release-please-version
+exports.VERSION = '1.10.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.js.map

@@ -1 +1 @@
-{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.js","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":";;;AAAa,QAAA,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '1.9.0'; // x-release-please-version
+export const VERSION = '1.10.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map

package/version.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,OAAO,CAAC,CAAC,2BAA2B"}
+{"version":3,"file":"version.mjs","sourceRoot":"","sources":["src/version.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,OAAO,GAAG,QAAQ,CAAC,CAAC,2BAA2B"}