UNPKG

cwmsjs

Version:

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

390 lines (389 loc) 20.1 kB
"use strict"; /* 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()); }); }; Object.defineProperty(exports, "__esModule", { value: true }); exports.TurbinesApi = void 0; const runtime = require("../runtime"); const index_1 = require("../models/index"); /** * */ class TurbinesApi extends runtime.BaseAPI { /** * Delete CWMS Turbine * Delete cwmsData projects turbines with name */ deleteProjectsTurbinesWithNameRaw(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 deleteProjectsTurbinesWithName().'); } if (requestParameters['office'] == null) { throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling deleteProjectsTurbinesWithName().'); } 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/turbines/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); }); } /** * Delete CWMS Turbine * Delete cwmsData projects turbines with name */ deleteProjectsTurbinesWithName(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { yield this.deleteProjectsTurbinesWithNameRaw(requestParameters, initOverrides); }); } /** * Delete CWMS Turbine Changes * Delete cwmsData projects with office with name turbineChanges */ deleteProjectsWithOfficeWithNameTurbineChangesRaw(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 deleteProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['name'] == null) { throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling deleteProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['begin'] == null) { throw new runtime.RequiredError('begin', 'Required parameter "begin" was null or undefined when calling deleteProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['end'] == null) { throw new runtime.RequiredError('end', 'Required parameter "end" was null or undefined when calling deleteProjectsWithOfficeWithNameTurbineChanges().'); } 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}/{name}/turbine-changes`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters['office']))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))), method: 'DELETE', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); }); } /** * Delete CWMS Turbine Changes * Delete cwmsData projects with office with name turbineChanges */ deleteProjectsWithOfficeWithNameTurbineChanges(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { yield this.deleteProjectsWithOfficeWithNameTurbineChangesRaw(requestParameters, initOverrides); }); } /** * Returns matching CWMS Turbine Data for a Reservoir Project. * Get cwmsData projects turbines */ getProjectsTurbinesRaw(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 getProjectsTurbines().'); } if (requestParameters['projectId'] == null) { throw new runtime.RequiredError('projectId', 'Required parameter "projectId" was null or undefined when calling getProjectsTurbines().'); } 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/turbines`, method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.TurbineFromJSON)); }); } /** * Returns matching CWMS Turbine Data for a Reservoir Project. * Get cwmsData projects turbines */ getProjectsTurbines(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.getProjectsTurbinesRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Returns CWMS Turbine Data * Get cwmsData projects turbines with name */ getProjectsTurbinesWithNameRaw(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 getProjectsTurbinesWithName().'); } if (requestParameters['office'] == null) { throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling getProjectsTurbinesWithName().'); } 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/turbines/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.TurbineFromJSON)(jsonValue)); }); } /** * Returns CWMS Turbine Data * Get cwmsData projects turbines with name */ getProjectsTurbinesWithName(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.getProjectsTurbinesWithNameRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Returns matching CWMS Turbine Change Data for a Reservoir Project. * Get cwmsData projects with office with name turbineChanges */ getProjectsWithOfficeWithNameTurbineChangesRaw(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 getProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['name'] == null) { throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling getProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['begin'] == null) { throw new runtime.RequiredError('begin', 'Required parameter "begin" was null or undefined when calling getProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['end'] == null) { throw new runtime.RequiredError('end', 'Required parameter "end" was null or undefined when calling getProjectsWithOfficeWithNameTurbineChanges().'); } 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}/{name}/turbine-changes`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters['office']))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))), method: 'GET', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.JSONApiResponse(response, (jsonValue) => jsonValue.map(index_1.TurbineChangeFromJSON)); }); } /** * Returns matching CWMS Turbine Change Data for a Reservoir Project. * Get cwmsData projects with office with name turbineChanges */ getProjectsWithOfficeWithNameTurbineChanges(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { const response = yield this.getProjectsWithOfficeWithNameTurbineChangesRaw(requestParameters, initOverrides); return yield response.value(); }); } /** * Rename CWMS Turbine * Patch cwmsData projects turbines with name */ patchProjectsTurbinesWithNameRaw(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 patchProjectsTurbinesWithName().'); } if (requestParameters['name2'] == null) { throw new runtime.RequiredError('name2', 'Required parameter "name2" was null or undefined when calling patchProjectsTurbinesWithName().'); } if (requestParameters['office'] == null) { throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling patchProjectsTurbinesWithName().'); } 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/turbines/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))), method: 'PATCH', headers: headerParameters, query: queryParameters, }, initOverrides); return new runtime.VoidApiResponse(response); }); } /** * Rename CWMS Turbine * Patch cwmsData projects turbines with name */ patchProjectsTurbinesWithName(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { yield this.patchProjectsTurbinesWithNameRaw(requestParameters, initOverrides); }); } /** * Create CWMS Turbine * Post cwmsData projects turbines */ postProjectsTurbinesRaw(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { if (requestParameters['turbine'] == null) { throw new runtime.RequiredError('turbine', 'Required parameter "turbine" was null or undefined when calling postProjectsTurbines().'); } 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/turbines`, method: 'POST', headers: headerParameters, query: queryParameters, body: (0, index_1.TurbineToJSON)(requestParameters['turbine']), }, initOverrides); return new runtime.VoidApiResponse(response); }); } /** * Create CWMS Turbine * Post cwmsData projects turbines */ postProjectsTurbines(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { yield this.postProjectsTurbinesRaw(requestParameters, initOverrides); }); } /** * Create CWMS Turbine Changes * Post cwmsData projects with office with name turbineChanges */ postProjectsWithOfficeWithNameTurbineChangesRaw(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 postProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['name'] == null) { throw new runtime.RequiredError('name', 'Required parameter "name" was null or undefined when calling postProjectsWithOfficeWithNameTurbineChanges().'); } if (requestParameters['turbineChange'] == null) { throw new runtime.RequiredError('turbineChange', 'Required parameter "turbineChange" was null or undefined when calling postProjectsWithOfficeWithNameTurbineChanges().'); } const queryParameters = {}; if (requestParameters['overrideProtection'] != null) { queryParameters['override-protection'] = requestParameters['overrideProtection']; } 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/{office}/{name}/turbine-changes`.replace(`{${"office"}}`, encodeURIComponent(String(requestParameters['office']))).replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))), method: 'POST', headers: headerParameters, query: queryParameters, body: (0, index_1.TurbineChangeToJSON)(requestParameters['turbineChange']), }, initOverrides); return new runtime.VoidApiResponse(response); }); } /** * Create CWMS Turbine Changes * Post cwmsData projects with office with name turbineChanges */ postProjectsWithOfficeWithNameTurbineChanges(requestParameters, initOverrides) { return __awaiter(this, void 0, void 0, function* () { yield this.postProjectsWithOfficeWithNameTurbineChangesRaw(requestParameters, initOverrides); }); } } exports.TurbinesApi = TurbinesApi;