cwmsjs/src/apis/TimeSeriesGroupsApi.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,
  TimeSeriesGroup,
} from '../models/index';
import {
    CdaErrorFromJSON,
    CdaErrorToJSON,
    TimeSeriesGroupFromJSON,
    TimeSeriesGroupToJSON,
} from '../models/index';

export interface DeleteTimeSeriesGroupWithGroupIdRequest {
    groupId: string;
    categoryId: string;
    office: string;
}

export interface GetTimeSeriesGroupRequest {
    office?: string;
    includeAssigned?: boolean;
    timeseriesCategoryLike?: string;
    timeseriesGroupLike?: string;
}

export interface GetTimeSeriesGroupWithGroupIdRequest {
    groupId: string;
    office: string;
    categoryId: string;
}

export interface PatchTimeSeriesGroupWithGroupIdRequest {
    groupId: string;
    office: string;
    timeSeriesGroup: TimeSeriesGroup;
    replaceAssignedTs?: boolean;
}

export interface PostTimeSeriesGroupRequest {
    timeSeriesGroup: TimeSeriesGroup;
    failIfExists?: boolean;
}

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

    /**
     * Deletes requested time series group
     * Delete cwmsData timeseries group with groupId
     */
    async deleteTimeSeriesGroupWithGroupIdRaw(requestParameters: DeleteTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        if (requestParameters['groupId'] == null) {
            throw new runtime.RequiredError(
                'groupId',
                'Required parameter "groupId" was null or undefined when calling deleteTimeSeriesGroupWithGroupId().'
            );
        }

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

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

        const queryParameters: any = {};

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

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

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Deletes requested time series group
     * Delete cwmsData timeseries group with groupId
     */
    async deleteTimeSeriesGroupWithGroupId(requestParameters: DeleteTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.deleteTimeSeriesGroupWithGroupIdRaw(requestParameters, initOverrides);
    }

    /**
     * Returns CWMS TimeSeries Groups Data
     * Get cwmsData timeseries group
     */
    async getTimeSeriesGroupRaw(requestParameters: GetTimeSeriesGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TimeSeriesGroup>>> {
        const queryParameters: any = {};

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

        if (requestParameters['includeAssigned'] != null) {
            queryParameters['include-assigned'] = requestParameters['includeAssigned'];
        }

        if (requestParameters['timeseriesCategoryLike'] != null) {
            queryParameters['timeseries-category-like'] = requestParameters['timeseriesCategoryLike'];
        }

        if (requestParameters['timeseriesGroupLike'] != null) {
            queryParameters['timeseries-group-like'] = requestParameters['timeseriesGroupLike'];
        }

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

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

    /**
     * Returns CWMS TimeSeries Groups Data
     * Get cwmsData timeseries group
     */
    async getTimeSeriesGroup(requestParameters: GetTimeSeriesGroupRequest = {}, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TimeSeriesGroup>> {
        const response = await this.getTimeSeriesGroupRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Retrieves requested timeseries group
     * Get cwmsData timeseries group with groupId
     */
    async getTimeSeriesGroupWithGroupIdRaw(requestParameters: GetTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TimeSeriesGroup>> {
        if (requestParameters['groupId'] == null) {
            throw new runtime.RequiredError(
                'groupId',
                'Required parameter "groupId" was null or undefined when calling getTimeSeriesGroupWithGroupId().'
            );
        }

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

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

        const queryParameters: any = {};

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

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

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

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

    /**
     * Retrieves requested timeseries group
     * Get cwmsData timeseries group with groupId
     */
    async getTimeSeriesGroupWithGroupId(requestParameters: GetTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TimeSeriesGroup> {
        const response = await this.getTimeSeriesGroupWithGroupIdRaw(requestParameters, initOverrides);
        return await response.value();
    }

    /**
     * Update existing TimeSeriesGroup. Allows for renaming of the group, assigning new time series, and unassigning all time series from the group.
     * Patch cwmsData timeseries group with groupId
     */
    async patchTimeSeriesGroupWithGroupIdRaw(requestParameters: PatchTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        if (requestParameters['groupId'] == null) {
            throw new runtime.RequiredError(
                'groupId',
                'Required parameter "groupId" was null or undefined when calling patchTimeSeriesGroupWithGroupId().'
            );
        }

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

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

        const queryParameters: any = {};

        if (requestParameters['replaceAssignedTs'] != null) {
            queryParameters['replace-assigned-ts'] = requestParameters['replaceAssignedTs'];
        }

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

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        const response = await this.request({
            path: `/timeseries/group/{group-id}`.replace(`{${"group-id"}}`, encodeURIComponent(String(requestParameters['groupId']))),
            method: 'PATCH',
            headers: headerParameters,
            query: queryParameters,
            body: TimeSeriesGroupToJSON(requestParameters['timeSeriesGroup']),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Update existing TimeSeriesGroup. Allows for renaming of the group, assigning new time series, and unassigning all time series from the group.
     * Patch cwmsData timeseries group with groupId
     */
    async patchTimeSeriesGroupWithGroupId(requestParameters: PatchTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.patchTimeSeriesGroupWithGroupIdRaw(requestParameters, initOverrides);
    }

    /**
     * Create new TimeSeriesGroup
     * Post cwmsData timeseries group
     */
    async postTimeSeriesGroupRaw(requestParameters: PostTimeSeriesGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
        if (requestParameters['timeSeriesGroup'] == null) {
            throw new runtime.RequiredError(
                'timeSeriesGroup',
                'Required parameter "timeSeriesGroup" was null or undefined when calling postTimeSeriesGroup().'
            );
        }

        const queryParameters: any = {};

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

        const headerParameters: runtime.HTTPHeaders = {};

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

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

        const response = await this.request({
            path: `/timeseries/group`,
            method: 'POST',
            headers: headerParameters,
            query: queryParameters,
            body: TimeSeriesGroupToJSON(requestParameters['timeSeriesGroup']),
        }, initOverrides);

        return new runtime.VoidApiResponse(response);
    }

    /**
     * Create new TimeSeriesGroup
     * Post cwmsData timeseries group
     */
    async postTimeSeriesGroup(requestParameters: PostTimeSeriesGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
        await this.postTimeSeriesGroupRaw(requestParameters, initOverrides);
    }

}