Class StreamsApi

Hierarchy (view full)

BaseAPI
- StreamsApi

Index

Constructors

Properties

Methods

deleteStreamsWithName deleteStreamsWithNameRaw getStreams getStreamsRaw getStreamsWithName getStreamsWithNameRaw patchStreamsWithName patchStreamsWithNameRaw postStreams postStreamsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteStreamsWithName

deleteStreamsWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Stream Delete streams with name
Parameters
- requestParameters: DeleteStreamsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamsApi.ts:108

deleteStreamsWithNameRaw

deleteStreamsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Stream Delete streams with name
Parameters
- requestParameters: DeleteStreamsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:69

getStreams

getStreams(requestParameters?, initOverrides?): Promise<Stream[]>
Returns matching CWMS Stream Data for a Reservoir Project. Get streams
Parameters
- requestParameters: GetStreamsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Stream[]>
- Defined in cwmsjs/src/apis/StreamsApi.ts:159

getStreamsRaw

getStreamsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Stream[]>>
Returns matching CWMS Stream Data for a Reservoir Project. Get streams
Parameters
- requestParameters: GetStreamsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Stream[]>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:116

getStreamsWithName

getStreamsWithName(requestParameters, initOverrides?): Promise<Stream[]>
Returns CWMS Stream Data Get streams with name
Parameters
- requestParameters: GetStreamsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<Stream[]>
- Defined in cwmsjs/src/apis/StreamsApi.ts:207

getStreamsWithNameRaw

getStreamsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Stream[]>>
Returns CWMS Stream Data Get streams with name
Parameters
- requestParameters: GetStreamsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Stream[]>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:168

patchStreamsWithName

patchStreamsWithName(requestParameters, initOverrides?): Promise<void>
Rename CWMS Stream Patch streams with name
Parameters
- requestParameters: PatchStreamsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamsApi.ts:259

patchStreamsWithNameRaw

patchStreamsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename CWMS Stream Patch streams with name
Parameters
- requestParameters: PatchStreamsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:216

postStreams

postStreams(requestParameters, initOverrides?): Promise<void>
Create CWMS Stream Post streams
Parameters
- requestParameters: PostStreamsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamsApi.ts:301

postStreamsRaw

postStreamsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Stream Post streams
Parameters
- requestParameters: PostStreamsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamsApi.ts:267

`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