Class LocationGroupsApi

Hierarchy (view full)

BaseAPI
- LocationGroupsApi

Index

Constructors

Properties

Methods

deleteLocationGroupWithGroupId deleteLocationGroupWithGroupIdRaw getLocationGroup getLocationGroupRaw getLocationGroupWithGroupId getLocationGroupWithGroupIdRaw isJsonMime patchLocationGroupWithGroupId patchLocationGroupWithGroupIdRaw postLocationGroup postLocationGroupRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteLocationGroupWithGroupId

deleteLocationGroupWithGroupId(requestParameters, initOverrides?): Promise<void>
Deletes requested location group Delete cwmsData location group with groupId
Parameters
- requestParameters: DeleteLocationGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:123

deleteLocationGroupWithGroupIdRaw

deleteLocationGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Deletes requested location group Delete cwmsData location group with groupId
Parameters
- requestParameters: DeleteLocationGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:67

getLocationGroup

getLocationGroup(requestParameters?, initOverrides?): Promise<LocationGroup[]>
Returns CWMS Location Groups Data Get cwmsData location group
Parameters
- requestParameters: GetLocationGroupRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<LocationGroup[]>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:162

getLocationGroupRaw

getLocationGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<LocationGroup[]>>
Returns CWMS Location Groups Data Get cwmsData location group
Parameters
- requestParameters: GetLocationGroupRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<LocationGroup[]>>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:131

getLocationGroupWithGroupId

getLocationGroupWithGroupId(requestParameters, initOverrides?): Promise<LocationGroup>
Retrieves requested Location Group Get cwmsData location group with groupId
Parameters
- requestParameters: GetLocationGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<LocationGroup>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:219

getLocationGroupWithGroupIdRaw

getLocationGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<LocationGroup>>
Retrieves requested Location Group Get cwmsData location group with groupId
Parameters
- requestParameters: GetLocationGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<LocationGroup>>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:171

`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

patchLocationGroupWithGroupId

patchLocationGroupWithGroupId(requestParameters, initOverrides?): Promise<void>
Update existing LocationGroup Patch cwmsData location group with groupId
Parameters
- requestParameters: PatchLocationGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:283

patchLocationGroupWithGroupIdRaw

patchLocationGroupWithGroupIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update existing LocationGroup Patch cwmsData location group with groupId
Parameters
- requestParameters: PatchLocationGroupWithGroupIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:228

postLocationGroup

postLocationGroup(requestParameters, initOverrides?): Promise<void>
Create new LocationGroup Post cwmsData location group
Parameters
- requestParameters: PostLocationGroupRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:324

postLocationGroupRaw

postLocationGroupRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new LocationGroup Post cwmsData location group
Parameters
- requestParameters: PostLocationGroupRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationGroupsApi.ts:291

`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