Class MeasurementsApi

Hierarchy (view full)

BaseAPI
- MeasurementsApi

Index

Constructors

Properties

Methods

deleteMeasurementsWithLocationId deleteMeasurementsWithLocationIdRaw getMeasurements getMeasurementsRaw getMeasurementsTimeExtents getMeasurementsTimeExtentsRaw postMeasurements postMeasurementsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteMeasurementsWithLocationId

deleteMeasurementsWithLocationId(requestParameters, initOverrides?): Promise<void>
Delete an existing measurement. Delete measurements with locationId
Parameters
- requestParameters: DeleteMeasurementsWithLocationIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:137

deleteMeasurementsWithLocationIdRaw

deleteMeasurementsWithLocationIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete an existing measurement. Delete measurements with locationId
Parameters
- requestParameters: DeleteMeasurementsWithLocationIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:74

getMeasurements

getMeasurements(requestParameters?, initOverrides?): Promise<Measurement[]>
Returns matching measurement data. Get measurements
Parameters
- requestParameters: GetMeasurementsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Measurement[]>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:224

getMeasurementsRaw

getMeasurementsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Measurement[]>>
Returns matching measurement data. Get measurements
Parameters
- requestParameters: GetMeasurementsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Measurement[]>>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:145

getMeasurementsTimeExtents

getMeasurementsTimeExtents(requestParameters?, initOverrides?): Promise<CwmsIdTimeExtentsEntry[]>
Returns matching downstream stream locations. Get measurements timeExtents
Parameters
- requestParameters: GetMeasurementsTimeExtentsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<CwmsIdTimeExtentsEntry[]>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:260

getMeasurementsTimeExtentsRaw

getMeasurementsTimeExtentsRaw(requestParameters, initOverrides?): Promise<ApiResponse<CwmsIdTimeExtentsEntry[]>>
Returns matching downstream stream locations. Get measurements timeExtents
Parameters
- requestParameters: GetMeasurementsTimeExtentsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<CwmsIdTimeExtentsEntry[]>>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:233

postMeasurements

postMeasurements(requestParameters, initOverrides?): Promise<void>
Create new measurement(s). Post measurements
Parameters
- requestParameters: PostMeasurementsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:303

postMeasurementsRaw

postMeasurementsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new measurement(s). Post measurements
Parameters
- requestParameters: PostMeasurementsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/MeasurementsApi.ts:269

`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