Class ProjectsApi

Hierarchy (view full)

BaseAPI
- ProjectsApi

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteProjectsWithName

deleteProjectsWithName(requestParameters, initOverrides?): Promise<void>
Deletes requested reservoir project Delete projects with name
Parameters
- requestParameters: DeleteProjectsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:129

deleteProjectsWithNameRaw

deleteProjectsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested reservoir project Delete projects with name
Parameters
- requestParameters: DeleteProjectsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:90

getProjects

getProjects(requestParameters?, initOverrides?): Promise<Projects>
Returns Projects Data Get projects
Parameters
- requestParameters: GetProjectsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Projects>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:176

getProjectsLocations

getProjectsLocations(requestParameters, initOverrides?): Promise<ProjectChildLocations[]>
Get a list of project child locations Get projects locations
Parameters
- requestParameters: GetProjectsLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ProjectChildLocations[]>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:224

getProjectsLocationsRaw

getProjectsLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<ProjectChildLocations[]>>
Get a list of project child locations Get projects locations
Parameters
- requestParameters: GetProjectsLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<ProjectChildLocations[]>>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:185

getProjectsRaw

getProjectsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Projects>>
Returns Projects Data Get projects
Parameters
- requestParameters: GetProjectsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Projects>>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:137

getProjectsWithName

getProjectsWithName(requestParameters, initOverrides?): Promise<Project>
Retrieves requested Project Get projects with name
Parameters
- requestParameters: GetProjectsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<Project>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:268

getProjectsWithNameRaw

getProjectsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Project>>
Retrieves requested Project Get projects with name
Parameters
- requestParameters: GetProjectsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Project>>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:233

patchProjectsWithName

patchProjectsWithName(requestParameters, initOverrides?): Promise<void>
Rename a project Patch projects with name
Parameters
- requestParameters: PatchProjectsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:323

patchProjectsWithNameRaw

patchProjectsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename a project Patch projects with name
Parameters
- requestParameters: PatchProjectsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:277

postProjects

postProjects(requestParameters, initOverrides?): Promise<void>
Create new Project Post projects
Parameters
- requestParameters: PostProjectsRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:365

postProjectsRaw

postProjectsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new Project Post projects
Parameters
- requestParameters: PostProjectsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:331

postProjectsStatusUpdateWithName

postProjectsStatusUpdateWithName(requestParameters, initOverrides?): Promise<void>
Publishes a message on the office's STATUS queue that a project has been updated for a specified application Post projects statusUpdate with name
Parameters
- requestParameters: PostProjectsStatusUpdateWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:432

postProjectsStatusUpdateWithNameRaw

postProjectsStatusUpdateWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Publishes a message on the office's STATUS queue that a project has been updated for a specified application Post projects statusUpdate with name
Parameters
- requestParameters: PostProjectsStatusUpdateWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/ProjectsApi.ts:373

`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