@robotbas/robotcloud-client 0.2.22 → 0.3.1

package/dist/{index-BQ8vrXpV.d.ts → index-9RfDay_a.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,74 @@ interface RobotCloudProject {
   organization: string;
 }
 
+interface RobotCloudDelete {
+  deleted_id: 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 {
+  name?: string
+  description?: string
+  access_level?: ProjectAccessLevel;
+}
+
+/** 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 +109,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 +183,80 @@ interface RobotCloudProjectDetails extends RobotCloudProject {
   app_access_level?: AppAccessLevel;
 }
 
+interface RobotCloudCreateProject {
+  name: string
+  description?: string
+  country?: string
+  timezone?: string
+  longitude?: number
+  latitude?: number
+  image_url?: string
+}
+
+interface RobotCloudCreateProject {
+  name: string
+  description?: string
+  country?: string
+  timezone?: string 
+  longitude?: number;
+  latitude?: number;
+  image_url?: string;
+}
+
+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 +269,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 +300,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 +491,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 +503,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 +521,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 +544,4 @@ declare const robotCloudPermissionsHelper: RobotCloudPermissionsHelper;
 
 declare const tagsHelper: TagsHelper;
 
-export { type FancoilSpeedState as $, type AirQuality1AlertEventValue as A, type AlertAggregatedLogsRequestParams as B, type RobotCloudOrganizationDetails as C, type RobotCloudUserDetails as D, type RobotCloudUserProject as E, tagsClient as F, tagsHelper as G, type HistoricAggregateFunction as H, robotCloudPermissionsHelper as I, type RobotCloudPermissionsHelper as J, type ProjectTagTreeNode as K, type LocationServiceInstancesRequestParams as L, type ProjectTagsTree as M, type ProjectTag as N, type ProjectTagDetails as O, type ProjectClassifiersRequestParams as P, type PaginableRequestParams as Q, type RegimState as R, type ServiceInstanceConfigClient as S, type TemperatureUnit as T, type SortableListRequestParams as U, type SubsystemTagsRequestParams as V, type BaseFullPaginableRequestParams as W, type ProjectTagRequestParams 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 AlertsProjectStatsRequestParams as y, type AlertLogsListRequestParams as z };
+export { type RobotCloudApplicationEnable as $, type AlertsProjectStatsRequestParams as A, type ServiceDataMeasurement as B, type ServiceInstanceDataRequestParams as C, type ServiceInstanceHistoricParams as D, type ServiceInstanceHistoricAggregateParams as E, type RoomGuestStatus1AlertEventValue as F, type AirQuality1AlertEventValue as G, type HistoricAggregateFunction as H, type AirQuality1DataEventValue as I, type RoomConsumes1AlertEventValue as J, type RobotCloudRobotCloudDeviceCreate as K, type RobotCloudDeviceDetails as L, type RobotCloudRobotCloudDeviceModify as M, type RobotCloudDeviceConfiguration as N, type ProjectLocationsRequestParams as O, type ProjectClassifiersRequestParams as P, type RobotCloudProject as Q, type RobotCloudOrganizations as R, type SubsystemRequestParams as S, type TemperatureUnit as T, type RobotCloudCreateProject as U, type ProjectsRequestParams as V, type ProjectDetailsRequestParams as W, type RobotCloudProjectDetails as X, type RobotCloudPutProject as Y, type RobotCloudProjectUsers as Z, type RobotCloudProjectApplications as _, type RobotCloudCreateOrganization as a, type ServiceInstancesRequestParams as a0, type RobotCloudServiceTypeDetails as a1, type LocationServiceInstancesRequestParams as a2, type ServiceInstanceRead as a3, tagsClient as a4, tagsHelper as a5, robotCloudPermissionsHelper as a6, type RobotCloudPermissionsHelper as a7, type ProjectTagTreeNode as a8, type ProjectTagsTree as a9, type ProjectTag as aa, type ProjectModifyTag as ab, type ProjectTagDetails as ac, type PaginableRequestParams as ad, type SortableListRequestParams as ae, type SubsystemTagsRequestParams as af, type BaseFullPaginableRequestParams as ag, type ProjectTagRequestParams as ah, type OrganizationAccessLevel as ai, type ProjectAccessLevel as aj, type AppAccessLevel as ak, type RobotCloudServiceType as al, type FancoilSpeedState as am, type RobotCloudUserAppAccess as an, type RobotCloudCreateUser as ao, type RobotCloudProjectInstances as ap, type MeasurementStatus as aq, type RobotCloudOrganizationDetails as b, type RobotCloudPutOrganization as c, type RobotCloudDelete as d, type RobotCloudOrganizationUsers as e, type RobotCloudOrganizationCreateUser as f, type RobotCloudUsers as g, type RobotCloudUserDetails as h, type RobotCloudPutUserDetails as i, type RobotCloudUserOrganization as j, type RobotCloudUserProject as k, type RobotCloudPostUserProject as l, type RobotCloudPutProjectUser as m, type AlertLogsListRequestParams as n, type RobotCloudNamedItem as o, type RobotCloudUserSimple as p, type AlertAggregatedLogsRequestParams as q, type RobotCloudDescribedItem as r, type RobotCloudCreateApplication as s, type RobotCloudGetApplication as t, type RobotCloudPutApplication as u, type RegimState as v, type ServiceInstanceConfigClient as w, type ServiceTypeClient as x, type RoomClime1AlertEventValue as y, type ServiceDataRequestParams as z };