@robotbas/robotcloud-client 0.2.21 → 0.3.0

package/types/RobotCloudClient.d.ts

@@ -5,7 +5,8 @@ export type OrganizationAccessLevel = "STAFF" | "STANDARD" | "ADMIN" | "SUPERUSE
 export type ProjectAccessLevel = "BLOCKED" | "RESTRICTED" | "BASIC" | "ADVANCED"
 export type AppAccessLevel = "BLOCKED" | "STANDARD" | "ADVANCED" | "ADMIN"
 
-export type RobotCloudServiceType = "RoomClime_1" | "RoomGuestStatus_1" | "AirQuality_1"
+export type RobotCloudServiceType = "PowerMeter_1" | "CoolHeatProd_1" | "HeatProd_1" | "CoolHeatCons_1" | "OutdoorClime_1" | "WaterCounter_1" | "RoomClime_1" | "RoomGuestStatus_1" | "EnergyProduction_1" | "RoomConsumes_1" | "EnergyCounter_1" | "HeatMeter_1" | "TemporizedOutput_1" | "GasCounter_1" | "ChillerHeatingPump_1" | "AirHandlingUnit_1" | "AirQuality_1" | "RoomDiagnostics_1" | "RoomBLEPairing_1" | "RoomGrouping_1" | "GenericTemperature_1" | "CoolHeatTemperature_1"
+
 
 // Desired fancoil speed (0 = Auto, 1..3 = Manual Speed)
 export type FancoilSpeedState = 0 | 1 | 2 | 3;
@@ -26,6 +27,86 @@ export interface RobotCloudProject {
   organization: string;
 }
 
