cwmsjs/dist/apis/ForecastApi.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.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, ForecastInstance, ForecastSpec } from '../models/index';
export interface DeleteForecastInstanceWithNameRequest {
    name: string;
    forecastDate: string;
    issueDate: string;
    office: string;
    designator: string;
}
export interface DeleteForecastSpecWithNameRequest {
    name: string;
    office: string;
    designator: string;
    method?: DeleteMethod;
}
export interface GetForecastInstanceRequest {
    office?: string;
    name?: string;
    designator?: string;
}
export interface GetForecastInstanceWithNameRequest {
    name: string;
    forecastDate: string;
    issueDate: string;
    office: string;
    designator: string;
}
export interface GetForecastInstanceWithNameFileDataRequest {
    name: string;
    forecastDate: string;
    issueDate: string;
    office: string;
    designator: string;
}
export interface GetForecastSpecRequest {
    office?: string;
    idMask?: string;
    designatorMask?: string;
    sourceEntity?: string;
}
export interface GetForecastSpecWithNameRequest {
    name: string;
    office: string;
    designator: string;
}
export interface PatchForecastInstanceWithNameRequest {
    name: string;
    forecastInstance: ForecastInstance;
}
export interface PatchForecastSpecWithNameRequest {
    name: string;
    forecastSpec: ForecastSpec;
}
export interface PostForecastInstanceRequest {
    forecastInstance: ForecastInstance;
}
export interface PostForecastSpecRequest {
    forecastSpec: ForecastSpec;
}
/**
 *
 */
export declare class ForecastApi extends runtime.BaseAPI {
    /**
     * Used to delete forecast instance data based on unique fields
     * Delete cwmsData forecastInstance with name
     */
    deleteForecastInstanceWithNameRaw(requestParameters: DeleteForecastInstanceWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Used to delete forecast instance data based on unique fields
     * Delete cwmsData forecastInstance with name
     */
    deleteForecastInstanceWithName(requestParameters: DeleteForecastInstanceWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Used to delete forecast spec data based on unique fields
     * Delete cwmsData forecastSpec with name
     */
    deleteForecastSpecWithNameRaw(requestParameters: DeleteForecastSpecWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Used to delete forecast spec data based on unique fields
     * Delete cwmsData forecastSpec with name
     */
    deleteForecastSpecWithName(requestParameters: DeleteForecastSpecWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Used to get all forecast instances for a given forecast spec
     * Get cwmsData forecastInstance
     */
    getForecastInstanceRaw(requestParameters: GetForecastInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ForecastInstance>>;
    /**
     * Used to get all forecast instances for a given forecast spec
     * Get cwmsData forecastInstance
     */
    getForecastInstance(requestParameters?: GetForecastInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ForecastInstance>;
    /**
     * Used to get all forecast instances for a given forecast spec
     * Get cwmsData forecastInstance with name
     */
    getForecastInstanceWithNameRaw(requestParameters: GetForecastInstanceWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ForecastInstance>>;
    /**
     * Used to get all forecast instances for a given forecast spec
     * Get cwmsData forecastInstance with name
     */
    getForecastInstanceWithName(requestParameters: GetForecastInstanceWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ForecastInstance>;
    /**
     * Used to download forecast file for the given parameters
     * Get cwmsData forecastInstance with name fileData
     */
    getForecastInstanceWithNameFileDataRaw(requestParameters: GetForecastInstanceWithNameFileDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
    /**
     * Used to download forecast file for the given parameters
     * Get cwmsData forecastInstance with name fileData
     */
    getForecastInstanceWithNameFileData(requestParameters: GetForecastInstanceWithNameFileDataRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
    /**
     * Used to query multiple forecast specs
     * Get cwmsData forecastSpec
     */
    getForecastSpecRaw(requestParameters: GetForecastSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ForecastSpec>>;
    /**
     * Used to query multiple forecast specs
     * Get cwmsData forecastSpec
     */
    getForecastSpec(requestParameters?: GetForecastSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ForecastSpec>;
    /**
     * Used to query a single forecast spec record
     * Get cwmsData forecastSpec with name
     */
    getForecastSpecWithNameRaw(requestParameters: GetForecastSpecWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ForecastSpec>>;
    /**
     * Used to query a single forecast spec record
     * Get cwmsData forecastSpec with name
     */
    getForecastSpecWithName(requestParameters: GetForecastSpecWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ForecastSpec>;
    /**
     * Update a forecast instance with new max age, notes, forecast fileand forecast info key/value pairs.
     * Patch cwmsData forecastInstance with name
     */
    patchForecastInstanceWithNameRaw(requestParameters: PatchForecastInstanceWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Update a forecast instance with new max age, notes, forecast fileand forecast info key/value pairs.
     * Patch cwmsData forecastInstance with name
     */
    patchForecastInstanceWithName(requestParameters: PatchForecastInstanceWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Update a forecast spec with provided values
     * Patch cwmsData forecastSpec with name
     */
    patchForecastSpecWithNameRaw(requestParameters: PatchForecastSpecWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Update a forecast spec with provided values
     * Patch cwmsData forecastSpec with name
     */
    patchForecastSpecWithName(requestParameters: PatchForecastSpecWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Used to create and save a forecast instance
     * Post cwmsData forecastInstance
     */
    postForecastInstanceRaw(requestParameters: PostForecastInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Used to create and save a forecast instance
     * Post cwmsData forecastInstance
     */
    postForecastInstance(requestParameters: PostForecastInstanceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Used to create and save forecast spec data
     * Post cwmsData forecastSpec
     */
    postForecastSpecRaw(requestParameters: PostForecastSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Used to create and save forecast spec data
     * Post cwmsData forecastSpec
     */
    postForecastSpec(requestParameters: PostForecastSpecRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}