Class WaterContractsApi

Hierarchy (view full)

Constructors

constructor

Properties

configuration

Methods

deleteProjectsWithOfficeContractTypesWithDisplayValue deleteProjectsWithOfficeContractTypesWithDisplayValueRaw deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUser deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithName deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithNameRaw deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw getProjectsWithOfficeContractTypes getProjectsWithOfficeContractTypesRaw getProjectsWithOfficeWithProjectIdWaterUser getProjectsWithOfficeWithProjectIdWaterUserRaw getProjectsWithOfficeWithProjectIdWaterUserWithWaterUser getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRaw getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw isJsonMime patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUser patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw postProjectsWithOfficeContractTypes postProjectsWithOfficeContractTypesRaw postProjectsWithOfficeWithProjectIdWaterUser postProjectsWithOfficeWithProjectIdWaterUserRaw postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = DefaultConfig

Methods

deleteProjectsWithOfficeContractTypesWithDisplayValue

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

  • Delete a water contract type Delete cwmsData projects with office contractTypes with displayValue

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeContractTypesWithDisplayValueRaw

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUser

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

  • Deletes a water user from CWMS. Delete cwmsData projects with office with projectId waterUser with waterUser

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithName

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithNameRaw

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw

getProjectsWithOfficeContractTypes

getProjectsWithOfficeContractTypesRaw

getProjectsWithOfficeWithProjectIdWaterUser

getProjectsWithOfficeWithProjectIdWaterUserRaw

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUser

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRaw

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw

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.

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUser

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

  • Updates a water user in CWMS. Patch cwmsData projects with office with projectId waterUser with waterUser

    Parameters

    Returns Promise<void>

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw

postProjectsWithOfficeContractTypes

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

  • Create a new water contract type Post cwmsData projects with office contractTypes

    Parameters

    Returns Promise<void>

postProjectsWithOfficeContractTypesRaw

postProjectsWithOfficeWithProjectIdWaterUser

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

  • Stores a water user to CWMS. Post cwmsData projects with office with projectId waterUser

    Parameters

    Returns Promise<void>

postProjectsWithOfficeWithProjectIdWaterUserRaw

postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts

postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRaw

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

constructorconfigurationdeleteProjectsWithOfficeContractTypesWithDisplayValuedeleteProjectsWithOfficeContractTypesWithDisplayValueRawdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamedeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithNamedeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithNameRawdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRawdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRawgetProjectsWithOfficeContractTypesgetProjectsWithOfficeContractTypesRawgetProjectsWithOfficeWithProjectIdWaterUsergetProjectsWithOfficeWithProjectIdWaterUserRawgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUsergetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRawgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamegetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRawgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRawisJsonMimepatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserpatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamepatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRawpatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRawpostProjectsWithOfficeContractTypespostProjectsWithOfficeContractTypesRawpostProjectsWithOfficeWithProjectIdWaterUserpostProjectsWithOfficeWithProjectIdWaterUserRawpostProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractspostProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware