cwmsjs/src/models/TextTimeSeries.ts

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

/* tslint:disable */
/* eslint-disable */
/**
 * 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 { exists, mapValues } from '../runtime';
import {
    RegularTextTimeSeriesRow,
    RegularTextTimeSeriesRowFromJSON,
    RegularTextTimeSeriesRowFromJSONTyped,
    RegularTextTimeSeriesRowToJSON,
} from './RegularTextTimeSeriesRow';

/**
 * 
 * @export
 * @interface TextTimeSeries
 */
export interface TextTimeSeries {
    /**
     * Owning office of object.
     * @type {string}
     * @memberof TextTimeSeries
     */
    officeId: string;
    /**
     * 
     * @type {string}
     * @memberof TextTimeSeries
     */
    name?: string;
    /**
     * 
     * @type {number}
     * @memberof TextTimeSeries
     */
    intervalOffset?: number;
    /**
     * 
     * @type {string}
     * @memberof TextTimeSeries
     */
    timeZone?: string;
    /**
     * Version type specifies the type of timeseries 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 TextTimeSeries
     */
    dateVersionType?: TextTimeSeriesDateVersionTypeEnum;
    /**
     * The version date of the time series trace
     * @type {Date}
     * @memberof TextTimeSeries
     */
    versionDate?: Date;
    /**
     * 
     * @type {Array<RegularTextTimeSeriesRow>}
     * @memberof TextTimeSeries
     */
    regularTextValues?: Array<RegularTextTimeSeriesRow>;
}

/**
* @export
* @enum {string}
*/
export enum TextTimeSeriesDateVersionTypeEnum {
    MaxAggregate = 'MAX_AGGREGATE',
    SingleVersion = 'SINGLE_VERSION',
    Unversioned = 'UNVERSIONED'
}

export function TextTimeSeriesFromJSON(json: any): TextTimeSeries {
    return TextTimeSeriesFromJSONTyped(json, false);
}

export function TextTimeSeriesFromJSONTyped(json: any, ignoreDiscriminator: boolean): TextTimeSeries {
    if ((json === undefined) || (json === null)) {
        return json;
    }
    return {
        
        'officeId': json['office-id'],
        'name': !exists(json, 'name') ? undefined : json['name'],
        'intervalOffset': !exists(json, 'interval-offset') ? undefined : json['interval-offset'],
        'timeZone': !exists(json, 'time-zone') ? undefined : json['time-zone'],
        'dateVersionType': !exists(json, 'date-version-type') ? undefined : json['date-version-type'],
        'versionDate': !exists(json, 'version-date') ? undefined : (new Date(json['version-date'])),
        'regularTextValues': !exists(json, 'regular-text-values') ? undefined : ((json['regular-text-values'] as Array<any>).map(RegularTextTimeSeriesRowFromJSON)),
    };
}

export function TextTimeSeriesToJSON(value?: TextTimeSeries | null): any {
    if (value === undefined) {
        return undefined;
    }
    if (value === null) {
        return null;
    }
    return {
        
        'office-id': value.officeId,
        'name': value.name,
        'interval-offset': value.intervalOffset,
        'time-zone': value.timeZone,
        'date-version-type': value.dateVersionType,
        'version-date': value.versionDate === undefined ? undefined : (value.versionDate.toISOString()),
        'regular-text-values': value.regularTextValues === undefined ? undefined : ((value.regularTextValues as Array<any>).map(RegularTextTimeSeriesRowToJSON)),
    };
}