c8y-nitro 0.1.0 → 0.1.1

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/IMeasurement.d.mts

@@ -0,0 +1,61 @@
+import { ISource } from "../core/ISource.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/IMeasurement.d.ts
+/**
+ * Interface which holds all mandantory fragments for measurements
+ */
+interface IMeasurement {
+  /**
+   * Uniquely identifies a measurement
+   */
+  id: string | number;
+  /**
+   * The most specific type of this entire measurement
+   */
+  type: string;
+  /**
+   * Time of the measurement
+   */
+  time: string;
+  /**
+   * Link to this resource
+   */
+  self: string;
+  /**
+   * The ManagedObject which is the source of this measurement,
+   * see [[ISource]]
+   */
+  source: ISource;
+  /**
+   * Custom fragments.
+   * **Example**
+   * ```typescript
+   *
+   * {
+   *  series: {
+   *    unit: '%',
+   *    value: 51
+   *  }
+   * }
+   * ```
+   */
+  [fragment: string]: {
+    [series: string]: IMeasurementValue;
+  } | any;
+}
+interface IMeasurementValue {
+  value: number;
+  unit?: string;
+  [key: string]: any;
+}
+/**
+ * This interface can be used to create a valid measurement.
+ */
+interface IMeasurementCreate extends IMeasurement {
+  /**
+   * Uniquely identifier to which source this measurement belongs to
+   */
+  sourceId: number | string;
+}
+//#endregion
+export { IMeasurement, IMeasurementCreate, IMeasurementValue };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/IMeasurementFilter.d.mts

@@ -0,0 +1,59 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/IMeasurementFilter.d.ts
+/**
+ * This interface specifies all fragments which can be used
+ * to filter for specific measurement.
+ */
+interface IMeasurementFilter {
+  /**
+   * The current page of the paginated results.
+   */
+  currentPage?: number;
+  /**
+   * The managed object ID which the measurement is associated to.
+   */
+  source?: number | string;
+  /**
+   * From which date the measurements should be gathered
+   */
+  dateFrom?: string | Date;
+  /**
+   * To which date the measurements should be gathered
+   */
+  dateTo?: string | Date;
+  /**
+   * Indicates how many entries of the collection shall be returned.
+   * The upper limit for one page is 2000 objects.
+   */
+  pageSize?: number;
+  /**
+   * If you are using a range query (that is, at least one of the dateFrom or dateTo parameters is included in the request),
+   * then setting revert=true will sort the results by the newest measurements first.
+   * By default, the results are sorted by the oldest measurements first.
+   */
+  revert?: boolean;
+  /**
+   * The type of measurement to search for.
+   */
+  type?: string;
+  /**
+   * The specific series to search for.
+   */
+  valueFragmentSeries?: string;
+  /**
+   * When set to true, the returned result will contain in the statistics object the total number of elements.
+   * Only applicable to range queries.
+   */
+  valueFragmentType?: string;
+  /**
+   * When set to true, the returned result will contain in the statistics object the total number of pages.
+   * Only applicable to range queries.
+   */
+  withTotalPages?: boolean;
+  /**
+   * When set to true, the returned result will contain in the statistics object the total number of elements.
+   * Only applicable to range queries.
+   */
+  withTotalElements?: boolean;
+}
+//#endregion
+export { IMeasurementFilter };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/ISeries.d.mts

@@ -0,0 +1,60 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/ISeries.d.ts
+interface ISeries {
+  /**
+   * **Example**
+   * ```typescript
+   *
+   * values: {
+   *  '2014-12-04T17:33:01.538+01:00': [{
+   *    min: 13.37,
+   *    max: 13.37
+   *  },
+   *  {
+   *    min: 11.37,
+   *    max: 11.37
+   *  }],
+   *  '2014-12-04T17:34:01.774+01:00': [{
+   *    min: 10.2,
+   *    max: 10.2
+   *  },
+   *  {
+   *    min: 11.37,
+   *    max: 11.37
+   *  }]
+   * }
+   * ```
+   */
+  values: {
+    [date: string]: Array<{
+      min: number;
+      max: number;
+    }>;
+  };
+  /**
+   * **Example**
+   * ```typescript
+   *
+   * series: [{
+   *   unit: "m/s2",
+   *   name: "acceleration",
+   *   type: "c8y_AccelerationMeasurement"
+   * },
+   * {
+   *   unit: "m/s",
+   *   name: "velocity",
+   *   type: "c8y_SpeedMeasurement"
+   * }]
+   * ```
+   */
+  series: Array<{
+    unit: string;
+    name: string;
+    type: string;
+  }>;
+  /**
+   * Indicates whether there were more than 5000 values and if the final result was truncated
+   */
+  truncated: boolean;
+}
+//#endregion
+export { ISeries };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/ISeriesFilter.d.mts

