@smartspectra/node-sdk 3.4.0-rc.5 → 3.4.0-rc.7

package/js/messages/generated.d.ts

@@ -588,7 +588,11 @@ export namespace presage {
             /** Standard Deviation of normal-to-normal (NN) Intervals */
             sdnn?: (number|null);
 
-            /** Baevsky's Stress Index, in 1/ms^2 (inverse-square milliseconds) */
+            /**
+             * Baevsky's Stress Index: a measure of autonomic balance derived from the
+             * NN interval distribution, computed as `AMo / (2 * Mo * MxDMn)`. Reported
+             * without a unit, matching the HRV model card.
+             */
             baevsky?: (number|null);
 
             /** Absolute timestamp at which the HRV measurement was taken, in microseconds, since Linux epoch */
@@ -619,7 +623,11 @@ export namespace presage {
             /** Standard Deviation of normal-to-normal (NN) Intervals */
             public sdnn: number;
 
-            /** Baevsky's Stress Index, in 1/ms^2 (inverse-square milliseconds) */
+            /**
+             * Baevsky's Stress Index: a measure of autonomic balance derived from the
+             * NN interval distribution, computed as `AMo / (2 * Mo * MxDMn)`. Reported
+             * without a unit, matching the HRV model card.
+             */
             public baevsky: number;
 
             /** Absolute timestamp at which the HRV measurement was taken, in microseconds, since Linux epoch */
@@ -714,6 +722,9 @@ export namespace presage {
 
             /** The strict value requiring high precision */
             value?: (number|null);
+
+            /** End of the completed measurement window, in microseconds on the session input timeline */
+            timestamp?: (number|Long|null);
         }
 
         /**
@@ -731,6 +742,9 @@ export namespace presage {
             /** The strict value requiring high precision */
             public value: number;
 
+            /** End of the completed measurement window, in microseconds on the session input timeline */
+            public timestamp: (number|Long);
+
             /**
              * Creates a new Strict instance using the specified properties.
              * @param [properties] Properties to set
@@ -825,7 +839,7 @@ export namespace presage {
              * Strict/high-precision pulse measurements over a fixed time interval.
              * Populated when strict mode analysis is enabled.
              */
-            strict?: (presage.smartspectra.IStrict|null);
+            pulseRateStrict?: (presage.smartspectra.IStrict|null);
         }
 
         /**
@@ -853,7 +867,7 @@ export namespace presage {
              * Strict/high-precision pulse measurements over a fixed time interval.
              * Populated when strict mode analysis is enabled.
              */
-            public strict?: (presage.smartspectra.IStrict|null);
+            public pulseRateStrict?: (presage.smartspectra.IStrict|null);
 
             /**
              * Creates a new Pulse instance using the specified properties.
@@ -976,9 +990,10 @@ export namespace presage {
 
             /**
              * Strict/high-precision breathing measurements over a fixed time interval.
-             * Populated when strict mode analysis is enabled.
+             * Populated only when BREATHING_RATE_STRICT is requested and a value is
+             * available.
              */
-            strict?: (presage.smartspectra.IStrict|null);
+            breathingRateStrict?: (presage.smartspectra.IStrict|null);
         }
 
         /**
@@ -1033,9 +1048,10 @@ export namespace presage {
 
             /**
              * Strict/high-precision breathing measurements over a fixed time interval.
-             * Populated when strict mode analysis is enabled.
+             * Populated only when BREATHING_RATE_STRICT is requested and a value is
+             * available.
              */
-            public strict?: (presage.smartspectra.IStrict|null);
+            public breathingRateStrict?: (presage.smartspectra.IStrict|null);
 
             /**
              * Creates a new Breathing instance using the specified properties.
@@ -1586,6 +1602,12 @@ export namespace presage {
              * for the confidence-to-error mapping.
              */
             hrv?: (presage.smartspectra.IHrv[]|null);
+
+            /**
+             * Strict pulse-rate measurement. Populated only when PULSE_RATE_STRICT is
+             * requested and a value is available.
+             */
+            pulseRateStrict?: (presage.smartspectra.IStrict|null);
         }
 
         /** Represents a Cardio. */
@@ -1624,6 +1646,12 @@ export namespace presage {
              */
             public hrv: presage.smartspectra.IHrv[];
 
+            /**
+             * Strict pulse-rate measurement. Populated only when PULSE_RATE_STRICT is
+             * requested and a value is available.
+             */
+            public pulseRateStrict?: (presage.smartspectra.IStrict|null);
+
             /**
              * Creates a new Cardio instance using the specified properties.
              * @param [properties] Properties to set
@@ -2149,5 +2177,135 @@ export namespace presage {
              */
             public static getTypeUrl(typeUrlPrefix?: string): string;
         }
+
+        /** FeatureType enum. */
+        enum FeatureType {
+            BREATHING = 0,
+            MICROMOTION = 1,
+            EDA = 2,
+            FACE = 3,
+            CARDIO = 4
+        }
+
+        /** MetricType enum. */
+        enum MetricType {
+            CHEST_BREATHING = 0,
+            ABDOMEN_BREATHING = 1,
+            BREATHING_RATE = 2,
+            BREATHING_AMPLITUDE = 3,
+            APNEA = 4,
+            RESPIRATORY_LINE_LENGTH = 5,
+            BASELINE = 6,
+            INHALE_EXHALE_RATIO = 7,
+            GLUTES_MICROMOTION = 8,
+            KNEES_MICROMOTION = 9,
+            EDA_TRACE = 10,
+            FACE_LANDMARKS = 11,
+            BLINKING = 12,
+            TALKING = 13,
+            EXPRESSIONS = 14,
+            PULSE_RATE = 15,
+            ARTERIAL_PRESSURE_TRACE = 16,
+            HRV = 17,
+            PULSE_RATE_STRICT = 18,
+            BREATHING_RATE_STRICT = 19
+        }
+
+        /** Properties of a RequestedMetrics. */
+        interface IRequestedMetrics {
+
+            /** RequestedMetrics metrics */
+            metrics?: (presage.smartspectra.MetricType[]|null);
+        }
+
+        /** Represents a RequestedMetrics. */
+        class RequestedMetrics implements IRequestedMetrics {
+
+            /**
+             * Constructs a new RequestedMetrics.
+             * @param [properties] Properties to set
+             */
+            constructor(properties?: presage.smartspectra.IRequestedMetrics);
+
+            /** RequestedMetrics metrics. */
+            public metrics: presage.smartspectra.MetricType[];
+
+            /**
+             * Creates a new RequestedMetrics instance using the specified properties.
+             * @param [properties] Properties to set
+             * @returns RequestedMetrics instance
+             */
+            public static create(properties?: presage.smartspectra.IRequestedMetrics): presage.smartspectra.RequestedMetrics;
+
+            /**
+             * Encodes the specified RequestedMetrics message. Does not implicitly {@link presage.smartspectra.RequestedMetrics.verify|verify} messages.
+             * @param message RequestedMetrics message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encode(message: presage.smartspectra.IRequestedMetrics, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Encodes the specified RequestedMetrics message, length delimited. Does not implicitly {@link presage.smartspectra.RequestedMetrics.verify|verify} messages.
+             * @param message RequestedMetrics message or plain object to encode
+             * @param [writer] Writer to encode to
+             * @returns Writer
+             */
+            public static encodeDelimited(message: presage.smartspectra.IRequestedMetrics, writer?: $protobuf.Writer): $protobuf.Writer;
+
+            /**
+             * Decodes a RequestedMetrics message from the specified reader or buffer.
+             * @param reader Reader or buffer to decode from
+             * @param [length] Message length if known beforehand
+             * @returns RequestedMetrics
+             * @throws {Error} If the payload is not a reader or valid buffer
+             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+             */
+            public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): presage.smartspectra.RequestedMetrics;
+
+            /**
+             * Decodes a RequestedMetrics message from the specified reader or buffer, length delimited.
+             * @param reader Reader or buffer to decode from
+             * @returns RequestedMetrics
+             * @throws {Error} If the payload is not a reader or valid buffer
+             * @throws {$protobuf.util.ProtocolError} If required fields are missing
+             */
+            public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): presage.smartspectra.RequestedMetrics;
+
+            /**
+             * Verifies a RequestedMetrics message.
+             * @param message Plain object to verify
+             * @returns `null` if valid, otherwise the reason why it is not
+             */
+            public static verify(message: { [k: string]: any }): (string|null);
+
+            /**
+             * Creates a RequestedMetrics message from a plain object. Also converts values to their respective internal types.
+             * @param object Plain object
+             * @returns RequestedMetrics
+             */
+            public static fromObject(object: { [k: string]: any }): presage.smartspectra.RequestedMetrics;
+
+            /**
+             * Creates a plain object from a RequestedMetrics message. Also converts values to other types if specified.
+             * @param message RequestedMetrics
+             * @param [options] Conversion options
+             * @returns Plain object
+             */
+            public static toObject(message: presage.smartspectra.RequestedMetrics, options?: $protobuf.IConversionOptions): { [k: string]: any };
+
+            /**
+             * Converts this RequestedMetrics to JSON.
+             * @returns JSON object
+             */
+            public toJSON(): { [k: string]: any };
+
+            /**
+             * Gets the default type url for RequestedMetrics
+             * @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
+             * @returns The default type url
+             */
+            public static getTypeUrl(typeUrlPrefix?: string): string;
+        }
     }
 }