Class LocksApi

Hierarchy (view full)

BaseAPI
- LocksApi

Index

Constructors

Properties

Methods

deleteProjectsLocksWithName deleteProjectsLocksWithNameRaw getProjectsLocks getProjectsLocksRaw getProjectsLocksWithName getProjectsLocksWithNameRaw patchProjectsLocksWithName patchProjectsLocksWithNameRaw postProjectsLocks postProjectsLocksRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteProjectsLocksWithName

deleteProjectsLocksWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Lock Delete projects locks with name
Parameters
- requestParameters: DeleteProjectsLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocksApi.ts:105

deleteProjectsLocksWithNameRaw

deleteProjectsLocksWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Lock Delete projects locks with name
Parameters
- requestParameters: DeleteProjectsLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocksApi.ts:66

getProjectsLocks

getProjectsLocks(requestParameters, initOverrides?): Promise<Lock[]>
Returns matching CWMS Lock Data for a Reservoir Project. Get projects locks
Parameters
- requestParameters: GetProjectsLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<Lock[]>
- Defined in cwmsjs/src/apis/LocksApi.ts:152

getProjectsLocksRaw

getProjectsLocksRaw(requestParameters, initOverrides?): Promise<ApiResponse<Lock[]>>
Returns matching CWMS Lock Data for a Reservoir Project. Get projects locks
Parameters
- requestParameters: GetProjectsLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Lock[]>>
- Defined in cwmsjs/src/apis/LocksApi.ts:113

getProjectsLocksWithName

getProjectsLocksWithName(requestParameters, initOverrides?): Promise<Lock[]>
Returns CWMS Lock Data Get projects locks with name
Parameters
- requestParameters: GetProjectsLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<Lock[]>
- Defined in cwmsjs/src/apis/LocksApi.ts:200

getProjectsLocksWithNameRaw

getProjectsLocksWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Lock[]>>
Returns CWMS Lock Data Get projects locks with name
Parameters
- requestParameters: GetProjectsLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Lock[]>>
- Defined in cwmsjs/src/apis/LocksApi.ts:161

patchProjectsLocksWithName

patchProjectsLocksWithName(requestParameters, initOverrides?): Promise<void>
Rename CWMS Lock Patch projects locks with name
Parameters
- requestParameters: PatchProjectsLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocksApi.ts:252

patchProjectsLocksWithNameRaw

patchProjectsLocksWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename CWMS Lock Patch projects locks with name
Parameters
- requestParameters: PatchProjectsLocksWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocksApi.ts:209

postProjectsLocks

postProjectsLocks(requestParameters, initOverrides?): Promise<void>
Create CWMS Lock Post projects locks
Parameters
- requestParameters: PostProjectsLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocksApi.ts:294

postProjectsLocksRaw

postProjectsLocksRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Lock Post projects locks
Parameters
- requestParameters: PostProjectsLocksRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocksApi.ts:260

`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