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.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 { mapValues } from '../runtime';
import type { RegularTextTimeSeriesRow } from './RegularTextTimeSeriesRow';
import {
    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 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 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
 */
export const TextTimeSeriesDateVersionTypeEnum = {
    MaxAggregate: 'MAX_AGGREGATE',
    SingleVersion: 'SINGLE_VERSION',
    Unversioned: 'UNVERSIONED'
} as const;
export type TextTimeSeriesDateVersionTypeEnum = typeof TextTimeSeriesDateVersionTypeEnum[keyof typeof TextTimeSeriesDateVersionTypeEnum];


/**
 * Check if a given object implements the TextTimeSeries interface.
 */
export function instanceOfTextTimeSeries(value: object): boolean {
    if (!('officeId' in value)) return false;
    return true;
}

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

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

export function TextTimeSeriesToJSON(value?: TextTimeSeries | null): any {
    if (value == null) {
        return value;
    }
    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'] == null ? undefined : ((value['versionDate']).toISOString()),
        'regular-text-values': value['regularTextValues'] == null ? undefined : ((value['regularTextValues'] as Array<any>).map(RegularTextTimeSeriesRowToJSON)),
    };
}