cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
106 lines (105 loc) • 3.89 kB
TypeScript
/**
* 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.
*/
import * as runtime from '../runtime';
import { ProjectLock, ProjectLockId } from '../models';
export interface DeleteProjectLocksWithNameRequest {
name: string;
office: string;
revokeTimeout?: number;
}
export interface GetProjectLocksRequest {
officeMask: string;
projectMask?: string;
applicationMask?: string;
}
export interface GetProjectLocksWithNameRequest {
name: string;
office: string;
applicationId: string;
}
export interface PostProjectLocksRequest {
projectLock: ProjectLock;
revokeExisting?: boolean;
revokeTimeout?: number;
}
export interface PostProjectLocksDenyRequest {
lockId: string;
}
export interface PostProjectLocksReleaseRequest {
office: string;
lockId: string;
}
/**
*
*/
export declare class ProjectLocksApi extends runtime.BaseAPI {
/**
* Revokes a project lock, if successful the lock is deleted
* Delete projectLocks with name
*/
deleteProjectLocksWithNameRaw(requestParameters: DeleteProjectLocksWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Revokes a project lock, if successful the lock is deleted
* Delete projectLocks with name
*/
deleteProjectLocksWithName(requestParameters: DeleteProjectLocksWithNameRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Get a list of project locks
* Get projectLocks
*/
getProjectLocksRaw(requestParameters: GetProjectLocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ProjectLock>>;
/**
* Get a list of project locks
* Get projectLocks
*/
getProjectLocks(requestParameters: GetProjectLocksRequest, initOverrides?: RequestInit): Promise<ProjectLock>;
/**
* Return a lock if the specified project is locked. Otherwise 404
* Get projectLocks with name
*/
getProjectLocksWithNameRaw(requestParameters: GetProjectLocksWithNameRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ProjectLock>>;
/**
* Return a lock if the specified project is locked. Otherwise 404
* Get projectLocks with name
*/
getProjectLocksWithName(requestParameters: GetProjectLocksWithNameRequest, initOverrides?: RequestInit): Promise<ProjectLock>;
/**
* Requests the creation of a new Reservoir Project Lock
* Post projectLocks
*/
postProjectLocksRaw(requestParameters: PostProjectLocksRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<ProjectLockId>>;
/**
* Requests the creation of a new Reservoir Project Lock
* Post projectLocks
*/
postProjectLocks(requestParameters: PostProjectLocksRequest, initOverrides?: RequestInit): Promise<ProjectLockId>;
/**
* Deny a Lock revoke request.
* Post projectLocks deny
*/
postProjectLocksDenyRaw(requestParameters: PostProjectLocksDenyRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Deny a Lock revoke request.
* Post projectLocks deny
*/
postProjectLocksDeny(requestParameters: PostProjectLocksDenyRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Releases a project lock
* Post projectLocks release
*/
postProjectLocksReleaseRaw(requestParameters: PostProjectLocksReleaseRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Releases a project lock
* Post projectLocks release
*/
postProjectLocksRelease(requestParameters: PostProjectLocksReleaseRequest, initOverrides?: RequestInit): Promise<void>;
}