Class LevelsApi

Hierarchy (view full)

BaseAPI
- LevelsApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteLevelsWithLevelId

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

deleteLevelsWithLevelIdRaw

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

deleteSpecifiedLevelsWithSpecifiedLevelId

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

deleteSpecifiedLevelsWithSpecifiedLevelIdRaw

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

getLevels

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

getLevelsRaw

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

getLevelsWithLevelId

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

getLevelsWithLevelIdRaw

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

getSpecifiedLevels

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

getSpecifiedLevelsRaw

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

`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

patchLevelsWithLevelId

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

patchLevelsWithLevelIdRaw

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

patchSpecifiedLevelsWithSpecifiedLevelId

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

patchSpecifiedLevelsWithSpecifiedLevelIdRaw

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

postLevels

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

postLevelsRaw

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

postSpecifiedLevels

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

postSpecifiedLevelsRaw

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

`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