cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
140 lines (139 loc) • 4.04 kB
TypeScript
/**
* 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 type { TimeSeriesColumn } from './TimeSeriesColumn';
import type { TimeSeriesInterval } from './TimeSeriesInterval';
import type { VerticalDatumInfo } from './VerticalDatumInfo';
/**
*
* @export
* @interface TimeSeries
*/
export interface TimeSeries {
/**
* The requested start time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')
* @type {Date}
* @memberof TimeSeries
*/
readonly begin?: Date;
/**
* Version type specifies the type of time-series response to be received. Can be max aggregate or single version. Max aggregate cannot be run if version date field is specified.
* @type {string}
* @memberof TimeSeries
*/
dateVersionType?: TimeSeriesDateVersionTypeEnum;
/**
* The requested end time of the data, in ISO-8601 format with offset and timezone ('yyyy-MM-dd'T'HH:mm:ssZ'['VV']'')
* @type {Date}
* @memberof TimeSeries
*/
readonly end?: Date;
/**
*
* @type {TimeSeriesInterval}
* @memberof TimeSeries
*/
interval?: TimeSeriesInterval;
/**
* Offset from top of interval
* @type {number}
* @memberof TimeSeries
*/
readonly intervalOffset?: number;
/**
* Time-series name
* @type {string}
* @memberof TimeSeries
*/
name?: string;
/**
* The cursor to the next page of data; null if there is no more data
* @type {string}
* @memberof TimeSeries
*/
readonly nextPage?: string;
/**
* Office ID that owns the time-series
* @type {string}
* @memberof TimeSeries
*/
officeId?: string;
/**
* The cursor to the current page of data
* @type {string}
* @memberof TimeSeries
*/
readonly page?: string;
/**
* The number of records fetched per-page; this may be larger than the number of records actually retrieved
* @type {number}
* @memberof TimeSeries
*/
readonly pageSize?: number;
/**
* Only on 21.1.1 Database. The timezone the Interval Offset is from.
* @type {string}
* @memberof TimeSeries
*/
readonly timeZone?: string;
/**
* The total number of records retrieved; null or not present if not supported or unknown
* @type {number}
* @memberof TimeSeries
*/
readonly total?: number;
/**
* The units of the time series data
* @type {string}
* @memberof TimeSeries
*/
units: string;
/**
*
* @type {Array<TimeSeriesColumn>}
* @memberof TimeSeries
*/
readonly valueColumns?: Array<TimeSeriesColumn>;
/**
*
* @type {Array<Array<number>>}
* @memberof TimeSeries
*/
values?: Array<Array<number>>;
/**
* The version date of the time series trace
* @type {Date}
* @memberof TimeSeries
*/
versionDate?: Date;
/**
*
* @type {VerticalDatumInfo}
* @memberof TimeSeries
*/
verticalDatumInfo?: VerticalDatumInfo;
}
/**
* @export
*/
export declare const TimeSeriesDateVersionTypeEnum: {
readonly MaxAggregate: "MAX_AGGREGATE";
readonly SingleVersion: "SINGLE_VERSION";
readonly Unversioned: "UNVERSIONED";
};
export type TimeSeriesDateVersionTypeEnum = typeof TimeSeriesDateVersionTypeEnum[keyof typeof TimeSeriesDateVersionTypeEnum];
/**
* Check if a given object implements the TimeSeries interface.
*/
export declare function instanceOfTimeSeries(value: object): boolean;
export declare function TimeSeriesFromJSON(json: any): TimeSeries;
export declare function TimeSeriesFromJSONTyped(json: any, ignoreDiscriminator: boolean): TimeSeries;
export declare function TimeSeriesToJSON(value?: TimeSeries | null): any;