cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
97 lines (96 loc) • 4.53 kB
TypeScript
/**
* 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 { DeleteMethod, TimeSeriesIdentifierDescriptor, TimeSeriesIdentifierDescriptors } 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 declare class TimeSeriesIdentifierApi extends runtime.BaseAPI {
/**
* Deletes requested timeseries identifier
* Delete timeseries identifierDescriptor with timeseriesId
*/
deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters: DeleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Deletes requested timeseries identifier
* Delete timeseries identifierDescriptor with timeseriesId
*/
deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters: DeleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results.
* Get timeseries identifierDescriptor
*/
getTimeSeriesIdentifierDescriptorRaw(requestParameters: GetTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TimeSeriesIdentifierDescriptors>>;
/**
* Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results.
* Get timeseries identifierDescriptor
*/
getTimeSeriesIdentifierDescriptor(requestParameters?: GetTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit): Promise<TimeSeriesIdentifierDescriptors>;
/**
* Retrieves requested timeseries identifier descriptor
* Get timeseries identifierDescriptor with timeseriesId
*/
getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<TimeSeriesIdentifierDescriptor>>;
/**
* Retrieves requested timeseries identifier descriptor
* Get timeseries identifierDescriptor with timeseriesId
*/
getTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters: GetTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<TimeSeriesIdentifierDescriptor>;
/**
* Patch timeseries identifierDescriptor with timeseriesId
*/
patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Patch timeseries identifierDescriptor with timeseriesId
*/
patchTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters: PatchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Create new TimeSeriesIdentifierDescriptor
* Post timeseries identifierDescriptor
*/
postTimeSeriesIdentifierDescriptorRaw(requestParameters: PostTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Create new TimeSeriesIdentifierDescriptor
* Post timeseries identifierDescriptor
*/
postTimeSeriesIdentifierDescriptor(requestParameters: PostTimeSeriesIdentifierDescriptorRequest, initOverrides?: RequestInit): Promise<void>;
}