cas-parser-node 1.4.1 → 1.7.1

package/resources/contract-note.js

@@ -0,0 +1,49 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ContractNote = void 0;
+const resource_1 = require("../core/resource.js");
+const uploads_1 = require("../internal/uploads.js");
+class ContractNote extends resource_1.APIResource {
+    /**
+     * This endpoint parses Contract Note PDF files from various brokers including
+     * Zerodha, Groww, Upstox, ICICI Securities, and others.
+     *
+     * **What is a Contract Note?** A contract note is a legal document that provides
+     * details of all trades executed by an investor. It includes:
+     *
+     * - Trade details with timestamps, quantities, and prices
+     * - Brokerage and charges breakdown
+     * - Settlement information
+     * - Regulatory compliance details
+     *
+     * **Supported Brokers:**
+     *
+     * - Zerodha Broking Limited
+     * - Groww Invest Tech Private Limited
+     * - Upstox (RKSV Securities)
+     * - ICICI Securities Limited
+     * - Auto-detection for unknown brokers
+     *
+     * **Key Features:**
+     *
+     * - **Auto-detection**: Automatically identifies broker type from PDF content
+     * - **Comprehensive parsing**: Extracts equity transactions, derivatives
+     *   transactions, detailed trades, and charges
+     * - **Flexible input**: Accepts both file upload and URL-based PDF input
+     * - **Password protection**: Supports password-protected PDFs
+     *
+     * The API returns structured data including contract note information, client
+     * details, transaction summaries, and detailed trade-by-trade breakdowns.
+     *
+     * @example
+     * ```ts
+     * const response = await client.contractNote.parse();
+     * ```
+     */
+    parse(body, options) {
+        return this._client.post('/v4/contract_note/parse', (0, uploads_1.maybeMultipartFormRequestOptions)({ body, ...options }, this._client));
+    }
+}
+exports.ContractNote = ContractNote;
+//# sourceMappingURL=contract-note.js.map

package/resources/contract-note.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-note.js","sourceRoot":"","sources":["../src/resources/contract-note.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAG/C,oDAAuE;AAEvE,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,IAA6B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,yBAAyB,EACzB,IAAA,0CAAgC,EAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACrE,CAAC;IACJ,CAAC;CACF;AA3CD,oCA2CC"}

package/resources/contract-note.mjs

@@ -0,0 +1,45 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+import { maybeMultipartFormRequestOptions } from "../internal/uploads.mjs";
+export class ContractNote extends APIResource {
+    /**
+     * This endpoint parses Contract Note PDF files from various brokers including
+     * Zerodha, Groww, Upstox, ICICI Securities, and others.
+     *
+     * **What is a Contract Note?** A contract note is a legal document that provides
+     * details of all trades executed by an investor. It includes:
+     *
+     * - Trade details with timestamps, quantities, and prices
+     * - Brokerage and charges breakdown
+     * - Settlement information
+     * - Regulatory compliance details
+     *
+     * **Supported Brokers:**
+     *
+     * - Zerodha Broking Limited
+     * - Groww Invest Tech Private Limited
+     * - Upstox (RKSV Securities)
+     * - ICICI Securities Limited
+     * - Auto-detection for unknown brokers
+     *
+     * **Key Features:**
+     *
+     * - **Auto-detection**: Automatically identifies broker type from PDF content
+     * - **Comprehensive parsing**: Extracts equity transactions, derivatives
+     *   transactions, detailed trades, and charges
+     * - **Flexible input**: Accepts both file upload and URL-based PDF input
+     * - **Password protection**: Supports password-protected PDFs
+     *
+     * The API returns structured data including contract note information, client
+     * details, transaction summaries, and detailed trade-by-trade breakdowns.
+     *
+     * @example
+     * ```ts
+     * const response = await client.contractNote.parse();
+     * ```
+     */
+    parse(body, options) {
+        return this._client.post('/v4/contract_note/parse', maybeMultipartFormRequestOptions({ body, ...options }, this._client));
+    }
+}
+//# sourceMappingURL=contract-note.mjs.map

package/resources/contract-note.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"contract-note.mjs","sourceRoot":"","sources":["../src/resources/contract-note.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAGf,EAAE,gCAAgC,EAAE;AAE3C,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;OAmCG;IACH,KAAK,CAAC,IAA6B,EAAE,OAAwB;QAC3D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CACtB,yBAAyB,EACzB,gCAAgC,CAAC,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,EAAE,IAAI,CAAC,OAAO,CAAC,CACrE,CAAC;IACJ,CAAC;CACF"}

package/resources/credits.d.mts

@@ -0,0 +1,47 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Credits extends APIResource {
+    /**
+     * Check your remaining API credits and usage for the current billing period.
+     *
+     * Returns:
+     *
+     * - Number of API calls used and remaining credits
+     * - Credit limit and reset date
+     * - List of enabled features for your plan
+     *
+     * Credits reset at the start of each billing period.
+     */
+    check(options?: RequestOptions): APIPromise<CreditCheckResponse>;
+}
+export interface CreditCheckResponse {
+    /**
+     * List of API features enabled for your plan
+     */
+    enabled_features?: Array<string>;
+    /**
+     * Whether the account has unlimited credits
+     */
+    is_unlimited?: boolean;
+    /**
+     * Total credit limit for billing period
+     */
+    limit?: number;
+    /**
+     * Remaining credits (null if unlimited)
+     */
+    remaining?: number | null;
+    /**
+     * When credits reset (ISO 8601)
+     */
+    resets_at?: string | null;
+    /**
+     * Number of credits used this billing period
+     */
+    used?: number;
+}
+export declare namespace Credits {
+    export { type CreditCheckResponse as CreditCheckResponse };
+}
+//# sourceMappingURL=credits.d.mts.map

package/resources/credits.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.mts","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}

package/resources/credits.d.ts

@@ -0,0 +1,47 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Credits extends APIResource {
+    /**
+     * Check your remaining API credits and usage for the current billing period.
+     *
+     * Returns:
+     *
+     * - Number of API calls used and remaining credits
+     * - Credit limit and reset date
+     * - List of enabled features for your plan
+     *
+     * Credits reset at the start of each billing period.
+     */
+    check(options?: RequestOptions): APIPromise<CreditCheckResponse>;
+}
+export interface CreditCheckResponse {
+    /**
+     * List of API features enabled for your plan
+     */
+    enabled_features?: Array<string>;
+    /**
+     * Whether the account has unlimited credits
+     */
+    is_unlimited?: boolean;
+    /**
+     * Total credit limit for billing period
+     */
+    limit?: number;
+    /**
+     * Remaining credits (null if unlimited)
+     */
+    remaining?: number | null;
+    /**
+     * When credits reset (ISO 8601)
+     */
+    resets_at?: string | null;
+    /**
+     * Number of credits used this billing period
+     */
+    used?: number;
+}
+export declare namespace Credits {
+    export { type CreditCheckResponse as CreditCheckResponse };
+}
+//# sourceMappingURL=credits.d.ts.map

package/resources/credits.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"credits.d.ts","sourceRoot":"","sources":["../src/resources/credits.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAEzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;;OAUG;IACH,KAAK,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;CAGjE;AAED,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEjC;;OAEG;IACH,YAAY,CAAC,EAAE,OAAO,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE1B;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EAAE,KAAK,mBAAmB,IAAI,mBAAmB,EAAE,CAAC;CAC5D"}

package/resources/credits.js

@@ -0,0 +1,23 @@
+"use strict";
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Credits = void 0;
+const resource_1 = require("../core/resource.js");
+class Credits extends resource_1.APIResource {
+    /**
+     * Check your remaining API credits and usage for the current billing period.
+     *
+     * Returns:
+     *
+     * - Number of API calls used and remaining credits
+     * - Credit limit and reset date
+     * - List of enabled features for your plan
+     *
+     * Credits reset at the start of each billing period.
+     */
+    check(options) {
+        return this._client.post('/credits', options);
+    }
+}
+exports.Credits = Credits;
+//# sourceMappingURL=credits.js.map

package/resources/credits.js.map

@@ -0,0 +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"}

package/resources/credits.mjs

