cwmsjs/dist/apis/LocationsApi.d.ts

CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps

/**
 * CWMS Data API
 * CWMS REST API for Data Retrieval
 *
 * The version of the OpenAPI document: 2.4.0-2026.3.16
 *
 *
 * 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 { Location } from '../models';
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;
    includeAliases?: boolean;
}
export interface PatchLocationsWithLocationIdRequest {
    locationId: string;
    location: Location;
}
export interface PostLocationsRequest {
    location: Location;
    failIfExists?: boolean;
}
/**
 *
 */
export declare class LocationsApi extends runtime.BaseAPI {
    /**
     * Delete CWMS Location
     * Delete locations with locationId
     */
    deleteLocationsWithLocationIdRaw(requestParameters: DeleteLocationsWithLocationIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Delete CWMS Location
     * Delete locations with locationId
     */
    deleteLocationsWithLocationId(requestParameters: DeleteLocationsWithLocationIdRequest, initOverrides?: RequestInit): 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 locations
     */
    getLocationsRaw(requestParameters: GetLocationsRequest, initOverrides?: RequestInit): 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 locations
     */
    getLocations(requestParameters?: GetLocationsRequest, initOverrides?: RequestInit): Promise<Array<Location>>;
    /**
     * Returns CWMS Location Data
     * Get locations with locationId
     */
    getLocationsWithLocationIdRaw(requestParameters: GetLocationsWithLocationIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Location>>;
    /**
     * Returns CWMS Location Data
     * Get locations with locationId
     */
    getLocationsWithLocationId(requestParameters: GetLocationsWithLocationIdRequest, initOverrides?: RequestInit): Promise<Location>;
    /**
     * Update CWMS Location
     * Patch locations with locationId
     */
    patchLocationsWithLocationIdRaw(requestParameters: PatchLocationsWithLocationIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Update CWMS Location
     * Patch locations with locationId
     */
    patchLocationsWithLocationId(requestParameters: PatchLocationsWithLocationIdRequest, initOverrides?: RequestInit): Promise<void>;
    /**
     * Create new CWMS Location
     * Post locations
     */
    postLocationsRaw(requestParameters: PostLocationsRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
    /**
     * Create new CWMS Location
     * Post locations
     */
    postLocations(requestParameters: PostLocationsRequest, initOverrides?: RequestInit): Promise<void>;
}