Class TimeSeriesCategoriesApi

Hierarchy (view full)

BaseAPI
- TimeSeriesCategoriesApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteTimeSeriesCategoryWithCategoryId

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

deleteTimeSeriesCategoryWithCategoryIdRaw

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

getTimeSeriesCategory

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

getTimeSeriesCategoryRaw

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

getTimeSeriesCategoryWithCategoryId

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

getTimeSeriesCategoryWithCategoryIdRaw

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

`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

postTimeSeriesCategory

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

postTimeSeriesCategoryRaw

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

`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

Class TimeSeriesCategoriesApi

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns TimeSeriesCategoriesApi

Properties

Protected configuration

Methods

deleteTimeSeriesCategoryWithCategoryId

Parameters

Returns Promise<void>

deleteTimeSeriesCategoryWithCategoryIdRaw

Parameters

Returns Promise<ApiResponse<void>>

getTimeSeriesCategory

Parameters

Returns Promise<TimeSeriesCategory[]>

getTimeSeriesCategoryRaw

Parameters

Returns Promise<ApiResponse<TimeSeriesCategory[]>>

getTimeSeriesCategoryWithCategoryId

Parameters

Returns Promise<TimeSeriesCategory>

getTimeSeriesCategoryWithCategoryIdRaw

Parameters

Returns Promise<ApiResponse<TimeSeriesCategory>>

Protected isJsonMime

Parameters

Returns boolean

postTimeSeriesCategory

Parameters

Returns Promise<void>

postTimeSeriesCategoryRaw

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` isJsonMime

`Protected` request