Class PoolsApi

Hierarchy (view full)

BaseAPI
- PoolsApi

Index

Constructors

Properties

Methods

getPools getPoolsRaw getPoolsWithPoolId getPoolsWithPoolIdRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getPools

getPools(requestParameters?, initOverrides?): Promise<Pools>
Returns Pools Data Get pools
Parameters
- requestParameters: GetPoolsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Pools>
- Defined in cwmsjs/src/apis/PoolsApi.ts:119

getPoolsRaw

getPoolsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Pools>>
Returns Pools Data Get pools
Parameters
- requestParameters: GetPoolsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Pools>>
- Defined in cwmsjs/src/apis/PoolsApi.ts:60

getPoolsWithPoolId

getPoolsWithPoolId(requestParameters, initOverrides?): Promise<Pool>
Retrieves requested Pool Get pools with poolId
Parameters
- requestParameters: GetPoolsWithPoolIdRequest
- Optional initOverrides: RequestInit
Returns Promise<Pool>
- Defined in cwmsjs/src/apis/PoolsApi.ts:187

getPoolsWithPoolIdRaw

getPoolsWithPoolIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<Pool>>
Retrieves requested Pool Get pools with poolId
Parameters
- requestParameters: GetPoolsWithPoolIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Pool>>
- Defined in cwmsjs/src/apis/PoolsApi.ts:128

`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