cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
100 lines (99 loc) • 3.94 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 { BinaryTimeSeries } from '../models';
export interface DeleteTimeSeriesBinaryWithNameRequest {
name: string;
office: string;
begin: string;
end: string;
binaryTypeMask?: string;
timezone?: string;
versionDate?: string;
}
export interface GetTimeSeriesBinaryRequest {
office: string;
name: string;
begin: string;
end: string;
binaryTypeMask?: string;
timezone?: string;
versionDate?: string;
}
export interface GetTimeSeriesBinaryWithNameValueRequest {
name: string;
office: string;
date: string;
timezone?: string;
versionDate?: string;
blobId?: string;
}
export interface PatchTimeSeriesBinaryWithNameRequest {
name: string;
binaryTimeSeries: BinaryTimeSeries;
replaceAll?: boolean;
}
export interface PostTimeSeriesBinaryRequest {
binaryTimeSeries: BinaryTimeSeries;
replaceAll?: boolean;
}
/**
*
*/
export declare class BinaryTimeSeriesApi extends runtime.BaseAPI {
/**
* Deletes requested binary timeseries id
* Delete timeseries binary with name
*/
deleteTimeSeriesBinaryWithNameRaw(requestParameters: DeleteTimeSeriesBinaryWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Deletes requested binary timeseries id
* Delete timeseries binary with name
*/
deleteTimeSeriesBinaryWithName(requestParameters: DeleteTimeSeriesBinaryWithNameRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Retrieve binary time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.
*/
getTimeSeriesBinaryRaw(requestParameters: GetTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<BinaryTimeSeries>>;
/**
* Retrieve binary time series values for a provided time window and date version.If individual values exceed 64 kilobytes, a URL to a separate download is provided instead of being included in the returned payload from this request.
*/
getTimeSeriesBinary(requestParameters: GetTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<BinaryTimeSeries>;
/**
* Get timeseries binary with name value
*/
getTimeSeriesBinaryWithNameValueRaw(requestParameters: GetTimeSeriesBinaryWithNameValueRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Blob>>;
/**
* Get timeseries binary with name value
*/
getTimeSeriesBinaryWithNameValue(requestParameters: GetTimeSeriesBinaryWithNameValueRequest, initOverrides?: RequestInit): Promise<Blob>;
/**
* Updates a binary timeseries
* Patch timeseries binary with name
*/
patchTimeSeriesBinaryWithNameRaw(requestParameters: PatchTimeSeriesBinaryWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Updates a binary timeseries
* Patch timeseries binary with name
*/
patchTimeSeriesBinaryWithName(requestParameters: PatchTimeSeriesBinaryWithNameRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Create new BinaryTimeSeries
* Post timeseries binary
*/
postTimeSeriesBinaryRaw(requestParameters: PostTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Create new BinaryTimeSeries
* Post timeseries binary
*/
postTimeSeriesBinary(requestParameters: PostTimeSeriesBinaryRequest, initOverrides?: RequestInit): Promise<void>;
}