cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
535 lines (534 loc) • 29.4 kB
JavaScript
"use strict";
/* 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 OutletsApi extends runtime.BaseAPI {
/**
* Delete CWMS Outlet
* Delete projects outlets with name
*/
deleteProjectsOutletsWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.name === null || requestParameters.name === undefined) {
throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling deleteProjectsOutletsWithName.');
}
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling deleteProjectsOutletsWithName.');
}
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: `/projects/outlets/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Delete CWMS Outlet
* Delete projects outlets with name
*/
deleteProjectsOutletsWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.deleteProjectsOutletsWithNameRaw(requestParameters, initOverrides);
});
}
/**
* Deletes matching CWMS gate change data for a Reservoir Project.
* Delete projects with office with projectId gateChanges
*/
deleteProjectsWithOfficeWithProjectIdGateChangesRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling deleteProjectsWithOfficeWithProjectIdGateChanges.');
}
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling deleteProjectsWithOfficeWithProjectIdGateChanges.');
}
if (requestParameters.begin === null || requestParameters.begin === undefined) {
throw new runtime.RequiredError('begin', 'Required parameter requestParameters.begin was null or undefined when calling deleteProjectsWithOfficeWithProjectIdGateChanges.');
}
if (requestParameters.end === null || requestParameters.end === undefined) {
throw new runtime.RequiredError('end', 'Required parameter requestParameters.end was null or undefined when calling deleteProjectsWithOfficeWithProjectIdGateChanges.');
}
const queryParameters = {};
if (requestParameters.begin !== undefined) {
queryParameters['begin'] = requestParameters.begin;
}
if (requestParameters.end !== undefined) {
queryParameters['end'] = requestParameters.end;
}
if (requestParameters.overrideProtection !== undefined) {
queryParameters['override-protection'] = requestParameters.overrideProtection;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/projects/{office}/{project-id}/gate-changes`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters.office))).replace(`{${"project-id"}}`, encodeURIComponent(String(requestParameters.projectId))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Deletes matching CWMS gate change data for a Reservoir Project.
* Delete projects with office with projectId gateChanges
*/
deleteProjectsWithOfficeWithProjectIdGateChanges(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.deleteProjectsWithOfficeWithProjectIdGateChangesRaw(requestParameters, initOverrides);
});
}
/**
* Delete CWMS Virtual Outlet
* Delete projects with office with projectId virtualOutlets with name
*/
deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName.');
}
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName.');
}
if (requestParameters.name === null || requestParameters.name === undefined) {
throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName.');
}
const queryParameters = {};
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: `/projects/{office}/{project-id}/virtual-outlets/{name}`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters.office))).replace(`{${"project-id"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Delete CWMS Virtual Outlet
* Delete projects with office with projectId virtualOutlets with name
*/
deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw(requestParameters, initOverrides);
});
}
/**
* Returns matching CWMS Outlet Data for a Reservoir Project.
* Get projects outlets
*/
getProjectsOutletsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling getProjectsOutlets.');
}
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getProjectsOutlets.');
}
const queryParameters = {};
if (requestParameters.office !== undefined) {
queryParameters['office'] = requestParameters.office;
}
if (requestParameters.projectId !== undefined) {
queryParameters['project-id'] = requestParameters.projectId;
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/projects/outlets`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.OutletFromJSON));
});
}
/**
* Returns matching CWMS Outlet Data for a Reservoir Project.
* Get projects outlets
*/
getProjectsOutlets(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getProjectsOutletsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Returns CWMS Outlet Data
* Get projects outlets with name
*/
getProjectsOutletsWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.name === null || requestParameters.name === undefined) {
throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling getProjectsOutletsWithName.');
}
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling getProjectsOutletsWithName.');
}
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: `/projects/outlets/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.OutletFromJSON(jsonValue));
});
}
/**
* Returns CWMS Outlet Data
* Get projects outlets with name
*/
getProjectsOutletsWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getProjectsOutletsWithNameRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Returns matching CWMS gate change data for a Reservoir Project.
* Get projects with office with projectId gateChanges
*/
getProjectsWithOfficeWithProjectIdGateChangesRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling getProjectsWithOfficeWithProjectIdGateChanges.');
}
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getProjectsWithOfficeWithProjectIdGateChanges.');
}
if (requestParameters.begin === null || requestParameters.begin === undefined) {
throw new runtime.RequiredError('begin', 'Required parameter requestParameters.begin was null or undefined when calling getProjectsWithOfficeWithProjectIdGateChanges.');
}
if (requestParameters.end === null || requestParameters.end === undefined) {
throw new runtime.RequiredError('end', 'Required parameter requestParameters.end was null or undefined when calling getProjectsWithOfficeWithProjectIdGateChanges.');
}
const queryParameters = {};
if (requestParameters.begin !== undefined) {
queryParameters['begin'] = requestParameters.begin;
}
if (requestParameters.end !== undefined) {
queryParameters['end'] = requestParameters.end;
}
if (requestParameters.startTimeInclusive !== undefined) {
queryParameters['start-time-inclusive'] = requestParameters.startTimeInclusive;
}
if (requestParameters.endTimeInclusive !== undefined) {
queryParameters['end-time-inclusive'] = requestParameters.endTimeInclusive;
}
if (requestParameters.unitSystem !== undefined) {
queryParameters['unit-system'] = requestParameters.unitSystem;
}
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: `/projects/{office}/{project-id}/gate-changes`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters.office))).replace(`{${"project-id"}}`, encodeURIComponent(String(requestParameters.projectId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.GateChangeFromJSON));
});
}
/**
* Returns matching CWMS gate change data for a Reservoir Project.
* Get projects with office with projectId gateChanges
*/
getProjectsWithOfficeWithProjectIdGateChanges(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getProjectsWithOfficeWithProjectIdGateChangesRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Returns matching CWMS Virtual Outlet Data for a Reservoir Project.
* Get projects with office with projectId virtualOutlets
*/
getProjectsWithOfficeWithProjectIdVirtualOutletsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling getProjectsWithOfficeWithProjectIdVirtualOutlets.');
}
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getProjectsWithOfficeWithProjectIdVirtualOutlets.');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/projects/{office}/{project-id}/virtual-outlets`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters.office))).replace(`{${"project-id"}}`, encodeURIComponent(String(requestParameters.projectId))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(models_1.VirtualOutletFromJSON));
});
}
/**
* Returns matching CWMS Virtual Outlet Data for a Reservoir Project.
* Get projects with office with projectId virtualOutlets
*/
getProjectsWithOfficeWithProjectIdVirtualOutlets(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getProjectsWithOfficeWithProjectIdVirtualOutletsRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Returns CWMS Virtual Outlet Data
* Get projects with office with projectId virtualOutlets with name
*/
getProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling getProjectsWithOfficeWithProjectIdVirtualOutletsWithName.');
}
if (requestParameters.projectId === null || requestParameters.projectId === undefined) {
throw new runtime.RequiredError('projectId', 'Required parameter requestParameters.projectId was null or undefined when calling getProjectsWithOfficeWithProjectIdVirtualOutletsWithName.');
}
if (requestParameters.name === null || requestParameters.name === undefined) {
throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling getProjectsWithOfficeWithProjectIdVirtualOutletsWithName.');
}
const queryParameters = {};
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/projects/{office}/{project-id}/virtual-outlets/{name}`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters.office))).replace(`{${"project-id"}}`, encodeURIComponent(String(requestParameters.projectId))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => models_1.VirtualOutletFromJSON(jsonValue));
});
}
/**
* Returns CWMS Virtual Outlet Data
* Get projects with office with projectId virtualOutlets with name
*/
getProjectsWithOfficeWithProjectIdVirtualOutletsWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Rename CWMS Outlet
* Patch projects outlets with name
*/
patchProjectsOutletsWithNameRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.name === null || requestParameters.name === undefined) {
throw new runtime.RequiredError('name', 'Required parameter requestParameters.name was null or undefined when calling patchProjectsOutletsWithName.');
}
if (requestParameters.name2 === null || requestParameters.name2 === undefined) {
throw new runtime.RequiredError('name2', 'Required parameter requestParameters.name2 was null or undefined when calling patchProjectsOutletsWithName.');
}
if (requestParameters.office === null || requestParameters.office === undefined) {
throw new runtime.RequiredError('office', 'Required parameter requestParameters.office was null or undefined when calling patchProjectsOutletsWithName.');
}
const queryParameters = {};
if (requestParameters.name2 !== undefined) {
queryParameters['name'] = requestParameters.name2;
}
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: `/projects/outlets/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters.name))),
method: 'PATCH',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Rename CWMS Outlet
* Patch projects outlets with name
*/
patchProjectsOutletsWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.patchProjectsOutletsWithNameRaw(requestParameters, initOverrides);
});
}
/**
* Create CWMS Gate Changes
* Post projects gateChanges
*/
postProjectsGateChangesRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.gateChange === null || requestParameters.gateChange === undefined) {
throw new runtime.RequiredError('gateChange', 'Required parameter requestParameters.gateChange was null or undefined when calling postProjectsGateChanges.');
}
const queryParameters = {};
if (requestParameters.failIfExists !== undefined) {
queryParameters['fail-if-exists'] = requestParameters.failIfExists;
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json;version=1';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/projects/gate-changes`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: requestParameters.gateChange.map(models_1.GateChangeToJSON),
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Create CWMS Gate Changes
* Post projects gateChanges
*/
postProjectsGateChanges(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.postProjectsGateChangesRaw(requestParameters, initOverrides);
});
}
/**
* Create CWMS Outlet
* Post projects outlets
*/
postProjectsOutletsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.outlet === null || requestParameters.outlet === undefined) {
throw new runtime.RequiredError('outlet', 'Required parameter requestParameters.outlet was null or undefined when calling postProjectsOutlets.');
}
const queryParameters = {};
if (requestParameters.failIfExists !== undefined) {
queryParameters['fail-if-exists'] = requestParameters.failIfExists;
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json;version=1';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/projects/outlets`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: models_1.OutletToJSON(requestParameters.outlet),
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Create CWMS Outlet
* Post projects outlets
*/
postProjectsOutlets(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.postProjectsOutletsRaw(requestParameters, initOverrides);
});
}
/**
* Create CWMS Virtual Outlet
* Post projects virtualOutlets
*/
postProjectsVirtualOutletsRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters.virtualOutlet === null || requestParameters.virtualOutlet === undefined) {
throw new runtime.RequiredError('virtualOutlet', 'Required parameter requestParameters.virtualOutlet was null or undefined when calling postProjectsVirtualOutlets.');
}
const queryParameters = {};
if (requestParameters.failIfExists !== undefined) {
queryParameters['fail-if-exists'] = requestParameters.failIfExists;
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json;version=1';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/projects/virtual-outlets`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: models_1.VirtualOutletToJSON(requestParameters.virtualOutlet),
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Create CWMS Virtual Outlet
* Post projects virtualOutlets
*/
postProjectsVirtualOutlets(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.postProjectsVirtualOutletsRaw(requestParameters, initOverrides);
});
}
}
exports.OutletsApi = OutletsApi;