@robotbas/robotcloud-client 0.3.1 → 0.3.3

package/dist/helpers/index.d.mts

@@ -1,2 +1,2 @@
-export { a7 as RobotCloudPermissionsHelper, a6 as robotCloudPermissionsHelper, a5 as tagsHelper } from '../index-9RfDay_a.mjs';
+export { ab as RobotCloudPermissionsHelper, aa as robotCloudPermissionsHelper, a9 as tagsHelper } from '../index-B8PC1dr5.mjs';
 import 'axios';

package/dist/helpers/index.d.ts

@@ -1,2 +1,2 @@
-export { a7 as RobotCloudPermissionsHelper, a6 as robotCloudPermissionsHelper, a5 as tagsHelper } from '../index-9RfDay_a.js';
+export { ab as RobotCloudPermissionsHelper, aa as robotCloudPermissionsHelper, a9 as tagsHelper } from '../index-B8PC1dr5.js';
 import 'axios';

package/dist/{index-9RfDay_a.d.mts → index-B8PC1dr5.d.mts}

@@ -309,6 +309,34 @@ type MeasurementStatus =
 interface ServiceDataMeasurement<T> extends ServiceInstanceRead<T> {
   status: MeasurementStatus;
 }
+interface AirHandlingUnit1AlertEventValue {
+  alarm_1: boolean,
+  alarm_2: boolean,
+  alarm_3: boolean,
+  alarm_4: boolean,
+  alarm_general: boolean
+}
+
+interface AirHandlingUnit1DataEventValue {
+  cool_heat_state?: "COOL" | "HEAT" | "AUTO",
+  cool_heat_valve_state?: number,
+  heat_valve_state?: number,
+  impulsion_fan_speed?: number,
+  impulsion_fan_state?: boolean,
+  impulsion_flow?: number,
+  impulsion_set_point?: number,
+  impulsion_temperature?: number,
+  on?: boolean,
+  outdoor_air_damper_state?: number,
+  return_ambient_air_quality?: number,
+  return_ambient_co2?: number,
+  return_ambient_enthalpy?: number,
+  return_ambient_humidity?: number,
+  return_ambient_temperature?: number,
+  return_fan_speed?: number,
+  return_fan_state?: boolean,
+  return_flow?: number
+}
 
 interface AirQuality1DataEventValue {
   co2: number;
@@ -318,6 +346,39 @@ interface AirQuality1AlertEventValue {
   high_co2: boolean;
 }
 
+interface ChillerHeatingPump1DataEventValue {
+  COP?: number,
+  capacity?: number,
+  compressor_state?: number,
+  condenser_impulsion_temperature?: number,
+  condenser_return_temperature?: number,
+  expansion_valve_position?: number,
+  flow_state?: boolean,
+  impulsion_temperature?: number,
+  max_capacity?: number,
+  on?: boolean,
+  recovery_impulsion_temperature?: number,
+  recovery_return_temperature?: number,
+  recovery_state?: boolean,
+  regim?: "COOL" | "HEAT" | "AUTO" | "FROST",
+  remote_state?: boolean,
+  return_temperature?: number
+}
+
+interface ChillerHeatingPump1AlertEventValue {
+  alarm_1?: boolean;
+  alarm_2?: boolean;
+  alarm_3?: boolean;
+  alarm_4?: boolean;
+  alarm_5?: boolean;
+  alarm_6?: boolean;
+  alarm_7?: boolean;
+  alarm_8?: boolean;
+  alarm_9?: boolean;
+  alarm_10?: boolean;
+  alarm_general?: boolean;
+}
+
 interface RoomGuestStatus1AlertEventValue {
   door_open_overtime: boolean;
   window_open_overtime: boolean;
@@ -344,30 +405,53 @@ type HistoricAggregateFunction =
   | "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> {
+interface ServiceInstanceDataClient<T> {
 
-  get configuration(): ServiceInstanceConfigClient<any>;  
-  getAlerts(
-    prjId: string,
-    params?: ServiceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_ALERTS>[]>>;
+  /**
+   * Get data for a given project and instance
+   * @param prjId - The project ID
+   * @param instanceId - The instance ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  get(prjId: string, instanceId: string, params?: ServiceInstanceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>>>;
 
-  getData(
-    prjId: string,
-    params?: ServiceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+  /**
+   * Get all data for a given project and service
+   * @param prjId - The project ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  getAll(prjId: string, params?: ServiceDataRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
+}
 
-  getInstanceData(
-    prjId: string,
-    instanceId: string,
-    params?: ServiceInstanceDataRequestParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>>>;
+interface ServiceInstanceAlertClient<T> {
+
+  /**
+   * Get Alert for a given project and instance
+   * @param prjId - The project ID
+   * @param instanceId - The instance ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  get(prjId: string, instanceId: string, params?: ServiceInstanceAlertRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>>>;
+
+  /**
+   * Get all alerts for a given project and service
+   * @param prjId - The project ID
+   * @param params - The request parameters
+   * @returns A promise that resolves to the data
+   */
+  getAll(prjId: string, params?: ServiceAlertRequestParams): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
+}
+
+interface ServiceInstanceHistoricClient<T> {
 
   getInstanceHistoric(
     prjId: string,
@@ -375,7 +459,7 @@ interface ServiceTypeClient<T_ALERTS, T_DATA> {
     startTime: Date,
     endTime: Date,
     params: ServiceInstanceHistoricParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
 
   getInstanceHistoricAggregate(
     prjId: string,
@@ -385,110 +469,122 @@ interface ServiceTypeClient<T_ALERTS, T_DATA> {
     aggFunction: HistoricAggregateFunction,
     periode: string,
     params: ServiceInstanceHistoricAggregateParams
-  ): Promise<AxiosResponse<ServiceDataMeasurement<T_DATA>[]>>;
-}
-
-/**
- *
- */
-
-
-
-/*
- *  GENERIC REQUEST PARAMS INTERFACES
- */
-
-interface SubsystemRequestParams {
-  subsystem_id?: string;
-}
-
-interface PaginableRequestParams {
-  startIndex?: number;
-  maxSize?: number;
-}
-interface SortableListRequestParams {
-  sort_by?: string; // Prefix the field name with '-' for descending order.
-}
-
-interface SubsystemTagsRequestParams extends SubsystemRequestParams {
-  tag_id?: string | string[];
-}
-
-interface BaseFullPaginableRequestParams
-  extends SubsystemTagsRequestParams,
-  PaginableRequestParams { }
-
-/*
- * CONCRETE INTERFACES
- */
-
-interface ProjectClassifiersRequestParams
-  extends PaginableRequestParams { }
-
-interface ProjectsRequestParams extends PaginableRequestParams {
-  "organization-id": string;
-}
-
-interface ProjectDetailsRequestParams { }
-
-interface ProjectLocationsRequestParams
-  extends BaseFullPaginableRequestParams { }
-
-interface ServiceInstanceDataRequestParams { }
-
-interface ProjectTagRequestParams extends PaginableRequestParams {
-  parent_tag?: string;
-  no_parent?: boolean;
-}
-
-interface LocationServiceInstancesRequestParams
-  extends BaseFullPaginableRequestParams { }
-
-interface AlertLogsListRequestParams
-  extends BaseFullPaginableRequestParams,
-  SortableListRequestParams {
-  location_id?: string;
-  classifier_id?: string;
-  service_name?: string;
-  instance_id?: string;
-  name?: string;
-  active?: boolean;
-  acknowledged?: boolean;
-  ack_user?: string;
-  active_time?: string;
-  deactive_time?: string;
-  ack_time?: string;
-}
-interface AlertsProjectStatsRequestParams extends SubsystemRequestParams { }
-interface AlertAggregatedLogsRequestParams extends SubsystemTagsRequestParams {
-  location_id?: string;
-  classifier_id?: string;
-  service_name?: string;
-  instance_id?: string;
-  name?: string;
-  periode: `${number}${'h' | 'd' | 'w' | 'm' | 'y'}`;
-  offset?: string;
-  time_range: string;
-}
-interface ServiceInstancesRequestParams
-  extends BaseFullPaginableRequestParams {
-  id?: string;
-  name?: string;
-  location_id?: string;
-  device_id?: string;
-}
-
-interface ServiceDataRequestParams extends SubsystemTagsRequestParams { }
-
-interface ServiceInstanceHistoricAggregateParams {
-  offset?: string;
-  property?: any[];
-  maxSize?: number;
-}
-interface ServiceInstanceHistoricParams {
-  status?: MeasurementStatus;
-  property?: any[];
-  maxSize?: number;
+  ): Promise<AxiosResponse<ServiceDataMeasurement<T>[]>>;
+}
+
+
+interface ServiceTypeClient<T_DATA, T_ALERTS, T_CONFIG> {
+  get configuration(): ServiceInstanceConfigClient<T_CONFIG>;
+  get data(): ServiceInstanceDataClient<T_DATA>;
+  get alert(): ServiceInstanceAlertClient<T_ALERTS>;
+  get historic(): ServiceInstanceHistoricClient<T_DATA>;
+}
+
+/**
+ *
+ */
+
+
+
+/*
+ *  GENERIC REQUEST PARAMS INTERFACES
+ */
+
+interface SubsystemRequestParams {
+  subsystem_id?: string;
+}
+
+interface PaginableRequestParams {
+  startIndex?: number;
+  maxSize?: number;
+}
+interface SortableListRequestParams {
+  sort_by?: string; // Prefix the field name with '-' for descending order.
+}
+
+interface SubsystemTagsRequestParams extends SubsystemRequestParams {
+  tag_id?: string | string[];
+}
+
+interface BaseFullPaginableRequestParams
+  extends SubsystemTagsRequestParams,
+  PaginableRequestParams { }
+
+/*
+ * CONCRETE INTERFACES
+ */
+
+interface ProjectClassifiersRequestParams
+  extends PaginableRequestParams { }
+
+interface ProjectsRequestParams extends PaginableRequestParams {
+  "organization-id": string;
+}
+
+interface ProjectDetailsRequestParams { }
+
+interface ProjectLocationsRequestParams
+  extends BaseFullPaginableRequestParams { }
+
+interface ServiceInstanceDataRequestParams { }
+
+interface ServiceInstanceAlertRequestParams { }
+
+interface ProjectTagRequestParams extends PaginableRequestParams {
+  parent_tag?: string;
+  no_parent?: boolean;
+}
+
+interface LocationServiceInstancesRequestParams
+  extends BaseFullPaginableRequestParams { }
+
+interface AlertLogsListRequestParams
+  extends BaseFullPaginableRequestParams,
+  SortableListRequestParams {
+  location_id?: string;
+  classifier_id?: string;
+  service_name?: string;
+  instance_id?: string;
+  name?: string;
+  active?: boolean;
+  acknowledged?: boolean;
+  ack_user?: string;
+  active_time?: string;
+  deactive_time?: string;
+  ack_time?: string;
+}
+interface AlertsProjectStatsRequestParams extends SubsystemRequestParams { }
+interface AlertAggregatedLogsRequestParams extends SubsystemTagsRequestParams {
+  location_id?: string;
+  classifier_id?: string;
+  service_name?: string;
+  instance_id?: string;
+  name?: string;
+  periode: `${number}${'h' | 'd' | 'w' | 'm' | 'y'}`;
+  offset?: string;
+  time_range: string;
+}
+interface ServiceInstancesRequestParams
+  extends BaseFullPaginableRequestParams {
+  id?: string;
+  name?: string;
+  location_id?: string;
+  device_id?: string;
+}
+
+interface ServiceDataRequestParams extends SubsystemTagsRequestParams { }
+
+interface ServiceAlertRequestParams extends SubsystemTagsRequestParams { }
+
+interface ServiceInstanceHistoricAggregateParams {
+  offset?: string;
+  property?: any[];
+  maxSize?: number;
+}
+interface ServiceInstanceHistoricParams {
+  status?: MeasurementStatus;
+  property?: any[];
+  maxSize?: number;
 }
 
 interface ProjectTagTreeNode {
@@ -544,4 +640,4 @@ declare const robotCloudPermissionsHelper: RobotCloudPermissionsHelper;
 
 declare const tagsHelper: TagsHelper;
 
-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 };
+export { type RobotCloudProjectDetails as $, type AlertsProjectStatsRequestParams as A, type ServiceDataRequestParams as B, type ServiceInstanceAlertClient as C, type ServiceInstanceAlertRequestParams as D, type ServiceAlertRequestParams as E, type ServiceInstanceHistoricClient as F, type ServiceInstanceHistoricParams as G, type HistoricAggregateFunction as H, type ServiceInstanceHistoricAggregateParams as I, type RoomClime1AlertEventValue as J, type ServiceTypeClient as K, type AirQuality1DataEventValue as L, type AirQuality1AlertEventValue as M, type RoomConsumes1AlertEventValue as N, type RobotCloudRobotCloudDeviceCreate as O, type ProjectClassifiersRequestParams as P, type RobotCloudDeviceDetails as Q, type RobotCloudOrganizations as R, type SubsystemRequestParams as S, type TemperatureUnit as T, type RobotCloudRobotCloudDeviceModify as U, type RobotCloudDeviceConfiguration as V, type ProjectLocationsRequestParams as W, type RobotCloudProject as X, type RobotCloudCreateProject as Y, type ProjectsRequestParams as Z, type ProjectDetailsRequestParams as _, type RobotCloudCreateOrganization as a, type RobotCloudPutProject as a0, type RobotCloudProjectUsers as a1, type RobotCloudProjectApplications as a2, type RobotCloudApplicationEnable as a3, type ServiceInstancesRequestParams as a4, type RobotCloudServiceTypeDetails as a5, type LocationServiceInstancesRequestParams as a6, type ServiceInstanceRead as a7, tagsClient as a8, tagsHelper as a9, robotCloudPermissionsHelper as aa, type RobotCloudPermissionsHelper as ab, type ProjectTagTreeNode as ac, type ProjectTagsTree as ad, type ProjectTag as ae, type ProjectModifyTag as af, type ProjectTagDetails as ag, type PaginableRequestParams as ah, type SortableListRequestParams as ai, type SubsystemTagsRequestParams as aj, type BaseFullPaginableRequestParams as ak, type ProjectTagRequestParams as al, type OrganizationAccessLevel as am, type ProjectAccessLevel as an, type AppAccessLevel as ao, type RobotCloudServiceType as ap, type FancoilSpeedState as aq, type RobotCloudUserAppAccess as ar, type RobotCloudCreateUser as as, type RobotCloudProjectInstances as at, type MeasurementStatus as au, type AirHandlingUnit1AlertEventValue as av, type AirHandlingUnit1DataEventValue as aw, type ChillerHeatingPump1DataEventValue as ax, type ChillerHeatingPump1AlertEventValue as ay, type RoomGuestStatus1AlertEventValue as az, 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 ServiceInstanceDataClient as x, type ServiceInstanceDataRequestParams as y, type ServiceDataMeasurement as z };