Class ForecastApi

Hierarchy (view full)

BaseAPI
- ForecastApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteForecastInstanceWithName

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

deleteForecastInstanceWithNameRaw

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

deleteForecastSpecWithName

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

deleteForecastSpecWithNameRaw

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

getForecastInstance

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

getForecastInstanceRaw

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

getForecastInstanceWithName

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

getForecastInstanceWithNameFileData

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

getForecastInstanceWithNameFileDataRaw

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

getForecastInstanceWithNameRaw

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

getForecastSpec

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

getForecastSpecRaw

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

getForecastSpecWithName

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

getForecastSpecWithNameRaw

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

`Protected` isJsonMime

isJsonMime(mime): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

patchForecastInstanceWithName

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

patchForecastInstanceWithNameRaw

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

patchForecastSpecWithName

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

patchForecastSpecWithNameRaw

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

postForecastInstance

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

postForecastInstanceRaw

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

postForecastSpec

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

postForecastSpecRaw

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

`Protected` request

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

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:101

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:112

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:107

Class ForecastApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ForecastApi

Properties

Protected configuration

Methods

deleteForecastInstanceWithName

Parameters

Returns Promise<void>

deleteForecastInstanceWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

deleteForecastSpecWithName

Parameters

Returns Promise<void>

deleteForecastSpecWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

getForecastInstance

Parameters

Returns Promise<ForecastInstance>

getForecastInstanceRaw

Parameters

Returns Promise<ApiResponse<ForecastInstance>>

getForecastInstanceWithName

Parameters

Returns Promise<ForecastInstance>

getForecastInstanceWithNameFileData

Parameters

Returns Promise<Blob>

getForecastInstanceWithNameFileDataRaw

Parameters

Returns Promise<ApiResponse<Blob>>

getForecastInstanceWithNameRaw

Parameters

Returns Promise<ApiResponse<ForecastInstance>>

getForecastSpec

Parameters

Returns Promise<ForecastSpec>

getForecastSpecRaw

Parameters

Returns Promise<ApiResponse<ForecastSpec>>

getForecastSpecWithName

Parameters

Returns Promise<ForecastSpec>

getForecastSpecWithNameRaw

Parameters

Returns Promise<ApiResponse<ForecastSpec>>

Protected isJsonMime

Parameters

Returns boolean

patchForecastInstanceWithName

Parameters

Returns Promise<void>

patchForecastInstanceWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

patchForecastSpecWithName

Parameters

Returns Promise<void>

patchForecastSpecWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

postForecastInstance

Parameters

Returns Promise<void>

postForecastInstanceRaw

Parameters

Returns Promise<ApiResponse<void>>

postForecastSpec

Parameters

Returns Promise<void>

postForecastSpecRaw

`Protected` configuration

`Protected` isJsonMime

`Protected` request