cwmsjs/dist/apis/StreamsApi.d.ts

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

/**
 * 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 { DeleteMethod, Stream } from '../models';
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 streams with name
     */
    deleteStreamsWithNameRaw(requestParameters: DeleteStreamsWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete CWMS Stream
     * Delete streams with name
     */
    deleteStreamsWithName(requestParameters: DeleteStreamsWithNameRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Returns matching CWMS Stream Data for a Reservoir Project.
     * Get streams
     */
    getStreamsRaw(requestParameters: GetStreamsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Stream>>>;
    /**
     * Returns matching CWMS Stream Data for a Reservoir Project.
     * Get streams
     */
    getStreams(requestParameters?: GetStreamsRequest, initOverrides?: RequestInit): Promise<Array<Stream>>;
    /**
     * Returns CWMS Stream Data
     * Get streams with name
     */
    getStreamsWithNameRaw(requestParameters: GetStreamsWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Stream>>>;
    /**
     * Returns CWMS Stream Data
     * Get streams with name
     */
    getStreamsWithName(requestParameters: GetStreamsWithNameRequest, initOverrides?: RequestInit): Promise<Array<Stream>>;
    /**
     * Rename CWMS Stream
     * Patch streams with name
     */
    patchStreamsWithNameRaw(requestParameters: PatchStreamsWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Rename CWMS Stream
     * Patch streams with name
     */
    patchStreamsWithName(requestParameters: PatchStreamsWithNameRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Create CWMS Stream
     * Post streams
     */
    postStreamsRaw(requestParameters: PostStreamsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Create CWMS Stream
     * Post streams
     */
    postStreams(requestParameters: PostStreamsRequest, initOverrides?: RequestInit): Promise<void>;
}