+export interface RobotCloudDelete {
+  deleted_id: string
+}
+
+export interface RobotCloudCreateProject {
+  name: string
+  description?: string
+  country?: string
+  timezone?: string
+  longitude?: number
+  latitude?: number
+  image_url?: string
+}
+/** APPLICATIONS */
+export interface RobotCloudCreateApplication extends RobotCloudDescribedItem{
+  access_level: ProjectAccessLevel;
+  api_key: string
+  create_time?: string
+  create_user?: string
+  update_time?: string
+  update_user?: string
+}
+
+export interface RobotCloudGetApplication extends RobotCloudDescribedItem{
+  access_level?: ProjectAccessLevel;
+  create_time?: string
+  create_user?: string
+  update_time?: string
+  update_user?: string
+}
+
+export interface RobotCloudPutApplication extends RobotCloudDescribedItem{
+  access_level?: ProjectAccessLevel;
+  create_time?: string
+  create_user?: string
+  update_time?: string
+  update_user?: string
+}
+
+/** ORGANIZATIONS */
+export interface RobotCloudCreateOrganization {
+  name: string
+  description: string
+  address: string
+}
+
+export interface RobotCloudPutOrganization {
+  name?: string
+  description?: string
+  address?: string
+}
+
+export interface RobotCloudOrganizationDetails extends RobotCloudDescribedItem {
+  address: string;
+}
+
+export interface RobotCloudOrganizations extends RobotCloudNamedItem {
+}
+
+export interface RobotCloudOrganizationUsers {
+  username: string
+  name: string
+  last_name: string
+  email?: string
+  external?: boolean
+}
+
+export interface RobotCloudOrganizationCreateUser {
+  username: string;
+  password: string;
+  name: string;
+  last_name: string;
+  email?: string;
+  org_access: OrganizationAccessLevel;
+  default_project_access: ProjectAccessLevel;
+  default_app_access?: RobotCloudUserAppAccess[];
+  access_all_projects?: boolean;
+  blocked?: boolean;
+}
+
 /** USERS */
 export interface RobotCloudUserAppAccess {
   app_id: string;
@@ -38,30 +119,67 @@ export interface RobotCloudUserSimple {
   name: string;
   last_name: string;
 }
+
+export interface RobotCloudUserOrganization extends RobotCloudNamedItem {
+}
+
+export interface RobotCloudUsers {
+  username: string;
+  name: string;
+  last_name: string;
+  email?: string;
+  external?: boolean;
+}
+
 export interface RobotCloudUserDetails {
   username: string;
   name: string;
   last_name: string;
-  email: string;
+  email?: string;
   org_id: string;
   org_access: OrganizationAccessLevel;
   default_project_access: ProjectAccessLevel;
-  default_app_access: RobotCloudUserAppAccess[];
-  access_all_projects: boolean;
-  blocked: boolean;
+  default_app_access?: RobotCloudUserAppAccess[];
+  access_all_projects?: boolean;
+  blocked?: boolean;
+}
+
+export interface RobotCloudPutUserDetails {
+  password?: string;
+  name?: string;
+  last_name?: string;
+  email?: string;
+  org_id?: string;
+  org_access?: OrganizationAccessLevel;
+  default_project_access?: ProjectAccessLevel;
+  default_app_access?: RobotCloudUserAppAccess[];
+  access_all_projects?: boolean;
+  blocked?: boolean;
+}
+
+export interface RobotCloudCreateUser extends RobotCloudUserDetails {
+  password?: string
 }
 
 export interface RobotCloudUserProject {
   project_id: string;
   project_name: string;
   access_level: ProjectAccessLevel;
-  app_access_level: { app_id: string, app_name: string, access_level: AppAccessLevel }[]
+  app_access_level?: { app_id: string, app_name: string, access_level: AppAccessLevel }[]
 }
 
-export interface RobotCloudOrganizationDetails extends RobotCloudDescribedItem {
-  address?: string;
+export interface RobotCloudPostUserProject {
+  project_id: string;
+  access_level: ProjectAccessLevel;
+  app_access_level?: { app_id: string, app_name: string, access_level: AppAccessLevel }[]
+}
+
+export interface RobotCloudPutProjectUser {
+  access_level: ProjectAccessLevel;
+  app_access_level?: { app_id: string, app_name: string, access_level: AppAccessLevel }[]
 }
 
+/** PROJECTS */
 export interface RobotCloudProjectDetails extends RobotCloudProject {
   version: number;
   description?: string;
@@ -75,6 +193,60 @@ export interface RobotCloudProjectDetails extends RobotCloudProject {
   app_access_level?: AppAccessLevel;
 }
 
+export interface RobotCloudProjectApplications {
+  application_id: string
+  application_name: string
+  enabled: string
+  expiration?: string
+  update_time?: string
+  update_user?: string 
+}
+
+export interface RobotCloudApplicationEnable {
+  enabled?: string
+  expiration?: string
+}
+
+export interface RobotCloudPutProject {
+  name?: string
+  description?: string
+  organization?: string
+  country?: string
+  timezone?: string 
+  longitude?: number;
+  latitude?: number;
+  image_url?: string;
+}
+
+export interface RobotCloudProjectUsers {
+  username: string
+  access_level: ProjectAccessLevel
+  external?: boolean
+}
+
+export interface RobotCloudDeviceConfiguration extends RobotCloudNamedItem {
+  description: string
+}
+
+export interface RobotCloudRobotCloudDeviceCreate {
+  name: string
+  description?: string
+  address: string
+  type?: number
+  configuration_type?: string;
+  tags?: string[];
+}
+
+export interface RobotCloudRobotCloudDeviceModify {
+  name?: string
+  description?: string
+  address?: string
+  location_id?: string
+  type?: number
+  configuration_type?: string;
+  tags?: string[];
+}
+
 export interface RobotCloudDeviceDetails extends RobotCloudDescribedItem {
   location: string;
   address: {
@@ -87,8 +259,14 @@ export interface RobotCloudDeviceDetails extends RobotCloudDescribedItem {
   tags: string[];
 }
 
+export interface RobotCloudProjectInstances {
+  id: string
+  name: string;
+  service: RobotCloudServiceType
+}
+
 export interface RobotCloudServiceTypeDetails {
-  description: string;
+  description?: string;
   name: RobotCloudServiceType
 }
 /** SERVICE EVENTS VALUES **/

package/types/ServiceInstance.d.ts

@@ -9,10 +9,19 @@ export interface RobotCloudServiceInstance extends RobotCloudNamedItem {
   service: string;
 }
 
+
 export interface ServiceInstanceDetails extends RobotCloudServiceInstance {
-  description: string;
-  location: string;
-  tags: string[];
-  subsystems: string[];
-  classifier: string;
+  description?: string;
+  location?: string;
+  tags?: string[];
+  subsystems?: string[];
+  classifier?: string;
+}
+
+export interface CreateServiceInstance extends RobotCloudServiceInstance {
+  description?: string;
+  name: string
+  tags?: string[];
+  subsystems?: string[];
+  classifier?: string;
 }

package/types/Token.d.ts

@@ -1,12 +1,20 @@
+export interface TokenResponse {
+  token: string;
+  expiration: string; // ISO 8601 date string (YYYY-MM-DDTHH:MM:SS.SSSZ)
+}
+export interface SessionTokenResponse {
+  access: TokenResponse;
+  renew: TokenResponse;
+}
 export interface CheckTokenResponse {
-    renewed: boolean;
-    invalid: boolean;
-    access: string;
-    renew: string;
+  renewed: boolean;
+  invalid: boolean;
+  access: string;
+  renew: string;
 }
 
 export interface RobotCloudJWTPayload {
-    exp: number;
-    sub: string; // username
-    org: string; // organization
+  exp: number;
+  sub: string; // username
+  org: string; // organization
 }

package/types/alerts.d.ts

@@ -0,0 +1,88 @@
+import { AxiosResponse } from "axios";
+import {
+  AlertAggregatedLogsRequestParams,
+  AlertLogsListRequestParams,
+  AlertsProjectStatsRequestParams,
+  SubsystemRequestParams
+} from "./request-params";
+import { RobotCloudNamedItem, RobotCloudUserSimple } from "./RobotCloudClient";
+
+export interface AlertsLogsStats {
+  total: number;
+  active: number;
+  noack: number;
+  active_noack: number;
+}
+
+export interface AlertLogLine {
+  id: string;
+  service: string;
+  instance: string;
+  location: RobotCloudNamedItem;
+  classifier: RobotCloudNamedItem;
+  alert_name: string;
+  acknowledged: boolean;
+  ack_time: string;
+  ack_user: RobotCloudUserSimple;
+  active: boolean;
+  active_time: string;
+  deactive_time: string;
+}
+
+export interface AlertsLogsList {
+  total_size: number;
+  initial_index: number;
+  alerts: AlertLogLine[];
+}
+
+interface AlertsLogsAggregatedAlertRecord {
+  periode_start: string,
+  periode_end: string,
+  activation_count: number,
+  active_seconds: number
+}
+
+interface AlertsLogsAggregatedAlert {
+  service: string;
+  alert_name: string;
+  aggregates: AlertsLogsAggregatedAlertRecord[];
+}
+
+export interface AlertsLogsAggregated {
+  alerts: AlertsLogsAggregatedAlert[];
+}
+
+interface AlertLogAckItem {
+  id: string;
+  acknowledged: boolean;
+}
+
+export interface AlertLogAckAlerts {
+  alerts: AlertLogAckItem[];
+}
+
+export interface AlertsClient {
+  getProjectStats(
+    projectId: string,
+    params?: AlertsProjectStatsRequestParams
+  ): Promise<AxiosResponse<AlertsLogsStats>>;
+
+  getProjectLog(
+    projectId: string,
+    params: AlertLogsListRequestParams
+  ): Promise<AxiosResponse<AlertsLogsList>>;
+
+  acknowledge(
+    projectId: string,
+    data: AlertLogAckAlerts
+  ): Promise<AxiosResponse<AlertsLogsList>>;
+
+  getAggregatedLogs(
+    projectId: string,
+    params: AlertAggregatedLogsRequestParams
+  ): Promise<AxiosResponse<AlertsLogsAggregated>>;
+
+  getAvailableAlerts(projectId: string, params?: SubsystemRequestParams): Promise<AxiosResponse<string[]>>;
+
+  getServiceTypeAlertKeys(serviceType: string): string[];
+}