cwmsjs/dist/apis/TimeSeriesCategoriesApi.d.ts

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

/**
 * 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 { TimeSeriesCategory } from '../models/index';
export interface DeleteTimeSeriesCategoryWithCategoryIdRequest {
    categoryId: string;
    office: string;
    cascadeDelete?: boolean;
}
export interface GetTimeSeriesCategoryRequest {
    office?: string;
}
export interface GetTimeSeriesCategoryWithCategoryIdRequest {
    categoryId: string;
    office: string;
}
export interface PostTimeSeriesCategoryRequest {
    timeSeriesCategory: TimeSeriesCategory;
    failIfExists?: boolean;
}
/**
 *
 */
export declare class TimeSeriesCategoriesApi extends runtime.BaseAPI {
    /**
     * Deletes requested time series category
     * Delete cwmsData timeseries category with categoryId
     */
    deleteTimeSeriesCategoryWithCategoryIdRaw(requestParameters: DeleteTimeSeriesCategoryWithCategoryIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Deletes requested time series category
     * Delete cwmsData timeseries category with categoryId
     */
    deleteTimeSeriesCategoryWithCategoryId(requestParameters: DeleteTimeSeriesCategoryWithCategoryIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
    /**
     * Returns CWMS timeseries category Data
     * Get cwmsData timeseries category
     */
    getTimeSeriesCategoryRaw(requestParameters: GetTimeSeriesCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TimeSeriesCategory>>>;
    /**
     * Returns CWMS timeseries category Data
     * Get cwmsData timeseries category
     */
    getTimeSeriesCategory(requestParameters?: GetTimeSeriesCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TimeSeriesCategory>>;
    /**
     * Retrieves requested timeseries category
     * Get cwmsData timeseries category with categoryId
     */
    getTimeSeriesCategoryWithCategoryIdRaw(requestParameters: GetTimeSeriesCategoryWithCategoryIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TimeSeriesCategory>>;
    /**
     * Retrieves requested timeseries category
     * Get cwmsData timeseries category with categoryId
     */
    getTimeSeriesCategoryWithCategoryId(requestParameters: GetTimeSeriesCategoryWithCategoryIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TimeSeriesCategory>;
    /**
     * Create new TimeSeriesCategory
     * Post cwmsData timeseries category
     */
    postTimeSeriesCategoryRaw(requestParameters: PostTimeSeriesCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
    /**
     * Create new TimeSeriesCategory
     * Post cwmsData timeseries category
     */
    postTimeSeriesCategory(requestParameters: PostTimeSeriesCategoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}