Class ProjectLockRevokerRightsApi

Hierarchy (view full)

BaseAPI
- ProjectLockRevokerRightsApi

Index

Constructors

Properties

Methods

getProjectLockRights getProjectLockRightsRaw isJsonMime postProjectLockRightsRemoveAll postProjectLockRightsRemoveAllRaw postProjectLockRightsUpdate postProjectLockRightsUpdateRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

getProjectLockRights

getProjectLockRights(requestParameters, initOverrides?): Promise<LockRevokerRights[]>
Get a list of project lock revoker rights Get cwmsData projectLockRights
Parameters
- requestParameters: GetProjectLockRightsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<LockRevokerRights[]>
- Defined in cwmsjs/src/apis/ProjectLockRevokerRightsApi.ts:99

getProjectLockRightsRaw

getProjectLockRightsRaw(requestParameters, initOverrides?): Promise<ApiResponse<LockRevokerRights[]>>
Get a list of project lock revoker rights Get cwmsData projectLockRights
Parameters
- requestParameters: GetProjectLockRightsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<LockRevokerRights[]>>
- Defined in cwmsjs/src/apis/ProjectLockRevokerRightsApi.ts:57

`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

postProjectLockRightsRemoveAll

postProjectLockRightsRemoveAll(requestParameters, initOverrides?): Promise<void>
Revokes a project lock, if successful the lock is deleted Post cwmsData projectLockRights removeAll
Parameters
- requestParameters: PostProjectLockRightsRemoveAllRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectLockRevokerRightsApi.ts:164

postProjectLockRightsRemoveAllRaw

postProjectLockRightsRemoveAllRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Revokes a project lock, if successful the lock is deleted Post cwmsData projectLockRights removeAll
Parameters
- requestParameters: PostProjectLockRightsRemoveAllRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectLockRevokerRightsApi.ts:108

postProjectLockRightsUpdate

postProjectLockRightsUpdate(requestParameters, initOverrides?): Promise<void>
Update Lock Revoker Rights. Post cwmsData projectLockRights update
Parameters
- requestParameters: PostProjectLockRightsUpdateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectLockRevokerRightsApi.ts:243

postProjectLockRightsUpdateRaw

postProjectLockRightsUpdateRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update Lock Revoker Rights. Post cwmsData projectLockRights update
Parameters
- requestParameters: PostProjectLockRightsUpdateRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectLockRevokerRightsApi.ts:172

`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