cwmsjs/dist/models/SeasonalLocationLevel.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 { Alias } from './Alias';
import { SeasonalValueBean } from './SeasonalValueBean';
/**
 *
 * @export
 * @interface SeasonalLocationLevel
 */
export interface SeasonalLocationLevel {
    /**
     * Owning office of object.
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    officeId: string;
    /**
     * Name of the location level
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    locationLevelId: string;
    /**
     * TimeSeries ID (e.g. from the times series catalog) to use as the location level. Mutually exclusive with seasonalValues and siParameterUnitsConstantValue
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    specifiedLevelId?: string;
    /**
     * The expiration date of the location level.
     * @type {Date}
     * @memberof SeasonalLocationLevel
     */
    expirationDate?: Date;
    /**
     * Data Type such as Stage, Elevation, or others.
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    parameterId?: string;
    /**
     * To indicate if single or aggregate value
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    parameterTypeId?: SeasonalLocationLevelParameterTypeIdEnum;
    /**
     * Indicating whether or not to interpolate between seasonal values.
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    interpolateString?: SeasonalLocationLevelInterpolateStringEnum;
    /**
     * Units the provided levels are in
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    levelUnitsId?: string;
    /**
     * The date/time at which this location level configuration takes effect.
     * @type {Date}
     * @memberof SeasonalLocationLevel
     */
    levelDate?: Date;
    /**
     *
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    levelComment?: string;
    /**
     * 0 if parameterTypeId is Inst. Otherwise duration indicating the time window of the aggregate value.
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    durationId?: string;
    /**
     *
     * @type {number}
     * @memberof SeasonalLocationLevel
     */
    attributeValue?: number;
    /**
     *
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    attributeUnitsId?: string;
    /**
     *
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    attributeParameterTypeId?: string;
    /**
     *
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    attributeParameterId?: string;
    /**
     *
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    attributeDurationId?: string;
    /**
     *
     * @type {string}
     * @memberof SeasonalLocationLevel
     */
    attributeComment?: string;
    /**
     *
     * @type {Array<Alias>}
     * @memberof SeasonalLocationLevel
     */
    aliases?: Array<Alias>;
    /**
     * The start point of provided seasonal values
     * @type {Date}
     * @memberof SeasonalLocationLevel
     */
    intervalOrigin?: Date;
    /**
     *
     * @type {number}
     * @memberof SeasonalLocationLevel
     */
    intervalMonths?: number;
    /**
     *
     * @type {number}
     * @memberof SeasonalLocationLevel
     */
    intervalMinutes?: number;
    /**
     * List of Repeating seasonal values. The values repeat after the specified interval. A yearly interval seasonable could have 12 different values, one for each month for example. Mutually exclusive with seasonalTimeSeriesId and siParameterUnitsConstantValue
     * @type {Array<SeasonalValueBean>}
     * @memberof SeasonalLocationLevel
     */
    seasonalValues?: Array<SeasonalValueBean>;
}
/**
* @export
* @enum {string}
*/
export declare enum SeasonalLocationLevelParameterTypeIdEnum {
    Inst = "Inst",
    Ave = "Ave",
    Min = "Min",
    Max = "Max",
    Total = "Total"
} /**
* @export
* @enum {string}
*/
export declare enum SeasonalLocationLevelInterpolateStringEnum {
    T = "T",
    F = "F"
}
export declare function SeasonalLocationLevelFromJSON(json: any): SeasonalLocationLevel;
export declare function SeasonalLocationLevelFromJSONTyped(json: any, ignoreDiscriminator: boolean): SeasonalLocationLevel;
export declare function SeasonalLocationLevelToJSON(value?: SeasonalLocationLevel | null): any;