cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
249 lines (248 loc) • 13.1 kB
JavaScript
/* 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.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
import * as runtime from '../runtime';
import { TimeSeriesIdentifierDescriptorFromJSON, TimeSeriesIdentifierDescriptorToJSON, TimeSeriesIdentifierDescriptorsFromJSON, } from '../models/index';
/**
*
*/
export class TimeSeriesIdentifierApi extends runtime.BaseAPI {
/**
* Deletes requested timeseries identifier
* Delete cwmsData timeseries identifierDescriptor with name
*/
deleteTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['name'] == null) {
throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithName().');
}
if (requestParameters['timeseriesId'] == null) {
throw new runtime.RequiredError('timeseriesId', 'Required parameter "timeseriesId" was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithName().');
}
if (requestParameters['office'] == null) {
throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithName().');
}
if (requestParameters['method'] == null) {
throw new runtime.RequiredError('method', 'Required parameter "method" was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithName().');
}
const queryParameters = {};
if (requestParameters['office'] != null) {
queryParameters['office'] = requestParameters['office'];
}
if (requestParameters['method'] != null) {
queryParameters['method'] = requestParameters['method'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))).replace(`{${"timeseries-id"}}`, encodeURIComponent(String(requestParameters['timeseriesId']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Deletes requested timeseries identifier
* Delete cwmsData timeseries identifierDescriptor with name
*/
deleteTimeSeriesIdentifierDescriptorWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.deleteTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides);
});
}
/**
* Returns CWMS timeseries identifier descriptorData
* Get cwmsData timeseries identifierDescriptor
*/
getTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters['office'] != null) {
queryParameters['office'] = requestParameters['office'];
}
if (requestParameters['timeseriesIdRegex'] != null) {
queryParameters['timeseries-id-regex'] = requestParameters['timeseriesIdRegex'];
}
if (requestParameters['page'] != null) {
queryParameters['page'] = requestParameters['page'];
}
if (requestParameters['pageSize'] != null) {
queryParameters['page-size'] = requestParameters['pageSize'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => TimeSeriesIdentifierDescriptorsFromJSON(jsonValue));
});
}
/**
* Returns CWMS timeseries identifier descriptorData
* Get cwmsData timeseries identifierDescriptor
*/
getTimeSeriesIdentifierDescriptor(requestParameters = {}, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Retrieves requested timeseries identifier descriptor
* Get cwmsData timeseries identifierDescriptor with name
*/
getTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['name'] == null) {
throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling getTimeSeriesIdentifierDescriptorWithName().');
}
if (requestParameters['timeseriesId'] == null) {
throw new runtime.RequiredError('timeseriesId', 'Required parameter "timeseriesId" was null or undefined when calling getTimeSeriesIdentifierDescriptorWithName().');
}
if (requestParameters['office'] == null) {
throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling getTimeSeriesIdentifierDescriptorWithName().');
}
const queryParameters = {};
if (requestParameters['office'] != null) {
queryParameters['office'] = requestParameters['office'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))).replace(`{${"timeseries-id"}}`, encodeURIComponent(String(requestParameters['timeseriesId']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => TimeSeriesIdentifierDescriptorFromJSON(jsonValue));
});
}
/**
* Retrieves requested timeseries identifier descriptor
* Get cwmsData timeseries identifierDescriptor with name
*/
getTimeSeriesIdentifierDescriptorWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Patch cwmsData timeseries identifierDescriptor with name
*/
patchTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['name'] == null) {
throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling patchTimeSeriesIdentifierDescriptorWithName().');
}
if (requestParameters['office'] == null) {
throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling patchTimeSeriesIdentifierDescriptorWithName().');
}
const queryParameters = {};
if (requestParameters['office'] != null) {
queryParameters['office'] = requestParameters['office'];
}
if (requestParameters['timeseriesId'] != null) {
queryParameters['timeseries-id'] = requestParameters['timeseriesId'];
}
if (requestParameters['intervalOffset'] != null) {
queryParameters['interval-offset'] = requestParameters['intervalOffset'];
}
if (requestParameters['snapForward'] != null) {
queryParameters['snap-forward'] = requestParameters['snapForward'];
}
if (requestParameters['snapBackward'] != null) {
queryParameters['snap-backward'] = requestParameters['snapBackward'];
}
if (requestParameters['active'] != null) {
queryParameters['active'] = requestParameters['active'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))),
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Patch cwmsData timeseries identifierDescriptor with name
*/
patchTimeSeriesIdentifierDescriptorWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.patchTimeSeriesIdentifierDescriptorWithNameRaw(requestParameters, initOverrides);
});
}
/**
* Create new TimeSeriesIdentifierDescriptor
* Post cwmsData timeseries identifierDescriptor
*/
postTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['timeSeriesIdentifierDescriptor'] == null) {
throw new runtime.RequiredError('timeSeriesIdentifierDescriptor', 'Required parameter "timeSeriesIdentifierDescriptor" was null or undefined when calling postTimeSeriesIdentifierDescriptor().');
}
const queryParameters = {};
if (requestParameters['failIfExists'] != null) {
queryParameters['fail-if-exists'] = requestParameters['failIfExists'];
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json;version=2';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: TimeSeriesIdentifierDescriptorToJSON(requestParameters['timeSeriesIdentifierDescriptor']),
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Create new TimeSeriesIdentifierDescriptor
* Post cwmsData timeseries identifierDescriptor
*/
postTimeSeriesIdentifierDescriptor(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.postTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides);
});
}
}