cas-parser-node 1.7.2 → 1.9.0

package/resources/access-token.js

@@ -10,6 +10,8 @@ class AccessToken extends resource_1.APIResource {
      * **Use this endpoint from your backend** to create tokens that can be safely
      * passed to frontend/SDK.
      *
+     * **Legacy path:** `/v1/access-token` (still supported)
+     *
      * Access tokens:
      *
      * - Are prefixed with `at_` for easy identification
@@ -23,7 +25,7 @@ class AccessToken extends resource_1.APIResource {
      * ```
      */
     create(body = {}, options) {
-        return this._client.post('/v1/access-token', { body, ...options });
+        return this._client.post('/v1/token', { body, ...options });
     }
 }
 exports.AccessToken = AccessToken;

package/resources/access-token.js.map

@@ -1 +1 @@
-{"version":3,"file":"access-token.js","sourceRoot":"","sources":["../src/resources/access-token.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF;AAzBD,kCAyBC"}
+{"version":3,"file":"access-token.js","sourceRoot":"","sources":["../src/resources/access-token.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,WAAY,SAAQ,sBAAW;IAC1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF;AA3BD,kCA2BC"}

package/resources/access-token.mjs

@@ -7,6 +7,8 @@ export class AccessToken extends APIResource {
      * **Use this endpoint from your backend** to create tokens that can be safely
      * passed to frontend/SDK.
      *
+     * **Legacy path:** `/v1/access-token` (still supported)
+     *
      * Access tokens:
      *
      * - Are prefixed with `at_` for easy identification
@@ -20,7 +22,7 @@ export class AccessToken extends APIResource {
      * ```
      */
     create(body = {}, options) {
-        return this._client.post('/v1/access-token', { body, ...options });
+        return this._client.post('/v1/token', { body, ...options });
     }
 }
 //# sourceMappingURL=access-token.mjs.map

package/resources/access-token.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"access-token.mjs","sourceRoot":"","sources":["../src/resources/access-token.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;OAiBG;IACH,MAAM,CACJ,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,kBAAkB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACrE,CAAC;CACF"}
+{"version":3,"file":"access-token.mjs","sourceRoot":"","sources":["../src/resources/access-token.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;;;;;;;;;OAmBG;IACH,MAAM,CACJ,OAAmD,EAAE,EACrD,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,WAAW,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC9D,CAAC;CACF"}

package/resources/credits.js

@@ -16,7 +16,7 @@ class Credits extends resource_1.APIResource {
      * Credits reset at the start of each billing period.
      */
     check(options) {
-        return this._client.post('/credits', options);
+        return this._client.post('/v1/credits', options);
     }
 }
 exports.Credits = Credits;

package/resources/credits.js.map

@@ -1 +1 @@
-{"version":3,"file":"credits.js","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;CACF;AAfD,0BAeC"}
+{"version":3,"file":"credits.js","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF;AAfD,0BAeC"}

package/resources/credits.mjs

@@ -13,7 +13,7 @@ export class Credits extends APIResource {
      * Credits reset at the start of each billing period.
      */
     check(options) {
-        return this._client.post('/credits', options);
+        return this._client.post('/v1/credits', options);
     }
 }
 //# sourceMappingURL=credits.mjs.map

package/resources/credits.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAChD,CAAC;CACF"}
+{"version":3,"file":"credits.mjs","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAwB;QAC5B,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,aAAa,EAAE,OAAO,CAAC,CAAC;IACnD,CAAC;CACF"}

package/resources/inbound-email.d.mts

@@ -0,0 +1,273 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+/**
+ * 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 declare namespace InboundEmailListResponse {
+    /**
+     * An inbound email address for receiving forwarded CAS emails
+     */
+    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, };
+}
+//# sourceMappingURL=inbound-email.d.mts.map

package/resources/inbound-email.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbound-email.d.mts","sourceRoot":"","sources":["../src/resources/inbound-email.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIxG;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIpG;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGjG;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IAE/D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IAE/D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAC;IAE9D,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;QAE/D;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}

package/resources/inbound-email.d.ts

@@ -0,0 +1,273 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+}
+/**
+ * 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 declare namespace InboundEmailListResponse {
+    /**
+     * An inbound email address for receiving forwarded CAS emails
+     */
+    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, };
+}
+//# sourceMappingURL=inbound-email.d.ts.map

package/resources/inbound-email.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbound-email.d.ts","sourceRoot":"","sources":["../src/resources/inbound-email.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAGzB,qBAAa,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OA8BG;IACH,MAAM,CAAC,IAAI,EAAE,wBAAwB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAIxG;;;;;;;;;OASG;IACH,QAAQ,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,4BAA4B,CAAC;IAIpG;;;;;;;;OAQG;IACH,IAAI,CACF,KAAK,GAAE,sBAAsB,GAAG,IAAI,GAAG,SAAc,EACrD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,cAAc,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;CAGjG;AAED;;GAEG;AACH,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IAE/D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED;;GAEG;AACH,MAAM,WAAW,4BAA4B;IAC3C;;OAEG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IAE/D;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;IAE7B;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,wBAAwB;IACvC,cAAc,CAAC,EAAE,KAAK,CAAC,wBAAwB,CAAC,YAAY,CAAC,CAAC;IAE9D,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,yBAAiB,wBAAwB,CAAC;IACxC;;OAEG;IACH,UAAiB,YAAY;QAC3B;;WAEG;QACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;QAE/D;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAE1B;;WAEG;QACH,QAAQ,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;SAAE,CAAC;QAErC;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE1B;;WAEG;QACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,CAAC;QAE7B;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;KACrB;CACF;AAED,MAAM,WAAW,0BAA0B;IACzC,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,wBAAwB;IACvC;;;OAGG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;;;;OAOG;IACH,eAAe,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IAE/D;;;OAGG;IACH,QAAQ,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAC;IAErC;;;OAGG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,QAAQ,GAAG,KAAK,CAAC;CACtC;AAED,MAAM,CAAC,OAAO,WAAW,YAAY,CAAC;IACpC,OAAO,EACL,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}