Class LocationsApi

Hierarchy (view full)

BaseAPI
- LocationsApi

Index

Constructors

Properties

Methods

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

Constructors

constructor

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

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

deleteLocationsWithLocationId

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

deleteLocationsWithLocationIdRaw

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

getLocations

getLocations(requestParameters?, initOverrides?): Promise<Location[]>
Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields. Get locations
Parameters
- requestParameters: GetLocationsRequest = {}
- Optional initOverrides: RequestInit
Returns Promise<Location[]>
- Defined in cwmsjs/src/apis/LocationsApi.ts:147

getLocationsRaw

getLocationsRaw(requestParameters, initOverrides?): Promise<ApiResponse<Location[]>>
Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields. Get locations
Parameters
- requestParameters: GetLocationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<Location[]>>
- Defined in cwmsjs/src/apis/LocationsApi.ts:104

getLocationsWithLocationId

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

getLocationsWithLocationIdRaw

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

patchLocationsWithLocationId

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

patchLocationsWithLocationIdRaw

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

postLocations

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

postLocationsRaw

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

`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