cwmsjs/dist/apis/StreamLocationsApi.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 { StreamLocation } from '../models';
export interface DeleteStreamLocationsWithNameRequest {
    name: string;
    office: string;
    streamId: string;
}
export interface GetStreamLocationsRequest {
    officeMask?: string;
    streamIdMask?: string;
    nameMask?: string;
    stationUnit?: string;
    stageUnit?: string;
    areaUnit?: string;
}
export interface GetStreamLocationsWithNameRequest {
    name: string;
    office: string;
    streamId: string;
    stationUnit?: string;
    stageUnit?: string;
    areaUnit?: string;
}
export interface GetStreamLocationsWithOfficeWithNameDownstreamLocationsRequest {
    office: string;
    name: string;
    allDownstream?: boolean;
    sameStreamOnly?: boolean;
    stationUnit?: string;
    stageUnit?: string;
    areaUnit?: string;
}
export interface GetStreamLocationsWithOfficeWithNameUpstreamLocationsRequest {
    office: string;
    name: string;
    allUpstream?: boolean;
    sameStreamOnly?: boolean;
    stationUnit?: string;
    stageUnit?: string;
    areaUnit?: string;
}
export interface PatchStreamLocationsWithNameRequest {
    name: string;
    streamLocation: StreamLocation;
}
export interface PostStreamLocationsRequest {
    streamLocation: StreamLocation;
    failIfExists?: boolean;
}
/**
 *
 */
export declare class StreamLocationsApi extends runtime.BaseAPI {
    /**
     * Delete CWMS Stream Location
     * Delete streamLocations with name
     */
    deleteStreamLocationsWithNameRaw(requestParameters: DeleteStreamLocationsWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete CWMS Stream Location
     * Delete streamLocations with name
     */
    deleteStreamLocationsWithName(requestParameters: DeleteStreamLocationsWithNameRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Returns matching CWMS Stream Location Data for a Reservoir Project.
     * Get streamLocations
     */
    getStreamLocationsRaw(requestParameters: GetStreamLocationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<StreamLocation>>>;
    /**
     * Returns matching CWMS Stream Location Data for a Reservoir Project.
     * Get streamLocations
     */
    getStreamLocations(requestParameters?: GetStreamLocationsRequest, initOverrides?: RequestInit): Promise<Array<StreamLocation>>;
    /**
     * Returns CWMS Stream Location Data
     * Get streamLocations with name
     */
    getStreamLocationsWithNameRaw(requestParameters: GetStreamLocationsWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<StreamLocation>>>;
    /**
     * Returns CWMS Stream Location Data
     * Get streamLocations with name
     */
    getStreamLocationsWithName(requestParameters: GetStreamLocationsWithNameRequest, initOverrides?: RequestInit): Promise<Array<StreamLocation>>;
    /**
     * Returns matching downstream stream locations.
     * Get streamLocations with office with name downstreamLocations
     */
    getStreamLocationsWithOfficeWithNameDownstreamLocationsRaw(requestParameters: GetStreamLocationsWithOfficeWithNameDownstreamLocationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<StreamLocation>>>;
    /**
     * Returns matching downstream stream locations.
     * Get streamLocations with office with name downstreamLocations
     */
    getStreamLocationsWithOfficeWithNameDownstreamLocations(requestParameters: GetStreamLocationsWithOfficeWithNameDownstreamLocationsRequest, initOverrides?: RequestInit): Promise<Array<StreamLocation>>;
    /**
     * Returns matching upstream stream locations.
     * Get streamLocations with office with name upstreamLocations
     */
    getStreamLocationsWithOfficeWithNameUpstreamLocationsRaw(requestParameters: GetStreamLocationsWithOfficeWithNameUpstreamLocationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<StreamLocation>>>;
    /**
     * Returns matching upstream stream locations.
     * Get streamLocations with office with name upstreamLocations
     */
    getStreamLocationsWithOfficeWithNameUpstreamLocations(requestParameters: GetStreamLocationsWithOfficeWithNameUpstreamLocationsRequest, initOverrides?: RequestInit): Promise<Array<StreamLocation>>;
    /**
     * Update CWMS Stream Location
     * Patch streamLocations with name
     */
    patchStreamLocationsWithNameRaw(requestParameters: PatchStreamLocationsWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Update CWMS Stream Location
     * Patch streamLocations with name
     */
    patchStreamLocationsWithName(requestParameters: PatchStreamLocationsWithNameRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Create CWMS Stream Location
     * Post streamLocations
     */
    postStreamLocationsRaw(requestParameters: PostStreamLocationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Create CWMS Stream Location
     * Post streamLocations
     */
    postStreamLocations(requestParameters: PostStreamLocationsRequest, initOverrides?: RequestInit): Promise<void>;
}