cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
275 lines (274 loc) • 12.9 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 { ProjectLockFromJSON, ProjectLockToJSON, ProjectLockIdFromJSON, } from '../models/index';
/**
*
*/
export class ProjectLocksApi extends runtime.BaseAPI {
/**
* Revokes a project lock, if successful the lock is deleted
* Delete cwmsData projectLocks with name
*/
deleteProjectLocksWithNameRaw(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 deleteProjectLocksWithName().');
}
if (requestParameters['office'] == null) {
throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling deleteProjectLocksWithName().');
}
const queryParameters = {};
if (requestParameters['office'] != null) {
queryParameters['office'] = requestParameters['office'];
}
if (requestParameters['revokeTimeout'] != null) {
queryParameters['revoke-timeout'] = requestParameters['revokeTimeout'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/project-locks/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))),
method: 'DELETE',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Revokes a project lock, if successful the lock is deleted
* Delete cwmsData projectLocks with name
*/
deleteProjectLocksWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.deleteProjectLocksWithNameRaw(requestParameters, initOverrides);
});
}
/**
* Get a list of project locks
* Get cwmsData projectLocks
*/
getProjectLocksRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['officeMask'] == null) {
throw new runtime.RequiredError('officeMask', 'Required parameter "officeMask" was null or undefined when calling getProjectLocks().');
}
const queryParameters = {};
if (requestParameters['officeMask'] != null) {
queryParameters['office-mask'] = requestParameters['officeMask'];
}
if (requestParameters['projectMask'] != null) {
queryParameters['project-mask'] = requestParameters['projectMask'];
}
if (requestParameters['applicationMask'] != null) {
queryParameters['application-mask'] = requestParameters['applicationMask'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/project-locks`,
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => ProjectLockFromJSON(jsonValue));
});
}
/**
* Get a list of project locks
* Get cwmsData projectLocks
*/
getProjectLocks(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getProjectLocksRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Return a lock if the specified project is locked. Otherwise 404
* Get cwmsData projectLocks with name
*/
getProjectLocksWithNameRaw(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 getProjectLocksWithName().');
}
if (requestParameters['office'] == null) {
throw new runtime.RequiredError('office', 'Required parameter "office" was null or undefined when calling getProjectLocksWithName().');
}
if (requestParameters['applicationId'] == null) {
throw new runtime.RequiredError('applicationId', 'Required parameter "applicationId" was null or undefined when calling getProjectLocksWithName().');
}
const queryParameters = {};
if (requestParameters['office'] != null) {
queryParameters['office'] = requestParameters['office'];
}
if (requestParameters['applicationId'] != null) {
queryParameters['application-id'] = requestParameters['applicationId'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/project-locks/{name}`.replace(`{${"name"}}`, encodeURIComponent(String(requestParameters['name']))),
method: 'GET',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => ProjectLockFromJSON(jsonValue));
});
}
/**
* Return a lock if the specified project is locked. Otherwise 404
* Get cwmsData projectLocks with name
*/
getProjectLocksWithName(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.getProjectLocksWithNameRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Requests the creation of a new Reservoir Project Lock
* Post cwmsData projectLocks
*/
postProjectLocksRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['projectLock'] == null) {
throw new runtime.RequiredError('projectLock', 'Required parameter "projectLock" was null or undefined when calling postProjectLocks().');
}
const queryParameters = {};
if (requestParameters['revokeExisting'] != null) {
queryParameters['revoke-existing'] = requestParameters['revokeExisting'];
}
if (requestParameters['revokeTimeout'] != null) {
queryParameters['revoke-timeout'] = requestParameters['revokeTimeout'];
}
const headerParameters = {};
headerParameters['Content-Type'] = 'application/json';
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/project-locks`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
body: ProjectLockToJSON(requestParameters['projectLock']),
}, initOverrides);
return new runtime.JSONApiResponse(response, (jsonValue) => ProjectLockIdFromJSON(jsonValue));
});
}
/**
* Requests the creation of a new Reservoir Project Lock
* Post cwmsData projectLocks
*/
postProjectLocks(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
const response = yield this.postProjectLocksRaw(requestParameters, initOverrides);
return yield response.value();
});
}
/**
* Deny a Lock revoke request.
* Post cwmsData projectLocks deny
*/
postProjectLocksDenyRaw(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
if (requestParameters['lockId'] == null) {
throw new runtime.RequiredError('lockId', 'Required parameter "lockId" was null or undefined when calling postProjectLocksDeny().');
}
const queryParameters = {};
if (requestParameters['lockId'] != null) {
queryParameters['lock-id'] = requestParameters['lockId'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/project-locks/deny`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Deny a Lock revoke request.
* Post cwmsData projectLocks deny
*/
postProjectLocksDeny(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.postProjectLocksDenyRaw(requestParameters, initOverrides);
});
}
/**
* Releases a project lock
* Post cwmsData projectLocks release
*/
postProjectLocksReleaseRaw(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 postProjectLocksRelease().');
}
if (requestParameters['lockId'] == null) {
throw new runtime.RequiredError('lockId', 'Required parameter "lockId" was null or undefined when calling postProjectLocksRelease().');
}
const queryParameters = {};
if (requestParameters['office'] != null) {
queryParameters['office'] = requestParameters['office'];
}
if (requestParameters['lockId'] != null) {
queryParameters['lock-id'] = requestParameters['lockId'];
}
const headerParameters = {};
if (this.configuration && this.configuration.apiKey) {
headerParameters["Authorization"] = yield this.configuration.apiKey("Authorization"); // ApiKey authentication
}
const response = yield this.request({
path: `/project-locks/release`,
method: 'POST',
headers: headerParameters,
query: queryParameters,
}, initOverrides);
return new runtime.VoidApiResponse(response);
});
}
/**
* Releases a project lock
* Post cwmsData projectLocks release
*/
postProjectLocksRelease(requestParameters, initOverrides) {
return __awaiter(this, void 0, void 0, function* () {
yield this.postProjectLocksReleaseRaw(requestParameters, initOverrides);
});
}
}