/** * User Service API * Solomon AI User Service API - Manages user profiles and authentication * * The version of the OpenAPI document: 1.0 * Contact: yoanyomba@solomon-ai.co * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /// import http from 'http'; import { AddDefaultPocketsToBankAccountRequest } from '../model/addDefaultPocketsToBankAccountRequest'; import { AddDefaultPocketsToBankAccountResponse } from '../model/addDefaultPocketsToBankAccountResponse'; import { AddNoteToFinancialUserProfileRequest } from '../model/addNoteToFinancialUserProfileRequest'; import { AddNoteToFinancialUserProfileResponse } from '../model/addNoteToFinancialUserProfileResponse'; import { AddNoteToRecurringTransactionRequest } from '../model/addNoteToRecurringTransactionRequest'; import { AddNoteToRecurringTransactionResponse } from '../model/addNoteToRecurringTransactionResponse'; import { AddNoteToSmartGoalRequest } from '../model/addNoteToSmartGoalRequest'; import { AddNoteToSmartGoalResponse } from '../model/addNoteToSmartGoalResponse'; import { AddNoteToTransactionRequest } from '../model/addNoteToTransactionRequest'; import { AddNoteToTransactionResponse } from '../model/addNoteToTransactionResponse'; import { AddTransactionsToManuallyLinkedAccountRequest } from '../model/addTransactionsToManuallyLinkedAccountRequest'; import { AddTransactionsToManuallyLinkedAccountResponse } from '../model/addTransactionsToManuallyLinkedAccountResponse'; import { BulkUpdateRecurringTransactionRequest } from '../model/bulkUpdateRecurringTransactionRequest'; import { BulkUpdateRecurringTransactionResponse } from '../model/bulkUpdateRecurringTransactionResponse'; import { BulkUpdateTransactionRequest } from '../model/bulkUpdateTransactionRequest'; import { BulkUpdateTransactionResponse } from '../model/bulkUpdateTransactionResponse'; import { CheckIfQuotaExceededResponse } from '../model/checkIfQuotaExceededResponse'; import { CreateBankAccountRequest } from '../model/createBankAccountRequest'; import { CreateBankAccountResponse } from '../model/createBankAccountResponse'; import { CreateBudgetRequest } from '../model/createBudgetRequest'; import { CreateBudgetResponse } from '../model/createBudgetResponse'; import { CreateCreditAccountRequest } from '../model/createCreditAccountRequest'; import { CreateCreditAccountResponse } from '../model/createCreditAccountResponse'; import { CreateManualLinkRequest } from '../model/createManualLinkRequest'; import { CreateManualLinkResponse } from '../model/createManualLinkResponse'; import { CreateMilestoneRequest } from '../model/createMilestoneRequest'; import { CreateMilestoneResponse } from '../model/createMilestoneResponse'; import { CreateSmartGoalRequest } from '../model/createSmartGoalRequest'; import { CreateSmartGoalResponse } from '../model/createSmartGoalResponse'; import { CreateSubscriptionRequest } from '../model/createSubscriptionRequest'; import { CreateSubscriptionResponse } from '../model/createSubscriptionResponse'; import { CreateUserProfileRequest1 } from '../model/createUserProfileRequest1'; import { CreateUserProfileResponse1 } from '../model/createUserProfileResponse1'; import { DeleteBankAccountResponse } from '../model/deleteBankAccountResponse'; import { DeleteBudgetResponse } from '../model/deleteBudgetResponse'; import { DeleteLinkResponse } from '../model/deleteLinkResponse'; import { DeleteMilestoneResponse } from '../model/deleteMilestoneResponse'; import { DeleteNoteFromRecurringTransactionResponse } from '../model/deleteNoteFromRecurringTransactionResponse'; import { DeleteNoteFromSmartGoalResponse } from '../model/deleteNoteFromSmartGoalResponse'; import { DeleteNoteFromTransactionResponse } from '../model/deleteNoteFromTransactionResponse'; import { DeletePocketResponse } from '../model/deletePocketResponse'; import { DeleteRecurringTransactionResponse } from '../model/deleteRecurringTransactionResponse'; import { DeleteSmartGoalResponse } from '../model/deleteSmartGoalResponse'; import { DeleteTransactionResponse } from '../model/deleteTransactionResponse'; import { DeleteUserProfileResponse1 } from '../model/deleteUserProfileResponse1'; import { GetAccountBalanceHistoryResponse } from '../model/getAccountBalanceHistoryResponse'; import { GetAllBudgetsResponse } from '../model/getAllBudgetsResponse'; import { GetBankAccountResponse } from '../model/getBankAccountResponse'; import { GetBudgetResponse } from '../model/getBudgetResponse'; import { GetCategoryMetricsFinancialSubProfileOverTimeResponse } from '../model/getCategoryMetricsFinancialSubProfileOverTimeResponse'; import { GetCategoryMonthlyTransactionCountResponse } from '../model/getCategoryMonthlyTransactionCountResponse'; import { GetDebtToIncomeRatioResponse } from '../model/getDebtToIncomeRatioResponse'; import { GetExpenseMetricsFinancialSubProfileOverTimeResponse } from '../model/getExpenseMetricsFinancialSubProfileOverTimeResponse'; import { GetExpenseMetricsResponse } from '../model/getExpenseMetricsResponse'; import { GetFinancialProfileResponse } from '../model/getFinancialProfileResponse'; import { GetForecastResponse } from '../model/getForecastResponse'; import { GetHistoricalAccountBalanceResponse } from '../model/getHistoricalAccountBalanceResponse'; import { GetIncomeExpenseRatioResponse } from '../model/getIncomeExpenseRatioResponse'; import { GetIncomeMetricsFinancialSubProfileOverTimeResponse } from '../model/getIncomeMetricsFinancialSubProfileOverTimeResponse'; import { GetIncomeMetricsResponse } from '../model/getIncomeMetricsResponse'; import { GetInvestmentAcccountResponse } from '../model/getInvestmentAcccountResponse'; import { GetLiabilityAccountResponse } from '../model/getLiabilityAccountResponse'; import { GetLinkResponse } from '../model/getLinkResponse'; import { GetLinksResponse } from '../model/getLinksResponse'; import { GetLocationMetricsFinancialSubProfileOverTimeResponse } from '../model/getLocationMetricsFinancialSubProfileOverTimeResponse'; import { GetMelodyFinancialContextResponse } from '../model/getMelodyFinancialContextResponse'; import { GetMerchantMetricsFinancialSubProfileOverTimeResponse } from '../model/getMerchantMetricsFinancialSubProfileOverTimeResponse'; import { GetMerchantMonthlyExpenditureResponse } from '../model/getMerchantMonthlyExpenditureResponse'; import { GetMilestoneResponse } from '../model/getMilestoneResponse'; import { GetMilestonesBySmartGoalIdResponse } from '../model/getMilestonesBySmartGoalIdResponse'; import { GetMonthlyBalanceResponse } from '../model/getMonthlyBalanceResponse'; import { GetMonthlyExpenditureResponse } from '../model/getMonthlyExpenditureResponse'; import { GetMonthlyIncomeResponse } from '../model/getMonthlyIncomeResponse'; import { GetMonthlySavingsResponse } from '../model/getMonthlySavingsResponse'; import { GetMonthlyTotalQuantityBySecurityAndUserResponse } from '../model/getMonthlyTotalQuantityBySecurityAndUserResponse'; import { GetMonthlyTransactionCountResponse } from '../model/getMonthlyTransactionCountResponse'; import { GetMortgageAccountResponse } from '../model/getMortgageAccountResponse'; import { GetNoteFromSmartGoalResponse } from '../model/getNoteFromSmartGoalResponse'; import { GetNoteFromTransactionResponse } from '../model/getNoteFromTransactionResponse'; import { GetNotesFromFinancialUserProfileResponse } from '../model/getNotesFromFinancialUserProfileResponse'; import { GetNotesFromSmartGoalResponse } from '../model/getNotesFromSmartGoalResponse'; import { GetPaymentChannelFinancialSubProfileOverTimeResponse } from '../model/getPaymentChannelFinancialSubProfileOverTimeResponse'; import { GetPaymentChannelMonthlyExpenditureResponse } from '../model/getPaymentChannelMonthlyExpenditureResponse'; import { GetPocketResponse } from '../model/getPocketResponse'; import { GetRecurringTransactionsForUserResponse } from '../model/getRecurringTransactionsForUserResponse'; import { GetSingleRecurringTransactionResponse } from '../model/getSingleRecurringTransactionResponse'; import { GetSmartGoalsByPocketIdResponse } from '../model/getSmartGoalsByPocketIdResponse'; import { GetSplitTransactionResponse } from '../model/getSplitTransactionResponse'; import { GetStudentLoanAccountResponse } from '../model/getStudentLoanAccountResponse'; import { GetTotalInvestmentBySecurityResponse } from '../model/getTotalInvestmentBySecurityResponse'; import { GetTransactionAggregatesResponse } from '../model/getTransactionAggregatesResponse'; import { GetTransactionResponse } from '../model/getTransactionResponse'; import { GetTransactionsBetweenTimeRangesResponse } from '../model/getTransactionsBetweenTimeRangesResponse'; import { GetTransactionsForBankAccountResponse } from '../model/getTransactionsForBankAccountResponse'; import { GetTransactionsForPastMonthResponse } from '../model/getTransactionsForPastMonthResponse'; import { GetTransactionsForPastWeekResponse } from '../model/getTransactionsForPastWeekResponse'; import { GetTransactionsResponse } from '../model/getTransactionsResponse'; import { GetUserAccountBalanceHistoryResponse } from '../model/getUserAccountBalanceHistoryResponse'; import { GetUserCategoryMonthlyExpenditureResponse } from '../model/getUserCategoryMonthlyExpenditureResponse'; import { GetUserCategoryMonthlyIncomeResponse } from '../model/getUserCategoryMonthlyIncomeResponse'; import { GetUserProfileResponse1 } from '../model/getUserProfileResponse1'; import { HealthCheckResponse } from '../model/healthCheckResponse'; import { ListRecurringTransactionNotesResponse } from '../model/listRecurringTransactionNotesResponse'; import { ListRecurringTransactionsForUserAndAccountResponse } from '../model/listRecurringTransactionsForUserAndAccountResponse'; import { ListTransactionNotesResponse } from '../model/listTransactionNotesResponse'; import { ListTransactionsAcrossAllAccountsResponse } from '../model/listTransactionsAcrossAllAccountsResponse'; import { ListTransactionsResponse } from '../model/listTransactionsResponse'; import { PlaidExchangeTokenRequest } from '../model/plaidExchangeTokenRequest'; import { PlaidExchangeTokenResponse } from '../model/plaidExchangeTokenResponse'; import { PlaidInitiateTokenExchangeRequest } from '../model/plaidInitiateTokenExchangeRequest'; import { PlaidInitiateTokenExchangeResponse } from '../model/plaidInitiateTokenExchangeResponse'; import { PlaidInitiateTokenUpdateRequest } from '../model/plaidInitiateTokenUpdateRequest'; import { PlaidInitiateTokenUpdateResponse } from '../model/plaidInitiateTokenUpdateResponse'; import { PlaidSyncAccountFromAccessTokenRequest } from '../model/plaidSyncAccountFromAccessTokenRequest'; import { PlaidSyncAccountFromAccessTokenResponse } from '../model/plaidSyncAccountFromAccessTokenResponse'; import { PollAsyncTaskExecutionStatusResponse } from '../model/pollAsyncTaskExecutionStatusResponse'; import { ReadynessCheckResponse2 } from '../model/readynessCheckResponse2'; import { RecordAskCopilotQuestionRequest } from '../model/recordAskCopilotQuestionRequest'; import { RecordAskCopilotQuestionResponse } from '../model/recordAskCopilotQuestionResponse'; import { SearchTransactionsRequest } from '../model/searchTransactionsRequest'; import { SearchTransactionsResponse } from '../model/searchTransactionsResponse'; import { SplitTransactionRequest } from '../model/splitTransactionRequest'; import { SplitTransactionResponse } from '../model/splitTransactionResponse'; import { TriggerSyncRequest } from '../model/triggerSyncRequest'; import { TriggerSyncResponse } from '../model/triggerSyncResponse'; import { UnSplitTransactionsRequest } from '../model/unSplitTransactionsRequest'; import { UnSplitTransactionsResponse } from '../model/unSplitTransactionsResponse'; import { UpdateBankAccountRequest } from '../model/updateBankAccountRequest'; import { UpdateBankAccountResponse } from '../model/updateBankAccountResponse'; import { UpdateBudgetRequest } from '../model/updateBudgetRequest'; import { UpdateBudgetResponse } from '../model/updateBudgetResponse'; import { UpdateMilestoneRequest } from '../model/updateMilestoneRequest'; import { UpdateMilestoneResponse } from '../model/updateMilestoneResponse'; import { UpdateNoteToRecurringTransactionRequest } from '../model/updateNoteToRecurringTransactionRequest'; import { UpdateNoteToRecurringTransactionResponse } from '../model/updateNoteToRecurringTransactionResponse'; import { UpdateNoteToSmartGoalRequest } from '../model/updateNoteToSmartGoalRequest'; import { UpdateNoteToSmartGoalResponse } from '../model/updateNoteToSmartGoalResponse'; import { UpdateNoteToTransactionRequest } from '../model/updateNoteToTransactionRequest'; import { UpdateNoteToTransactionResponse } from '../model/updateNoteToTransactionResponse'; import { UpdatePocketRequest } from '../model/updatePocketRequest'; import { UpdatePocketResponse } from '../model/updatePocketResponse'; import { UpdateRecurringTransactionRequest } from '../model/updateRecurringTransactionRequest'; import { UpdateRecurringTransactionResponse } from '../model/updateRecurringTransactionResponse'; import { UpdateSingleTransactionRequest } from '../model/updateSingleTransactionRequest'; import { UpdateSingleTransactionResponse } from '../model/updateSingleTransactionResponse'; import { UpdateSmartGoalRequest } from '../model/updateSmartGoalRequest'; import { UpdateSmartGoalResponse } from '../model/updateSmartGoalResponse'; import { UpdateUserProfileRequest } from '../model/updateUserProfileRequest'; import { UpdateUserProfileResponse } from '../model/updateUserProfileResponse'; import { Authentication, Interceptor } from '../model/models'; import { ApiKeyAuth } from '../model/models'; export declare enum FinancialServiceApiApiKeys { ApiKeyAuth = 0, Bearer = 1 } export declare class FinancialServiceApi { protected _basePath: string; protected _defaultHeaders: any; protected _useQuerystring: boolean; protected authentications: { default: Authentication; ApiKeyAuth: ApiKeyAuth; Bearer: ApiKeyAuth; }; protected interceptors: Interceptor[]; constructor(basePath?: string); set useQuerystring(value: boolean); set basePath(basePath: string); set defaultHeaders(defaultHeaders: any); get defaultHeaders(): any; get basePath(): string; setDefaultAuthentication(auth: Authentication): void; setApiKey(key: FinancialServiceApiApiKeys, value: string): void; addInterceptor(interceptor: Interceptor): void; /** * This endpoint adds a default pocket to a specific bank account of interest * @summary adds a default set of pockets to a specific bank account of interest * @param addDefaultPocketsToBankAccountRequest */ addDefaultPocketsToBankAccount(addDefaultPocketsToBankAccountRequest: AddDefaultPocketsToBankAccountRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddDefaultPocketsToBankAccountResponse; }>; /** * This endpoint adds a note to a business account * @summary Adds a note to a business account * @param addNoteToFinancialUserProfileRequest */ addNoteToFinancialUserProfile(addNoteToFinancialUserProfileRequest: AddNoteToFinancialUserProfileRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddNoteToFinancialUserProfileResponse; }>; /** * This endpoint adds a note to a transaction * @summary adds a note to a transaction * @param addNoteToRecurringTransactionRequest */ addNoteToRecurringTransaction(addNoteToRecurringTransactionRequest: AddNoteToRecurringTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddNoteToRecurringTransactionResponse; }>; /** * This endpoint adds a note to a smart goal * @summary adds a note to a smart goal * @param addNoteToSmartGoalRequest */ addNoteToSmartGoal(addNoteToSmartGoalRequest: AddNoteToSmartGoalRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddNoteToSmartGoalResponse; }>; /** * This endpoint adds a note to a transaction * @summary adds a note to a transaction * @param addNoteToTransactionRequest */ addNoteToTransaction(addNoteToTransactionRequest: AddNoteToTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddNoteToTransactionResponse; }>; /** * This endpoint adds transactions to a manually linked account * @summary Adds transactions to a manually linked account * @param addTransactionsToManuallyLinkedAccountRequest Add transactions to an account. */ addTransactionsToManuallyLinkedAccount(addTransactionsToManuallyLinkedAccountRequest: AddTransactionsToManuallyLinkedAccountRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: AddTransactionsToManuallyLinkedAccountResponse; }>; /** * This endpoint checks if a user can ask his/her copilot a question * @summary Ask a question to copilot * @param recordAskCopilotQuestionRequest */ askCopilotQuestion(recordAskCopilotQuestionRequest: RecordAskCopilotQuestionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: RecordAskCopilotQuestionResponse; }>; /** * This endpoint updates a set of transactions * @summary update a transaction * @param bulkUpdateRecurringTransactionRequest */ bulkUpdateRecurringTransaction(bulkUpdateRecurringTransactionRequest: BulkUpdateRecurringTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: BulkUpdateRecurringTransactionResponse; }>; /** * This endpoint updates a set of transactions * @summary update a transaction * @param bulkUpdateTransactionRequest */ bulkUpdateTransaction(bulkUpdateTransactionRequest: BulkUpdateTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: BulkUpdateTransactionResponse; }>; /** * This endpoint checks if a user has exceeded his/her copilot question quota * @summary Checks if the question quota has been exceeded * @param userId the account id associated with the user * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ checkIfQuotaExceeded(userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CheckIfQuotaExceededResponse; }>; /** * This endpoint creates a bank account for a given user profile * @summary create a bank account for a given user profile * @param createBankAccountRequest */ createBankAccount(createBankAccountRequest: CreateBankAccountRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateBankAccountResponse; }>; /** * This endpoint creates a budget * @summary create a budget * @param createBudgetRequest */ createBudget(createBudgetRequest: CreateBudgetRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateBudgetResponse; }>; /** * This endpoint creates a credit account for a given user profile * @summary create a credit account for a given user profile * @param createCreditAccountRequest */ createCreditAccount(createCreditAccountRequest: CreateCreditAccountRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateCreditAccountResponse; }>; /** * This endpoint creates a link * @summary create link * @param createManualLinkRequest */ createLink(createManualLinkRequest: CreateManualLinkRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateManualLinkResponse; }>; /** * This endpoint creates a milestone * @summary create a milestone * @param createMilestoneRequest */ createMilestone(createMilestoneRequest: CreateMilestoneRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateMilestoneResponse; }>; /** * This endpoint creates a smart goal * @summary create a smart goal * @param createSmartGoalRequest */ createSmartGoal(createSmartGoalRequest: CreateSmartGoalRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateSmartGoalResponse; }>; /** * This endpoint enabled a user to create a new subscription against stripe * @summary Creates a new subscription for a given customer against stripe * @param createSubscriptionRequest */ createSubscription(createSubscriptionRequest: CreateSubscriptionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateSubscriptionResponse; }>; /** * This endpoint performs an a creation operation of a user profile based on the provided parametersThis operation is implemented as a distributed transactions as this operation can span multiple services * @summary create a user profile * @param createUserProfileRequest1 CreateUserProfileRequest represents the request object for creating a user profile in the financial service. This message encapsulates the essential information needed to establish a new financial user profile, including identification, contact details, and the type of financial profile. */ createUserProfile1(createUserProfileRequest1: CreateUserProfileRequest1, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: CreateUserProfileResponse1; }>; /** * This endpoint deletes a budget * @summary delete a budget * @param budgetId The budget id Validations: - budget_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteBudget(budgetId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteBudgetResponse; }>; /** * This endpoint deletes the link if the link exists * @summary delete link by id * @param linkId The link id Validations: - link_id must be greater than 0 * @param userId The user id Validations: - user_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteLink(linkId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteLinkResponse; }>; /** * This endpoint deletes a milestone * @summary delete a milestone * @param milestoneId The milestone id Validations: - milestone_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteMilestone(milestoneId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteMilestoneResponse; }>; /** * This endpoint deletes a note from a transaction * @summary deletes a note from a transaction * @param transactionId The transaction id Validations: - transaction_id must be greater than 0 * @param noteId The note id Validations: - note_id must be greater than 0 * @param userId The user id * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteNoteFromRecurringTransaction(transactionId: string, noteId: string, userId: string, orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteNoteFromRecurringTransactionResponse; }>; /** * This endpoint deletes a note from a smart goal * @summary deletes a note from a smart goal * @param noteId The note id Validations: - note_id must be greater than 0 * @param smartGoalId The smart goal id Validations: - smart_goal_id must be greater than 0 * @param userId The user id * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteNoteFromSmartGoal(noteId: string, smartGoalId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteNoteFromSmartGoalResponse; }>; /** * This endpoint deletes a note from a transaction * @summary deletes a note from a transaction * @param transactionId The transaction id Validations: - transaction_id must be greater than 0 * @param noteId The note id Validations: - note_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteNoteFromTransaction(transactionId: string, noteId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteNoteFromTransactionResponse; }>; /** * This endpoint deletes a pocket * @summary deletes a pocket * @param pocketId The pocket id Validations: - pocket_id must be greater than 0 * @param userId * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deletePocket(pocketId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeletePocketResponse; }>; /** * This endpoint deletes a smart goal * @summary delete a smart goal * @param smartGoalId The smart goal id Validations: - smart_goal_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteSmartGoal(smartGoalId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteSmartGoalResponse; }>; /** * This endpoint deletes a specific transaction based on the transaction id * @summary deletes a transaction by id * @param transactionId the transaction of interest we aim to delete * @param userId The user id * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteTransaction(transactionId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteRecurringTransactionResponse; }>; /** * This endpoint deletes a specific transaction based on the transaction id * @summary deletes a transaction by id * @param transactionId the transaction of interest we aim to delete * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteTransaction1(transactionId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteTransactionResponse; }>; /** * This endpoint performs a delete operation on a user profile based on the provided parametersThis deletion operation spans multiple services (plaid) as user details are stored across a suite of our backend servicesThe operation itself is an atomic one of nature. Either all services successfully delete the recod or we fail the requestDivergent state is not expected to be encountered with this endpoint. * @summary deletes a bank account for a given user profile * @param bankAccountId The bank account id Validations: - bank_account_id must be greater than 0 * @param userId The account ID associated with the user Validations: - user_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteUserProfile1(bankAccountId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteBankAccountResponse; }>; /** * This endpoint performs a delete operation on a user profile based on the provided parameters * @summary deletes a user profile * @param userId The account ID associated with the user. NOTE: This user_id is the simfiny backend platform wide user id Validations: - user_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ deleteUserProfile2(userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: DeleteUserProfileResponse1; }>; /** * This endpoint returns the historical balance for a given account * @summary gets account balance of an account * @param userId * @param plaidAccountId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param profileType */ getAccountBalance(userId: string, plaidAccountId: string, orgId: string, tenantId: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetHistoricalAccountBalanceResponse; }>; /** * This API could accept account_id as input parameters and return the account balance history for that account. * @summary Returns the account balance history for an account * @param plaidAccountId Account ID * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType Type of financial user profile * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getAccountBalanceHistory(plaidAccountId: string, pageNumber: string, pageSize: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', userId: string, orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetAccountBalanceHistoryResponse; }>; /** * This endpoint returns all budgets * @summary get all budgets * @param pocketId The pocket account id Validations: - pocket_account_id must be greater than 0 * @param smartGoalId The smart goal id Validations: - smart_goal_id must be greater than 0 * @param milestoneId The milestone id Validations: - milestone_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getAllBudgets(pocketId: string, smartGoalId: string, milestoneId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetAllBudgetsResponse; }>; /** * This endpoint returns the bank account if the user record id and bank account id exists example: /api/v1/bank-account?user_id=xxxxxx&&bank_account_id=xxxxxxx * @summary get a bank account for a given user profile * @param bankAccountId The bank account id Validations: - bank_account_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getBankAccount(bankAccountId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetBankAccountResponse; }>; /** * This endpoint returns the budget if the budget exists * @summary get budget by id * @param budgetId The budget id Validations: - budget_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getBudget(budgetId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetBudgetResponse; }>; /** * This endpoint gets category metrics for a financial sub profile over time * @summary Gets category metrics for a financial sub profile over time * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param userId * @param profileType * @param personalFinanceCategoryPrimary * @param month * @param pageNumber * @param pageSize Number of items to return per page. */ getCategoryMetricsFinancialSubProfileOverTime(orgId: string, tenantId: string, userId?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', personalFinanceCategoryPrimary?: string, month?: number, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetCategoryMetricsFinancialSubProfileOverTimeResponse; }>; /** * * @summary Get monthly transaction count by user, month, and category * @param userId has to be present and defined * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optional * @param personalFinanceCategoryPrimary optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getCategoryMonthlyTransactionCount(userId: string, orgId: string, tenantId: string, month?: number, personalFinanceCategoryPrimary?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetCategoryMonthlyTransactionCountResponse; }>; /** * * @summary Get Debt-to-Income ratio by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getDebtToIncomeRatio(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetDebtToIncomeRatioResponse; }>; /** * * @summary Get Expense Metrics by user, month and category * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optonal * @param personalFinanceCategoryPrimary optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getExpenseMetrics(userId: string, orgId: string, tenantId: string, month?: number, personalFinanceCategoryPrimary?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetExpenseMetricsResponse; }>; /** * This endpoint gets expense metrics for a financial sub profile over time * @summary Gets expense metrics for a financial sub profile over time * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param userId * @param profileType * @param month * @param pageNumber * @param pageSize Number of items to return per page. */ getExpenseMetricsFinancialSubProfileOverTime(orgId: string, tenantId: string, userId?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', month?: number, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetExpenseMetricsFinancialSubProfileOverTimeResponse; }>; /** * * @summary Get Financial Profile by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getFinancialProfile(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetFinancialProfileResponse; }>; /** * This endpoint returns the forecast if the forecast exists * @summary get forecast by id * @param smartGoalId The smart goal id Validations: - smart_goal_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getForecast(smartGoalId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetForecastResponse; }>; /** * * @summary Get Income Expense Ratio by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getIncomeExpenseRatio(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetIncomeExpenseRatioResponse; }>; /** * * @summary Get Income Metrics by user, month and category * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optional * @param personalFinanceCategoryPrimary optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getIncomeMetrics(userId: string, orgId: string, tenantId: string, month?: number, personalFinanceCategoryPrimary?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetIncomeMetricsResponse; }>; /** * This endpoint gets expense metrics for a financial sub profile over time * @summary Gets income metrics for a financial sub profile over time * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param userId * @param profileType * @param month * @param pageNumber * @param pageSize Number of items to return per page. */ getIncomeMetricsFinancialSubProfileOverTime(orgId: string, tenantId: string, userId?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', month?: number, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetIncomeMetricsFinancialSubProfileOverTimeResponse; }>; /** * This endpoint returns the investment account if the investment account exists * @summary get investment account by id * @param userId The user id Validations: - user_id must be greater than 0 * @param investmentAccountId The investment account id Validations: - investment_account_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getInvestmentAccount(userId: string, investmentAccountId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetInvestmentAcccountResponse; }>; /** * This endpoint returns the liability account if the liability account exists * @summary get liability account by id * @param userId The user id Validations: - user_id must be greater than 0 * @param liabilityAccountId The liability account id Validations: - liability_account_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getLiabilityAccount(userId: string, liabilityAccountId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetLiabilityAccountResponse; }>; /** * This endpoint returns the link if the link exists * @summary get link by id * @param linkId The link id Validations: - link_id must be greater than 0 * @param userId The user id Validations: - user_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getLink(linkId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetLinkResponse; }>; /** * This endpoint returns the links * @summary get links * @param userId The user id Validations: - user_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getLinks(userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetLinksResponse; }>; /** * This endpoint gets location metrics for a financial sub profile over time * @summary Gets income metrics for a financial sub profile over time * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param userId * @param profileType * @param month * @param locationCity * @param pageNumber * @param pageSize Number of items to return per page. */ getLocationMetricsFinancialSubProfileOverTime(orgId: string, tenantId: string, userId?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', month?: number, locationCity?: string, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetLocationMetricsFinancialSubProfileOverTimeResponse; }>; /** * * @summary Get Melody Financial Context * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param profileType */ getMelodyFinancialContext(userId: string, orgId: string, tenantId: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMelodyFinancialContextResponse; }>; /** * This endpoint gets merchant metrics for a financial sub profile over time * @summary Gets merchant metrics for a financial sub profile over time * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param userId * @param profileType * @param month * @param merchantName * @param pageNumber * @param pageSize Number of items to return per page. */ getMerchantMetricsFinancialSubProfileOverTime(orgId: string, tenantId: string, userId?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', month?: number, merchantName?: string, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMerchantMetricsFinancialSubProfileOverTimeResponse; }>; /** * * @summary Get Merchant Monthly Expenditure by user, month and merchant name * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optional * @param merchantName optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getMerchantMonthlyExpenditure(userId: string, orgId: string, tenantId: string, month?: number, merchantName?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMerchantMonthlyExpenditureResponse; }>; /** * This endpoint returns the milestone if the milestone exists * @summary get milestone by id * @param milestoneId The milestone id Validations: - milestone_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getMilestone(milestoneId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMilestoneResponse; }>; /** * This endpoint returns the milestones if the smart goal exists * @summary get milestones by smart goal id * @param smartGoalId The smart goal id Validations: - smart_goal_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getMilestones(smartGoalId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMilestonesBySmartGoalIdResponse; }>; /** * * @summary Get Monthly Balance by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month optional * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getMonthlyBalance(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMonthlyBalanceResponse; }>; /** * * @summary Get Monthly Expenditure by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getMonthlyExpenditure(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMonthlyExpenditureResponse; }>; /** * * @summary Get Monthly Income by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getMonthlyIncome(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMonthlyIncomeResponse; }>; /** * * @summary Get Monthly Savings by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getMonthlySavings(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMonthlySavingsResponse; }>; /** * * @summary Get Monthly Total Quantity of Security by user, month and security * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month * @param securityId * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getMonthlyTotalQuantityBySecurityAndUser(userId: string, orgId: string, tenantId: string, month?: number, securityId?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMonthlyTotalQuantityBySecurityAndUserResponse; }>; /** * * @summary Get Monthly Transaction Count by user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getMonthlyTransactionCount(userId: string, orgId: string, tenantId: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMonthlyTransactionCountResponse; }>; /** * This endpoint returns the mortgage account if the mortgage account exists * @summary get mortgage account by id * @param userId The user id Validations: - user_id must be greater than 0 * @param mortgageAccountId The mortage account id Validations: - mortage_account_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getMortageAccount(userId: string, mortgageAccountId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetMortgageAccountResponse; }>; /** * This endpoint gets a note from a smart goal * @summary gets a note from a smart goal * @param noteId The note id Validations: - note_id must be greater than 0 * @param userId The user id * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getNoteFromSmartGoal(noteId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetNoteFromSmartGoalResponse; }>; /** * This endpoint gets a note from a transaction * @summary gets a note from a transaction * @param transactionId The transaction id Validations: - transaction_id must be greater than 0 * @param noteId The note id Validations: - note_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getNoteFromTransaction(transactionId: string, noteId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetNoteFromTransactionResponse; }>; /** * This endpoint gets notes from a business account * @summary Gets notes from a business account * @param businessAccountUserId The business account id Validations: - business_account_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getNotesFromFinancialUserProfile(businessAccountUserId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetNotesFromFinancialUserProfileResponse; }>; /** * This endpoint gets notes from a smart goal * @summary gets notes from a smart goal * @param smartGoalId The smart goal id Validations: - smart_goal_id must be greater than 0 * @param userId The user id * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getNotesFromSmartGoal(smartGoalId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetNotesFromSmartGoalResponse; }>; /** * This endpoint gets payment metrics for a financial sub profile over time * @summary Gets payment metrics for a financial sub profile over time * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param userId * @param profileType * @param month * @param paymentChannel * @param pageNumber * @param pageSize Number of items to return per page. */ getPaymentChannelFinancialSubProfileOverTime(orgId: string, tenantId: string, userId?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', month?: number, paymentChannel?: string, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetPaymentChannelFinancialSubProfileOverTimeResponse; }>; /** * * @summary Get Payment Channel Monthly Expenditure by user, month, and payment channel * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month * @param paymentChannel * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getPaymentChannelMonthlyExpenditure(userId: string, orgId: string, tenantId: string, month?: number, paymentChannel?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetPaymentChannelMonthlyExpenditureResponse; }>; /** * This endpoint returns the pocket if the pocket exists example: /api/v1/pocket/xxxxxxx * @summary get a pocket * @param pocketId The pocket account id Validations: - pocket_account_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getPocket(pocketId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetPocketResponse; }>; /** * This endpoint gets a specific transaction based on the transaction id * @summary lists a set of transactions against a given account of interest * @param transactionId the transaction of interest we aim to obtain * @param userId The user id * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getRecurringTransaction(transactionId: string, userId: string, orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetSingleRecurringTransactionResponse; }>; /** * This endpoint returns the recurring transactions for a given user id * @summary get recurring transactions * @param userId The user id Validations: - user_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param pageNumber * @param pageSize */ getRecurringTransactionsForUser(userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetRecurringTransactionsForUserResponse; }>; /** * This endpoint returns the smart goals if the pocket exists * @summary get smart goals by pocket id * @param pocketId The pocket account id Validations: - pocket_account_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getSmartGoalsByPocketId(pocketId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetSmartGoalsByPocketIdResponse; }>; /** * This endpoint gets a split transaction that was split previously into multiple transactions * @summary gets a split transaction * @param transactionId The transaction id Validations: - transaction_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getSplitTransaction(transactionId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetSplitTransactionResponse; }>; /** * This endpoint returns the student loan account if the student loan account exists * @summary get student loan account by id * @param userId The user id Validations: - user_id must be greater than 0 * @param studentLoanAccountId The student loan account id Validations: - student_loan_account_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getStudentLoanAccount(userId: string, studentLoanAccountId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetStudentLoanAccountResponse; }>; /** * * @summary Get Total Investment by user and security * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param securityId * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getTotalInvestmentBySecurity(userId: string, orgId: string, tenantId: string, securityId?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTotalInvestmentBySecurityResponse; }>; /** * This endpoint gets a specific transaction based on the transaction id * @summary lists a set of transactions against a given account of interest * @param transactionId the transaction of interest we aim to obtain * @param userId The user id * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getTransaction(transactionId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTransactionResponse; }>; /** * This endpoint returns the transactions for a given user id and a business account id * @summary get transactions tied to a bank account and account id * @param userId The user id Validations: - user_id must be greater than 0 * @param plaidAccountId * @param pageNumber * @param pageSize * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getTransactions(userId: string, plaidAccountId: string, pageNumber: string, pageSize: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTransactionsForBankAccountResponse; }>; /** * This endpoint returns the transactions for a given user id * @summary get transactions * @param userId The user id Validations: - user_id must be greater than 0 * @param pageNumber * @param pageSize * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ getTransactions1(userId: string, pageNumber: string, pageSize: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTransactionsResponse; }>; /** * This endpoint returns the transactions for a given user id and time example: /api/v1/users/{user_id}/accounts/{account_id}/transactions?start_time={start_time}&end_time={end_time} * @summary get transactions by time * @param userId The user id Validations: - user_id must be greater than 0 * @param accountId * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param startDate start date * @param endDate end date * @param page Current page number * @param limit Number of transactions per page * @param financialAccountType */ getTransactionsByTime(userId: string, accountId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, startDate?: Date, endDate?: Date, page?: number, limit?: number, financialAccountType?: 'FINANCIAL_ACCOUNT_TYPE_UNSPECIFIED' | 'FINANCIAL_ACCOUNT_TYPE_BANK' | 'FINANCIAL_ACCOUNT_TYPE_INVESTMENT' | 'FINANCIAL_ACCOUNT_TYPE_CREDIT' | 'FINANCIAL_ACCOUNT_TYPE_MORTGAGE' | 'FINANCIAL_ACCOUNT_TYPE_STUDENT_LOAN', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTransactionsBetweenTimeRangesResponse; }>; /** * This endpoint returns the transactions for a given user id over the past month example: /api/v1/users/{user_id}/transactions/month/accounts/{plaid_account_id} * @summary Get transactions for the past month * @param userId * @param plaidAccountId * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param page Current page number * @param limit Number of transactions per page * @param financialAccountType */ getTransactionsForPastMonth(userId: string, plaidAccountId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, page?: number, limit?: number, financialAccountType?: 'FINANCIAL_ACCOUNT_TYPE_UNSPECIFIED' | 'FINANCIAL_ACCOUNT_TYPE_BANK' | 'FINANCIAL_ACCOUNT_TYPE_INVESTMENT' | 'FINANCIAL_ACCOUNT_TYPE_CREDIT' | 'FINANCIAL_ACCOUNT_TYPE_MORTGAGE' | 'FINANCIAL_ACCOUNT_TYPE_STUDENT_LOAN', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTransactionsForPastMonthResponse; }>; /** * This endpoint returns the transactions for a given user id and time example: /api/v1/users/{user_id}/transactions/week/accounts/{plaid_account_id} * @summary get transactions for the past week * @param userId * @param plaidAccountId * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param page Current page number * @param limit Number of transactions per page * @param financialAccountType */ getTransactionsForPastWeek(userId: string, plaidAccountId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, page?: number, limit?: number, financialAccountType?: 'FINANCIAL_ACCOUNT_TYPE_UNSPECIFIED' | 'FINANCIAL_ACCOUNT_TYPE_BANK' | 'FINANCIAL_ACCOUNT_TYPE_INVESTMENT' | 'FINANCIAL_ACCOUNT_TYPE_CREDIT' | 'FINANCIAL_ACCOUNT_TYPE_MORTGAGE' | 'FINANCIAL_ACCOUNT_TYPE_STUDENT_LOAN', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTransactionsForPastWeekResponse; }>; /** * This API could accept user_id as input parameters and return the account balance history for that user. * @summary Returns the account balance history for a user * @param userId User ID * @param pageNumber * @param pageSize Number of items to return per page. * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param profileType */ getUserAccountBalanceHistory(userId: string, pageNumber: string, pageSize: string, orgId: string, tenantId: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserAccountBalanceHistoryResponse; }>; /** * This API could accept user_id as an input parameter and return the monthly category expenditure for that user. * @summary Returns the monthly category expenditure for a user * @param userId User ID * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param personalFinanceCategoryPrimary Personal finance category * @param month Month in the format of YYYYMM * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getUserCategoryMonthlyExpenditure(userId: string, orgId: string, tenantId: string, personalFinanceCategoryPrimary?: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserCategoryMonthlyExpenditureResponse; }>; /** * * @summary Get monthly income by user for a specific category * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param personalFinanceCategoryPrimary * @param month * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ getUserCategoryMonthlyIncome(userId: string, orgId: string, tenantId: string, personalFinanceCategoryPrimary?: string, month?: number, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserCategoryMonthlyIncomeResponse; }>; /** * Queries and obtains a user profile based on the provided parameters * @summary Gets a user profile * @param userId The account ID associated with the user. NOTE: This user_id is the simfiny backend platform wide user id Validations: - user_id must be greater than 0 * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param bypassCache bypass_cache is a flag to bypass the cache and fetch the data from the source this is very valuable when we want to get the latest data from the source */ getUserProfile1(userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, bypassCache?: boolean, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetUserProfileResponse1; }>; /** * This endpoint performs a healc check on the service * @summary health check */ healthCheck2(options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: HealthCheckResponse; }>; /** * This endpoint lists notes from a transaction * @summary lists notes from a transaction * @param transactionId The transaction id Validations: - transaction_id must be greater than 0 * @param userId The user id * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ listRecurringTransactionNotes(transactionId: string, userId: string, orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListRecurringTransactionNotesResponse; }>; /** * This endpoint gets a list of transactions against a given account of interest * @summary lists a set of transactions against a given account of interest * @param accountId * @param userId * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param pageNumber * @param pageSize * @param financialAccountType */ listRecurringTransactionsForUserAndAccount(accountId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, pageNumber?: string, pageSize?: string, financialAccountType?: 'FINANCIAL_ACCOUNT_TYPE_UNSPECIFIED' | 'FINANCIAL_ACCOUNT_TYPE_BANK' | 'FINANCIAL_ACCOUNT_TYPE_INVESTMENT' | 'FINANCIAL_ACCOUNT_TYPE_CREDIT' | 'FINANCIAL_ACCOUNT_TYPE_MORTGAGE' | 'FINANCIAL_ACCOUNT_TYPE_STUDENT_LOAN', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListRecurringTransactionsForUserAndAccountResponse; }>; /** * This endpoint lists notes from a transaction * @summary lists notes from a transaction * @param transactionId The transaction id Validations: - transaction_id must be greater than 0 * @param userId * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ listTransactionNotes(transactionId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTransactionNotesResponse; }>; /** * This endpoint gets a list of transactions against a given account of interest * @summary lists a set of transactions against a given account of interest * @param accountId * @param userId * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param pageNumber * @param pageSize * @param financialAccountType */ listTransactions(accountId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, pageNumber?: string, pageSize?: string, financialAccountType?: 'FINANCIAL_ACCOUNT_TYPE_UNSPECIFIED' | 'FINANCIAL_ACCOUNT_TYPE_BANK' | 'FINANCIAL_ACCOUNT_TYPE_INVESTMENT' | 'FINANCIAL_ACCOUNT_TYPE_CREDIT' | 'FINANCIAL_ACCOUNT_TYPE_MORTGAGE' | 'FINANCIAL_ACCOUNT_TYPE_STUDENT_LOAN', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTransactionsResponse; }>; /** * This endpoint gets a list of transactions across all connected accounts * @summary lists a set of transactions across all connected accounts * @param userId * @param profileType * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param pageNumber * @param pageSize */ listTransactions1(userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, pageNumber?: string, pageSize?: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ListTransactionsAcrossAllAccountsResponse; }>; /** * This endpoint exchanges a plaid link token for a plaid access token * @summary exchange plaid token * @param plaidExchangeTokenRequest */ plaidExchangeToken(plaidExchangeTokenRequest: PlaidExchangeTokenRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: PlaidExchangeTokenResponse; }>; /** * This endpoint initiates a plaid link token creation * @summary initiate plaid setup * @param plaidInitiateTokenExchangeRequest */ plaidInitiateTokenExchange(plaidInitiateTokenExchangeRequest: PlaidInitiateTokenExchangeRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: PlaidInitiateTokenExchangeResponse; }>; /** * This endpoint initiates a plaid link token update * @summary initiate plaid link token update * @param plaidInitiateTokenUpdateRequest */ plaidInitiateTokenUpdate(plaidInitiateTokenUpdateRequest: PlaidInitiateTokenUpdateRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: PlaidInitiateTokenUpdateResponse; }>; /** * This endpoint syncs accounts based on plaid access token * @summary sync accounts based on plaid access token * @param plaidSyncAccountFromAccessTokenRequest */ plaidSyncAccountFromAccessToken(plaidSyncAccountFromAccessTokenRequest: PlaidSyncAccountFromAccessTokenRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: PlaidSyncAccountFromAccessTokenResponse; }>; /** * This endpoint polls the status of an async task * @summary polls the status of an async task * @param workflowId The task id Validations: - workflow id cannot be empty * @param runId The run id Validations: - run id cannot be empty * @param userId The user id * @param profileType Type of financial user profile * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support */ pollAsyncTaskExecutionStatus(workflowId: string, runId: string, userId: string, profileType: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', orgId: string, tenantId: string, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: PollAsyncTaskExecutionStatusResponse; }>; /** * This endpoint performs a readiness check on the service * @summary readyness check */ readynessCheck2(options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: ReadynessCheckResponse2; }>; /** * This endpoint searches transactions based on a search query and returns a list of transactions that match the search query * @summary searches transactions * @param searchTransactionsRequest */ searchTransactions(searchTransactionsRequest: SearchTransactionsRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: SearchTransactionsResponse; }>; /** * This endpoint splits a transaction into multiple transactions * @summary splits a transaction * @param splitTransactionRequest */ splitTransaction(splitTransactionRequest: SplitTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: SplitTransactionResponse; }>; /** * This API could accept user_id and month as input parameters and return the aggregated transactions for that user and month. * @summary Returns the aggregated transactions for a user and month * @param userId * @param orgId Organization identifier for multi-org support * @param tenantId Tenant identifier for multi-tenancy support * @param month * @param personalFinanceCategoryPrimary * @param locationCity * @param paymentChannel * @param merchantName * @param pageNumber * @param pageSize Number of items to return per page. * @param profileType */ transactionAggregates(userId: string, orgId: string, tenantId: string, month?: number, personalFinanceCategoryPrimary?: string, locationCity?: string, paymentChannel?: string, merchantName?: string, pageNumber?: string, pageSize?: string, profileType?: 'FINANCIAL_USER_PROFILE_TYPE_UNSPECIFIED' | 'FINANCIAL_USER_PROFILE_TYPE_USER' | 'FINANCIAL_USER_PROFILE_TYPE_BUSINESS', options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: GetTransactionAggregatesResponse; }>; /** * This endpoint triggers a sync * @summary Triggers a sync * @param triggerSyncRequest */ triggerSync(triggerSyncRequest: TriggerSyncRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: TriggerSyncResponse; }>; /** * This endpoint unsplit a transaction that was split previously into multiple transactions * @summary unsplit a transaction * @param unSplitTransactionsRequest */ unsplitTransactions(unSplitTransactionsRequest: UnSplitTransactionsRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UnSplitTransactionsResponse; }>; /** * This endpoint updates a bank account if the user record id and bank account id exists * @summary update a bank account for a given user profile * @param updateBankAccountRequest */ updateBankAccount(updateBankAccountRequest: UpdateBankAccountRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateBankAccountResponse; }>; /** * This endpoint Updates a note to a transaction * @summary Updates a note to a transaction * @param updateNoteToRecurringTransactionRequest */ updateNoteToRecurringTransaction(updateNoteToRecurringTransactionRequest: UpdateNoteToRecurringTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateNoteToRecurringTransactionResponse; }>; /** * This endpoint updates a note to a smart goal * @summary updates a note to a smart goal * @param updateNoteToSmartGoalRequest */ updateNoteToSmartGoal(updateNoteToSmartGoalRequest: UpdateNoteToSmartGoalRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateNoteToSmartGoalResponse; }>; /** * This endpoint Updates a note to a transaction * @summary Updates a note to a transaction * @param updateNoteToTransactionRequest */ updateNoteToTransaction(updateNoteToTransactionRequest: UpdateNoteToTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateNoteToTransactionResponse; }>; /** * This endpoint updates a pocket * @summary updates a pocket * @param updatePocketRequest */ updatePocket(updatePocketRequest: UpdatePocketRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdatePocketResponse; }>; /** * This endpoint updates a transaction * @summary update a transaction * @param updateSingleTransactionRequest */ updateSingleTransaction(updateSingleTransactionRequest: UpdateSingleTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateSingleTransactionResponse; }>; /** * This endpoint updates a smart goal * @summary update a smart goal * @param updateSmartGoalRequest */ updateSmartGoal(updateSmartGoalRequest: UpdateSmartGoalRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateSmartGoalResponse; }>; /** * This endpoint updates a transaction * @summary update a transaction * @param updateRecurringTransactionRequest */ updateTransaction(updateRecurringTransactionRequest: UpdateRecurringTransactionRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateRecurringTransactionResponse; }>; /** * This endpoint performs an updates operation on a user profile based on the provided parameters * @summary update a user profile * @param updateUserProfileRequest */ updateUserProfile(updateUserProfileRequest: UpdateUserProfileRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateUserProfileResponse; }>; /** * This endpoint updates a budget * @summary updates a budget * @param updateBudgetRequest */ updatesBudget(updateBudgetRequest: UpdateBudgetRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateBudgetResponse; }>; /** * This endpoint updates a milestone * @summary updates a milestone * @param updateMilestoneRequest */ updatesMilestone(updateMilestoneRequest: UpdateMilestoneRequest, options?: { headers: { [name: string]: string; }; }): Promise<{ response: http.IncomingMessage; body: UpdateMilestoneResponse; }>; }