@@ -0,0 +1,19 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+import { APIResource } from "../core/resource.mjs";
+export class Credits extends APIResource {
+    /**
+     * Check your remaining API credits and usage for the current billing period.
+     *
+     * Returns:
+     *
+     * - Number of API calls used and remaining credits
+     * - Credit limit and reset date
+     * - List of enabled features for your plan
+     *
+     * Credits reset at the start of each billing period.
+     */
+    check(options) {
+        return this._client.post('/credits', options);
+    }
+}
+//# sourceMappingURL=credits.mjs.map

package/resources/credits.mjs.map

@@ -0,0 +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"}

package/resources/inbox.d.mts

@@ -0,0 +1,206 @@
+import { APIResource } from "../core/resource.mjs";
+import { APIPromise } from "../core/api-promise.mjs";
+import { RequestOptions } from "../internal/request-options.mjs";
+export declare class Inbox extends APIResource {
+    /**
+     * Verify if an `inbox_token` is still valid and check connection status.
+     *
+     * Use this to check if the user needs to re-authenticate (e.g., if they revoked
+     * access in their email provider settings).
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.checkConnectionStatus({
+     *   'x-inbox-token': 'x-inbox-token',
+     * });
+     * ```
+     */
+    checkConnectionStatus(params: InboxCheckConnectionStatusParams, options?: RequestOptions): APIPromise<InboxCheckConnectionStatusResponse>;
+    /**
+     * Initiate OAuth flow to connect user's email inbox.
+     *
+     * Returns an `oauth_url` that you should redirect the user to. After
+     * authorization, they are redirected back to your `redirect_uri` with the
+     * following query parameters:
+     *
+     * **On success:**
+     *
+     * - `inbox_token` - Encrypted token to store client-side
+     * - `email` - Email address of the connected account
+     * - `state` - Your original state parameter (for CSRF verification)
+     *
+     * **On error:**
+     *
+     * - `error` - Error code (e.g., `access_denied`, `token_exchange_failed`)
+     * - `state` - Your original state parameter
+     *
+     * **Store the `inbox_token` client-side** and use it for all subsequent inbox API
+     * calls.
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.connectEmail({
+     *   redirect_uri: 'https://yourapp.com/oauth-callback',
+     * });
+     * ```
+     */
+    connectEmail(body: InboxConnectEmailParams, options?: RequestOptions): APIPromise<InboxConnectEmailResponse>;
+    /**
+     * Revoke email access and invalidate the token.
+     *
+     * This calls the provider's token revocation API (e.g., Google's revoke endpoint)
+     * to ensure the user's consent is properly removed.
+     *
+     * After calling this, the `inbox_token` becomes unusable.
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.disconnectEmail({
+     *   'x-inbox-token': 'x-inbox-token',
+     * });
+     * ```
+     */
+    disconnectEmail(params: InboxDisconnectEmailParams, options?: RequestOptions): APIPromise<InboxDisconnectEmailResponse>;
+    /**
+     * Search the user's email inbox for CAS files from known senders (CAMS, KFintech,
+     * CDSL, NSDL).
+     *
+     * Files are uploaded to temporary cloud storage. **URLs expire in 24 hours.**
+     *
+     * Optionally filter by CAS provider and date range.
+     *
+     * **Billing:** 0.2 credits per request (charged regardless of success or number of
+     * files found).
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.listCasFiles({
+     *   'x-inbox-token': 'x-inbox-token',
+     * });
+     * ```
+     */
+    listCasFiles(params: InboxListCasFilesParams, options?: RequestOptions): APIPromise<InboxListCasFilesResponse>;
+}
+export interface InboxCheckConnectionStatusResponse {
+    /**
+     * Whether the token is valid and usable
+     */
+    connected?: boolean;
+    /**
+     * Email address of the connected account
+     */
+    email?: string;
+    provider?: string;
+    status?: string;
+}
+export interface InboxConnectEmailResponse {
+    /**
+     * Seconds until the OAuth URL expires (typically 10 minutes)
+     */
+    expires_in?: number;
+    /**
+     * Redirect user to this URL to start OAuth flow
+     */
+    oauth_url?: string;
+    status?: string;
+}
+export interface InboxDisconnectEmailResponse {
+    msg?: string;
+    status?: string;
+}
+export interface InboxListCasFilesResponse {
+    /**
+     * Number of CAS files found
+     */
+    count?: number;
+    files?: Array<InboxListCasFilesResponse.File>;
+    status?: string;
+}
+export declare namespace InboxListCasFilesResponse {
+    /**
+     * A CAS file found in the user's email inbox
+     */
+    interface File {
+        /**
+         * Detected CAS provider based on sender email
+         */
+        cas_type?: 'cdsl' | 'nsdl' | 'cams' | 'kfintech';
+        /**
+         * URL expiration time in seconds (default 86400 = 24 hours)
+         */
+        expires_in?: number;
+        /**
+         * Standardized filename (provider_YYYYMMDD_uniqueid.pdf)
+         */
+        filename?: string;
+        /**
+         * Date the email was received
+         */
+        message_date?: string;
+        /**
+         * Unique identifier for the email message (use for subsequent API calls)
+         */
+        message_id?: string;
+        /**
+         * Original attachment filename from the email
+         */
+        original_filename?: string;
+        /**
+         * File size in bytes
+         */
+        size?: number;
+        /**
+         * Direct download URL (presigned, expires based on expires_in)
+         */
+        url?: string;
+    }
+}
+export interface InboxCheckConnectionStatusParams {
+    /**
+     * The encrypted inbox token
+     */
+    'x-inbox-token': string;
+}
+export interface InboxConnectEmailParams {
+    /**
+     * Your callback URL to receive the inbox_token (must be http or https)
+     */
+    redirect_uri: string;
+    /**
+     * State parameter for CSRF protection (returned in redirect)
+     */
+    state?: string;
+}
+export interface InboxDisconnectEmailParams {
+    /**
+     * The encrypted inbox token to revoke
+     */
+    'x-inbox-token': string;
+}
+export interface InboxListCasFilesParams {
+    /**
+     * Header param: The encrypted inbox token
+     */
+    'x-inbox-token': string;
+    /**
+     * Body param: Filter by CAS provider(s):
+     *
+     * - `cdsl` → eCAS@cdslstatement.com
+     * - `nsdl` → NSDL-CAS@nsdl.co.in
+     * - `cams` → donotreply@camsonline.com
+     * - `kfintech` → samfS@kfintech.com
+     */
+    cas_types?: Array<'cdsl' | 'nsdl' | 'cams' | 'kfintech'>;
+    /**
+     * Body param: End date in ISO format (YYYY-MM-DD). Defaults to today.
+     */
+    end_date?: string;
+    /**
+     * Body param: Start date in ISO format (YYYY-MM-DD). Defaults to 30 days ago.
+     */
+    start_date?: string;
+}
+export declare namespace Inbox {
+    export { type InboxCheckConnectionStatusResponse as InboxCheckConnectionStatusResponse, type InboxConnectEmailResponse as InboxConnectEmailResponse, type InboxDisconnectEmailResponse as InboxDisconnectEmailResponse, type InboxListCasFilesResponse as InboxListCasFilesResponse, type InboxCheckConnectionStatusParams as InboxCheckConnectionStatusParams, type InboxConnectEmailParams as InboxConnectEmailParams, type InboxDisconnectEmailParams as InboxDisconnectEmailParams, type InboxListCasFilesParams as InboxListCasFilesParams, };
+}
+//# sourceMappingURL=inbox.d.mts.map

