cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
92 lines (91 loc) • 3.76 kB
TypeScript
/**
* CWMS Data API
* CWMS REST API for Data Retrieval
*
* The version of the OpenAPI document: 2.3.2-2025.03.19
*
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
import * as runtime from '../runtime';
import type { Location } from '../models/index';
export interface DeleteLocationsWithLocationIdRequest {
locationId: string;
office?: string;
}
export interface GetLocationsRequest {
names?: string;
office?: string;
unit?: string;
datum?: string;
format?: string;
}
export interface GetLocationsWithLocationIdRequest {
locationId: string;
office: string;
unit?: string;
}
export interface PatchLocationsWithLocationIdRequest {
locationId: string;
location: Location;
}
export interface PostLocationsRequest {
location: Location;
}
/**
*
*/
export declare class LocationsApi extends runtime.BaseAPI {
/**
* Delete CWMS Location
* Delete cwmsData locations with locationId
*/
deleteLocationsWithLocationIdRaw(requestParameters: DeleteLocationsWithLocationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Delete CWMS Location
* Delete cwmsData locations with locationId
*/
deleteLocationsWithLocationId(requestParameters: DeleteLocationsWithLocationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields.
* Get cwmsData locations
*/
getLocationsRaw(requestParameters: GetLocationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Location>>>;
/**
* Returns CWMS Location Data. The Catalog end-point is also capable of retrieving lists of locations and can filter on additional fields.
* Get cwmsData locations
*/
getLocations(requestParameters?: GetLocationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Location>>;
/**
* Returns CWMS Location Data
* Get cwmsData locations with locationId
*/
getLocationsWithLocationIdRaw(requestParameters: GetLocationsWithLocationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Location>>;
/**
* Returns CWMS Location Data
* Get cwmsData locations with locationId
*/
getLocationsWithLocationId(requestParameters: GetLocationsWithLocationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Location>;
/**
* Update CWMS Location
* Patch cwmsData locations with locationId
*/
patchLocationsWithLocationIdRaw(requestParameters: PatchLocationsWithLocationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Update CWMS Location
* Patch cwmsData locations with locationId
*/
patchLocationsWithLocationId(requestParameters: PatchLocationsWithLocationIdRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Create new CWMS Location
* Post cwmsData locations
*/
postLocationsRaw(requestParameters: PostLocationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Create new CWMS Location
* Post cwmsData locations
*/
postLocations(requestParameters: PostLocationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}