cwmsjs/src/apis/BinaryTimeSeriesApi.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 {
    BinaryTimeSeries,
    BinaryTimeSeriesFromJSON,
    BinaryTimeSeriesToJSON,
    CdaError,
    CdaErrorFromJSON,
    CdaErrorToJSON,
} from '../models';

export interface DeleteTimeSeriesBinaryWithNameRequest {
    name: string;
    office: string;
    begin: string;
    end: string;
    binaryTypeMask?: string;
    timezone?: string;
    versionDate?: string;
}

export interface GetTimeSeriesBinaryRequest {
    office: string;
    name: string;
    begin: string;
    end: string;
    binaryTypeMask?: string;
    timezone?: string;
    versionDate?: string;
}

export interface GetTimeSeriesBinaryWithNameValueRequest {
    name: string;
    office: string;
    date: string;
    timezone?: string;
    versionDate?: string;
    blobId?: string;
}

export interface PatchTimeSeriesBinaryWithNameRequest {
    name: string;
    binaryTimeSeries: BinaryTimeSeries;
    replaceAll?: boolean;
}

export interface PostTimeSeriesBinaryRequest {
    binaryTimeSeries: BinaryTimeSeries;
    replaceAll?: boolean;
}

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

    /**
     * Deletes requested binary timeseries id
     * Delete timeseries binary with name
     */
    async deleteTimeSeriesBinaryWithNameRaw(requestParameters: DeleteTimeSeriesBinaryWithNameRequest, 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 deleteTimeSeriesBinaryWithName.');
        }

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

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

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

        const queryParameters: any = {};

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

        if (requestParameters.binaryTypeMask !== undefined) {
            queryParameters['binary-type-mask'] = requestParameters.binaryTypeMask;
        }

        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/binary/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'DELETE',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Deletes requested binary timeseries id
     * Delete timeseries binary with name
     */
    async deleteTimeSeriesBinaryWithName(requestParameters: DeleteTimeSeriesBinaryWithNameRequest, initOverrides?: RequestInit): Promise<void> {
        await this.deleteTimeSeriesBinaryWithNameRaw(requestParameters, initOverrides);
    }

    /**
     * Retrieve binary 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 getTimeSeriesBinaryRaw(requestParameters: GetTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BinaryTimeSeries>> {
        if (requestParameters.office === null || requestParameters.office === undefined) {
            throw new runtime.RequiredError('office','Required parameter requestParameters.office was null or undefined when calling getTimeSeriesBinary.');
        }

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

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

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

        const queryParameters: any = {};

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

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

        if (requestParameters.binaryTypeMask !== undefined) {
            queryParameters['binary-type-mask'] = requestParameters.binaryTypeMask;
        }

        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/binary`,
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

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

    /**
     * Retrieve binary 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 getTimeSeriesBinary(requestParameters: GetTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<BinaryTimeSeries> {
        const response = await this.getTimeSeriesBinaryRaw(requestParameters, initOverrides);
        return await response.value();
    }

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

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

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

        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.blobId !== undefined) {
            queryParameters['blob-id'] = requestParameters.blobId;
        }

        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/binary/{name}/value`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'GET',
            headers: headerParameters,
            query: queryParameters,
        }, initOverrides);

        return new runtime.BlobApiResponse(response);
    }

    /**
     * Get timeseries binary with name value
     */
    async getTimeSeriesBinaryWithNameValue(requestParameters: GetTimeSeriesBinaryWithNameValueRequest, initOverrides?: RequestInit): Promise<Blob> {
        const response = await this.getTimeSeriesBinaryWithNameValueRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Updates a binary timeseries
     * Patch timeseries binary with name
     */
    async patchTimeSeriesBinaryWithNameRaw(requestParameters: PatchTimeSeriesBinaryWithNameRequest, 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 patchTimeSeriesBinaryWithName.');
        }

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

        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/binary/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
            method: 'PATCH',
            headers: headerParameters,
            query: queryParameters,
            body: BinaryTimeSeriesToJSON(requestParameters.binaryTimeSeries),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Updates a binary timeseries
     * Patch timeseries binary with name
     */
    async patchTimeSeriesBinaryWithName(requestParameters: PatchTimeSeriesBinaryWithNameRequest, initOverrides?: RequestInit): Promise<void> {
        await this.patchTimeSeriesBinaryWithNameRaw(requestParameters, initOverrides);
    }

    /**
     * Create new BinaryTimeSeries
     * Post timeseries binary
     */
    async postTimeSeriesBinaryRaw(requestParameters: PostTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.binaryTimeSeries === null || requestParameters.binaryTimeSeries === undefined) {
            throw new runtime.RequiredError('binaryTimeSeries','Required parameter requestParameters.binaryTimeSeries was null or undefined when calling postTimeSeriesBinary.');
        }

        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/binary`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: BinaryTimeSeriesToJSON(requestParameters.binaryTimeSeries),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Create new BinaryTimeSeries
     * Post timeseries binary
     */
    async postTimeSeriesBinary(requestParameters: PostTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<void> {
        await this.postTimeSeriesBinaryRaw(requestParameters, initOverrides);
    }

}