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 patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUser patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw postProjectsWithOfficeContractTypes postProjectsWithOfficeContractTypesRaw postProjectsWithOfficeWithProjectIdWaterUser postProjectsWithOfficeWithProjectIdWaterUserRaw postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

Properties

Protected configuration

configuration: Configuration = ...

Methods

deleteProjectsWithOfficeContractTypesWithDisplayValue

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

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

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeContractTypesWithDisplayValueRaw

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

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

    Parameters

    Returns Promise<ApiResponse<void>>

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUser

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

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

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName

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

  • Delete a specified water contract Delete projects with office with projectId waterUser with waterUser contracts with contractName

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithName

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

  • Disassociate a pump from a contract Delete projects with office with projectId waterUser with waterUser contracts with contractName pumps with name

    Parameters

    Returns Promise<void>

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithNameRaw

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw

deleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw

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

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

    Parameters

    Returns Promise<ApiResponse<void>>

getProjectsWithOfficeContractTypes

  • getProjectsWithOfficeContractTypes(requestParameters, initOverrides?): Promise<LookupType>

  • Get all water contract types Get projects with office contractTypes

    Parameters

    Returns Promise<LookupType>

getProjectsWithOfficeContractTypesRaw

getProjectsWithOfficeWithProjectIdWaterUser

  • getProjectsWithOfficeWithProjectIdWaterUser(requestParameters, initOverrides?): Promise<WaterUser>

  • Gets all water users. Get projects with office with projectId waterUser

    Parameters

    Returns Promise<WaterUser>

getProjectsWithOfficeWithProjectIdWaterUserRaw

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUser

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRaw

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw

getProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUser

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

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

    Parameters

    Returns Promise<void>

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractName

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

  • Renames a water contract Patch projects with office with projectId waterUser with waterUser contracts with contractName

    Parameters

    Returns Promise<void>

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRaw

patchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRaw

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

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

    Parameters

    Returns Promise<ApiResponse<void>>

postProjectsWithOfficeContractTypes

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

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

    Parameters

    Returns Promise<void>

postProjectsWithOfficeContractTypesRaw

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

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

    Parameters

    Returns Promise<ApiResponse<void>>

postProjectsWithOfficeWithProjectIdWaterUser

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

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

    Parameters

    Returns Promise<void>

postProjectsWithOfficeWithProjectIdWaterUserRaw

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

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

    Parameters

    Returns Promise<ApiResponse<void>>

postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContracts

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

  • Create a new water contract Post projects with office with projectId waterUser with waterUser contracts

    Parameters

    Returns Promise<void>

postProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRaw

Protected request

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

  • Parameters

    • context: RequestOpts
    • Optional initOverrides: RequestInit

    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

constructorconfigurationdeleteProjectsWithOfficeContractTypesWithDisplayValuedeleteProjectsWithOfficeContractTypesWithDisplayValueRawdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamedeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithNamedeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamePumpsWithNameRawdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRawdeleteProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRawgetProjectsWithOfficeContractTypesgetProjectsWithOfficeContractTypesRawgetProjectsWithOfficeWithProjectIdWaterUsergetProjectsWithOfficeWithProjectIdWaterUserRawgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUsergetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRawgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamegetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRawgetProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRawpatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserpatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNamepatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsWithContractNameRawpatchProjectsWithOfficeWithProjectIdWaterUserWithWaterUserRawpostProjectsWithOfficeContractTypespostProjectsWithOfficeContractTypesRawpostProjectsWithOfficeWithProjectIdWaterUserpostProjectsWithOfficeWithProjectIdWaterUserRawpostProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractspostProjectsWithOfficeWithProjectIdWaterUserWithWaterUserContractsRawrequestwithMiddlewarewithPostMiddlewarewithPreMiddleware