package/resources/inbox.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"inbox.d.mts","sourceRoot":"","sources":["../src/resources/inbox.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAEzB,qBAAa,KAAM,SAAQ,WAAW;IACpC;;;;;;;;;;;;OAYG;IACH,qBAAqB,CACnB,MAAM,EAAE,gCAAgC,EACxC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kCAAkC,CAAC;IAQjD;;;;;;;;;;;;;;;;;;;;;;;;;;;OA2BG;IACH,YAAY,CACV,IAAI,EAAE,uBAAuB,EAC7B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;IAIxC;;;;;;;;;;;;;;OAcG;IACH,eAAe,CACb,MAAM,EAAE,0BAA0B,EAClC,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,4BAA4B,CAAC;IAQ3C;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,CACV,MAAM,EAAE,uBAAuB,EAC/B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,yBAAyB,CAAC;CAQzC;AAED,MAAM,WAAW,kCAAkC;IACjD;;OAEG;IACH,SAAS,CAAC,EAAE,OAAO,CAAC;IAEpB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,4BAA4B;IAC3C,GAAG,CAAC,EAAE,MAAM,CAAC;IAEb,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,yBAAyB;IACxC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf,KAAK,CAAC,EAAE,KAAK,CAAC,yBAAyB,CAAC,IAAI,CAAC,CAAC;IAE9C,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,yBAAiB,yBAAyB,CAAC;IACzC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC;QAEjD;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,YAAY,CAAC,EAAE,MAAM,CAAC;QAEtB;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,iBAAiB,CAAC,EAAE,MAAM,CAAC;QAE3B;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;CACF;AAED,MAAM,WAAW,gCAAgC;IAC/C;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,uBAAuB;IACtC;;OAEG;IACH,eAAe,EAAE,MAAM,CAAC;IAExB;;;;;;;OAOG;IACH,SAAS,CAAC,EAAE,KAAK,CAAC,MAAM,GAAG,MAAM,GAAG,MAAM,GAAG,UAAU,CAAC,CAAC;IAEzD;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,CAAC,OAAO,WAAW,KAAK,CAAC;IAC7B,OAAO,EACL,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,4BAA4B,IAAI,4BAA4B,EACjE,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,gCAAgC,IAAI,gCAAgC,EACzE,KAAK,uBAAuB,IAAI,uBAAuB,EACvD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,uBAAuB,IAAI,uBAAuB,GACxD,CAAC;CACH"}

