Class StreamLocationsApi

Hierarchy (view full)

BaseAPI
- StreamLocationsApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteStreamLocationsWithName

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

deleteStreamLocationsWithNameRaw

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

getStreamLocations

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

getStreamLocationsRaw

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

getStreamLocationsWithName

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

getStreamLocationsWithNameRaw

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

getStreamLocationsWithOfficeWithNameDownstreamLocations

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

getStreamLocationsWithOfficeWithNameDownstreamLocationsRaw

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

getStreamLocationsWithOfficeWithNameUpstreamLocations

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

getStreamLocationsWithOfficeWithNameUpstreamLocationsRaw

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

`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

patchStreamLocationsWithName

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

patchStreamLocationsWithNameRaw

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

postStreamLocations

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

postStreamLocationsRaw

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

`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

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[]>>

Protected isJsonMime

Parameters

Returns boolean

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` isJsonMime

`Protected` request