Class EmbankmentsApi

Hierarchy (view full)

BaseAPI
- EmbankmentsApi

Index

Constructors

Properties

Methods

deleteProjectsEmbankmentsWithName deleteProjectsEmbankmentsWithNameRaw getProjectsEmbankments getProjectsEmbankmentsRaw getProjectsEmbankmentsWithName getProjectsEmbankmentsWithNameRaw isJsonMime patchProjectsEmbankmentsWithName patchProjectsEmbankmentsWithNameRaw postProjectsEmbankments postProjectsEmbankmentsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteProjectsEmbankmentsWithName

deleteProjectsEmbankmentsWithName(requestParameters, initOverrides?): Promise<void>
Delete CWMS Embankment Delete cwmsData projects embankments with name
Parameters
- requestParameters: DeleteProjectsEmbankmentsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:112

deleteProjectsEmbankmentsWithNameRaw

deleteProjectsEmbankmentsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Embankment Delete cwmsData projects embankments with name
Parameters
- requestParameters: DeleteProjectsEmbankmentsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:67

getProjectsEmbankments

getProjectsEmbankments(requestParameters, initOverrides?): Promise<Embankment[]>
Returns matching CWMS Embankment Data for a Reservoir Project. Get cwmsData projects embankments
Parameters
- requestParameters: GetProjectsEmbankmentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Embankment[]>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:158

getProjectsEmbankmentsRaw

getProjectsEmbankmentsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Embankment[]>>
Returns matching CWMS Embankment Data for a Reservoir Project. Get cwmsData projects embankments
Parameters
- requestParameters: GetProjectsEmbankmentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Embankment[]>>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:120

getProjectsEmbankmentsWithName

getProjectsEmbankmentsWithName(requestParameters, initOverrides?): Promise<Embankment[]>
Returns CWMS Embankment Data Get cwmsData projects embankments with name
Parameters
- requestParameters: GetProjectsEmbankmentsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Embankment[]>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:208

getProjectsEmbankmentsWithNameRaw

getProjectsEmbankmentsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Embankment[]>>
Returns CWMS Embankment Data Get cwmsData projects embankments with name
Parameters
- requestParameters: GetProjectsEmbankmentsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Embankment[]>>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:167

`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.
Inherited from BaseAPI.isJsonMime
- Defined in cwmsjs/src/runtime.ts:127

patchProjectsEmbankmentsWithName

patchProjectsEmbankmentsWithName(requestParameters, initOverrides?): Promise<void>
Rename CWMS Embankment Patch cwmsData projects embankments with name
Parameters
- requestParameters: PatchProjectsEmbankmentsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:269

patchProjectsEmbankmentsWithNameRaw

patchProjectsEmbankmentsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Rename CWMS Embankment Patch cwmsData projects embankments with name
Parameters
- requestParameters: PatchProjectsEmbankmentsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:217

postProjectsEmbankments

postProjectsEmbankments(requestParameters, initOverrides?): Promise<void>
Create CWMS Embankment Post cwmsData projects embankments
Parameters
- requestParameters: PostProjectsEmbankmentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:314

postProjectsEmbankmentsRaw

postProjectsEmbankmentsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create CWMS Embankment Post cwmsData projects embankments
Parameters
- requestParameters: PostProjectsEmbankmentsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/EmbankmentsApi.ts:277

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in cwmsjs/src/runtime.ts:134

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:101

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:112

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:107