cwmsjs/src/apis/TextTimeSeriesApi.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 * as runtime from '../runtime';
import {
    CdaError,
    CdaErrorFromJSON,
    CdaErrorToJSON,
    TextTimeSeries,
    TextTimeSeriesFromJSON,
    TextTimeSeriesToJSON,
} from '../models';

export interface DeleteTimeSeriesTextWithNameRequest {
    name: string;
    office: string;
    textMask: string;
    begin: string;
    end: string;
    timezone?: string;
    versionDate?: string;
}

export interface GetTimeSeriesTextRequest {
    office: string;
    name: string;
    begin: string;
    end: string;
    timezone?: string;
}

export interface GetTimeSeriesTextWithNameValueRequest {
    name: string;
    office: string;
    date: string;
    timezone?: string;
    versionDate?: string;
    clobId?: string;
}

export interface PatchTimeSeriesTextWithNameRequest {
    name: string;
    textTimeSeries: TextTimeSeries;
    replaceAll?: boolean;
}

export interface PostTimeSeriesTextRequest {
    textTimeSeries: TextTimeSeries;
    replaceAll?: boolean;
}

/**
 * 
 */
export class TextTimeSeriesApi extends runtime.BaseAPI {

    /**
     * Deletes requested text timeseries id
     * Delete timeseries text with name
     */
    async deleteTimeSeriesTextWithNameRaw(requestParameters: DeleteTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.name === null || requestParameters.name === undefined) {
            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling deleteTimeSeriesTextWithName.');
        }

        if (requestParameters.office === null || requestParameters.office === undefined) {
            throw new runtime.RequiredError('office','Required parameter requestParameters.office was null or undefined when calling deleteTimeSeriesTextWithName.');
        }

        if (requestParameters.textMask === null || requestParameters.textMask === undefined) {
            throw new runtime.RequiredError('textMask','Required parameter requestParameters.textMask was null or undefined when calling deleteTimeSeriesTextWithName.');
        }

        if (requestParameters.begin === null || requestParameters.begin === undefined) {
            throw new runtime.RequiredError('begin','Required parameter requestParameters.begin was null or undefined when calling deleteTimeSeriesTextWithName.');
        }

        if (requestParameters.end === null || requestParameters.end === undefined) {
            throw new runtime.RequiredError('end','Required parameter requestParameters.end was null or undefined when calling deleteTimeSeriesTextWithName.');
        }

        const queryParameters: any = {};

        if (requestParameters.office !== undefined) {
            queryParameters['office'] = requestParameters.office;
        }

        if (requestParameters.textMask !== undefined) {
            queryParameters['text-mask'] = requestParameters.textMask;
        }

        if (requestParameters.timezone !== undefined) {
            queryParameters['timezone'] = requestParameters.timezone;
        }

        if (requestParameters.begin !== undefined) {
            queryParameters['begin'] = requestParameters.begin;
        }

        if (requestParameters.end !== undefined) {
            queryParameters['end'] = requestParameters.end;
        }

        if (requestParameters.versionDate !== undefined) {
            queryParameters['version-date'] = requestParameters.versionDate;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
        }

