Class ForecastApi

Hierarchy (view full)

BaseAPI
- ForecastApi

Constructors

constructor

new ForecastApi(configuration?): ForecastApi
Parameters
- configuration: Configuration = ...
Returns ForecastApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteForecastInstanceWithName

deleteForecastInstanceWithName(requestParameters, initOverrides?): Promise<void>
Used to delete forecast instance data based on unique fields Delete forecastInstance with name
Parameters
- requestParameters: DeleteForecastInstanceWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ForecastApi.ts:164

deleteForecastInstanceWithNameRaw

deleteForecastInstanceWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Used to delete forecast instance data based on unique fields Delete forecastInstance with name
Parameters
- requestParameters: DeleteForecastInstanceWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:109

deleteForecastSpecWithName

deleteForecastSpecWithName(requestParameters, initOverrides?): Promise<void>
Used to delete forecast spec data based on unique fields Delete forecastSpec with name
Parameters
- requestParameters: DeleteForecastSpecWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ForecastApi.ts:215

deleteForecastSpecWithNameRaw

deleteForecastSpecWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Used to delete forecast spec data based on unique fields Delete forecastSpec with name
Parameters
- requestParameters: DeleteForecastSpecWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:172

getForecastInstance

getForecastInstance(requestParameters?, initOverrides?): Promise<ForecastInstance>
Used to get all forecast instances for a given forecast spec Get forecastInstance
Parameters
- requestParameters: GetForecastInstanceRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<ForecastInstance>
- Defined in cwmsjs/src/apis/ForecastApi.ts:258

getForecastInstanceRaw

getForecastInstanceRaw(requestParameters, initOverrides?): Promise<ApiResponse<ForecastInstance>>
Used to get all forecast instances for a given forecast spec Get forecastInstance
Parameters
- requestParameters: GetForecastInstanceRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ForecastInstance>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:223

getForecastInstanceWithName

getForecastInstanceWithName(requestParameters, initOverrides?): Promise<ForecastInstance>
Used to get all forecast instances for a given forecast spec Get forecastInstance with name
Parameters
- requestParameters: GetForecastInstanceWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ForecastInstance>
- Defined in cwmsjs/src/apis/ForecastApi.ts:322

getForecastInstanceWithNameFileData

getForecastInstanceWithNameFileData(requestParameters, initOverrides?): Promise<Blob>
Used to download forecast file for the given parameters Get forecastInstance with name fileData
Parameters
- requestParameters: GetForecastInstanceWithNameFileDataRequest
- Optional initOverrides: RequestInit
Returns Promise<Blob>
- Defined in cwmsjs/src/apis/ForecastApi.ts:386

getForecastInstanceWithNameFileDataRaw

getForecastInstanceWithNameFileDataRaw(requestParameters, initOverrides?): Promise<ApiResponse<Blob>>
Used to download forecast file for the given parameters Get forecastInstance with name fileData
Parameters
- requestParameters: GetForecastInstanceWithNameFileDataRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Blob>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:331

getForecastInstanceWithNameRaw

getForecastInstanceWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<ForecastInstance>>
Used to get all forecast instances for a given forecast spec Get forecastInstance with name
Parameters
- requestParameters: GetForecastInstanceWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ForecastInstance>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:267

getForecastSpec

getForecastSpec(requestParameters?, initOverrides?): Promise<ForecastSpec>
Used to query multiple forecast specs Get forecastSpec
Parameters
- requestParameters: GetForecastSpecRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<ForecastSpec>
- Defined in cwmsjs/src/apis/ForecastApi.ts:434

getForecastSpecRaw

getForecastSpecRaw(requestParameters, initOverrides?): Promise<ApiResponse<ForecastSpec>>
Used to query multiple forecast specs Get forecastSpec
Parameters
- requestParameters: GetForecastSpecRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ForecastSpec>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:395

getForecastSpecWithName

getForecastSpecWithName(requestParameters, initOverrides?): Promise<ForecastSpec>
Used to query a single forecast spec record Get forecastSpec with name
Parameters
- requestParameters: GetForecastSpecWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ForecastSpec>
- Defined in cwmsjs/src/apis/ForecastApi.ts:482

getForecastSpecWithNameRaw

getForecastSpecWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<ForecastSpec>>
Used to query a single forecast spec record Get forecastSpec with name
Parameters
- requestParameters: GetForecastSpecWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ForecastSpec>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:443

patchForecastInstanceWithName

patchForecastInstanceWithName(requestParameters, initOverrides?): Promise<void>
Update a forecast instance with new max age, notes, forecast fileand forecast info key/value pairs. Patch forecastInstance with name
Parameters
- requestParameters: PatchForecastInstanceWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ForecastApi.ts:525

patchForecastInstanceWithNameRaw

patchForecastInstanceWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update a forecast instance with new max age, notes, forecast fileand forecast info key/value pairs. Patch forecastInstance with name
Parameters
- requestParameters: PatchForecastInstanceWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:491

patchForecastSpecWithName

patchForecastSpecWithName(requestParameters, initOverrides?): Promise<void>
Update a forecast spec with provided values Patch forecastSpec with name
Parameters
- requestParameters: PatchForecastSpecWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ForecastApi.ts:567

patchForecastSpecWithNameRaw

patchForecastSpecWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update a forecast spec with provided values Patch forecastSpec with name
Parameters
- requestParameters: PatchForecastSpecWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:533

postForecastInstance

postForecastInstance(requestParameters, initOverrides?): Promise<void>
Used to create and save a forecast instance Post forecastInstance
Parameters
- requestParameters: PostForecastInstanceRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ForecastApi.ts:605

postForecastInstanceRaw

postForecastInstanceRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Used to create and save a forecast instance Post forecastInstance
Parameters
- requestParameters: PostForecastInstanceRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:575

postForecastSpec

postForecastSpec(requestParameters, initOverrides?): Promise<void>
Used to create and save forecast spec data Post forecastSpec
Parameters
- requestParameters: PostForecastSpecRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ForecastApi.ts:643

postForecastSpecRaw

postForecastSpecRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Used to create and save forecast spec data Post forecastSpec
Parameters
- requestParameters: PostForecastSpecRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ForecastApi.ts:613

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:47

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:37