Class LocationCategoriesApi

Hierarchy (view full)

BaseAPI
- LocationCategoriesApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteLocationCategoryWithCategoryId

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

deleteLocationCategoryWithCategoryIdRaw

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

getLocationCategory

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

getLocationCategoryRaw

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

getLocationCategoryWithCategoryId

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

getLocationCategoryWithCategoryIdRaw

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

`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

postLocationCategory

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

postLocationCategoryRaw

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

`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