Class ForecastApi

ForecastApi - object-oriented interface

export
class: ForecastApi
extends: {BaseAPI}

Hierarchy

BaseAPI
- ForecastApi

Index

Constructors

constructor

Methods

Constructors

constructor

new ForecastApi(configuration?: Configuration, basePath?: string, fetch?: FetchAPI): ForecastApi

Inherited from BaseAPI.constructor
- Defined in api.ts:58
Parameters
- Optional configuration: Configuration
- Default value basePath: string = BASE_PATH
- Default value fetch: FetchAPI = portableFetch
Returns ForecastApi

Methods

getForecast

getForecast(accessId: string, accountId: string, options?: any): Promise<Forecast>

- Defined in api.ts:2763
The current month is determined by the most recent refresh.

summary

Get balance forecast

throws

{RequiredError}

memberof

ForecastApi

Parameters
- accessId: string
  
  The accessId for which to retrieve forecasts
- accountId: string
  
  The accountId for which to retrieve forecasts
- Optional options: any
Returns Promise<Forecast>

getForecastTransactions

getForecastTransactions(accessId: string, accountId: string, options?: any): Promise<ForecastTransaction>

- Defined in api.ts:2776
The current month is determined by the most recent refresh of transactions. The request also retrieves the transactions expected to be applied until the end of the current month.

summary

Get forecast transactions

throws

{RequiredError}

memberof

ForecastApi

Parameters
- accessId: string
  
  The accessId for the forecast
- accountId: string
  
  The id for the account
- Optional options: any
Returns Promise<ForecastTransaction>