Class OutletsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteProjectsOutletsWithName deleteProjectsOutletsWithNameRaw deleteProjectsWithOfficeWithProjectIdGateChanges deleteProjectsWithOfficeWithProjectIdGateChangesRaw deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw getProjectsOutlets getProjectsOutletsRaw getProjectsOutletsWithName getProjectsOutletsWithNameRaw getProjectsWithOfficeWithProjectIdGateChanges getProjectsWithOfficeWithProjectIdGateChangesRaw getProjectsWithOfficeWithProjectIdVirtualOutlets getProjectsWithOfficeWithProjectIdVirtualOutletsRaw getProjectsWithOfficeWithProjectIdVirtualOutletsWithName getProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw isJsonMime patchProjectsOutletsWithName patchProjectsOutletsWithNameRaw postProjectsGateChanges postProjectsGateChangesRaw postProjectsOutlets postProjectsOutletsRaw postProjectsVirtualOutlets postProjectsVirtualOutletsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteProjectsOutletsWithName

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

  • Delete CWMS Outlet Delete cwmsData projects outlets with name

    Parameters

    Returns Promise<void>

deleteProjectsOutletsWithNameRaw

deleteProjectsWithOfficeWithProjectIdGateChanges

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

  • Deletes matching CWMS gate change data for a Reservoir Project. Delete cwmsData projects with office with projectId gateChanges

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdGateChangesRaw

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithName

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

  • Delete CWMS Virtual Outlet Delete cwmsData projects with office with projectId virtualOutlets with name

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw

getProjectsOutlets

  • getProjectsOutlets(requestParameters, initOverrides?): Promise<Outlet[]>

  • Returns matching CWMS Outlet Data for a Reservoir Project. Get cwmsData projects outlets

    Parameters

    Returns Promise<Outlet[]>

getProjectsOutletsRaw

getProjectsOutletsWithName

  • getProjectsOutletsWithName(requestParameters, initOverrides?): Promise<Outlet>

  • Returns CWMS Outlet Data Get cwmsData projects outlets with name

    Parameters

    Returns Promise<Outlet>

getProjectsOutletsWithNameRaw

getProjectsWithOfficeWithProjectIdGateChanges

getProjectsWithOfficeWithProjectIdGateChangesRaw

getProjectsWithOfficeWithProjectIdVirtualOutlets

getProjectsWithOfficeWithProjectIdVirtualOutletsRaw

getProjectsWithOfficeWithProjectIdVirtualOutletsWithName

getProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRaw

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.

patchProjectsOutletsWithName

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

  • Rename CWMS Outlet Patch cwmsData projects outlets with name

    Parameters

    Returns Promise<void>

patchProjectsOutletsWithNameRaw

postProjectsGateChanges

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

  • Create CWMS Gate Changes Post cwmsData projects gateChanges

    Parameters

    Returns Promise<void>

postProjectsGateChangesRaw

postProjectsOutlets

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

  • Create CWMS Outlet Post cwmsData projects outlets

    Parameters

    Returns Promise<void>

postProjectsOutletsRaw

postProjectsVirtualOutlets

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

  • Create CWMS Virtual Outlet Post cwmsData projects virtualOutlets

    Parameters

    Returns Promise<void>

postProjectsVirtualOutletsRaw

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

constructorconfigurationdeleteProjectsOutletsWithNamedeleteProjectsOutletsWithNameRawdeleteProjectsWithOfficeWithProjectIdGateChangesdeleteProjectsWithOfficeWithProjectIdGateChangesRawdeleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNamedeleteProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRawgetProjectsOutletsgetProjectsOutletsRawgetProjectsOutletsWithNamegetProjectsOutletsWithNameRawgetProjectsWithOfficeWithProjectIdGateChangesgetProjectsWithOfficeWithProjectIdGateChangesRawgetProjectsWithOfficeWithProjectIdVirtualOutletsgetProjectsWithOfficeWithProjectIdVirtualOutletsRawgetProjectsWithOfficeWithProjectIdVirtualOutletsWithNamegetProjectsWithOfficeWithProjectIdVirtualOutletsWithNameRawisJsonMimepatchProjectsOutletsWithNamepatchProjectsOutletsWithNameRawpostProjectsGateChangespostProjectsGateChangesRawpostProjectsOutletspostProjectsOutletsRawpostProjectsVirtualOutletspostProjectsVirtualOutletsRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware