Class ProjectLocksApi

Hierarchy (view full)

BaseAPI
- ProjectLocksApi

Index

Constructors

Properties

Methods

deleteProjectLocksWithName deleteProjectLocksWithNameRaw getProjectLocks getProjectLocksRaw getProjectLocksWithName getProjectLocksWithNameRaw postProjectLocks postProjectLocksDeny postProjectLocksDenyRaw postProjectLocksRaw postProjectLocksRelease postProjectLocksReleaseRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

new ProjectLocksApi(configuration?): ProjectLocksApi
Parameters
- configuration: Configuration = ...
Returns ProjectLocksApi
Inherited from BaseAPI.constructor
- Defined in cwmsjs/src/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteProjectLocksWithName

deleteProjectLocksWithName(requestParameters, initOverrides?): Promise<void>
Revokes a project lock, if successful the lock is deleted Delete projectLocks with name
Parameters
- requestParameters: DeleteProjectLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:110

deleteProjectLocksWithNameRaw

deleteProjectLocksWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Revokes a project lock, if successful the lock is deleted Delete projectLocks with name
Parameters
- requestParameters: DeleteProjectLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:71

getProjectLocks

getProjectLocks(requestParameters, initOverrides?): Promise<ProjectLock>
Get a list of project locks Get projectLocks
Parameters
- requestParameters: GetProjectLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<ProjectLock>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:157

getProjectLocksRaw

getProjectLocksRaw(requestParameters, initOverrides?): Promise<ApiResponse<ProjectLock>>
Get a list of project locks Get projectLocks
Parameters
- requestParameters: GetProjectLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ProjectLock>>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:118

getProjectLocksWithName

getProjectLocksWithName(requestParameters, initOverrides?): Promise<ProjectLock>
Return a lock if the specified project is locked. Otherwise 404 Get projectLocks with name
Parameters
- requestParameters: GetProjectLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ProjectLock>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:209

getProjectLocksWithNameRaw

getProjectLocksWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<ProjectLock>>
Return a lock if the specified project is locked. Otherwise 404 Get projectLocks with name
Parameters
- requestParameters: GetProjectLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ProjectLock>>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:166

postProjectLocks

postProjectLocks(requestParameters, initOverrides?): Promise<ProjectLockId>
Requests the creation of a new Reservoir Project Lock Post projectLocks
Parameters
- requestParameters: PostProjectLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<ProjectLockId>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:256

postProjectLocksDeny

postProjectLocksDeny(requestParameters, initOverrides?): Promise<void>
Deny a Lock revoke request. Post projectLocks deny
Parameters
- requestParameters: PostProjectLocksDenyRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:296

postProjectLocksDenyRaw

postProjectLocksDenyRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deny a Lock revoke request. Post projectLocks deny
Parameters
- requestParameters: PostProjectLocksDenyRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:265

postProjectLocksRaw

postProjectLocksRaw(requestParameters, initOverrides?): Promise<ApiResponse<ProjectLockId>>
Requests the creation of a new Reservoir Project Lock Post projectLocks
Parameters
- requestParameters: PostProjectLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ProjectLockId>>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:218

postProjectLocksRelease

postProjectLocksRelease(requestParameters, initOverrides?): Promise<void>
Releases a project lock Post projectLocks release
Parameters
- requestParameters: PostProjectLocksReleaseRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:343

postProjectLocksReleaseRaw

postProjectLocksReleaseRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Releases a project lock Post projectLocks release
Parameters
- requestParameters: PostProjectLocksReleaseRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectLocksApi.ts:304

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:47

withMiddleware

withMiddleware<T>(this, ...middlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in cwmsjs/src/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this, ...postMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in cwmsjs/src/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this, ...preMiddlewares): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in cwmsjs/src/runtime.ts:37