Class StreamReachesApi

Hierarchy (view full)

BaseAPI
- StreamReachesApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteStreamReachesWithName

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

deleteStreamReachesWithNameRaw

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

getStreamReaches

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

getStreamReachesRaw

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

getStreamReachesWithName

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

getStreamReachesWithNameRaw

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

`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

patchStreamReachesWithName

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

patchStreamReachesWithNameRaw

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

postStreamReaches

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

postStreamReachesRaw

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

`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