cas-parser-node 1.7.1 → 1.8.0

package/src/resources/inbound-email.ts

@@ -0,0 +1,332 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class InboundEmail extends APIResource {
+  /**
+   * Create a dedicated inbound email address for collecting CAS statements via email
+   * forwarding.
+   *
+   * **How it works:**
+   *
+   * 1. Create an inbound email with your webhook URL
+   * 2. Display the email address to your user (e.g., "Forward your CAS to
+   *    ie_xxx@import.casparser.in")
+   * 3. When an investor forwards a CAS email, we verify the sender and deliver to
+   *    your webhook
+   *
+   * **Webhook Delivery:**
+   *
+   * - We POST to your `callback_url` with JSON body containing files (matching
+   *   EmailCASFile schema)
+   * - Failed deliveries are retried automatically with exponential backoff
+   *
+   * **Inactivity:**
+   *
+   * - Inbound emails with no activity in 30 days are marked inactive
+   * - Active inbound emails remain operational indefinitely
+   *
+   * @example
+   * ```ts
+   * const inboundEmail = await client.inboundEmail.create({
+   *   callback_url:
+   *     'https://api.yourapp.com/webhooks/cas-email',
+   * });
+   * ```
+   */
+  create(body: InboundEmailCreateParams, options?: RequestOptions): APIPromise<InboundEmailCreateResponse> {
+    return this._client.post('/v4/inbound-email', { body, ...options });
+  }
+
+  /**
+   * Retrieve details of a specific mailbox including statistics.
+   *
+   * @example
+   * ```ts
+   * const inboundEmail = await client.inboundEmail.retrieve(
+   *   'ie_a1b2c3d4e5f6',
+   * );
+   * ```
+   */
+  retrieve(inboundEmailID: string, options?: RequestOptions): APIPromise<InboundEmailRetrieveResponse> {
+    return this._client.get(path`/v4/inbound-email/${inboundEmailID}`, options);
+  }
+
+  /**
+   * List all mailboxes associated with your API key. Returns active and inactive
+   * mailboxes (deleted mailboxes are excluded).
+   *
+   * @example
+   * ```ts
+   * const inboundEmails = await client.inboundEmail.list();
+   * ```
+   */
+  list(
+    query: InboundEmailListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<InboundEmailListResponse> {
+    return this._client.get('/v4/inbound-email', { query, ...options });
+  }
+
+  /**
+   * Permanently delete an inbound email address. It will stop accepting emails.
+   *
+   * **Note:** Deletion is immediate and cannot be undone. Any emails received after
+   * deletion will be rejected.
+   *
+   * @example
+   * ```ts
+   * const inboundEmail = await client.inboundEmail.delete(
+   *   'inbound_email_id',
+   * );
+   * ```
+   */
+  delete(inboundEmailID: string, options?: RequestOptions): APIPromise<InboundEmailDeleteResponse> {
+    return this._client.delete(path`/v4/inbound-email/${inboundEmailID}`, options);
+  }
+}
+
+/**
+ * An inbound email address for receiving forwarded CAS emails
+ */
+export interface InboundEmailCreateResponse {
+  /**
+   * Accepted CAS providers (empty = all)
+   */
+  allowed_sources?: Array<'cdsl' | 'nsdl' | 'cams' | 'kfintech'>;
+
+  /**
+   * Webhook URL for email notifications
+   */
+  callback_url?: string;
+
+  /**
+   * When the mailbox was created
+   */
+  created_at?: string;
+
+  /**
+   * The inbound email address to forward CAS statements to
+   */
+  email?: string;
+
+  /**
+   * Unique inbound email identifier
+   */
+  inbound_email_id?: string;
+
+  /**
+   * Custom key-value metadata
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * Your internal reference identifier
+   */
+  reference?: string | null;
+
+  /**
+   * Current mailbox status
+   */
+  status?: 'active' | 'paused';
+
+  /**
+   * When the mailbox was last updated
+   */
+  updated_at?: string;
+}
+
+/**
+ * An inbound email address for receiving forwarded CAS emails
+ */
+export interface InboundEmailRetrieveResponse {
+  /**
+   * Accepted CAS providers (empty = all)
+   */
+  allowed_sources?: Array<'cdsl' | 'nsdl' | 'cams' | 'kfintech'>;
+
+  /**
+   * Webhook URL for email notifications
+   */
+  callback_url?: string;
+
+  /**
+   * When the mailbox was created
+   */
+  created_at?: string;
+
+  /**
+   * The inbound email address to forward CAS statements to
+   */
+  email?: string;
+
+  /**
+   * Unique inbound email identifier
+   */
+  inbound_email_id?: string;
+
+  /**
+   * Custom key-value metadata
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * Your internal reference identifier
+   */
+  reference?: string | null;
+
+  /**
+   * Current mailbox status
+   */
+  status?: 'active' | 'paused';
+
+  /**
+   * When the mailbox was last updated
+   */
+  updated_at?: string;
+}
+
+export interface InboundEmailListResponse {
+  inbound_emails?: Array<InboundEmailListResponse.InboundEmail>;
+
+  limit?: number;
+
+  offset?: number;
+
+  status?: string;
+
+  /**
+   * Total number of inbound emails (for pagination)
+   */
+  total?: number;
+}
+
+export namespace InboundEmailListResponse {
+  /**
+   * An inbound email address for receiving forwarded CAS emails
+   */
+  export interface InboundEmail {
+    /**
+     * Accepted CAS providers (empty = all)
+     */
+    allowed_sources?: Array<'cdsl' | 'nsdl' | 'cams' | 'kfintech'>;
+
+    /**
+     * Webhook URL for email notifications
+     */
+    callback_url?: string;
+
+    /**
+     * When the mailbox was created
+     */
+    created_at?: string;
+
+    /**
+     * The inbound email address to forward CAS statements to
+     */
+    email?: string;
+
+    /**
+     * Unique inbound email identifier
+     */
+    inbound_email_id?: string;
+
+    /**
+     * Custom key-value metadata
+     */
+    metadata?: { [key: string]: string };
+
+    /**
+     * Your internal reference identifier
+     */
+    reference?: string | null;
+
+    /**
+     * Current mailbox status
+     */
+    status?: 'active' | 'paused';
+
+    /**
+     * When the mailbox was last updated
+     */
+    updated_at?: string;
+  }
+}
+
+export interface InboundEmailDeleteResponse {
+  msg?: string;
+
+  status?: string;
+}
+
+export interface InboundEmailCreateParams {
+  /**
+   * Webhook URL where we POST email notifications. Must be HTTPS in production (HTTP
+   * allowed for localhost during development).
+   */
+  callback_url: string;
+
+  /**
+   * Optional custom email prefix for user-friendly addresses.
+   *
+   * - Must be 3-32 characters
+   * - Alphanumeric + hyphens only
+   * - Must start and end with letter/number
+   * - Example: `john-portfolio@import.casparser.in`
+   * - If omitted, generates random ID like `ie_abc123xyz@import.casparser.in`
+   */
+  alias?: string;
+
+  /**
+   * Filter emails by CAS provider. If omitted, accepts all providers.
+   *
+   * - `cdsl` → eCAS@cdslstatement.com
+   * - `nsdl` → NSDL-CAS@nsdl.co.in
+   * - `cams` → donotreply@camsonline.com
+   * - `kfintech` → samfS@kfintech.com
+   */
+  allowed_sources?: Array<'cdsl' | 'nsdl' | 'cams' | 'kfintech'>;
+
+  /**
+   * Optional key-value pairs (max 10) to include in webhook payload. Useful for
+   * passing context like plan_type, campaign_id, etc.
+   */
+  metadata?: { [key: string]: string };
+
+  /**
+   * Your internal identifier (e.g., user_id, account_id). Returned in webhook
+   * payload for correlation.
+   */
+  reference?: string;
+}
+
+export interface InboundEmailListParams {
+  /**
+   * Maximum number of inbound emails to return
+   */
+  limit?: number;
+
+  /**
+   * Pagination offset
+   */
+  offset?: number;
+
+  /**
+   * Filter by status
+   */
+  status?: 'active' | 'paused' | 'all';
+}
+
+export declare namespace InboundEmail {
+  export {
+    type InboundEmailCreateResponse as InboundEmailCreateResponse,
+    type InboundEmailRetrieveResponse as InboundEmailRetrieveResponse,
+    type InboundEmailListResponse as InboundEmailListResponse,
+    type InboundEmailDeleteResponse as InboundEmailDeleteResponse,
+    type InboundEmailCreateParams as InboundEmailCreateParams,
+    type InboundEmailListParams as InboundEmailListParams,
+  };
+}

package/src/resources/inbox.ts

@@ -204,6 +204,12 @@ export namespace InboxListCasFilesResponse {
      */
     original_filename?: string;
 
+    /**
+     * Email address of the CAS authority (CDSL, NSDL, CAMS, or KFintech) who
+     * originally sent this statement
+     */
+    sender_email?: string;
+
     /**
      * File size in bytes
      */

package/src/resources/index.ts

@@ -11,6 +11,15 @@ export {
 export { Cdsl, type CdslParsePdfParams } from './cdsl/cdsl';
 export { ContractNote, type ContractNoteParseResponse, type ContractNoteParseParams } from './contract-note';
 export { Credits, type CreditCheckResponse } from './credits';
+export {
+  InboundEmail,
+  type InboundEmailCreateResponse,
+  type InboundEmailRetrieveResponse,
+  type InboundEmailListResponse,
+  type InboundEmailDeleteResponse,
+  type InboundEmailCreateParams,
+  type InboundEmailListParams,
+} from './inbound-email';
 export {
   Inbox,
   type InboxCheckConnectionStatusResponse,

package/src/resources/logs.ts

@@ -11,6 +11,8 @@ export class Logs extends APIResource {
    * Returns a list of API calls with timestamps, features used, status codes, and
    * credits consumed. Useful for monitoring usage patterns and debugging.
    *
+   * **Legacy path:** `/logs` (still supported)
+   *
    * @example
    * ```ts
    * const log = await client.logs.create();
@@ -20,7 +22,7 @@ export class Logs extends APIResource {
     body: LogCreateParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LogCreateResponse> {
-    return this._client.post('/logs', { body, ...options });
+    return this._client.post('/v1/usage', { body, ...options });
   }
 
   /**
@@ -29,6 +31,8 @@ export class Logs extends APIResource {
    * Useful for understanding which API features are being used most and tracking
    * usage trends.
    *
+   * **Legacy path:** `/logs/summary` (still supported)
+   *
    * @example
    * ```ts
    * const response = await client.logs.getSummary();
@@ -38,7 +42,7 @@ export class Logs extends APIResource {
     body: LogGetSummaryParams | null | undefined = {},
     options?: RequestOptions,
   ): APIPromise<LogGetSummaryResponse> {
-    return this._client.post('/logs/summary', { body, ...options });
+    return this._client.post('/v1/usage/summary', { body, ...options });
   }
 }
 

package/src/resources/verify-token.ts

@@ -10,7 +10,7 @@ export class VerifyToken extends APIResource {
    * issues.
    */
   verify(options?: RequestOptions): APIPromise<VerifyTokenVerifyResponse> {
-    return this._client.post('/v1/verify-token', options);
+    return this._client.post('/v1/token/verify', options);
   }
 }
 

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '1.7.1'; // x-release-please-version
+export const VERSION = '1.8.0'; // x-release-please-version

package/version.d.mts

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

package/version.d.ts

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

package/version.js

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

package/version.mjs

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