cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
92 lines (91 loc) • 3.47 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 { Property } from '../models/index';
export interface DeletePropertiesWithNameRequest {
name: string;
office: string;
categoryId: string;
}
export interface GetPropertiesRequest {
officeMask?: string;
categoryId?: string;
nameMask?: string;
}
export interface GetPropertiesWithNameRequest {
name: string;
office: string;
categoryId: string;
defaultValue?: string;
}
export interface PatchPropertiesWithNameRequest {
name: string;
property: Property;
}
export interface PostPropertiesRequest {
property: Property;
}
/**
*
*/
export declare class PropertiesApi extends runtime.BaseAPI {
/**
* Delete CWMS Property
* Delete cwmsData properties with name
*/
deletePropertiesWithNameRaw(requestParameters: DeletePropertiesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Delete CWMS Property
* Delete cwmsData properties with name
*/
deletePropertiesWithName(requestParameters: DeletePropertiesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Returns matching CWMS Property Data.
* Get cwmsData properties
*/
getPropertiesRaw(requestParameters: GetPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Array<Property>>>;
/**
* Returns matching CWMS Property Data.
* Get cwmsData properties
*/
getProperties(requestParameters?: GetPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Array<Property>>;
/**
* Returns CWMS Property Data
* Get cwmsData properties with name
*/
getPropertiesWithNameRaw(requestParameters: GetPropertiesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Property>>;
/**
* Returns CWMS Property Data
* Get cwmsData properties with name
*/
getPropertiesWithName(requestParameters: GetPropertiesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Property>;
/**
* Update CWMS Property
* Patch cwmsData properties with name
*/
patchPropertiesWithNameRaw(requestParameters: PatchPropertiesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Update CWMS Property
* Patch cwmsData properties with name
*/
patchPropertiesWithName(requestParameters: PatchPropertiesWithNameRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
/**
* Create CWMS Property
* Post cwmsData properties
*/
postPropertiesRaw(requestParameters: PostPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
/**
* Create CWMS Property
* Post cwmsData properties
*/
postProperties(requestParameters: PostPropertiesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
}