Class StreamReachesApi

Hierarchy (view full)

BaseAPI
- StreamReachesApi

Index

Constructors

Properties

Methods

deleteStreamReachesWithName deleteStreamReachesWithNameRaw getStreamReaches getStreamReachesRaw getStreamReachesWithName getStreamReachesWithNameRaw patchStreamReachesWithName patchStreamReachesWithNameRaw postStreamReaches postStreamReachesRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteStreamReachesWithName

deleteStreamReachesWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Stream Reach Delete streamReaches with name
Parameters
- requestParameters: DeleteStreamReachesWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:101

deleteStreamReachesWithNameRaw

deleteStreamReachesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Stream Reach Delete streamReaches with name
Parameters
- requestParameters: DeleteStreamReachesWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:66

getStreamReaches

getStreamReaches(requestParameters?, initOverrides?): Promise<StreamReach[]>
Returns matching CWMS Stream Reach Data for a Reservoir Project. Get streamReaches
Parameters
- requestParameters: GetStreamReachesRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<StreamReach[]>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:152

getStreamReachesRaw

getStreamReachesRaw(requestParameters, initOverrides?): Promise<ApiResponse<StreamReach[]>>
Returns matching CWMS Stream Reach Data for a Reservoir Project. Get streamReaches
Parameters
- requestParameters: GetStreamReachesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StreamReach[]>>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:109

getStreamReachesWithName

getStreamReachesWithName(requestParameters, initOverrides?): Promise<StreamReach[]>
Returns CWMS Stream Reach Data Get streamReaches with name
Parameters
- requestParameters: GetStreamReachesWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<StreamReach[]>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:208

getStreamReachesWithNameRaw

getStreamReachesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<StreamReach[]>>
Returns CWMS Stream Reach Data Get streamReaches with name
Parameters
- requestParameters: GetStreamReachesWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StreamReach[]>>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:161

patchStreamReachesWithName

patchStreamReachesWithName(requestParameters, initOverrides?): Promise<void>
Rename CWMS Stream Reach Patch streamReaches with name
Parameters
- requestParameters: PatchStreamReachesWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:260

patchStreamReachesWithNameRaw

patchStreamReachesWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename CWMS Stream Reach Patch streamReaches with name
Parameters
- requestParameters: PatchStreamReachesWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:217

postStreamReaches

postStreamReaches(requestParameters, initOverrides?): Promise<void>
Create CWMS Stream Reach Post streamReaches
Parameters
- requestParameters: PostStreamReachesRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:302

postStreamReachesRaw

postStreamReachesRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Stream Reach Post streamReaches
Parameters
- requestParameters: PostStreamReachesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamReachesApi.ts:268

`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