@@ -0,0 +1,48 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/ISeriesFilter.d.ts
+declare enum aggregationType {
+  MINUTELY = "MINUTELY",
+  HOURLY = "HOURLY",
+  DAILY = "DAILY"
+}
+/**
+ * This interface specifies all fragments which can be used
+ * to filter for specific series.
+ */
+interface ISeriesFilter {
+  /**
+   * The ManagedObject which is the source of these series
+   */
+  source: number | string;
+  /**
+   * From which date the series should be gathered
+   */
+  dateFrom: string | Date;
+  /**
+   * To which date the series should be gathered
+   */
+  dateTo: string | Date;
+  /**
+   * For which aggregation it should filter, see [[aggregationType]]
+   */
+  aggregationType?: aggregationType;
+  /**
+   * The series type and name
+   *
+   * **Example**
+   * ```typescript
+   *
+   * const series: string[] = ['c8y_AccelerationMeasurement.acceleration', '...'];
+   * ```
+   */
+  series?: string | string[];
+  /**
+   * If you are using a range query (that is, at least one of the dateFrom or dateTo parameters is included in the request),
+   * then setting revert=true will sort the results by the newest measurements first.
+   * By default, the results are sorted by the oldest measurements first.
+   *
+   * Note: it will not sort a measurements by a date, but by the order of the measurements in the response.
+   */
+  revert?: boolean;
+}
+//#endregion
+export { ISeriesFilter, aggregationType };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/MeasurementService.d.mts

@@ -0,0 +1,163 @@
+import { IFetchResponse } from "../core/IFetchResponse.mjs";
+import { IIdentified } from "../core/IIdentified.mjs";
+import { IResultList } from "../core/IResultList.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { IMeasurement, IMeasurementCreate } from "./IMeasurement.mjs";
+import { IMeasurementFilter } from "./IMeasurementFilter.mjs";
+import { ISeries } from "./ISeries.mjs";
+import { ISeriesFilter } from "./ISeriesFilter.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/measurement/MeasurementService.d.ts
+/**
+ * This class allows for managing measurements.
+ */
+declare class MeasurementService extends Service<IMeasurement> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  protected propertyName: string;
+  protected channel: string;
+  /**
+   * Gets the details of selected measurement.
+   *
+   * @param {string|number|IIdentified} entityOrId Entity or Id of the entity.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @deprecated As of version 10.16.0.0 and the usage of the time series database,
+   * reading a single measurement via id is not supported any more.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const measurementId: number = 1;
+   *
+   *    (async () => {
+   *      const {data, res} = await measurementService.detail(measurementId);
+   *   })();
+   * ```
+   */
+  detail(entityOrId: string | number | IIdentified): Promise<IResult<IMeasurement>>;
+  /**
+   * Creates a new measurement.
+   *
+   * @param {Partial<IMeasurementCreate>} entity At least sourceId is mandantory.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const mandantoryObject: Partial<IMeasurementCreate> = {
+   *    sourceId: device.id,
+   *    fragment: { series: { unit: '%', value: 51 } },
+   *  };
+   *
+   *  (async () => {
+   *    const {data, res} = await measurementService.create(mandantoryObject);
+   *  })();
+   * ```
+   */
+  create(entity: Partial<IMeasurementCreate>): Promise<IResult<IMeasurement>>;
+  /**
+   * Gets the list of measurements filtered by parameters.
+   *
+   * @returns Response wrapped in [[IResultList]]
+   *
+   * @param {object} filter Object containing filters for querying measurements.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter: object = {
+   *     pageSize: 100,
+   *     withTotalPages: true
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res, paging} = await measurementService.list(filter);
+   *   })();
+   * ```
+   */
+  list(filter?: object): Promise<IResultList<IMeasurement>>;
+  /**
+   * Removes a measurement with given id.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {string | number | IIdentified} entityOrId
+   *
+   * @deprecated As of version 10.16.0.0 and the usage of the time series database,
+   * deleting a single measurement via id is not supported any more.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const id: number = 1;
+   *
+   *    (async () => {
+   *      const {data, res} = await measurementService.delete(id);
+   *   })();
+   * ```
+   */
+  delete(entityOrId: string | number | IIdentified): Promise<IResult<null>>;
+  /**
+   * Gets the list of series in a measurement filtered by parameters.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {object} filter Object containing filters for querying measurements.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter: object = {
+   *    dateFrom: '2018-02-06T10:43:55.077Z',
+   *    dateTo: '2018-02-06T10:50:55.077Z',
+   *    source: device.id
+   *  };
+   *
+   *   (async () => {
+   *     const {data, res} = await measurementService.listSeries(filter);
+   *   })();
+   * ```
+   */
+  listSeries(params: ISeriesFilter): Promise<IResult<ISeries>>;
+  /**
+   * Retrieves the measurement file based on the provided filter parameters and headers, but only if the response is 200.
+   * If the response is 202, the file is processed in the background and the file is sent by email.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter: IFetchResponse = {
+   *    dateFrom: "2024-08-11T12:13:00+02:00"
+   *    dateTo: "2024-08-12T12:15:00+02:00"
+   *    source: "32666427"
+   *    valueFragmentSeries: "accelerationX"
+   *    valueFragmentType: "c8y_Acceleration"
+   *  };
+   *
+   *  const headers = {
+   *    accept: 'text/csv'
+   *  }
+   *
+   *   (async () => {
+   *     const response = await measurementService.getMeasurementsFile(filter, headers);
+   *     if (response.status === 200) {
+   *        const blob = await response.blob();
+   *     }
+   *   })();
+   * ```
+   *
+   * @param filter Object containing filters for querying measurements.
+   * @param headers The headers for the request.
+   * @returns A promise that resolves to the fetch response.
+   */
+  getMeasurementsFile(params: IMeasurementFilter, headers: {
+    accept: string;
+  }): Promise<IFetchResponse>;
+  protected onBeforeCreate(entity: Partial<IMeasurementCreate>): Partial<IMeasurementCreate>;
+}
+//#endregion
+export { MeasurementService };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/IOperation.d.mts

