Class BasinsApi

Hierarchy (view full)

BaseAPI
- BasinsApi

Index

Constructors

Properties

Methods

deleteBasinsWithName deleteBasinsWithNameRaw getBasins getBasinsRaw getBasinsWithName getBasinsWithNameRaw isJsonMime patchBasinsWithName patchBasinsWithNameRaw postBasins postBasinsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteBasinsWithName

deleteBasinsWithName(requestParameters, initOverrides?): Promise<void>
Renames CWMS Basin Delete cwmsData basins with name
Parameters
- requestParameters: DeleteBasinsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/BasinsApi.ts:115

deleteBasinsWithNameRaw

deleteBasinsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Renames CWMS Basin Delete cwmsData basins with name
Parameters
- requestParameters: DeleteBasinsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/BasinsApi.ts:63

getBasins

getBasins(requestParameters?, initOverrides?): Promise<Basin>
Returns CWMS Basin Data Get cwmsData basins
Parameters
- requestParameters: GetBasinsRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Basin>
- Defined in cwmsjs/src/apis/BasinsApi.ts:154

getBasinsRaw

getBasinsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Basin>>
Returns CWMS Basin Data Get cwmsData basins
Parameters
- requestParameters: GetBasinsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Basin>>
- Defined in cwmsjs/src/apis/BasinsApi.ts:123

getBasinsWithName

getBasinsWithName(requestParameters, initOverrides?): Promise<Basin>
Returns CWMS Basin Data Get cwmsData basins with name
Parameters
- requestParameters: GetBasinsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Basin>
- Defined in cwmsjs/src/apis/BasinsApi.ts:208

getBasinsWithNameRaw

getBasinsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Basin>>
Returns CWMS Basin Data Get cwmsData basins with name
Parameters
- requestParameters: GetBasinsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Basin>>
- Defined in cwmsjs/src/apis/BasinsApi.ts:163

`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

patchBasinsWithName

patchBasinsWithName(requestParameters, initOverrides?): Promise<void>
Renames CWMS Basin Patch cwmsData basins with name
Parameters
- requestParameters: PatchBasinsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/BasinsApi.ts:269

patchBasinsWithNameRaw

patchBasinsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Renames CWMS Basin Patch cwmsData basins with name
Parameters
- requestParameters: PatchBasinsWithNameRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/BasinsApi.ts:217

postBasins

postBasins(initOverrides?): Promise<void>
Creates CWMS Basin Post cwmsData basins
Parameters
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/BasinsApi.ts:300

postBasinsRaw

postBasinsRaw(initOverrides?): Promise<ApiResponse<void>>
Creates CWMS Basin Post cwmsData basins
Parameters
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/BasinsApi.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