cwmsjs
Version:
CWMS Data API Library for JavaScript/TypeScript created with OpenAPI generator for use with browser webapps
93 lines (92 loc) • 3.12 kB
TypeScript
/**
* 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 { Entity } from '../models';
export interface DeleteEntityWithEntityIdRequest {
entityId: string;
office: string;
cascadeDelete: boolean;
}
export interface GetEntityRequest {
office?: string;
entityId?: string;
parentEntityId?: string;
categoryId?: string;
longName?: string;
matchNullParents?: boolean;
}
export interface GetEntityWithEntityIdRequest {
entityId: string;
office: string;
}
export interface PatchEntityWithEntityIdRequest {
entityId: string;
entity: Entity;
}
export interface PostEntityRequest {
entity: Entity;
}
/**
*
*/
export declare class EntityApi extends runtime.BaseAPI {
/**
* Delete CWMS Entity.
* Delete entity with entityId
*/
deleteEntityWithEntityIdRaw(requestParameters: DeleteEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Delete CWMS Entity.
* Delete entity with entityId
*/
deleteEntityWithEntityId(requestParameters: DeleteEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Returns all CWMS Entity Data filtered by optional masks.
* Get entity
*/
getEntityRaw(requestParameters: GetEntityRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Array<Entity>>>;
/**
* Returns all CWMS Entity Data filtered by optional masks.
* Get entity
*/
getEntity(requestParameters?: GetEntityRequest, initOverrides?: RequestInit): Promise<Array<Entity>>;
/**
* Returns CWMS Entity data by entity id and office id.
* Get entity with entityId
*/
getEntityWithEntityIdRaw(requestParameters: GetEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<Entity>>;
/**
* Returns CWMS Entity data by entity id and office id.
* Get entity with entityId
*/
getEntityWithEntityId(requestParameters: GetEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<Entity>;
/**
* Update an existing Entity.
* Patch entity with entityId
*/
patchEntityWithEntityIdRaw(requestParameters: PatchEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Update an existing Entity.
* Patch entity with entityId
*/
patchEntityWithEntityId(requestParameters: PatchEntityWithEntityIdRequest, initOverrides?: RequestInit): Promise<void>;
/**
* Create CWMS Entity
* Post entity
*/
postEntityRaw(requestParameters: PostEntityRequest, initOverrides?: RequestInit): Promise<runtime.ApiResponse<void>>;
/**
* Create CWMS Entity
* Post entity
*/
postEntity(requestParameters: PostEntityRequest, initOverrides?: RequestInit): Promise<void>;
}