@@ -0,0 +1,27 @@
+import { OperationStatus } from "./OperationStatus.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/IOperation.d.ts
+/**
+ * Interface to gather all mandantory fragments to
+ * have a valid operation.
+ */
+interface IOperation {
+  /**
+   * Identifier for operation
+   */
+  id?: string | number;
+  /**
+   * Identifies the target device on which this operation should be performed
+   */
+  deviceId: string;
+  /**
+   * Status of operation, see [[OperationStatus]]
+   */
+  status?: OperationStatus;
+  /**
+   * Custom fragments
+   */
+  [key: string]: any;
+}
+//#endregion
+export { IOperation };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/IOperationBulk.d.mts

@@ -0,0 +1,58 @@
+import { IOperation } from "./IOperation.mjs";
+import { OperationBulkStatus } from "./OperationBulkStatus.mjs";
+import { OperationBulkGeneralStatus } from "./OperationBulkGeneralStatus.mjs";
+import { IOperationBulkProgress } from "./IOperationBulkProgress.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/IOperationBulk.d.ts
+/**
+ * Interface to gather all mandantory fragments to
+ * have a valid bulk operation.
+ */
+interface IOperationBulk {
+  /**
+   * Identifier for bulk operation
+   */
+  id?: string | number;
+  /**
+   * Identifies the target group on which this operation should be performed
+   */
+  groupId: string | number;
+  /**
+   * Time when operations should be created
+   */
+  startDate: string;
+  /**
+   * Delay between every operation creation
+   */
+  creationRamp: number;
+  /**
+   * Operation to be executed for every device in a group
+   */
+  operationPrototype: Partial<IOperation>;
+  /**
+   * Status of Bulk Operation, see [[OperationBulkStatus]]
+   */
+  status?: OperationBulkStatus;
+  /**
+   * Simplified user friendly status of Bulk Operation, see [[OperationBulkGeneralStatus]]
+   */
+  generalStatus?: OperationBulkGeneralStatus;
+  /**
+   * Contains information about number of processed operations, see [[IOperationBulkProgress]]
+   */
+  progress?: IOperationBulkProgress;
+  /**
+   * Identifier of the failed bulk operation that current operation was created from
+   */
+  failedParentId?: string | number;
+  /**
+   * User specified note
+   */
+  note?: string;
+  /**
+   * Link to this resource
+   */
+  self?: string;
+}
+//#endregion
+export { IOperationBulk };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/IOperationBulkProgress.d.mts

@@ -0,0 +1,29 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/IOperationBulkProgress.d.ts
+/**
+ * Interface to gather more information about the process
+ * of performed bulk operation.
+ */
+interface IOperationBulkProgress {
+  /**
+   * Count of processed operations
+   */
+  all: number;
+  /**
+   * Count of pending operations
+   */
+  pending: number;
+  /**
+   * Count of executing operations
+   */
+  executing: number;
+  /**
+   * Count of successful operations
+   */
+  successful: number;
+  /**
+   * Count of failed operations
+   */
+  failed: number;
+}
+//#endregion
+export { IOperationBulkProgress };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationBulkGeneralStatus.d.mts

