ofx4js/lib/client/InvestmentAccount.d.ts

A javascript OFX library, ported from OFX4J

import { FinancialInstitutionAccount } from "./FinancialInstitutionAccount";
import { InvestmentStatementResponse } from "../domain/data/investment/statements/InvestmentStatementResponse";
import { SecurityRequest } from "../domain/data/seclist/SecurityRequest";
import { SecurityList } from "../domain/data/seclist/SecurityList";
import { InvestmentAccountDetails } from "../domain/data/investment/accounts/InvestmentAccountDetails";
export interface InvestmentAccount extends FinancialInstitutionAccount {
    /**
     * Read an account statement.
     *
     * @param start The start date of the statement.
     * @param end The end date of the statement.
     * @throws OFXException if there's an error talking to the brokerage
     * @return The account statement.
     */
    readStatement(start: Date, end: Date): Promise<InvestmentStatementResponse>;
    /**
     * Reads a list of securities from the brokerage
     *
     * @param securities the securities to read
     * @return The security response containing the security infos
     * @throws OFXException if there's an error talking to the brokerage
     */
    readSecurityList(securities: Array<SecurityRequest>): Promise<SecurityList>;
    /**
     * The details of the account.
     *
     * @return The details of the account.
     */
    getDetails(): InvestmentAccountDetails;
}