cas-parser-node 1.4.0 → 1.6.2

package/src/resources/cdsl/cdsl.ts

@@ -0,0 +1,67 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../../core/resource';
+import * as CamsKfintechAPI from '../cams-kfintech';
+import * as FetchAPI from './fetch';
+import {
+  Fetch,
+  FetchRequestOtpParams,
+  FetchRequestOtpResponse,
+  FetchVerifyOtpParams,
+  FetchVerifyOtpResponse,
+} from './fetch';
+import { APIPromise } from '../../core/api-promise';
+import { RequestOptions } from '../../internal/request-options';
+import { maybeMultipartFormRequestOptions } from '../../internal/uploads';
+
+export class Cdsl extends APIResource {
+  fetch: FetchAPI.Fetch = new FetchAPI.Fetch(this._client);
+
+  /**
+   * This endpoint specifically parses CDSL CAS (Consolidated Account Statement) PDF
+   * files and returns data in a unified format. Use this endpoint when you know the
+   * PDF is from CDSL.
+   *
+   * @example
+   * ```ts
+   * const unifiedResponse = await client.cdsl.parsePdf();
+   * ```
+   */
+  parsePdf(body: CdslParsePdfParams, options?: RequestOptions): APIPromise<CamsKfintechAPI.UnifiedResponse> {
+    return this._client.post(
+      '/v4/cdsl/parse',
+      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+export interface CdslParsePdfParams {
+  /**
+   * Password for the PDF file (if required)
+   */
+  password?: string;
+
+  /**
+   * Base64 encoded CAS PDF file (required if pdf_url not provided)
+   */
+  pdf_file?: string;
+
+  /**
+   * URL to the CAS PDF file (required if pdf_file not provided)
+   */
+  pdf_url?: string;
+}
+
+Cdsl.Fetch = Fetch;
+
+export declare namespace Cdsl {
+  export { type CdslParsePdfParams as CdslParsePdfParams };
+
+  export {
+    Fetch as Fetch,
+    type FetchRequestOtpResponse as FetchRequestOtpResponse,
+    type FetchVerifyOtpResponse as FetchVerifyOtpResponse,
+    type FetchRequestOtpParams as FetchRequestOtpParams,
+    type FetchVerifyOtpParams as FetchVerifyOtpParams,
+  };
+}

package/src/resources/cdsl/fetch.ts

@@ -0,0 +1,122 @@
+// 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 Fetch extends APIResource {
+  /**
+   * **Step 1 of 2**: Request OTP for CDSL CAS fetch.
+   *
+   * This endpoint:
+   *
+   * 1. Solves reCAPTCHA automatically (~15-20 seconds)
+   * 2. Submits login credentials to CDSL portal
+   * 3. Triggers OTP to user's registered mobile number
+   *
+   * After user receives OTP, call `/v4/cdsl/fetch/{session_id}/verify` to complete.
+   *
+   * @example
+   * ```ts
+   * const response = await client.cdsl.fetch.requestOtp({
+   *   bo_id: '1234567890123456',
+   *   dob: '1990-01-15',
+   *   pan: 'ABCDE1234F',
+   * });
+   * ```
+   */
+  requestOtp(body: FetchRequestOtpParams, options?: RequestOptions): APIPromise<FetchRequestOtpResponse> {
+    return this._client.post('/v4/cdsl/fetch', { body, ...options });
+  }
+
+  /**
+   * **Step 2 of 2**: Verify OTP and retrieve CDSL CAS files.
+   *
+   * After successful verification, CAS PDFs are fetched from CDSL portal, uploaded
+   * to cloud storage, and returned as direct download URLs.
+   *
+   * @example
+   * ```ts
+   * const response = await client.cdsl.fetch.verifyOtp(
+   *   'session_id',
+   *   { otp: '123456' },
+   * );
+   * ```
+   */
+  verifyOtp(
+    sessionID: string,
+    body: FetchVerifyOtpParams,
+    options?: RequestOptions,
+  ): APIPromise<FetchVerifyOtpResponse> {
+    return this._client.post(path`/v4/cdsl/fetch/${sessionID}/verify`, { body, ...options });
+  }
+}
+
+export interface FetchRequestOtpResponse {
+  msg?: string;
+
+  /**
+   * Session ID for verify step
+   */
+  session_id?: string;
+
+  status?: string;
+}
+
+export interface FetchVerifyOtpResponse {
+  files?: Array<FetchVerifyOtpResponse.File>;
+
+  msg?: string;
+
+  status?: string;
+}
+
+export namespace FetchVerifyOtpResponse {
+  export interface File {
+    filename?: string;
+
+    /**
+     * Direct download URL (cloud storage)
+     */
+    url?: string;
+  }
+}
+
+export interface FetchRequestOtpParams {
+  /**
+   * CDSL BO ID (16 digits)
+   */
+  bo_id: string;
+
+  /**
+   * Date of birth (YYYY-MM-DD)
+   */
+  dob: string;
+
+  /**
+   * PAN number
+   */
+  pan: string;
+}
+
+export interface FetchVerifyOtpParams {
+  /**
+   * OTP received on mobile
+   */
+  otp: string;
+
+  /**
+   * Number of monthly statements to fetch (default 6)
+   */
+  num_periods?: number;
+}
+
+export declare namespace Fetch {
+  export {
+    type FetchRequestOtpResponse as FetchRequestOtpResponse,
+    type FetchVerifyOtpResponse as FetchVerifyOtpResponse,
+    type FetchRequestOtpParams as FetchRequestOtpParams,
+    type FetchVerifyOtpParams as FetchVerifyOtpParams,
+  };
+}

package/src/resources/cdsl/index.ts

@@ -0,0 +1,10 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export { Cdsl, type CdslParsePdfParams } from './cdsl';
+export {
+  Fetch,
+  type FetchRequestOtpResponse,
+  type FetchVerifyOtpResponse,
+  type FetchRequestOtpParams,
+  type FetchVerifyOtpParams,
+} from './fetch';

package/src/resources/cdsl.ts

@@ -0,0 +1,3 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+export * from './cdsl/index';

package/src/resources/contract-note.ts

@@ -0,0 +1,402 @@
+// 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 { maybeMultipartFormRequestOptions } from '../internal/uploads';
+
+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: ContractNoteParseParams, options?: RequestOptions): APIPromise<ContractNoteParseResponse> {
+    return this._client.post(
+      '/v4/contract_note/parse',
+      maybeMultipartFormRequestOptions({ body, ...options }, this._client),
+    );
+  }
+}
+
+export interface ContractNoteParseResponse {
+  data?: ContractNoteParseResponse.Data;
+
+  msg?: string;
+
+  status?: string;
+}
+
+export namespace ContractNoteParseResponse {
+  export interface Data {
+    broker_info?: Data.BrokerInfo;
+
+    /**
+     * Breakdown of various charges and fees
+     */
+    charges_summary?: Data.ChargesSummary;
+
+    client_info?: Data.ClientInfo;
+
+    contract_note_info?: Data.ContractNoteInfo;
+
+    /**
+     * Summary of derivatives transactions
+     */
+    derivatives_transactions?: Array<Data.DerivativesTransaction>;
+
+    /**
+     * Detailed breakdown of all individual trades
+     */
+    detailed_trades?: Array<Data.DetailedTrade>;
+
+    /**
+     * Summary of equity transactions grouped by security
+     */
+    equity_transactions?: Array<Data.EquityTransaction>;
+  }
+
+  export namespace Data {
+    export interface BrokerInfo {
+      /**
+       * Auto-detected or specified broker type
+       */
+      broker_type?: 'zerodha' | 'groww' | 'upstox' | 'icici' | 'unknown';
+
+      /**
+       * Broker company name
+       */
+      name?: string;
+
+      /**
+       * SEBI registration number of the broker
+       */
+      sebi_registration?: string;
+    }
+
+    /**
+     * Breakdown of various charges and fees
+     */
+    export interface ChargesSummary {
+      /**
+       * Central GST amount
+       */
+      cgst?: number;
+
+      /**
+       * Exchange transaction charges
+       */
+      exchange_transaction_charges?: number;
+
+      /**
+       * Integrated GST amount
+       */
+      igst?: number;
+
+      /**
+       * Final net amount receivable or payable
+       */
+      net_amount_receivable_payable?: number;
+
+      /**
+       * Net pay-in/pay-out obligation
+       */
+      pay_in_pay_out_obligation?: number;
+
+      /**
+       * SEBI turnover fees
+       */
+      sebi_turnover_fees?: number;
+
+      /**
+       * Securities Transaction Tax
+       */
+      securities_transaction_tax?: number;
+
+      /**
+       * State GST amount
+       */
+      sgst?: number;
+
+      /**
+       * Stamp duty charges
+       */
+      stamp_duty?: number;
+
+      /**
+       * Taxable brokerage amount
+       */
+      taxable_value_brokerage?: number;
+    }
+
+    export interface ClientInfo {
+      /**
+       * Client address
+       */
+      address?: string;
+
+      /**
+       * GST state code
+       */
+      gst_state_code?: string;
+
+      /**
+       * Client name
+       */
+      name?: string;
+
+      /**
+       * Client PAN number
+       */
+      pan?: string;
+
+      /**
+       * GST place of supply
+       */
+      place_of_supply?: string;
+
+      /**
+       * Unique Client Code
+       */
+      ucc?: string;
+    }
+
+    export interface ContractNoteInfo {
+      /**
+       * Contract note reference number
+       */
+      contract_note_number?: string;
+
+      /**
+       * Settlement date for the trades
+       */
+      settlement_date?: string;
+
+      /**
+       * Settlement reference number
+       */
+      settlement_number?: string;
+
+      /**
+       * Date when trades were executed
+       */
+      trade_date?: string;
+    }
+
+    export interface DerivativesTransaction {
+      /**
+       * Brokerage charged per unit
+       */
+      brokerage_per_unit?: number;
+
+      /**
+       * Transaction type (Buy/Sell/Bring Forward/Carry Forward)
+       */
+      buy_sell_bf_cf?: string;
+
+      /**
+       * Closing rate per unit
+       */
+      closing_rate_per_unit?: number;
+
+      /**
+       * Derivatives contract description
+       */
+      contract_description?: string;
+
+      /**
+       * Net total amount
+       */
+      net_total?: number;
+
+      /**
+       * Quantity traded
+       */
+      quantity?: number;
+
+      /**
+       * Weighted Average Price per unit
+       */
+      wap_per_unit?: number;
+    }
+
+    export interface DetailedTrade {
+      /**
+       * Brokerage charged for this trade
+       */
+      brokerage?: number;
+
+      /**
+       * Transaction type (B for Buy, S for Sell)
+       */
+      buy_sell?: string;
+
+      /**
+       * Closing rate per unit
+       */
+      closing_rate_per_unit?: number;
+
+      /**
+       * Exchange name
+       */
+      exchange?: string;
+
+      /**
+       * Net rate per unit
+       */
+      net_rate_per_unit?: number;
+
+      /**
+       * Net total for this trade
+       */
+      net_total?: number;
+
+      /**
+       * Order reference number
+       */
+      order_number?: string;
+
+      /**
+       * Time when order was placed
+       */
+      order_time?: string;
+
+      /**
+       * Quantity traded
+       */
+      quantity?: number;
+
+      /**
+       * Additional remarks or notes
+       */
+      remarks?: string;
+
+      /**
+       * Security name with exchange and ISIN
+       */
+      security_description?: string;
+
+      /**
+       * Trade reference number
+       */
+      trade_number?: string;
+
+      /**
+       * Time when trade was executed
+       */
+      trade_time?: string;
+    }
+
+    export interface EquityTransaction {
+      /**
+       * Total quantity purchased
+       */
+      buy_quantity?: number;
+
+      /**
+       * Total value of buy transactions
+       */
+      buy_total_value?: number;
+
+      /**
+       * Weighted Average Price for buy transactions
+       */
+      buy_wap?: number;
+
+      /**
+       * ISIN code of the security
+       */
+      isin?: string;
+
+      /**
+       * Net amount payable/receivable for this security
+       */
+      net_obligation?: number;
+
+      /**
+       * Name of the security
+       */
+      security_name?: string;
+
+      /**
+       * Trading symbol
+       */
+      security_symbol?: string;
+
+      /**
+       * Total quantity sold
+       */
+      sell_quantity?: number;
+
+      /**
+       * Total value of sell transactions
+       */
+      sell_total_value?: number;
+
+      /**
+       * Weighted Average Price for sell transactions
+       */
+      sell_wap?: number;
+    }
+  }
+}
+
+export interface ContractNoteParseParams {
+  /**
+   * Optional broker type override. If not provided, system will auto-detect.
+   */
+  broker_type?: 'zerodha' | 'groww' | 'upstox' | 'icici';
+
+  /**
+   * Password for the PDF file (usually PAN number for Zerodha)
+   */
+  password?: string;
+
+  /**
+   * Base64 encoded contract note PDF file
+   */
+  pdf_file?: string;
+
+  /**
+   * URL to the contract note PDF file
+   */
+  pdf_url?: string;
+}
+
+export declare namespace ContractNote {
+  export {
+    type ContractNoteParseResponse as ContractNoteParseResponse,
+    type ContractNoteParseParams as ContractNoteParseParams,
+  };
+}

package/src/resources/credits.ts

@@ -0,0 +1,58 @@
+// 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';
+
+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?: RequestOptions): APIPromise<CreditCheckResponse> {
+    return this._client.post('/credits', options);
+  }
+}
+
+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 };
+}