cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
95 lines (94 loc) • 3.78 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 { StreamReach } from '../models/index';
export interface DeleteStreamReachesWithNameRequest {
name: string;
office: string;
}
export interface GetStreamReachesRequest {
officeMask?: string;
streamIdMask?: string;
reachIdMask?: string;
configurationIdMask?: string;
stationUnit?: string;
}
export interface GetStreamReachesWithNameRequest {
name: string;
office: string;
streamId: string;
stationUnit?: string;
}
export interface PatchStreamReachesWithNameRequest {
name: string;
name2: string;
office: string;
}
export interface PostStreamReachesRequest {
streamReach: StreamReach;
failIfExists?: boolean;
}
/**
*
*/
export declare class StreamReachesApi extends runtime.BaseAPI {
/**
* Delete CWMS Stream Reach
* Delete cwmsData streamReaches with name
*/
deleteStreamReachesWithNameRaw(requestParameters: DeleteStreamReachesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Delete CWMS Stream Reach
* Delete cwmsData streamReaches with name
*/
deleteStreamReachesWithName(requestParameters: DeleteStreamReachesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Returns matching CWMS Stream Reach Data for a Reservoir Project.
* Get cwmsData streamReaches
*/
getStreamReachesRaw(requestParameters: GetStreamReachesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StreamReach>>>;
/**
* Returns matching CWMS Stream Reach Data for a Reservoir Project.
* Get cwmsData streamReaches
*/
getStreamReaches(requestParameters?: GetStreamReachesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StreamReach>>;
/**
* Returns CWMS Stream Reach Data
* Get cwmsData streamReaches with name
*/
getStreamReachesWithNameRaw(requestParameters: GetStreamReachesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<StreamReach>>>;
/**
* Returns CWMS Stream Reach Data
* Get cwmsData streamReaches with name
*/
getStreamReachesWithName(requestParameters: GetStreamReachesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<StreamReach>>;
/**
* Rename CWMS Stream Reach
* Patch cwmsData streamReaches with name
*/
patchStreamReachesWithNameRaw(requestParameters: PatchStreamReachesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Rename CWMS Stream Reach
* Patch cwmsData streamReaches with name
*/
patchStreamReachesWithName(requestParameters: PatchStreamReachesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Create CWMS Stream Reach
* Post cwmsData streamReaches
*/
postStreamReachesRaw(requestParameters: PostStreamReachesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Create CWMS Stream Reach
* Post cwmsData streamReaches
*/
postStreamReaches(requestParameters: PostStreamReachesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}