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.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 * as runtime from '../runtime';
import type {
  CdaError,
  DeleteMethod,
  TimeSeriesIdentifierDescriptor,
  TimeSeriesIdentifierDescriptors,
} from '../models/index';
import {
    CdaErrorFromJSON,
    CdaErrorToJSON,
    DeleteMethodFromJSON,
    DeleteMethodToJSON,
    TimeSeriesIdentifierDescriptorFromJSON,
    TimeSeriesIdentifierDescriptorToJSON,
    TimeSeriesIdentifierDescriptorsFromJSON,
    TimeSeriesIdentifierDescriptorsToJSON,
} from '../models/index';

export interface DeleteTimeSeriesIdentifierDescriptorWithNameRequest {
    name: string;
    timeseriesId: string;
    office: string;
    method: DeleteMethod;
}

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

export interface GetTimeSeriesIdentifierDescriptorWithNameRequest {
    name: string;
    timeseriesId: string;
    office: string;
}

export interface PatchTimeSeriesIdentifierDescriptorWithNameRequest {
    name: string;
    office: string;
    timeseriesId?: 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 cwmsData timeseries identifierDescriptor with name
     */
    async deleteTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters: DeleteTimeSeriesIdentifierDescriptorWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        if (requestParameters['name'] == null) {
            throw new runtime.RequiredError(
                'name',
                'Required parameter "name" was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithName().'
            );
        }

        if (requestParameters['timeseriesId'] == null) {
            throw new runtime.RequiredError(
                'timeseriesId',
                'Required parameter "timeseriesId" was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithName().'
            );
        }

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

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

        const queryParameters: any = {};

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

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

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Deletes requested timeseries identifier
     * Delete cwmsData timeseries identifierDescriptor with name
     */
    async deleteTimeSeriesIdentifierDescriptorWithName(requestParameters: DeleteTimeSeriesIdentifierDescriptorWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.deleteTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides);
    }

    /**
     * Returns CWMS timeseries identifier descriptorData
     * Get cwmsData timeseries identifierDescriptor
     */
    async getTimeSeriesIdentifierDescriptorRaw(requestParameters: GetTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TimeSeriesIdentifierDescriptors>> {
        const queryParameters: any = {};

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

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

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

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

        const headerParameters: runtime.HTTPHeaders = {};

        if (this.configuration && this.configuration.apiKey) {
            headerParameters["Authorization"] = await 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
     * Get cwmsData timeseries identifierDescriptor
     */
    async getTimeSeriesIdentifierDescriptor(requestParameters: GetTimeSeriesIdentifierDescriptorRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TimeSeriesIdentifierDescriptors> {
        const response = await this.getTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieves requested timeseries identifier descriptor
     * Get cwmsData timeseries identifierDescriptor with name
     */
    async getTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters: GetTimeSeriesIdentifierDescriptorWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TimeSeriesIdentifierDescriptor>> {
        if (requestParameters['name'] == null) {
            throw new runtime.RequiredError(
                'name',
                'Required parameter "name" was null or undefined when calling getTimeSeriesIdentifierDescriptorWithName().'
            );
        }

        if (requestParameters['timeseriesId'] == null) {
            throw new runtime.RequiredError(
                'timeseriesId',
                'Required parameter "timeseriesId" was null or undefined when calling getTimeSeriesIdentifierDescriptorWithName().'
            );
        }

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

        const queryParameters: any = {};

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

        const headerParameters: runtime.HTTPHeaders = {};

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

        const response = await this.request({
            path: `/timeseries/identifier-descriptor/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))).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 cwmsData timeseries identifierDescriptor with name
     */
    async getTimeSeriesIdentifierDescriptorWithName(requestParameters: GetTimeSeriesIdentifierDescriptorWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TimeSeriesIdentifierDescriptor> {
        const response = await this.getTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Patch cwmsData timeseries identifierDescriptor with name
     */
    async patchTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters: PatchTimeSeriesIdentifierDescriptorWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        if (requestParameters['name'] == null) {
            throw new runtime.RequiredError(
                'name',
                'Required parameter "name" was null or undefined when calling patchTimeSeriesIdentifierDescriptorWithName().'
            );
        }

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

        const queryParameters: any = {};

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

        if (requestParameters['timeseriesId'] != null) {
            queryParameters['timeseries-id'] = requestParameters['timeseriesId'];
        }

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

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

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

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

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Patch cwmsData timeseries identifierDescriptor with name
     */
    async patchTimeSeriesIdentifierDescriptorWithName(requestParameters: PatchTimeSeriesIdentifierDescriptorWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.patchTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides);
    }

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

        const queryParameters: any = {};

        if (requestParameters['failIfExists'] != null) {
            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"] = await 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 cwmsData timeseries identifierDescriptor
     */
    async postTimeSeriesIdentifierDescriptor(requestParameters: PostTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.postTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides);
    }

}