Class ProjectsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteProjectsWithName deleteProjectsWithNameRaw getProjects getProjectsLocations getProjectsLocationsRaw getProjectsRaw getProjectsWithName getProjectsWithNameRaw isJsonMime patchProjectsWithName patchProjectsWithNameRaw postProjects postProjectsRaw postProjectsStatusUpdateWithName postProjectsStatusUpdateWithNameRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteProjectsWithName

  • deleteProjectsWithName(requestParameters, initOverrides?): Promise<void>

  • Deletes requested reservoir project Delete cwmsData projects with name

    Parameters

    Returns Promise<void>

deleteProjectsWithNameRaw

getProjects

  • getProjects(requestParameters?, initOverrides?): Promise<Projects>

  • Returns Projects Data Get cwmsData projects

    Parameters

    Returns Promise<Projects>

getProjectsLocations

getProjectsLocationsRaw

getProjectsRaw

getProjectsWithName

  • getProjectsWithName(requestParameters, initOverrides?): Promise<Project>

  • Retrieves requested Project Get cwmsData projects with name

    Parameters

    Returns Promise<Project>

getProjectsWithNameRaw

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.

patchProjectsWithName

  • patchProjectsWithName(requestParameters, initOverrides?): Promise<void>

  • Rename a project Patch cwmsData projects with name

    Parameters

    Returns Promise<void>

patchProjectsWithNameRaw

postProjects

  • postProjects(requestParameters, initOverrides?): Promise<void>

  • Create new Project Post cwmsData projects

    Parameters

    Returns Promise<void>

postProjectsRaw

  • postProjectsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>

  • Create new Project Post cwmsData projects

    Parameters

    Returns Promise<ApiResponse<void>>

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 cwmsData projects statusUpdate with name

    Parameters

    Returns Promise<void>

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 cwmsData projects statusUpdate with name

    Parameters

    Returns Promise<ApiResponse<void>>

Protected request

  • request(context, initOverrides?): Promise<Response>

  • Parameters

    Returns Promise<Response>

withMiddleware

withPostMiddleware

  • withPostMiddleware<T>(this, ...postMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...postMiddlewares: ((context) => Promise<void | Response>)[]

    Returns T

withPreMiddleware

  • withPreMiddleware<T>(this, ...preMiddlewares): T

  • Type Parameters

    Parameters

    • this: T
    • Rest ...preMiddlewares: ((context) => Promise<void | FetchParams>)[]

    Returns T

Settings

Member Visibility

Theme

On This Page

constructorconfigurationdeleteProjectsWithNamedeleteProjectsWithNameRawgetProjectsgetProjectsLocationsgetProjectsLocationsRawgetProjectsRawgetProjectsWithNamegetProjectsWithNameRawisJsonMimepatchProjectsWithNamepatchProjectsWithNameRawpostProjectspostProjectsRawpostProjectsStatusUpdateWithNamepostProjectsStatusUpdateWithNameRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware