cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
95 lines (94 loc) • 3.5 kB
TypeScript
/**
* CWMS Data API
* CWMS REST API for Data Retrieval
*
* The version of the OpenAPI document: 2.3.2-2025.03.19
*
*
* 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 type { DeleteMethod, Stream } from '../models/index';
export interface DeleteStreamsWithNameRequest {
name: string;
office: string;
method?: DeleteMethod;
}
export interface GetStreamsRequest {
officeMask?: string;
streamIdMask?: string;
divertsFromStreamIdMask?: string;
flowsIntoStreamIdMask?: string;
stationUnit?: string;
}
export interface GetStreamsWithNameRequest {
name: string;
office: string;
stationUnit?: string;
}
export interface PatchStreamsWithNameRequest {
name: string;
name2: string;
office: string;
}
export interface PostStreamsRequest {
stream: Stream;
failIfExists?: boolean;
}
/**
*
*/
export declare class StreamsApi extends runtime.BaseAPI {
/**
* Delete CWMS Stream
* Delete cwmsData streams with name
*/
deleteStreamsWithNameRaw(requestParameters: DeleteStreamsWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Delete CWMS Stream
* Delete cwmsData streams with name
*/
deleteStreamsWithName(requestParameters: DeleteStreamsWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Returns matching CWMS Stream Data for a Reservoir Project.
* Get cwmsData streams
*/
getStreamsRaw(requestParameters: GetStreamsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Stream>>>;
/**
* Returns matching CWMS Stream Data for a Reservoir Project.
* Get cwmsData streams
*/
getStreams(requestParameters?: GetStreamsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Stream>>;
/**
* Returns CWMS Stream Data
* Get cwmsData streams with name
*/
getStreamsWithNameRaw(requestParameters: GetStreamsWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Stream>>>;
/**
* Returns CWMS Stream Data
* Get cwmsData streams with name
*/
getStreamsWithName(requestParameters: GetStreamsWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Stream>>;
/**
* Rename CWMS Stream
* Patch cwmsData streams with name
*/
patchStreamsWithNameRaw(requestParameters: PatchStreamsWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Rename CWMS Stream
* Patch cwmsData streams with name
*/
patchStreamsWithName(requestParameters: PatchStreamsWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Create CWMS Stream
* Post cwmsData streams
*/
postStreamsRaw(requestParameters: PostStreamsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Create CWMS Stream
* Post cwmsData streams
*/
postStreams(requestParameters: PostStreamsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}