@robotbas/robotcloud-client 0.2.21 → 0.3.0

package/dist/{index-DmP793IB.d.ts → index-BsViQoY8.d.ts}

@@ -7,7 +7,8 @@ type OrganizationAccessLevel = "STAFF" | "STANDARD" | "ADMIN" | "SUPERUSER" | "M
 type ProjectAccessLevel = "BLOCKED" | "RESTRICTED" | "BASIC" | "ADVANCED"
 type AppAccessLevel = "BLOCKED" | "STANDARD" | "ADVANCED" | "ADMIN"
 
-type RobotCloudServiceType = "RoomClime_1" | "RoomGuestStatus_1" | "AirQuality_1"
+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)
 type FancoilSpeedState = 0 | 1 | 2 | 3;
@@ -28,6 +29,86 @@ interface RobotCloudProject {
   organization: string;
 }
 
+interface RobotCloudDelete {
+  deleted_id: string
+}
+
+interface RobotCloudCreateProject {
+  name: string
+  description?: string
+  country?: string
+  timezone?: string
+  longitude?: number
+  latitude?: number
+  image_url?: string
+}
+/** APPLICATIONS */
+interface RobotCloudCreateApplication extends RobotCloudDescribedItem{
+  access_level: ProjectAccessLevel;
+  api_key: string
+  create_time?: string
+  create_user?: string
+  update_time?: string
+  update_user?: string
+}
+
+interface RobotCloudGetApplication extends RobotCloudDescribedItem{
+  access_level?: ProjectAccessLevel;
+  create_time?: string
+  create_user?: string
+  update_time?: string
+  update_user?: string
+}
+
+interface RobotCloudPutApplication extends RobotCloudDescribedItem{
+  access_level?: ProjectAccessLevel;
+  create_time?: string
+  create_user?: string
+  update_time?: string
+  update_user?: string
+}
+
+/** ORGANIZATIONS */
+interface RobotCloudCreateOrganization {
+  name: string
+  description: string
+  address: string
+}
+
+interface RobotCloudPutOrganization {
+  name?: string
+  description?: string
+  address?: string
+}
+
+interface RobotCloudOrganizationDetails extends RobotCloudDescribedItem {
+  address: string;
+}
+
+interface RobotCloudOrganizations extends RobotCloudNamedItem {
+}
+
+interface RobotCloudOrganizationUsers {
+  username: string
+  name: string
+  last_name: string
+  email?: string
+  external?: boolean
+}
+
+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 */
 interface RobotCloudUserAppAccess {
   app_id: string;
@@ -40,30 +121,67 @@ interface RobotCloudUserSimple {
   name: string;
   last_name: string;
 }
+
+interface RobotCloudUserOrganization extends RobotCloudNamedItem {
+}
+
+interface RobotCloudUsers {
+  username: string;
+  name: string;
+  last_name: string;
+  email?: string;
+  external?: boolean;
+}
+
 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;
+}
+
+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;
+}
+
+interface RobotCloudCreateUser extends RobotCloudUserDetails {
+  password?: string
 }
 
 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 }[]
 }
 
