cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
94 lines (93 loc) • 3.19 kB
TypeScript
/**
* 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.
*/
/**
*
* @export
* @interface RateInputTimeSeries
*/
export interface RateInputTimeSeries {
/**
* The units of the output values
* @type {string}
* @memberof RateInputTimeSeries
*/
outputUnit: string;
/**
* A specific date/time to use as the "current time" of the rating. No ratings with a create date later than this will be used. Useful for performing historical ratings. If not specified or NULL, the current time is use.
* @type {number}
* @memberof RateInputTimeSeries
*/
ratingTime?: number;
/**
* A flag specifying whether to round the rated values according to the rounding spec contained in the rating specification. Defaults to false.
* @type {boolean}
* @memberof RateInputTimeSeries
*/
round?: boolean;
/**
*
* @type {Array<string>}
* @memberof RateInputTimeSeries
*/
timeSeriesIds: Array<string>;
/**
* The start of the time window to rate.Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.
* @type {number}
* @memberof RateInputTimeSeries
*/
startTime: number;
/**
* The end of the time window to rate.Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.
* @type {number}
* @memberof RateInputTimeSeries
*/
endTime: number;
/**
* Specifies the version date of the retrieve time series. Represents milliseconds since 1970-01-01 (Unix Epoch), always UTC.
* @type {number}
* @memberof RateInputTimeSeries
*/
versionDate?: number;
/**
* Specifies whether to trim missing values from the ends of the retrieved time series. Defaults to false.
* @type {boolean}
* @memberof RateInputTimeSeries
*/
trim?: boolean;
/**
* Specifies whether the time window starts on or after the specified time. Defaults to true.
* @type {boolean}
* @memberof RateInputTimeSeries
*/
startInclusive?: boolean;
/**
* Specifies whether the time window ends on or before the specified time. Defaults to true;
* @type {boolean}
* @memberof RateInputTimeSeries
*/
endInclusive?: boolean;
/**
* Specifies whether to retrieve the latest value before the start of the time window. Defaults to false.
* @type {boolean}
* @memberof RateInputTimeSeries
*/
previous?: boolean;
/**
* Specifies whether to retrieve the earliest value after the end of the time window. Defaults to false.
* @type {boolean}
* @memberof RateInputTimeSeries
*/
next?: boolean;
}
export declare function RateInputTimeSeriesFromJSON(json: any): RateInputTimeSeries;
export declare function RateInputTimeSeriesFromJSONTyped(json: any, ignoreDiscriminator: boolean): RateInputTimeSeries;
export declare function RateInputTimeSeriesToJSON(value?: RateInputTimeSeries | null): any;