cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
251 lines (250 loc) • 13.6 kB
JavaScript
;
/* tslint:disable */
/* eslint-disable */
/**
* 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.
*/
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
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) : new P(function (resolve) { resolve(result.value); }).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
Object.defineProperty(exports, "__esModule", { value: true });
const runtime = require("../runtime");
const models_1 = require("../models");
/**
*
*/
class TimeSeriesIdentifierApi extends runtime.BaseAPI {
/**
* Deletes requested timeseries identifier
* Delete timeseries identifierDescriptor with timeseriesId
*/
deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.timeseriesId === null || requestParameters.timeseriesId === undefined) {
throw new runtime.RequiredError('timeseriesId', 'Required parameter requestParameters.timeseriesId was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
if (requestParameters.method === null || requestParameters.method === undefined) {
throw new runtime.RequiredError('method', 'Required parameter requestParameters.method was null or undefined when calling deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
const queryParameters = {};
if (requestParameters.office !== undefined) {
queryParameters['office'] = requestParameters.office;
}
if (requestParameters.method !== undefined) {
queryParameters['method'] = requestParameters.method;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor/{timeseries-id}`.replace(`{${"timeseries-id"}}`, encodeURIComponent(String(requestParameters.timeseriesId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Deletes requested timeseries identifier
* Delete timeseries identifierDescriptor with timeseriesId
*/
deleteTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.deleteTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides);
});
}
/**
* Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results.
* Get timeseries identifierDescriptor
*/
getTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const queryParameters = {};
if (requestParameters.office !== undefined) {
queryParameters['office'] = requestParameters.office;
}
if (requestParameters.timeseriesIdRegex !== undefined) {
queryParameters['timeseries-id-regex'] = requestParameters.timeseriesIdRegex;
}
if (requestParameters.includeAliases !== undefined) {
queryParameters['include-aliases'] = requestParameters.includeAliases;
}
if (requestParameters.page !== undefined) {
queryParameters['page'] = requestParameters.page;
}
if (requestParameters.pageSize !== undefined) {
queryParameters['page-size'] = requestParameters.pageSize;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = 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) => models_1.TimeSeriesIdentifierDescriptorsFromJSON(jsonValue));
});
}
/**
* Returns CWMS timeseries identifier descriptorData. Currently includes aliased items in results.
* Get 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 timeseries identifierDescriptor with timeseriesId
*/
getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.timeseriesId === null || requestParameters.timeseriesId === undefined) {
throw new runtime.RequiredError('timeseriesId', 'Required parameter requestParameters.timeseriesId was null or undefined when calling getTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling getTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
const queryParameters = {};
if (requestParameters.office !== undefined) {
queryParameters['office'] = requestParameters.office;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor/{timeseries-id}`.replace(`{${"timeseries-id"}}`, encodeURIComponent(String(requestParameters.timeseriesId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.TimeSeriesIdentifierDescriptorFromJSON(jsonValue));
});
}
/**
* Retrieves requested timeseries identifier descriptor
* Get timeseries identifierDescriptor with timeseriesId
*/
getTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Patch timeseries identifierDescriptor with timeseriesId
*/
patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.timeseriesId === null || requestParameters.timeseriesId === undefined) {
throw new runtime.RequiredError('timeseriesId', 'Required parameter requestParameters.timeseriesId was null or undefined when calling patchTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
if (requestParameters.name === null || requestParameters.name === undefined) {
throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling patchTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling patchTimeSeriesIdentifierDescriptorWithTimeSeriesId.');
}
const queryParameters = {};
if (requestParameters.office !== undefined) {
queryParameters['office'] = requestParameters.office;
}
if (requestParameters.timeseriesId2 !== undefined) {
queryParameters['timeseries-id'] = requestParameters.timeseriesId2;
}
if (requestParameters.intervalOffset !== undefined) {
queryParameters['interval-offset'] = requestParameters.intervalOffset;
}
if (requestParameters.snapForward !== undefined) {
queryParameters['snap-forward'] = requestParameters.snapForward;
}
if (requestParameters.snapBackward !== undefined) {
queryParameters['snap-backward'] = requestParameters.snapBackward;
}
if (requestParameters.active !== undefined) {
queryParameters['active'] = requestParameters.active;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor/{timeseries-id}`.replace(`{${"timeseries-id"}}`, encodeURIComponent(String(requestParameters.timeseriesId))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Patch timeseries identifierDescriptor with timeseriesId
*/
patchTimeSeriesIdentifierDescriptorWithTimeSeriesId(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.patchTimeSeriesIdentifierDescriptorWithTimeSeriesIdRaw(requestParameters, initOverrides);
});
}
/**
* Create new TimeSeriesIdentifierDescriptor
* Post timeseries identifierDescriptor
*/
postTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.timeSeriesIdentifierDescriptor === null || requestParameters.timeSeriesIdentifierDescriptor === undefined) {
throw new runtime.RequiredError('timeSeriesIdentifierDescriptor', 'Required parameter requestParameters.timeSeriesIdentifierDescriptor was null or undefined when calling postTimeSeriesIdentifierDescriptor.');
}
const queryParameters = {};
if (requestParameters.failIfExists !== undefined) {
queryParameters['fail-if-exists'] = requestParameters.failIfExists;
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json;version=2';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/timeseries/identifier-descriptor`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: models_1.TimeSeriesIdentifierDescriptorToJSON(requestParameters.timeSeriesIdentifierDescriptor),
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Create new TimeSeriesIdentifierDescriptor
* Post timeseries identifierDescriptor
*/
postTimeSeriesIdentifierDescriptor(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.postTimeSeriesIdentifierDescriptorRaw(requestParameters, initOverrides);
});
}
}
exports.TimeSeriesIdentifierApi = TimeSeriesIdentifierApi;