-interface RobotCloudOrganizationDetails extends RobotCloudDescribedItem {
-  address?: string;
+interface RobotCloudPostUserProject {
+  project_id: string;
+  access_level: ProjectAccessLevel;
+  app_access_level?: { app_id: string, app_name: string, access_level: AppAccessLevel }[]
 }
 
+interface RobotCloudPutProjectUser {
+  access_level: ProjectAccessLevel;
+  app_access_level?: { app_id: string, app_name: string, access_level: AppAccessLevel }[]
+}
+
+/** PROJECTS */
 interface RobotCloudProjectDetails extends RobotCloudProject {
   version: number;
   description?: string;
@@ -77,6 +195,60 @@ interface RobotCloudProjectDetails extends RobotCloudProject {
   app_access_level?: AppAccessLevel;
 }
 
+interface RobotCloudProjectApplications {
+  application_id: string
+  application_name: string
+  enabled: string
+  expiration?: string
+  update_time?: string
+  update_user?: string 
+}
+
+interface RobotCloudApplicationEnable {
+  enabled?: string
+  expiration?: string
+}
+
+interface RobotCloudPutProject {
+  name?: string
+  description?: string
+  organization?: string
+  country?: string
+  timezone?: string 
+  longitude?: number;
+  latitude?: number;
+  image_url?: string;
+}
+
+interface RobotCloudProjectUsers {
+  username: string
+  access_level: ProjectAccessLevel
+  external?: boolean
+}
+
+interface RobotCloudDeviceConfiguration extends RobotCloudNamedItem {
+  description: string
+}
+
+interface RobotCloudRobotCloudDeviceCreate {
+  name: string
+  description?: string
+  address: string
+  type?: number
+  configuration_type?: string;
+  tags?: string[];
+}
+
+interface RobotCloudRobotCloudDeviceModify {
+  name?: string
+  description?: string
+  address?: string
+  location_id?: string
+  type?: number
+  configuration_type?: string;
+  tags?: string[];
+}
+
 interface RobotCloudDeviceDetails extends RobotCloudDescribedItem {
   location: string;
   address: {
@@ -89,8 +261,14 @@ interface RobotCloudDeviceDetails extends RobotCloudDescribedItem {
   tags: string[];
 }
 
+interface RobotCloudProjectInstances {
+  id: string
+  name: string;
+  service: RobotCloudServiceType
+}
+
 interface RobotCloudServiceTypeDetails {
-  description: string;
+  description?: string;
   name: RobotCloudServiceType
 }
 /** SERVICE EVENTS VALUES **/
@@ -114,6 +292,94 @@ interface ServiceInstanceRead<T> {
     value: T;
 }
 
+type MeasurementStatus =
+  | "GOOD"
+  | "NOT_MEASURED"
+  | "INVALID_VALUE"
+  | "DEVICE_ERROR";
+
+interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
+  status: MeasurementStatus;
+}
+
+interface AirQuality1DataEventValue {
+  co2: number;
+}
+
+interface AirQuality1AlertEventValue {
+  high_co2: boolean;
+}
+
+interface RoomGuestStatus1AlertEventValue {
+  door_open_overtime: boolean;
+  window_open_overtime: boolean;
+  medical_alarm: boolean;
+}
+
+
+////
+// Generic interface  types
+////
+
+type HistoricAggregateFunction =
+  | "count"
+  | "increase"
+  | "mean"
+  | "first"
+  | "last"
+  | "max"
+  | "min"
+  | "amax"
+  | "amin"
+  | "pmax"
+  | "pmin"
+  | "nmax"
+  | "nmin";
+
+  
+interface ServiceInstanceConfigClient<T> {
+  get(project_id: string, instance_id: string): Promise<AxiosResponse<T>>;
+  put(project_id: string, instance_id: string, configuration: T): Promise<AxiosResponse<T>>;
+}
+
+interface ServiceTypeClient<T_ALERTS, T_DATA> {
+
+  get configuration(): ServiceInstanceConfigClient<any>;  
+  getAlerts(
+    prjId: string,
+    params?: ServiceDataRequestParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_ALERTS>[]>>;
+
+  getData(
+    prjId: string,
+    params?: ServiceDataRequestParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+
+  getInstanceData(
+    prjId: string,
+    instanceId: string,
+    params?: ServiceInstanceDataRequestParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>>>;
+
+  getInstanceHistoric(
+    prjId: string,
+    instanceId: string,
+    startTime: Date,
+    endTime: Date,
+    params: ServiceInstanceHistoricParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+
+  getInstanceHistoricAggregate(
+    prjId: string,
+    instanceId: string,
+    startTime: Date,
+    endTime: Date,
+    aggFunction: HistoricAggregateFunction,
+    periode: string,
+    params: ServiceInstanceHistoricAggregateParams
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+}
+
 /**
  *
  */
@@ -217,94 +483,6 @@ interface ServiceInstanceHistoricParams {
   maxSize?: number;
 }
 
-type MeasurementStatus =
-  | "GOOD"
-  | "NOT_MEASURED"
-  | "INVALID_VALUE"
-  | "DEVICE_ERROR";
-
-interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
-  status: MeasurementStatus;
-}
-
-interface AirQuality1DataEventValue {
-  co2: number;
-}
-
-interface AirQuality1AlertEventValue {
-  high_co2: boolean;
-}
-
-interface RoomGuestStatus1AlertEventValue {
-  door_open_overtime: boolean;
-  window_open_overtime: boolean;
-  medical_alarm: boolean;
-}
-
-
-////
-// Generic interface  types
-////
-
-type HistoricAggregateFunction =
-  | "count"
-  | "increase"
-  | "mean"
-  | "first"
-  | "last"
-  | "max"
-  | "min"
-  | "amax"
-  | "amin"
-  | "pmax"
-  | "pmin"
-  | "nmax"
-  | "nmin";
-
-  
-interface ServiceInstanceConfigClient<T> {
-  get(project_id: string, instance_id: string): Promise<AxiosResponse<T>>;
-  put(project_id: string, instance_id: string, configuration: T): Promise<AxiosResponse<T>>;
-}
-
-interface ServiceTypeClient<T_ALERTS, T_DATA> {
-
-  get configuration(): ServiceInstanceConfigClient<any>;  
-  getAlerts(
-    prjId: string,
-    params?: ServiceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_ALERTS>[]>>;
-
-  getData(
-    prjId: string,
-    params?: ServiceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
-
-  getInstanceData(
-    prjId: string,
-    instanceId: string,
-    params?: ServiceInstanceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>>>;
-
-  getInstanceHistoric(
-    prjId: string,
-    instanceId: string,
-    startTime: Date,
-    endTime: Date,
-    params: ServiceInstanceHistoricParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
-
-  getInstanceHistoricAggregate(
-    prjId: string,
-    instanceId: string,
-    startTime: Date,
-    endTime: Date,
-    aggFunction: HistoricAggregateFunction,
-    periode: string,
-    params: ServiceInstanceHistoricAggregateParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
-}
-
 interface ProjectTagTreeNode {
   tag: ProjectTag;
   children: ProjectTagTreeNode[];
@@ -317,8 +495,15 @@ interface ProjectTagsTree {
 interface ProjectTag {
   id: string;
   name: string;
-  parent_id: string;
+  parent_id?: string;
 }
+
+interface ProjectModifyTag {
+  id?: string,
+  name?: string,
+  parent_id?: string
+}
+
 interface ProjectTagDetails extends ProjectTag {
   color: string;
   project: string;
@@ -328,6 +513,9 @@ interface ProjectTagDetails extends ProjectTag {
 declare class TagsClient {
     getTags: (prjId: string, params?: ProjectTagRequestParams) => Promise<AxiosResponse<ProjectTag[]>>;
     getTag: (prjId: string, tagId: string) => Promise<AxiosResponse<ProjectTagDetails>>;
+    postTag: (prjId: string) => Promise<AxiosResponse<ProjectTag>>;
+    putTag: (prjId: string, tagId: string) => Promise<AxiosResponse<ProjectModifyTag>>;
+    deleteTag: (prjId: string, tagId: string) => Promise<AxiosResponse<RobotCloudDelete>>;
 }
 declare const tagsClient: TagsClient;
 
@@ -348,4 +536,4 @@ declare const robotCloudPermissionsHelper: RobotCloudPermissionsHelper;
 
 declare const tagsHelper: TagsHelper;
 
-export { type FancoilSpeedState as $, type AirQuality1AlertEventValue as A, type RobotCloudOrganizationDetails as B, type RobotCloudUserDetails as C, type RobotCloudUserProject as D, tagsClient as E, tagsHelper as F, robotCloudPermissionsHelper as G, type HistoricAggregateFunction as H, type RobotCloudPermissionsHelper as I, type ProjectTagTreeNode as J, type ProjectTagsTree as K, type LocationServiceInstancesRequestParams as L, type ProjectTag as M, type ProjectTagDetails as N, type PaginableRequestParams as O, type ProjectClassifiersRequestParams as P, type SortableListRequestParams as Q, type RegimState as R, type ServiceInstanceConfigClient as S, type TemperatureUnit as T, type SubsystemTagsRequestParams as U, type BaseFullPaginableRequestParams as V, type ProjectTagRequestParams as W, type AlertsProjectStatsRequestParams as X, type OrganizationAccessLevel as Y, type ProjectAccessLevel as Z, type AppAccessLevel as _, type ServiceTypeClient as a, type RobotCloudUserAppAccess as a0, type MeasurementStatus as a1, type RoomClime1AlertEventValue as b, type ServiceDataRequestParams as c, type ServiceDataMeasurement as d, type ServiceInstanceDataRequestParams as e, type ServiceInstanceHistoricParams as f, type ServiceInstanceHistoricAggregateParams as g, type RoomGuestStatus1AlertEventValue as h, type AirQuality1DataEventValue as i, type RoomConsumes1AlertEventValue as j, type RobotCloudNamedItem as k, type RobotCloudDeviceDetails as l, type RobotCloudServiceType as m, type ProjectLocationsRequestParams as n, type ProjectsRequestParams as o, type RobotCloudProject as p, type ProjectDetailsRequestParams as q, type RobotCloudProjectDetails as r, type SubsystemRequestParams as s, type RobotCloudServiceTypeDetails as t, type ServiceInstancesRequestParams as u, type ServiceInstanceRead as v, type RobotCloudDescribedItem as w, type RobotCloudUserSimple as x, type AlertLogsListRequestParams as y, type AlertAggregatedLogsRequestParams as z };
+export { type RobotCloudProjectInstances as $, type AlertsProjectStatsRequestParams as A, type ServiceDataRequestParams as B, type ServiceDataMeasurement as C, type ServiceInstanceDataRequestParams as D, type ServiceInstanceHistoricParams as E, type ServiceInstanceHistoricAggregateParams as F, type RoomGuestStatus1AlertEventValue as G, type HistoricAggregateFunction as H, type AirQuality1AlertEventValue as I, type AirQuality1DataEventValue as J, type RoomConsumes1AlertEventValue as K, type RobotCloudRobotCloudDeviceCreate as L, type RobotCloudDeviceDetails as M, type RobotCloudRobotCloudDeviceModify as N, type RobotCloudDeviceConfiguration as O, type ProjectClassifiersRequestParams as P, type RobotCloudServiceType as Q, type RobotCloudOrganizations as R, type SubsystemRequestParams as S, type TemperatureUnit as T, type LocationServiceInstancesRequestParams as U, type ProjectLocationsRequestParams as V, type ProjectsRequestParams as W, type ProjectDetailsRequestParams as X, type RobotCloudProjectDetails as Y, type RobotCloudPutProject as Z, type RobotCloudProjectUsers as _, type RobotCloudCreateOrganization as a, type RobotCloudServiceTypeDetails as a0, type RobotCloudProjectApplications as a1, type RobotCloudApplicationEnable as a2, type ServiceInstancesRequestParams as a3, type ServiceInstanceRead as a4, tagsClient as a5, tagsHelper as a6, robotCloudPermissionsHelper as a7, type RobotCloudPermissionsHelper as a8, type ProjectTagTreeNode as a9, type ProjectTagsTree as aa, type ProjectTag as ab, type ProjectModifyTag as ac, type ProjectTagDetails as ad, type PaginableRequestParams as ae, type SortableListRequestParams as af, type SubsystemTagsRequestParams as ag, type BaseFullPaginableRequestParams as ah, type ProjectTagRequestParams as ai, type OrganizationAccessLevel as aj, type ProjectAccessLevel as ak, type AppAccessLevel as al, type FancoilSpeedState as am, type RobotCloudCreateProject as an, type RobotCloudUserAppAccess as ao, type RobotCloudCreateUser as ap, type MeasurementStatus as aq, type RobotCloudOrganizationDetails as b, type RobotCloudPutOrganization as c, type RobotCloudDelete as d, type RobotCloudProject as e, type RobotCloudOrganizationCreateUser as f, type RobotCloudOrganizationUsers as g, type RobotCloudUsers as h, type RobotCloudUserDetails as i, type RobotCloudPutUserDetails as j, type RobotCloudUserOrganization as k, type RobotCloudUserProject as l, type RobotCloudPostUserProject as m, type RobotCloudPutProjectUser as n, type AlertLogsListRequestParams as o, type RobotCloudNamedItem as p, type RobotCloudUserSimple as q, type AlertAggregatedLogsRequestParams as r, type RobotCloudDescribedItem as s, type RobotCloudCreateApplication as t, type RobotCloudGetApplication as u, type RobotCloudPutApplication as v, type RegimState as w, type ServiceInstanceConfigClient as x, type ServiceTypeClient as y, type RoomClime1AlertEventValue as z };