cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
78 lines (77 loc) • 2.27 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 { BinaryTimeSeriesRow } from './BinaryTimeSeriesRow';
/**
*
* @export
* @interface BinaryTimeSeries
*/
export interface BinaryTimeSeries {
/**
* Owning office of object.
* @type {string}
* @memberof BinaryTimeSeries
*/
officeId: string;
/**
*
* @type {string}
* @memberof BinaryTimeSeries
*/
name?: string;
/**
*
* @type {number}
* @memberof BinaryTimeSeries
*/
intervalOffset?: number;
/**
*
* @type {string}
* @memberof BinaryTimeSeries
*/
timeZone?: string;
/**
* 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 BinaryTimeSeries
*/
dateVersionType?: BinaryTimeSeriesDateVersionTypeEnum;
/**
* The version date of the time series trace
* @type {Date}
* @memberof BinaryTimeSeries
*/
versionDate?: Date;
/**
*
* @type {Array<BinaryTimeSeriesRow>}
* @memberof BinaryTimeSeries
*/
binaryValues?: Array<BinaryTimeSeriesRow>;
}
/**
* @export
*/
export declare const BinaryTimeSeriesDateVersionTypeEnum: {
readonly MaxAggregate: "MAX_AGGREGATE";
readonly SingleVersion: "SINGLE_VERSION";
readonly Unversioned: "UNVERSIONED";
};
export type BinaryTimeSeriesDateVersionTypeEnum = typeof BinaryTimeSeriesDateVersionTypeEnum[keyof typeof BinaryTimeSeriesDateVersionTypeEnum];
/**
* Check if a given object implements the BinaryTimeSeries interface.
*/
export declare function instanceOfBinaryTimeSeries(value: object): boolean;
export declare function BinaryTimeSeriesFromJSON(json: any): BinaryTimeSeries;
export declare function BinaryTimeSeriesFromJSONTyped(json: any, ignoreDiscriminator: boolean): BinaryTimeSeries;
export declare function BinaryTimeSeriesToJSON(value?: BinaryTimeSeries | null): any;