cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
91 lines (90 loc) • 3.1 kB
TypeScript
/**
* CWMS Data API
* CWMS REST API for Data Retrieval
*
* The version of the OpenAPI document: 2.4.0-2026.3.16
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import { CwmsIdTimeExtentsEntry, Measurement } from '../models';
export interface DeleteMeasurementsWithLocationIdRequest {
locationId: string;
office: string;
begin: string;
end: string;
timezone?: string;
minNumber?: string;
maxNumber?: string;
}
export interface GetMeasurementsRequest {
officeMask?: string;
idMask?: string;
minNumber?: string;
maxNumber?: string;
begin?: string;
end?: string;
timezone?: string;
minHeight?: string;
maxHeight?: string;
minFlow?: string;
maxFlow?: string;
agency?: string;
quality?: string;
unitSystem?: string;
}
export interface GetMeasurementsTimeExtentsRequest {
officeMask?: string;
}
export interface PostMeasurementsRequest {
measurement: Array<Measurement>;
failIfExists?: boolean;
}
/**
*
*/
export declare class MeasurementsApi extends runtime.BaseAPI {
/**
* Delete an existing measurement.
* Delete measurements with locationId
*/
deleteMeasurementsWithLocationIdRaw(requestParameters: DeleteMeasurementsWithLocationIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Delete an existing measurement.
* Delete measurements with locationId
*/
deleteMeasurementsWithLocationId(requestParameters: DeleteMeasurementsWithLocationIdRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Returns matching measurement data.
* Get measurements
*/
getMeasurementsRaw(requestParameters: GetMeasurementsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Measurement>>>;
/**
* Returns matching measurement data.
* Get measurements
*/
getMeasurements(requestParameters?: GetMeasurementsRequest, initOverrides?: RequestInit): Promise<Array<Measurement>>;
/**
* Returns matching downstream stream locations.
* Get measurements timeExtents
*/
getMeasurementsTimeExtentsRaw(requestParameters: GetMeasurementsTimeExtentsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<CwmsIdTimeExtentsEntry>>>;
/**
* Returns matching downstream stream locations.
* Get measurements timeExtents
*/
getMeasurementsTimeExtents(requestParameters?: GetMeasurementsTimeExtentsRequest, initOverrides?: RequestInit): Promise<Array<CwmsIdTimeExtentsEntry>>;
/**
* Create new measurement(s).
* Post measurements
*/
postMeasurementsRaw(requestParameters: PostMeasurementsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Create new measurement(s).
* Post measurements
*/
postMeasurements(requestParameters: PostMeasurementsRequest, initOverrides?: RequestInit): Promise<void>;
}