Class LocationsApi

Hierarchy (view full)

BaseAPI
- LocationsApi

Index

Constructors

Properties

Methods

deleteLocationsWithLocationId deleteLocationsWithLocationIdRaw getLocations getLocationsRaw getLocationsWithLocationId getLocationsWithLocationIdRaw isJsonMime patchLocationsWithLocationId patchLocationsWithLocationIdRaw postLocations postLocationsRaw request withMiddleware withPostMiddleware withPreMiddleware

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = DefaultConfig

Methods

deleteLocationsWithLocationId

deleteLocationsWithLocationId(requestParameters, initOverrides?): Promise<void>
Delete CWMS Location Delete cwmsData locations with locationId
Parameters
- requestParameters: DeleteLocationsWithLocationIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationsApi.ts:99

deleteLocationsWithLocationIdRaw

deleteLocationsWithLocationIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Delete CWMS Location Delete cwmsData locations with locationId
Parameters
- requestParameters: DeleteLocationsWithLocationIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationsApi.ts:65

getLocations

getLocations(requestParameters?, initOverrides?): Promise<object>
Returns CWMS Location Data Get cwmsData locations
Parameters
- requestParameters: GetLocationsRequest = {}
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<object>
- Defined in cwmsjs/src/apis/LocationsApi.ts:146

getLocationsRaw

getLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<object>>
Returns CWMS Location Data Get cwmsData locations
Parameters
- requestParameters: GetLocationsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<object>>
- Defined in cwmsjs/src/apis/LocationsApi.ts:107

getLocationsWithLocationId

getLocationsWithLocationId(requestParameters, initOverrides?): Promise<Location>
Returns CWMS Location Data Get cwmsData locations with locationId
Parameters
- requestParameters: GetLocationsWithLocationIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Location>
- Defined in cwmsjs/src/apis/LocationsApi.ts:196

getLocationsWithLocationIdRaw

getLocationsWithLocationIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<Location>>
Returns CWMS Location Data Get cwmsData locations with locationId
Parameters
- requestParameters: GetLocationsWithLocationIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<Location>>
- Defined in cwmsjs/src/apis/LocationsApi.ts:155

`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

patchLocationsWithLocationId

patchLocationsWithLocationId(requestParameters, initOverrides?): Promise<void>
Update CWMS Location Patch cwmsData locations with locationId
Parameters
- requestParameters: PatchLocationsWithLocationIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationsApi.ts:245

patchLocationsWithLocationIdRaw

patchLocationsWithLocationIdRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Update CWMS Location Patch cwmsData locations with locationId
Parameters
- requestParameters: PatchLocationsWithLocationIdRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationsApi.ts:205

postLocations

postLocations(requestParameters, initOverrides?): Promise<void>
Create new CWMS Location Post cwmsData locations
Parameters
- requestParameters: PostLocationsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<void>
- Defined in cwmsjs/src/apis/LocationsApi.ts:286

postLocationsRaw

postLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<void>>
Create new CWMS Location Post cwmsData locations
Parameters
- requestParameters: PostLocationsRequest
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<ApiResponse<void>>
- Defined in cwmsjs/src/apis/LocationsApi.ts:253

`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