Class LocationCategoriesApi

Hierarchy (view full)

BaseAPI
- LocationCategoriesApi

Index

Constructors

Properties

Methods

deleteLocationCategoryWithCategoryId deleteLocationCategoryWithCategoryIdRaw getLocationCategory getLocationCategoryRaw getLocationCategoryWithCategoryId getLocationCategoryWithCategoryIdRaw postLocationCategory postLocationCategoryRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteLocationCategoryWithCategoryId

deleteLocationCategoryWithCategoryId(requestParameters, initOverrides?): Promise<void>
Deletes requested location category Delete location category with categoryId
Parameters
- requestParameters: DeleteLocationCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:93

deleteLocationCategoryWithCategoryIdRaw

deleteLocationCategoryWithCategoryIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested location category Delete location category with categoryId
Parameters
- requestParameters: DeleteLocationCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:54

getLocationCategory

getLocationCategory(requestParameters?, initOverrides?): Promise<LocationCategory[]>
Returns CWMS Location Category Data Get location category
Parameters
- requestParameters: GetLocationCategoryRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<LocationCategory[]>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:128

getLocationCategoryRaw

getLocationCategoryRaw(requestParameters, initOverrides?): Promise<ApiResponse<LocationCategory[]>>
Returns CWMS Location Category Data Get location category
Parameters
- requestParameters: GetLocationCategoryRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LocationCategory[]>>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:101

getLocationCategoryWithCategoryId

getLocationCategoryWithCategoryId(requestParameters, initOverrides?): Promise<LocationCategory>
Retrieves requested Location Category Get location category with categoryId
Parameters
- requestParameters: GetLocationCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<LocationCategory>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:172

getLocationCategoryWithCategoryIdRaw

getLocationCategoryWithCategoryIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<LocationCategory>>
Retrieves requested Location Category Get location category with categoryId
Parameters
- requestParameters: GetLocationCategoryWithCategoryIdRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<LocationCategory>>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:137

postLocationCategory

postLocationCategory(requestParameters, initOverrides?): Promise<void>
Create new LocationCategory Post location category
Parameters
- requestParameters: PostLocationCategoryRequest
- Optional initOverrides: RequestInit
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:211

postLocationCategoryRaw

postLocationCategoryRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new LocationCategory Post location category
Parameters
- requestParameters: PostLocationCategoryRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationCategoriesApi.ts:181

`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