package/resources/inbox.d.ts

@@ -0,0 +1,206 @@
+import { APIResource } from "../core/resource.js";
+import { APIPromise } from "../core/api-promise.js";
+import { RequestOptions } from "../internal/request-options.js";
+export declare class Inbox extends APIResource {
+    /**
+     * Verify if an `inbox_token` is still valid and check connection status.
+     *
+     * Use this to check if the user needs to re-authenticate (e.g., if they revoked
+     * access in their email provider settings).
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.checkConnectionStatus({
+     *   'x-inbox-token': 'x-inbox-token',
+     * });
+     * ```
+     */
+    checkConnectionStatus(params: InboxCheckConnectionStatusParams, options?: RequestOptions): APIPromise<InboxCheckConnectionStatusResponse>;
+    /**
+     * Initiate OAuth flow to connect user's email inbox.
+     *
+     * Returns an `oauth_url` that you should redirect the user to. After
+     * authorization, they are redirected back to your `redirect_uri` with the
+     * following query parameters:
+     *
+     * **On success:**
+     *
+     * - `inbox_token` - Encrypted token to store client-side
+     * - `email` - Email address of the connected account
+     * - `state` - Your original state parameter (for CSRF verification)
+     *
+     * **On error:**
+     *
+     * - `error` - Error code (e.g., `access_denied`, `token_exchange_failed`)
+     * - `state` - Your original state parameter
+     *
+     * **Store the `inbox_token` client-side** and use it for all subsequent inbox API
+     * calls.
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.connectEmail({
+     *   redirect_uri: 'https://yourapp.com/oauth-callback',
+     * });
+     * ```
+     */
+    connectEmail(body: InboxConnectEmailParams, options?: RequestOptions): APIPromise<InboxConnectEmailResponse>;
+    /**
+     * Revoke email access and invalidate the token.
+     *
+     * This calls the provider's token revocation API (e.g., Google's revoke endpoint)
+     * to ensure the user's consent is properly removed.
+     *
+     * After calling this, the `inbox_token` becomes unusable.
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.disconnectEmail({
+     *   'x-inbox-token': 'x-inbox-token',
+     * });
+     * ```
+     */
+    disconnectEmail(params: InboxDisconnectEmailParams, options?: RequestOptions): APIPromise<InboxDisconnectEmailResponse>;
+    /**
+     * Search the user's email inbox for CAS files from known senders (CAMS, KFintech,
+     * CDSL, NSDL).
+     *
+     * Files are uploaded to temporary cloud storage. **URLs expire in 24 hours.**
+     *
+     * Optionally filter by CAS provider and date range.
+     *
+     * **Billing:** 0.2 credits per request (charged regardless of success or number of
+     * files found).
+     *
+     * @example
+     * ```ts
+     * const response = await client.inbox.listCasFiles({
+     *   'x-inbox-token': 'x-inbox-token',
+     * });
+     * ```
+     */
+    listCasFiles(params: InboxListCasFilesParams, options?: RequestOptions): APIPromise<InboxListCasFilesResponse>;
+}
+export interface InboxCheckConnectionStatusResponse {
+    /**
+     * Whether the token is valid and usable
+     */
+    connected?: boolean;
+    /**
+     * Email address of the connected account
+     */
+    email?: string;
+    provider?: string;
+    status?: string;
+}
+export interface InboxConnectEmailResponse {
+    /**
+     * Seconds until the OAuth URL expires (typically 10 minutes)
+     */
+    expires_in?: number;
+    /**
+     * Redirect user to this URL to start OAuth flow
+     */
+    oauth_url?: string;
+    status?: string;
+}
+export interface InboxDisconnectEmailResponse {
+    msg?: string;
+    status?: string;
+}
+export interface InboxListCasFilesResponse {
+    /**
+     * Number of CAS files found
+     */
+    count?: number;
+    files?: Array<InboxListCasFilesResponse.File>;
+    status?: string;
+}
+export declare namespace InboxListCasFilesResponse {
+    /**
+     * A CAS file found in the user's email inbox
+     */
+    interface File {
+        /**
+         * Detected CAS provider based on sender email
+         */
+        cas_type?: 'cdsl' | 'nsdl' | 'cams' | 'kfintech';
+        /**
+         * URL expiration time in seconds (default 86400 = 24 hours)
+         */
+        expires_in?: number;
+        /**
+         * Standardized filename (provider_YYYYMMDD_uniqueid.pdf)
+         */
+        filename?: string;
+        /**
+         * Date the email was received
+         */
+        message_date?: string;
+        /**
+         * Unique identifier for the email message (use for subsequent API calls)
+         */
+        message_id?: string;
+        /**
+         * Original attachment filename from the email
+         */
+        original_filename?: string;
+        /**
+         * File size in bytes
+         */
+        size?: number;
+        /**
+         * Direct download URL (presigned, expires based on expires_in)
+         */
+        url?: string;
+    }
+}
+export interface InboxCheckConnectionStatusParams {
+    /**
+     * The encrypted inbox token
+     */
+    'x-inbox-token': string;
+}
+export interface InboxConnectEmailParams {
+    /**
+     * Your callback URL to receive the inbox_token (must be http or https)
+     */
+    redirect_uri: string;
+    /**
+     * State parameter for CSRF protection (returned in redirect)
+     */
+    state?: string;
+}
+export interface InboxDisconnectEmailParams {
+    /**
+     * The encrypted inbox token to revoke
+     */
+    'x-inbox-token': string;
+}
+export interface InboxListCasFilesParams {
+    /**
+     * Header param: The encrypted inbox token
+     */
+    'x-inbox-token': string;
+    /**
+     * Body param: Filter by CAS provider(s):
+     *
+     * - `cdsl` → eCAS@cdslstatement.com
+     * - `nsdl` → NSDL-CAS@nsdl.co.in
+     * - `cams` → donotreply@camsonline.com
+     * - `kfintech` → samfS@kfintech.com
+     */
+    cas_types?: Array<'cdsl' | 'nsdl' | 'cams' | 'kfintech'>;
+    /**
+     * Body param: End date in ISO format (YYYY-MM-DD). Defaults to today.
+     */
+    end_date?: string;
+    /**
+     * Body param: Start date in ISO format (YYYY-MM-DD). Defaults to 30 days ago.
+     */
+    start_date?: string;
+}
+export declare namespace Inbox {
+    export { type InboxCheckConnectionStatusResponse as InboxCheckConnectionStatusResponse, type InboxConnectEmailResponse as InboxConnectEmailResponse, type InboxDisconnectEmailResponse as InboxDisconnectEmailResponse, type InboxListCasFilesResponse as InboxListCasFilesResponse, type InboxCheckConnectionStatusParams as InboxCheckConnectionStatusParams, type InboxConnectEmailParams as InboxConnectEmailParams, type InboxDisconnectEmailParams as InboxDisconnectEmailParams, type InboxListCasFilesParams as InboxListCasFilesParams, };
+}
+//# sourceMappingURL=inbox.d.ts.map