Class TimeSeriesCategoriesApi

Hierarchy (view full)

BaseAPI
- TimeSeriesCategoriesApi

Index

Constructors

Properties

Methods

deleteTimeSeriesCategoryWithCategoryId deleteTimeSeriesCategoryWithCategoryIdRaw getTimeSeriesCategory getTimeSeriesCategoryRaw getTimeSeriesCategoryWithCategoryId getTimeSeriesCategoryWithCategoryIdRaw postTimeSeriesCategory postTimeSeriesCategoryRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteTimeSeriesCategoryWithCategoryId

deleteTimeSeriesCategoryWithCategoryId(requestParameters, initOverrides?): Promise<void>
Deletes requested time series category Delete timeseries category with categoryId
Parameters
- requestParameters: DeleteTimeSeriesCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:94

deleteTimeSeriesCategoryWithCategoryIdRaw

deleteTimeSeriesCategoryWithCategoryIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested time series category Delete timeseries category with categoryId
Parameters
- requestParameters: DeleteTimeSeriesCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:55

getTimeSeriesCategory

getTimeSeriesCategory(requestParameters?, initOverrides?): Promise<TimeSeriesCategory[]>
Returns CWMS timeseries category Data Get timeseries category
Parameters
- requestParameters: GetTimeSeriesCategoryRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<TimeSeriesCategory[]>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:129

getTimeSeriesCategoryRaw

getTimeSeriesCategoryRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesCategory[]>>
Returns CWMS timeseries category Data Get timeseries category
Parameters
- requestParameters: GetTimeSeriesCategoryRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TimeSeriesCategory[]>>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:102

getTimeSeriesCategoryWithCategoryId

getTimeSeriesCategoryWithCategoryId(requestParameters, initOverrides?): Promise<TimeSeriesCategory>
Retrieves requested timeseries category Get timeseries category with categoryId
Parameters
- requestParameters: GetTimeSeriesCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<TimeSeriesCategory>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:173

getTimeSeriesCategoryWithCategoryIdRaw

getTimeSeriesCategoryWithCategoryIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<TimeSeriesCategory>>
Retrieves requested timeseries category Get timeseries category with categoryId
Parameters
- requestParameters: GetTimeSeriesCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<TimeSeriesCategory>>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:138

postTimeSeriesCategory

postTimeSeriesCategory(requestParameters, initOverrides?): Promise<void>
Create new TimeSeriesCategory Post timeseries category
Parameters
- requestParameters: PostTimeSeriesCategoryRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:216

postTimeSeriesCategoryRaw

postTimeSeriesCategoryRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new TimeSeriesCategory Post timeseries category
Parameters
- requestParameters: PostTimeSeriesCategoryRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/TimeSeriesCategoriesApi.ts:182

`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