Class StreamLocationsApi

Hierarchy (view full)

BaseAPI
- StreamLocationsApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteStreamLocationsWithName

deleteStreamLocationsWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Stream Location Delete streamLocations with name
Parameters
- requestParameters: DeleteStreamLocationsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:132

deleteStreamLocationsWithNameRaw

deleteStreamLocationsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Stream Location Delete streamLocations with name
Parameters
- requestParameters: DeleteStreamLocationsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:89

getStreamLocations

getStreamLocations(requestParameters?, initOverrides?): Promise<StreamLocation[]>
Returns matching CWMS Stream Location Data for a Reservoir Project. Get streamLocations
Parameters
- requestParameters: GetStreamLocationsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<StreamLocation[]>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:187

getStreamLocationsRaw

getStreamLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<StreamLocation[]>>
Returns matching CWMS Stream Location Data for a Reservoir Project. Get streamLocations
Parameters
- requestParameters: GetStreamLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StreamLocation[]>>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:140

getStreamLocationsWithName

getStreamLocationsWithName(requestParameters, initOverrides?): Promise<StreamLocation[]>
Returns CWMS Stream Location Data Get streamLocations with name
Parameters
- requestParameters: GetStreamLocationsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<StreamLocation[]>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:251

getStreamLocationsWithNameRaw

getStreamLocationsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<StreamLocation[]>>
Returns CWMS Stream Location Data Get streamLocations with name
Parameters
- requestParameters: GetStreamLocationsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StreamLocation[]>>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:196

getStreamLocationsWithOfficeWithNameDownstreamLocations

getStreamLocationsWithOfficeWithNameDownstreamLocations(requestParameters, initOverrides?): Promise<StreamLocation[]>
Returns matching downstream stream locations. Get streamLocations with office with name downstreamLocations
Parameters
- requestParameters: GetStreamLocationsWithOfficeWithNameDownstreamLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<StreamLocation[]>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:311

getStreamLocationsWithOfficeWithNameDownstreamLocationsRaw

getStreamLocationsWithOfficeWithNameDownstreamLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<StreamLocation[]>>
Returns matching downstream stream locations. Get streamLocations with office with name downstreamLocations
Parameters
- requestParameters: GetStreamLocationsWithOfficeWithNameDownstreamLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StreamLocation[]>>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:260

getStreamLocationsWithOfficeWithNameUpstreamLocations

getStreamLocationsWithOfficeWithNameUpstreamLocations(requestParameters, initOverrides?): Promise<StreamLocation[]>
Returns matching upstream stream locations. Get streamLocations with office with name upstreamLocations
Parameters
- requestParameters: GetStreamLocationsWithOfficeWithNameUpstreamLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<StreamLocation[]>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:371

getStreamLocationsWithOfficeWithNameUpstreamLocationsRaw

getStreamLocationsWithOfficeWithNameUpstreamLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<StreamLocation[]>>
Returns matching upstream stream locations. Get streamLocations with office with name upstreamLocations
Parameters
- requestParameters: GetStreamLocationsWithOfficeWithNameUpstreamLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<StreamLocation[]>>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:320

patchStreamLocationsWithName

patchStreamLocationsWithName(requestParameters, initOverrides?): Promise<void>
Update CWMS Stream Location Patch streamLocations with name
Parameters
- requestParameters: PatchStreamLocationsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:414

patchStreamLocationsWithNameRaw

patchStreamLocationsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update CWMS Stream Location Patch streamLocations with name
Parameters
- requestParameters: PatchStreamLocationsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:380

postStreamLocations

postStreamLocations(requestParameters, initOverrides?): Promise<void>
Create CWMS Stream Location Post streamLocations
Parameters
- requestParameters: PostStreamLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:456

postStreamLocationsRaw

postStreamLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Stream Location Post streamLocations
Parameters
- requestParameters: PostStreamLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/StreamLocationsApi.ts:422

`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

Class StreamLocationsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StreamLocationsApi

Properties

Protected configuration

Methods

deleteStreamLocationsWithName

Parameters

Returns Promise<void>

deleteStreamLocationsWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

getStreamLocations

Parameters

Returns Promise<StreamLocation[]>

getStreamLocationsRaw

Parameters

Returns Promise<ApiResponse<StreamLocation[]>>

getStreamLocationsWithName

Parameters

Returns Promise<StreamLocation[]>

getStreamLocationsWithNameRaw

Parameters

Returns Promise<ApiResponse<StreamLocation[]>>

getStreamLocationsWithOfficeWithNameDownstreamLocations

Parameters

Returns Promise<StreamLocation[]>

getStreamLocationsWithOfficeWithNameDownstreamLocationsRaw

Parameters

Returns Promise<ApiResponse<StreamLocation[]>>

getStreamLocationsWithOfficeWithNameUpstreamLocations

Parameters

Returns Promise<StreamLocation[]>

getStreamLocationsWithOfficeWithNameUpstreamLocationsRaw

Parameters

Returns Promise<ApiResponse<StreamLocation[]>>

patchStreamLocationsWithName

Parameters

Returns Promise<void>

patchStreamLocationsWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

postStreamLocations

Parameters

Returns Promise<void>

postStreamLocationsRaw

Parameters

Returns Promise<ApiResponse<void>>

Protected request

Parameters

Returns Promise<Response>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Protected` request