Class BasinsApi

Hierarchy (view full)

BaseAPI
- BasinsApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteBasinsWithName

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

deleteBasinsWithNameRaw

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

getBasins

getBasins(requestParameters?, initOverrides?): Promise<Basin>
Returns CWMS Basin Data. This endpoint handles multiple accept header types, including named pg json. For more information about accept header usage, <a href="legacy-format/">see this page. Get basins
Parameters
- requestParameters: GetBasinsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Basin>
- Defined in cwmsjs/src/apis/BasinsApi.ts:143

getBasinsRaw

getBasinsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Basin>>
Returns CWMS Basin Data. This endpoint handles multiple accept header types, including named pg json. For more information about accept header usage, <a href="legacy-format/">see this page. Get basins
Parameters
- requestParameters: GetBasinsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Basin>>
- Defined in cwmsjs/src/apis/BasinsApi.ts:112

getBasinsWithName

getBasinsWithName(requestParameters, initOverrides?): Promise<Basin>
Returns CWMS Basin Data. This endpoint handles multiple accept header types, including named pg json. For more information about accept header usage, <a href="legacy-format/">see this page. Get basins with name
Parameters
- requestParameters: GetBasinsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<Basin>
- Defined in cwmsjs/src/apis/BasinsApi.ts:191

getBasinsWithNameRaw

getBasinsWithNameRaw(requestParameters, initOverrides?): Promise<ApiResponse<Basin>>
Returns CWMS Basin Data. This endpoint handles multiple accept header types, including named pg json. For more information about accept header usage, <a href="legacy-format/">see this page. Get basins with name
Parameters
- requestParameters: GetBasinsWithNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Basin>>
- Defined in cwmsjs/src/apis/BasinsApi.ts:152

patchBasinsWithName

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

patchBasinsWithNameRaw

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

postBasins

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

postBasinsRaw

postBasinsRaw(initOverrides?): Promise<ApiResponse<void>>
Creates CWMS Basin Post basins
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/BasinsApi.ts:251

`Protected` request

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

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

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

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

Class BasinsApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns BasinsApi

Properties

Protected configuration

Methods

deleteBasinsWithName

Parameters

Returns Promise<void>

deleteBasinsWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

getBasins

Parameters

Returns Promise<Basin>

getBasinsRaw

Parameters

Returns Promise<ApiResponse<Basin>>

getBasinsWithName

Parameters

Returns Promise<Basin>

getBasinsWithNameRaw

Parameters

Returns Promise<ApiResponse<Basin>>

patchBasinsWithName

Parameters

Returns Promise<void>

patchBasinsWithNameRaw

Parameters

Returns Promise<ApiResponse<void>>

postBasins

Parameters

Returns Promise<void>

postBasinsRaw

Parameters

Returns Promise<ApiResponse<void>>

Protected request

Parameters

Returns Promise<Response>

withMiddleware

Type Parameters

Parameters

Returns T

withPostMiddleware

Type Parameters

Parameters

Returns T

withPreMiddleware

Type Parameters

Parameters

Returns T

Settings

Member Visibility

Theme

On This Page

`Protected` configuration

`Protected` request