Class LevelsApi

Hierarchy (view full)

BaseAPI
- LevelsApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteLevelsWithLevelId

deleteLevelsWithLevelId(requestParameters, initOverrides?): Promise<void>
Delete CWMS Location Level Delete levels with levelId
Parameters
- requestParameters: DeleteLevelsWithLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LevelsApi.ts:159

deleteLevelsWithLevelIdRaw

deleteLevelsWithLevelIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Location Level Delete levels with levelId
Parameters
- requestParameters: DeleteLevelsWithLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:116

deleteSpecifiedLevelsWithSpecifiedLevelId

deleteSpecifiedLevelsWithSpecifiedLevelId(requestParameters, initOverrides?): Promise<void>
Deletes requested specified level id Delete specifiedLevels with specifiedLevelId
Parameters
- requestParameters: DeleteSpecifiedLevelsWithSpecifiedLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LevelsApi.ts:202

deleteSpecifiedLevelsWithSpecifiedLevelIdRaw

deleteSpecifiedLevelsWithSpecifiedLevelIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested specified level id Delete specifiedLevels with specifiedLevelId
Parameters
- requestParameters: DeleteSpecifiedLevelsWithSpecifiedLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:167

getLevels

getLevels(requestParameters?, initOverrides?): Promise<object>
Get levels
Parameters
- requestParameters: GetLevelsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<object>
- Defined in cwmsjs/src/apis/LevelsApi.ts:275

getLevelsRaw

getLevelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<object>>
Get levels
Parameters
- requestParameters: GetLevelsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<object>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:209

getLevelsWithLevelId

getLevelsWithLevelId(requestParameters, initOverrides?): Promise<LocationLevel>
Retrieves requested Location Level Get levels with levelId
Parameters
- requestParameters: GetLevelsWithLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<LocationLevel>
- Defined in cwmsjs/src/apis/LevelsApi.ts:339

getLevelsWithLevelIdRaw

getLevelsWithLevelIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<LocationLevel>>
Retrieves requested Location Level Get levels with levelId
Parameters
- requestParameters: GetLevelsWithLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LocationLevel>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:284

getLevelsWithLevelIdTimeSeries

getLevelsWithLevelIdTimeSeries(requestParameters, initOverrides?): Promise<TimeSeries>
Retrieves requested Location Level Get levels with levelId timeseries
Parameters
- requestParameters: GetLevelsWithLevelIdTimeSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<TimeSeries>
- Defined in cwmsjs/src/apis/LevelsApi.ts:407

getLevelsWithLevelIdTimeSeriesRaw

getLevelsWithLevelIdTimeSeriesRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeries>>
Retrieves requested Location Level Get levels with levelId timeseries
Parameters
- requestParameters: GetLevelsWithLevelIdTimeSeriesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TimeSeries>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:348

getSpecifiedLevels

getSpecifiedLevels(requestParameters?, initOverrides?): Promise<SpecifiedLevel>
Get specifiedLevels
Parameters
- requestParameters: GetSpecifiedLevelsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<SpecifiedLevel>
- Defined in cwmsjs/src/apis/LevelsApi.ts:445

getSpecifiedLevelsRaw

getSpecifiedLevelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<SpecifiedLevel>>
Get specifiedLevels
Parameters
- requestParameters: GetSpecifiedLevelsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<SpecifiedLevel>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:415

patchLevelsWithLevelId

patchLevelsWithLevelId(requestParameters, initOverrides?): Promise<void>
Update CWMS Location Level Patch levels with levelId
Parameters
- requestParameters: PatchLevelsWithLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LevelsApi.ts:492

patchLevelsWithLevelIdRaw

patchLevelsWithLevelIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update CWMS Location Level Patch levels with levelId
Parameters
- requestParameters: PatchLevelsWithLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:454

patchSpecifiedLevelsWithSpecifiedLevelId

patchSpecifiedLevelsWithSpecifiedLevelId(requestParameters, initOverrides?): Promise<void>
Renames the requested specified level id Patch specifiedLevels with specifiedLevelId
Parameters
- requestParameters: PatchSpecifiedLevelsWithSpecifiedLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LevelsApi.ts:543

patchSpecifiedLevelsWithSpecifiedLevelIdRaw

patchSpecifiedLevelsWithSpecifiedLevelIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Renames the requested specified level id Patch specifiedLevels with specifiedLevelId
Parameters
- requestParameters: PatchSpecifiedLevelsWithSpecifiedLevelIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:500

postLevels

postLevels(requestParameters, initOverrides?): Promise<void>
Create new CWMS Location Level Post levels
Parameters
- requestParameters: PostLevelsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LevelsApi.ts:581

postLevelsRaw

postLevelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new CWMS Location Level Post levels
Parameters
- requestParameters: PostLevelsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:551

postSpecifiedLevels

postSpecifiedLevels(requestParameters, initOverrides?): Promise<void>
Create new SpecifiedLevel Post specifiedLevels
Parameters
- requestParameters: PostSpecifiedLevelsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LevelsApi.ts:623

postSpecifiedLevelsRaw

postSpecifiedLevelsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new SpecifiedLevel Post specifiedLevels
Parameters
- requestParameters: PostSpecifiedLevelsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LevelsApi.ts:589

`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