Class MintClient

Example

import MintClient, { EOTPType, OTPProviders } from '@ftim/mint-client';

const client = new MintClient({
  username: 'supersaver',
  password: 'supersecurepassword',
  otpProviders: {
    [EOTPType.CAPTCHA_TOKEN]: new OTPProviders.CaptchaOTPProvider(),
    [EOTPType.TOTP]: new OTPProviders.TOTPProvider('TOTPSECRET'),
    [EOTPType.SMS_OTP]: new OTPProviders.UserInputOTPProvider('Please enter your SMS OTP token:'),
    [EOTPType.EMAIL_OTP]: new OTPProviders.EmailOTPProvider({
      host: 'imap.gmail.com',
      port: 993,
      auth: {
        user: 'supersaver@gmail.com',
        pass: 'supersecurepassword',
      },
    }),
  },
});

Hierarchy

  • MintClient

Constructors

constructor

Properties

authClient dataApiClient mobileMintClient sessionStore

Methods

getBudgetSummary getCategories getNetworth getOverviewChart getTransactions getUserProfile

Constructors

constructor

Properties

Private authClient

authClient: AccessPlatformClient

Private dataApiClient

dataApiClient: DataApiClient

Private mobileMintClient

mobileMintClient: MobileMintClient

Private sessionStore

sessionStore: ISessionStore

Methods

getBudgetSummary

  • Parameters

    • options: {
          date: Date;
      }
      • date: Date

    Returns Promise<{
        consumer: {
            finance: {
                budgets: {
                    spendSummary: {
                        budgetedLeftOverCash: number;
                        leftOverCash: number;
                        month: string;
                        totalBudgetedIncome: number;
                        totalBudgetedSpending: number;
                        totalExpensesBudget: number;
                        totalIncome: number;
                        totalIncomeBudget: number;
                        totalSpending: number;
                        totalUnbudgetedIncome: number;
                        totalUnbudgetedSpending: number;
                    }[];
                    unbudgetedExpenses: {
                        amount: number;
                        category: {
                            id: string;
                            name: string;
                            parentId: string;
                            parentName: string;
                            type: string;
                        };
                        categoryId: string;
                        date: string;
                    }[];
                    userBudgets: {
                        amount: number;
                        budgetAdjustmentAmount: unknown;
                        budgetAmount: number;
                        budgetDate: string;
                        budgetInterval: string;
                        budgetType: string;
                        id: string;
                        performanceStatus: string;
                        reset: boolean;
                        rollover: boolean;
                        source: {
                            categoryName: string;
                            categoryType: string;
                            id: string;
                            parentId: string;
                            parentName: string;
                            type: string;
                        };
                        subsumed: boolean;
                    }[];
                };
            };
        };
    }>

getCategories

  • Parameters

    • options: undefined | {
          includeDeletedCategories?: boolean;
      }

    Returns Promise<TCategory[]>

getNetworth

getOverviewChart

  • Parameters

    • options: {
          date: Date;
          reportType: "SPENDING" | "NETWORTH";
          timeframe: "_7D" | "_30D" | "_1Y" | "ALL";
      }
      • date: Date
      • reportType: "SPENDING" | "NETWORTH"
      • timeframe: "_7D" | "_30D" | "_1Y" | "ALL"

    Returns Promise<{
        consumer: {
            finance: {
                mintOverviewChart: {
                    categoryId: unknown;
                    currency: string;
                    currentDate: string;
                    customDataPoints: {
                        date: string;
                        value: number;
                    }[];
                    dataPoints: {
                        date: string;
                        value: number;
                    }[];
                    delta: null | number;
                    forecastDataPoints: {
                        date: string;
                        value: number;
                    }[];
                    forecastedSpendingCategories: unknown[];
                    heroMainValue: number;
                    lookAlikeDataPoints: {
                        date: string;
                        value: number;
                    }[];
                    reportType: string;
                    subHeaderText: null | string;
                    subHeaderValue: null | number;
                    timeframe: string;
                    topCategories: unknown[];
                    topOverBudgetCategories: unknown[];
                };
            };
        };
    }>

getTransactions

  • Parameters

    • options: {
          accountIds: number[];
          fromDate: Date;
          limit: number;
          toDate: Date;
      }
      • accountIds: number[]
      • fromDate: Date
      • limit: number
      • toDate: Date

    Returns Promise<TTransaction[]>

getUserProfile

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc