@ricado/api-client 1.4.0 → 1.4.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/dist/ricado.api.client.js +1 -1
  2. package/lib/Controllers/Site/PointController.js +2 -0
  3. package/lib/PackageVersion.js +1 -1
  4. package/lib/index.d.ts +8 -0
  5. package/package.json +1 -1
  6. package/src/Controllers/Site/PointController.js +2 -0
  7. package/src/PackageVersion.js +1 -1
package/lib/Controllers/Site/PointController.js CHANGED
@@ -473,6 +473,8 @@ var _default = PointController;
473
473
  * @typedef {Object} PointController.GetAllHistoryQueryParameters
474
474
  * @property {Date} [timestampBegin] The Beginning Timestamp of the Point History Results. Defaults to 24 Hours ago
475
475
  * @property {Date} [timestampEnd] The End Timestamp of the Point History Results. Defaults to Now
476
+ * @property {number} [maximumValues] The Maximum Number of Values that should be returned for each Point ID. Defaults to an Unlimited Number of Values
477
+ * @property {number} [resolution] A Resolution (Interval) in Seconds for the History Results - NOTE: Use of the maximumValues Query Parameter may enforce a higher minimum resolution. Defaults to 30 Seconds
476
478
  * @memberof Controllers.Site
477
479
  */
478
480
 
package/lib/PackageVersion.js CHANGED
@@ -5,5 +5,5 @@ Object.defineProperty(exports, "__esModule", {
5
5
  });
6
6
  exports.version = void 0;
7
7
  // generated by genversion
8
- var version = '1.4.0';
8
+ var version = '1.4.1';
9
9
  exports.version = version;
package/lib/index.d.ts CHANGED
@@ -4460,6 +4460,14 @@ declare module '@ricado/api-client/Controllers/Site/PointController' {
4460
4460
  * The End Timestamp of the Point History Results. Defaults to Now
4461
4461
  */
4462
4462
  timestampEnd?: Date;
4463
+ /**
4464
+ * The Maximum Number of Values that should be returned for each Point ID. Defaults to an Unlimited Number of Values
4465
+ */
4466
+ maximumValues?: number;
4467
+ /**
4468
+ * A Resolution (Interval) in Seconds for the History Results - NOTE: Use of the maximumValues Query Parameter may enforce a higher minimum resolution. Defaults to 30 Seconds
4469
+ */
4470
+ resolution?: number;
4463
4471
  };
4464
4472
  /**
4465
4473
  * The Optional Query Parameters for the getAllEvents Function
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ricado/api-client",
3
- "version": "1.4.0",
3
+ "version": "1.4.1",
4
4
  "description": "RICADO Gen 4 API Client Library for NodeJS and Browsers",
5
5
  "author": {
6
6
  "name": "Ash Neilson"
package/src/Controllers/Site/PointController.js CHANGED
@@ -476,6 +476,8 @@ export default PointController;
476
476
  * @typedef {Object} PointController.GetAllHistoryQueryParameters
477
477
  * @property {Date} [timestampBegin] The Beginning Timestamp of the Point History Results. Defaults to 24 Hours ago
478
478
  * @property {Date} [timestampEnd] The End Timestamp of the Point History Results. Defaults to Now
479
+ * @property {number} [maximumValues] The Maximum Number of Values that should be returned for each Point ID. Defaults to an Unlimited Number of Values
480
+ * @property {number} [resolution] A Resolution (Interval) in Seconds for the History Results - NOTE: Use of the maximumValues Query Parameter may enforce a higher minimum resolution. Defaults to 30 Seconds
479
481
  * @memberof Controllers.Site
480
482
  */
481
483
 
package/src/PackageVersion.js CHANGED
@@ -1,2 +1,2 @@
1
1
  // generated by genversion
2
- export const version = '1.4.0';
2
+ export const version = '1.4.1';