@@ -0,0 +1,16 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationBulkGeneralStatus.d.ts
+/**
+ * A bulk operation can have one of the following general statuses.
+ */
+declare enum OperationBulkGeneralStatus {
+  SCHEDULED,
+  EXECUTING,
+  EXECUTING_WITH_ERROR,
+  CANCELED,
+  FAILED,
+  SUCCESSFUL,
+  DELETED,
+  INCORRECT
+}
+//#endregion
+export { OperationBulkGeneralStatus };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationBulkService.d.mts

@@ -0,0 +1,130 @@
+import { IIdentified } from "../core/IIdentified.mjs";
+import { IResultList } from "../core/IResultList.mjs";
+import { IResult } from "../core/IResult.mjs";
+import { Service } from "../core/Service.mjs";
+import { IOperationBulk } from "./IOperationBulk.mjs";
+
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationBulkService.d.ts
+/**
+ * This class allows for managing bulk operations.
+ */
+declare class OperationBulkService extends Service<IOperationBulk> {
+  protected baseUrl: string;
+  protected listUrl: string;
+  protected propertyName: string;
+  /**
+   * Gets the details of selected bulk operation.
+   *
+   * @param {string|number|IIdentified} entityOrId Entity or Id of the entity.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *    const bulkOperationId: number = 1;
+   *
+   *    (async () => {
+   *      const {data, res} = await operationBulkService.detail(bulkOperationId);
+   *   })();
+   * ```
+   */
+  detail(operationOrId: string | number | IIdentified): Promise<IResult<IOperationBulk>>;
+  /**
+   * Creates a new operation.
+   *
+   * @param {Partial<IOperationBulk>} operation Operation object with mandantory fragments.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const mandantoryObject: Partial<IOperationBulk> = {
+   *    creationRamp: 15,
+   *    groupId: '149044',
+   *    operationPrototype: {
+   *      c8y_Restart: {},
+   *      description: 'Restart device',
+   *      deviceId: device.id,
+   *      status: 'PENDING'
+   *    },
+   *     startDate: '2018-02-15T16:01:00.000Z'
+   *  };
+   *
+   *  (async () => {
+   *    const {data, res} = await operationBulkService.create(mandantoryObject);
+   *  })();
+   * ```
+   */
+  create(operation: Partial<IOperationBulk>): Promise<IResult<IOperationBulk>>;
+  /**
+   * Updates a new operation.
+   *
+   * @param {Partial<IOperationBulk>} operation Operation object.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const updateObject: Partial<IOperationBulk> = {
+   *    creationRamp: 15,
+   *    groupId: '149044',
+   *    operationPrototype: {
+   *      c8y_Restart: {},
+   *      description: 'Restart device',
+   *      deviceId: device.id,
+   *      status: 'PENDING'
+   *    },
+   *     startDate: '2018-02-15T16:01:00.000Z'
+   *  };
+   *
+   *  (async () => {
+   *    const {data, res} = await operationBulkService.update(updateObject);
+   *  })();
+   * ```
+   */
+  update(entity: Partial<IOperationBulk>): Promise<IResult<IOperationBulk>>;
+  /**
+   * Gets the list of bulk operations filtered by parameters.
+   *
+   * @returns Response wrapped in [[IResultList]]
+   *
+   * @param {object} filter Object containing filters for querying alarms.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *  const filter: object = {
+   *     pageSize: 100,
+   *     withTotalPages: true
+   *   };
+   *
+   *   (async () => {
+   *     const {data, res, paging} = await operationBulkService.list(filter);
+   *   })();
+   * ```
+   */
+  list(filter?: object): Promise<IResultList<IOperationBulk>>;
+  /**
+   * Removes an bulk operation with given id.
+   *
+   * @returns Response wrapped in [[IResult]]
+   *
+   * @param {string | number | IIdentified):} operationOrId Operation object or id.
+   *
+   * **Example**
+   * ```typescript
+   *
+   *   const id: number = 1;
+   *
+   *    (async () => {
+   *      const {data, res} = await operationBulkService.delete(id);
+   *   })();
+   * ```
+   */
+  delete(operationOrId: string | number | IIdentified): Promise<IResult<null>>;
+}
+//#endregion
+export { OperationBulkService };

package/dist/node_modules/.pnpm/@c8y_client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationBulkStatus.d.mts

@@ -0,0 +1,12 @@
+//#region node_modules/.pnpm/@c8y+client@1023.17.8_encoding@0.1.13/node_modules/@c8y/client/lib/src/operation/OperationBulkStatus.d.ts
+/**
+ * A bulk operation can have one of the following states.
+ */
+declare enum OperationBulkStatus {
+  ACTIVE,
+  IN_PROGRESS,
+  COMPLETED,
+  DELETED
+}
+//#endregion
+export { OperationBulkStatus };