Class ProjectLocksApi

Hierarchy (view full)

BaseAPI
- ProjectLocksApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteProjectLocksWithName

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

deleteProjectLocksWithNameRaw

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

getProjectLocks

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

getProjectLocksRaw

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

getProjectLocksWithName

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

getProjectLocksWithNameRaw

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

`Protected` isJsonMime

isJsonMime(mime): boolean
Check if the given MIME is a JSON MIME. JSON MIME examples: application/json application/json; charset=UTF8 APPLICATION/JSON application/vnd.company+json
Parameters
- mime: string
  MIME (Multipurpose Internet Mail Extensions)
Returns boolean
True if the given MIME is JSON, false otherwise.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

postProjectLocks

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

postProjectLocksDeny

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

postProjectLocksDenyRaw

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

postProjectLocksRaw

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

postProjectLocksRelease

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

postProjectLocksReleaseRaw

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

`Protected` request

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

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:101

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:112

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:107