cwmsjs/src/apis/TimeSeriesIdentifierApi.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,
    DeleteMethod,
    DeleteMethodFromJSON,
    DeleteMethodToJSON,
    TimeSeriesIdentifierDescriptor,
    TimeSeriesIdentifierDescriptorFromJSON,
    TimeSeriesIdentifierDescriptorToJSON,
    TimeSeriesIdentifierDescriptors,
    TimeSeriesIdentifierDescriptorsFromJSON,
    TimeSeriesIdentifierDescriptorsToJSON,
} from '../models';

export interface DeleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest {
    timeseriesId: string;
    office: string;
    method: DeleteMethod;
}

export interface GetTimeSeriesIdentifierDescriptorRequest {
    office?: string;
    timeseriesIdRegex?: string;
    includeAliases?: boolean;
    page?: string;
    pageSize?: number;
}

export interface GetTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest {
    timeseriesId: string;
    office: string;
}

export interface PatchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest {
    timeseriesId: string;
    name: string;
    office: string;
    timeseriesId2?: string;
    intervalOffset?: number;
    snapForward?: number;
    snapBackward?: number;
    active?: boolean;
}

export interface PostTimeSeriesIdentifierDescriptorRequest {
    timeSeriesIdentifierDescriptor: TimeSeriesIdentifierDescriptor;
    failIfExists?: boolean;
}

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

    /**
     * Deletes requested timeseries identifier
     * Delete timeseries identifierDescriptor with timeseriesId
     */
    async deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters: DeleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.timeseriesId === null || requestParameters.timeseriesId === undefined) {
            throw new runtime.RequiredError('timeseriesId','Required parameter requestParameters.timeseriesId was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
        }

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

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

        const queryParameters: any = {};

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

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

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

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Deletes requested timeseries identifier
     * Delete timeseries identifierDescriptor with timeseriesId
     */
    async deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters: DeleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<void> {
        await this.deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides);
    }

    /**
     * Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results.
     * Get timeseries identifierDescriptor
     */
    async getTimeSeriesIdentifierDescriptorRaw(requestParameters: GetTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TimeSeriesIdentifierDescriptors>> {
        const queryParameters: any = {};

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

        if (requestParameters.timeseriesIdRegex !== undefined) {
            queryParameters['timeseries-id-regex'] = requestParameters.timeseriesIdRegex;
        }

        if (requestParameters.includeAliases !== undefined) {
            queryParameters['include-aliases'] = requestParameters.includeAliases;
        }

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

        if (requestParameters.pageSize !== undefined) {
            queryParameters['page-size'] = requestParameters.pageSize;
        }

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

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

    /**
     * Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results.
     * Get timeseries identifierDescriptor
     */
    async getTimeSeriesIdentifierDescriptor(requestParameters: GetTimeSeriesIdentifierDescriptorRequest = {}, initOverrides?: RequestInit): Promise<TimeSeriesIdentifierDescriptors> {
        const response = await this.getTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieves requested timeseries identifier descriptor
     * Get timeseries identifierDescriptor with timeseriesId
     */
    async getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TimeSeriesIdentifierDescriptor>> {
        if (requestParameters.timeseriesId === null || requestParameters.timeseriesId === undefined) {
            throw new runtime.RequiredError('timeseriesId','Required parameter requestParameters.timeseriesId was null or undefined when calling getTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
        }

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

        const queryParameters: any = {};

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

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

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

    /**
     * Retrieves requested timeseries identifier descriptor
     * Get timeseries identifierDescriptor with timeseriesId
     */
    async getTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<TimeSeriesIdentifierDescriptor> {
        const response = await this.getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Patch timeseries identifierDescriptor with timeseriesId
     */
    async patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.timeseriesId === null || requestParameters.timeseriesId === undefined) {
            throw new runtime.RequiredError('timeseriesId','Required parameter requestParameters.timeseriesId was null or undefined when calling patchTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
        }

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

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

        const queryParameters: any = {};

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

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

        if (requestParameters.intervalOffset !== undefined) {
            queryParameters['interval-offset'] = requestParameters.intervalOffset;
        }

        if (requestParameters.snapForward !== undefined) {
            queryParameters['snap-forward'] = requestParameters.snapForward;
        }

        if (requestParameters.snapBackward !== undefined) {
            queryParameters['snap-backward'] = requestParameters.snapBackward;
        }

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

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

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Patch timeseries identifierDescriptor with timeseriesId
     */
    async patchTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<void> {
        await this.patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides);
    }

    /**
     * Create new TimeSeriesIdentifierDescriptor
     * Post timeseries identifierDescriptor
     */
    async postTimeSeriesIdentifierDescriptorRaw(requestParameters: PostTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>> {
        if (requestParameters.timeSeriesIdentifierDescriptor === null || requestParameters.timeSeriesIdentifierDescriptor === undefined) {
            throw new runtime.RequiredError('timeSeriesIdentifierDescriptor','Required parameter requestParameters.timeSeriesIdentifierDescriptor was null or undefined when calling postTimeSeriesIdentifierDescriptor.');
        }

        const queryParameters: any = {};

        if (requestParameters.failIfExists !== undefined) {
            queryParameters['fail-if-exists'] = requestParameters.failIfExists;
        }

        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/identifier-descriptor`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: TimeSeriesIdentifierDescriptorToJSON(requestParameters.timeSeriesIdentifierDescriptor),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Create new TimeSeriesIdentifierDescriptor
     * Post timeseries identifierDescriptor
     */
    async postTimeSeriesIdentifierDescriptor(requestParameters: PostTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit): Promise<void> {
        await this.postTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides);
    }

}