cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
95 lines (94 loc) • 4.2 kB
TypeScript
/**
* 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 { TimeSeriesGroup } 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 declare class TimeSeriesGroupsApi extends runtime.BaseAPI {
/**
* Deletes requested time series group
* Delete cwmsData timeseries group with groupId
*/
deleteTimeSeriesGroupWithGroupIdRaw(requestParameters: DeleteTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Deletes requested time series group
* Delete cwmsData timeseries group with groupId
*/
deleteTimeSeriesGroupWithGroupId(requestParameters: DeleteTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Returns CWMS TimeSeries Groups Data
* Get cwmsData timeseries group
*/
getTimeSeriesGroupRaw(requestParameters: GetTimeSeriesGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<TimeSeriesGroup>>>;
/**
* Returns CWMS TimeSeries Groups Data
* Get cwmsData timeseries group
*/
getTimeSeriesGroup(requestParameters?: GetTimeSeriesGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<TimeSeriesGroup>>;
/**
* Retrieves requested timeseries group
* Get cwmsData timeseries group with groupId
*/
getTimeSeriesGroupWithGroupIdRaw(requestParameters: GetTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TimeSeriesGroup>>;
/**
* Retrieves requested timeseries group
* Get cwmsData timeseries group with groupId
*/
getTimeSeriesGroupWithGroupId(requestParameters: GetTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TimeSeriesGroup>;
/**
* 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
*/
patchTimeSeriesGroupWithGroupIdRaw(requestParameters: PatchTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* 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
*/
patchTimeSeriesGroupWithGroupId(requestParameters: PatchTimeSeriesGroupWithGroupIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Create new TimeSeriesGroup
* Post cwmsData timeseries group
*/
postTimeSeriesGroupRaw(requestParameters: PostTimeSeriesGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Create new TimeSeriesGroup
* Post cwmsData timeseries group
*/
postTimeSeriesGroup(requestParameters: PostTimeSeriesGroupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}