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