        const response = await this.request({
            path: `/timeseries/text/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Deletes requested text timeseries id
     * Delete timeseries text with name
     */
    async deleteTimeSeriesTextWithName(requestParameters: DeleteTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<void> {
        await this.deleteTimeSeriesTextWithNameRaw(requestParameters, initOverrides);
    }

    /**
     * Retrieve text time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.
     */
    async getTimeSeriesTextRaw(requestParameters: GetTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TextTimeSeries>> {
        if (requestParameters.office === null || requestParameters.office === undefined) {
            throw new runtime.RequiredError('office','Required parameter requestParameters.office was null or undefined when calling getTimeSeriesText.');
        }

        if (requestParameters.name === null || requestParameters.name === undefined) {
            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling getTimeSeriesText.');
        }

        if (requestParameters.begin === null || requestParameters.begin === undefined) {
            throw new runtime.RequiredError('begin','Required parameter requestParameters.begin was null or undefined when calling getTimeSeriesText.');
        }

        if (requestParameters.end === null || requestParameters.end === undefined) {
            throw new runtime.RequiredError('end','Required parameter requestParameters.end was null or undefined when calling getTimeSeriesText.');
        }

        const queryParameters: any = {};

        if (requestParameters.office !== undefined) {
            queryParameters['office'] = requestParameters.office;
        }

        if (requestParameters.name !== undefined) {
            queryParameters['name'] = requestParameters.name;
        }

        if (requestParameters.timezone !== undefined) {
            queryParameters['timezone'] = requestParameters.timezone;
        }

        if (requestParameters.begin !== undefined) {
            queryParameters['begin'] = requestParameters.begin;
        }

        if (requestParameters.end !== undefined) {
            queryParameters['end'] = requestParameters.end;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
        }

        const response = await this.request({
            path: `/timeseries/text`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.JSONApiResponse(response, (jsonValue) => TextTimeSeriesFromJSON(jsonValue));
    }

    /**
     * Retrieve text time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.
     */
    async getTimeSeriesText(requestParameters: GetTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<TextTimeSeries> {
        const response = await this.getTimeSeriesTextRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Get timeseries text with name value
     */
    async getTimeSeriesTextWithNameValueRaw(requestParameters: GetTimeSeriesTextWithNameValueRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<string>> {
        if (requestParameters.name === null || requestParameters.name === undefined) {
            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling getTimeSeriesTextWithNameValue.');
        }

        if (requestParameters.office === null || requestParameters.office === undefined) {
            throw new runtime.RequiredError('office','Required parameter requestParameters.office was null or undefined when calling getTimeSeriesTextWithNameValue.');
        }

        if (requestParameters.date === null || requestParameters.date === undefined) {
            throw new runtime.RequiredError('date','Required parameter requestParameters.date was null or undefined when calling getTimeSeriesTextWithNameValue.');
        }

        const queryParameters: any = {};

        if (requestParameters.office !== undefined) {
            queryParameters['office'] = requestParameters.office;
        }

        if (requestParameters.timezone !== undefined) {
            queryParameters['timezone'] = requestParameters.timezone;
        }

        if (requestParameters.date !== undefined) {
            queryParameters['date'] = requestParameters.date;
        }

        if (requestParameters.versionDate !== undefined) {
            queryParameters['version-date'] = requestParameters.versionDate;
        }

        if (requestParameters.clobId !== undefined) {
            queryParameters['clob-id'] = requestParameters.clobId;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
        }

        const response = await this.request({
            path: `/timeseries/text/{name}/value`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.TextApiResponse(response) as any;
    }

    /**
     * Get timeseries text with name value
     */
    async getTimeSeriesTextWithNameValue(requestParameters: GetTimeSeriesTextWithNameValueRequest, initOverrides?: RequestInit): Promise<string> {
        const response = await this.getTimeSeriesTextWithNameValueRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Updates a text timeseries
     * Patch timeseries text with name
     */
    async patchTimeSeriesTextWithNameRaw(requestParameters: PatchTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.name === null || requestParameters.name === undefined) {
            throw new runtime.RequiredError('name','Required parameter requestParameters.name was null or undefined when calling patchTimeSeriesTextWithName.');
        }

        if (requestParameters.textTimeSeries === null || requestParameters.textTimeSeries === undefined) {
            throw new runtime.RequiredError('textTimeSeries','Required parameter requestParameters.textTimeSeries was null or undefined when calling patchTimeSeriesTextWithName.');
        }

        const queryParameters: any = {};

        if (requestParameters.replaceAll !== undefined) {
            queryParameters['replace-all'] = requestParameters.replaceAll;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json;version=2';

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
        }

        const response = await this.request({
            path: `/timeseries/text/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'PATCH',
            headers: headerParameters,
            query: queryParameters,
            body: TextTimeSeriesToJSON(requestParameters.textTimeSeries),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Updates a text timeseries
     * Patch timeseries text with name
     */
    async patchTimeSeriesTextWithName(requestParameters: PatchTimeSeriesTextWithNameRequest, initOverrides?: RequestInit): Promise<void> {
        await this.patchTimeSeriesTextWithNameRaw(requestParameters, initOverrides);
    }

    /**
     * Create new TextTimeSeries
     * Post timeseries text
     */
    async postTimeSeriesTextRaw(requestParameters: PostTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.textTimeSeries === null || requestParameters.textTimeSeries === undefined) {
            throw new runtime.RequiredError('textTimeSeries','Required parameter requestParameters.textTimeSeries was null or undefined when calling postTimeSeriesText.');
        }

        const queryParameters: any = {};

        if (requestParameters.replaceAll !== undefined) {
            queryParameters['replace-all'] = requestParameters.replaceAll;
        }

        const headerParameters: runtime.HTTPHeaders = {};

        headerParameters['Content-Type'] = 'application/json;version=2';

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
        }

        const response = await this.request({
            path: `/timeseries/text`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: TextTimeSeriesToJSON(requestParameters.textTimeSeries),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Create new TextTimeSeries
     * Post timeseries text
     */
    async postTimeSeriesText(requestParameters: PostTimeSeriesTextRequest, initOverrides?: RequestInit): Promise<void> {
        await this.postTimeSeriesTextRaw(requestParameters, initOverrides);
    }

}