@uug-ai/models 1.7.72 → 1.7.74
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.
- package/dist/types.d.ts +403 -127
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -7413,6 +7413,45 @@ export interface paths {
|
|
|
7413
7413
|
patch?: never;
|
|
7414
7414
|
trace?: never;
|
|
7415
7415
|
};
|
|
7416
|
+
"/internal/deviceagent": {
|
|
7417
|
+
parameters: {
|
|
7418
|
+
query?: never;
|
|
7419
|
+
header?: never;
|
|
7420
|
+
path?: never;
|
|
7421
|
+
cookie?: never;
|
|
7422
|
+
};
|
|
7423
|
+
/**
|
|
7424
|
+
* Get DeviceAgent (schema generation only)
|
|
7425
|
+
* @description Internal endpoint used only to ensure DeviceAgent schema is generated in OpenAPI spec
|
|
7426
|
+
*/
|
|
7427
|
+
get: {
|
|
7428
|
+
parameters: {
|
|
7429
|
+
query?: never;
|
|
7430
|
+
header?: never;
|
|
7431
|
+
path?: never;
|
|
7432
|
+
cookie?: never;
|
|
7433
|
+
};
|
|
7434
|
+
requestBody?: never;
|
|
7435
|
+
responses: {
|
|
7436
|
+
/** @description OK */
|
|
7437
|
+
200: {
|
|
7438
|
+
headers: {
|
|
7439
|
+
[name: string]: unknown;
|
|
7440
|
+
};
|
|
7441
|
+
content: {
|
|
7442
|
+
"application/json": components["schemas"]["models.DeviceAgent"];
|
|
7443
|
+
};
|
|
7444
|
+
};
|
|
7445
|
+
};
|
|
7446
|
+
};
|
|
7447
|
+
put?: never;
|
|
7448
|
+
post?: never;
|
|
7449
|
+
delete?: never;
|
|
7450
|
+
options?: never;
|
|
7451
|
+
head?: never;
|
|
7452
|
+
patch?: never;
|
|
7453
|
+
trace?: never;
|
|
7454
|
+
};
|
|
7416
7455
|
"/internal/deviceatruntimemetadata": {
|
|
7417
7456
|
parameters: {
|
|
7418
7457
|
query?: never;
|
|
@@ -7569,6 +7608,45 @@ export interface paths {
|
|
|
7569
7608
|
patch?: never;
|
|
7570
7609
|
trace?: never;
|
|
7571
7610
|
};
|
|
7611
|
+
"/internal/deviceheartbeat": {
|
|
7612
|
+
parameters: {
|
|
7613
|
+
query?: never;
|
|
7614
|
+
header?: never;
|
|
7615
|
+
path?: never;
|
|
7616
|
+
cookie?: never;
|
|
7617
|
+
};
|
|
7618
|
+
/**
|
|
7619
|
+
* Get DeviceHeartbeat (schema generation only)
|
|
7620
|
+
* @description Internal endpoint used only to ensure DeviceHeartbeat schema is generated in OpenAPI spec
|
|
7621
|
+
*/
|
|
7622
|
+
get: {
|
|
7623
|
+
parameters: {
|
|
7624
|
+
query?: never;
|
|
7625
|
+
header?: never;
|
|
7626
|
+
path?: never;
|
|
7627
|
+
cookie?: never;
|
|
7628
|
+
};
|
|
7629
|
+
requestBody?: never;
|
|
7630
|
+
responses: {
|
|
7631
|
+
/** @description OK */
|
|
7632
|
+
200: {
|
|
7633
|
+
headers: {
|
|
7634
|
+
[name: string]: unknown;
|
|
7635
|
+
};
|
|
7636
|
+
content: {
|
|
7637
|
+
"application/json": components["schemas"]["models.DeviceHeartbeat"];
|
|
7638
|
+
};
|
|
7639
|
+
};
|
|
7640
|
+
};
|
|
7641
|
+
};
|
|
7642
|
+
put?: never;
|
|
7643
|
+
post?: never;
|
|
7644
|
+
delete?: never;
|
|
7645
|
+
options?: never;
|
|
7646
|
+
head?: never;
|
|
7647
|
+
patch?: never;
|
|
7648
|
+
trace?: never;
|
|
7649
|
+
};
|
|
7572
7650
|
"/internal/devicekey": {
|
|
7573
7651
|
parameters: {
|
|
7574
7652
|
query?: never;
|
|
@@ -7608,6 +7686,45 @@ export interface paths {
|
|
|
7608
7686
|
patch?: never;
|
|
7609
7687
|
trace?: never;
|
|
7610
7688
|
};
|
|
7689
|
+
"/internal/devicemediaref": {
|
|
7690
|
+
parameters: {
|
|
7691
|
+
query?: never;
|
|
7692
|
+
header?: never;
|
|
7693
|
+
path?: never;
|
|
7694
|
+
cookie?: never;
|
|
7695
|
+
};
|
|
7696
|
+
/**
|
|
7697
|
+
* Get DeviceMediaRef (schema generation only)
|
|
7698
|
+
* @description Internal endpoint used only to ensure DeviceMediaRef schema is generated in OpenAPI spec
|
|
7699
|
+
*/
|
|
7700
|
+
get: {
|
|
7701
|
+
parameters: {
|
|
7702
|
+
query?: never;
|
|
7703
|
+
header?: never;
|
|
7704
|
+
path?: never;
|
|
7705
|
+
cookie?: never;
|
|
7706
|
+
};
|
|
7707
|
+
requestBody?: never;
|
|
7708
|
+
responses: {
|
|
7709
|
+
/** @description OK */
|
|
7710
|
+
200: {
|
|
7711
|
+
headers: {
|
|
7712
|
+
[name: string]: unknown;
|
|
7713
|
+
};
|
|
7714
|
+
content: {
|
|
7715
|
+
"application/json": components["schemas"]["models.DeviceMediaRef"];
|
|
7716
|
+
};
|
|
7717
|
+
};
|
|
7718
|
+
};
|
|
7719
|
+
};
|
|
7720
|
+
put?: never;
|
|
7721
|
+
post?: never;
|
|
7722
|
+
delete?: never;
|
|
7723
|
+
options?: never;
|
|
7724
|
+
head?: never;
|
|
7725
|
+
patch?: never;
|
|
7726
|
+
trace?: never;
|
|
7727
|
+
};
|
|
7611
7728
|
"/internal/devicemetadata": {
|
|
7612
7729
|
parameters: {
|
|
7613
7730
|
query?: never;
|
|
@@ -7647,6 +7764,45 @@ export interface paths {
|
|
|
7647
7764
|
patch?: never;
|
|
7648
7765
|
trace?: never;
|
|
7649
7766
|
};
|
|
7767
|
+
"/internal/devicemonitor": {
|
|
7768
|
+
parameters: {
|
|
7769
|
+
query?: never;
|
|
7770
|
+
header?: never;
|
|
7771
|
+
path?: never;
|
|
7772
|
+
cookie?: never;
|
|
7773
|
+
};
|
|
7774
|
+
/**
|
|
7775
|
+
* Get DeviceMonitor (schema generation only)
|
|
7776
|
+
* @description Internal endpoint used only to ensure DeviceMonitor schema is generated in OpenAPI spec
|
|
7777
|
+
*/
|
|
7778
|
+
get: {
|
|
7779
|
+
parameters: {
|
|
7780
|
+
query?: never;
|
|
7781
|
+
header?: never;
|
|
7782
|
+
path?: never;
|
|
7783
|
+
cookie?: never;
|
|
7784
|
+
};
|
|
7785
|
+
requestBody?: never;
|
|
7786
|
+
responses: {
|
|
7787
|
+
/** @description OK */
|
|
7788
|
+
200: {
|
|
7789
|
+
headers: {
|
|
7790
|
+
[name: string]: unknown;
|
|
7791
|
+
};
|
|
7792
|
+
content: {
|
|
7793
|
+
"application/json": components["schemas"]["models.DeviceMonitor"];
|
|
7794
|
+
};
|
|
7795
|
+
};
|
|
7796
|
+
};
|
|
7797
|
+
};
|
|
7798
|
+
put?: never;
|
|
7799
|
+
post?: never;
|
|
7800
|
+
delete?: never;
|
|
7801
|
+
options?: never;
|
|
7802
|
+
head?: never;
|
|
7803
|
+
patch?: never;
|
|
7804
|
+
trace?: never;
|
|
7805
|
+
};
|
|
7650
7806
|
"/internal/deviceoption": {
|
|
7651
7807
|
parameters: {
|
|
7652
7808
|
query?: never;
|
|
@@ -7803,6 +7959,45 @@ export interface paths {
|
|
|
7803
7959
|
patch?: never;
|
|
7804
7960
|
trace?: never;
|
|
7805
7961
|
};
|
|
7962
|
+
"/internal/devicethresholds": {
|
|
7963
|
+
parameters: {
|
|
7964
|
+
query?: never;
|
|
7965
|
+
header?: never;
|
|
7966
|
+
path?: never;
|
|
7967
|
+
cookie?: never;
|
|
7968
|
+
};
|
|
7969
|
+
/**
|
|
7970
|
+
* Get DeviceThresholds (schema generation only)
|
|
7971
|
+
* @description Internal endpoint used only to ensure DeviceThresholds schema is generated in OpenAPI spec
|
|
7972
|
+
*/
|
|
7973
|
+
get: {
|
|
7974
|
+
parameters: {
|
|
7975
|
+
query?: never;
|
|
7976
|
+
header?: never;
|
|
7977
|
+
path?: never;
|
|
7978
|
+
cookie?: never;
|
|
7979
|
+
};
|
|
7980
|
+
requestBody?: never;
|
|
7981
|
+
responses: {
|
|
7982
|
+
/** @description OK */
|
|
7983
|
+
200: {
|
|
7984
|
+
headers: {
|
|
7985
|
+
[name: string]: unknown;
|
|
7986
|
+
};
|
|
7987
|
+
content: {
|
|
7988
|
+
"application/json": components["schemas"]["models.DeviceThresholds"];
|
|
7989
|
+
};
|
|
7990
|
+
};
|
|
7991
|
+
};
|
|
7992
|
+
};
|
|
7993
|
+
put?: never;
|
|
7994
|
+
post?: never;
|
|
7995
|
+
delete?: never;
|
|
7996
|
+
options?: never;
|
|
7997
|
+
head?: never;
|
|
7998
|
+
patch?: never;
|
|
7999
|
+
trace?: never;
|
|
8000
|
+
};
|
|
7806
8001
|
"/internal/devicevlmmetadata": {
|
|
7807
8002
|
parameters: {
|
|
7808
8003
|
query?: never;
|
|
@@ -18489,6 +18684,45 @@ export interface paths {
|
|
|
18489
18684
|
patch?: never;
|
|
18490
18685
|
trace?: never;
|
|
18491
18686
|
};
|
|
18687
|
+
"/internal/gpsfix": {
|
|
18688
|
+
parameters: {
|
|
18689
|
+
query?: never;
|
|
18690
|
+
header?: never;
|
|
18691
|
+
path?: never;
|
|
18692
|
+
cookie?: never;
|
|
18693
|
+
};
|
|
18694
|
+
/**
|
|
18695
|
+
* Get GPSFix (schema generation only)
|
|
18696
|
+
* @description Internal endpoint used only to ensure GPSFix schema is generated in OpenAPI spec
|
|
18697
|
+
*/
|
|
18698
|
+
get: {
|
|
18699
|
+
parameters: {
|
|
18700
|
+
query?: never;
|
|
18701
|
+
header?: never;
|
|
18702
|
+
path?: never;
|
|
18703
|
+
cookie?: never;
|
|
18704
|
+
};
|
|
18705
|
+
requestBody?: never;
|
|
18706
|
+
responses: {
|
|
18707
|
+
/** @description OK */
|
|
18708
|
+
200: {
|
|
18709
|
+
headers: {
|
|
18710
|
+
[name: string]: unknown;
|
|
18711
|
+
};
|
|
18712
|
+
content: {
|
|
18713
|
+
"application/json": components["schemas"]["models.GPSFix"];
|
|
18714
|
+
};
|
|
18715
|
+
};
|
|
18716
|
+
};
|
|
18717
|
+
};
|
|
18718
|
+
put?: never;
|
|
18719
|
+
post?: never;
|
|
18720
|
+
delete?: never;
|
|
18721
|
+
options?: never;
|
|
18722
|
+
head?: never;
|
|
18723
|
+
patch?: never;
|
|
18724
|
+
trace?: never;
|
|
18725
|
+
};
|
|
18492
18726
|
"/internal/gpsmetadata": {
|
|
18493
18727
|
parameters: {
|
|
18494
18728
|
query?: never;
|
|
@@ -36894,7 +37128,7 @@ export interface components {
|
|
|
36894
37128
|
userId?: string;
|
|
36895
37129
|
};
|
|
36896
37130
|
/** @enum {string} */
|
|
36897
|
-
"models.AccessTokenScope": "
|
|
37131
|
+
"models.AccessTokenScope": "application" | "markers.read" | "markers.write" | "markers.all" | "days.read" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete";
|
|
36898
37132
|
"models.Account": {
|
|
36899
37133
|
account?: components["schemas"]["models.AccountBody"];
|
|
36900
37134
|
};
|
|
@@ -37212,33 +37446,30 @@ export interface components {
|
|
|
37212
37446
|
/** @enum {string} */
|
|
37213
37447
|
"models.BaseRole": "guest" | "editor" | "admin" | "owner" | "application";
|
|
37214
37448
|
"models.CameraMetadata": {
|
|
37215
|
-
/** @description
|
|
37449
|
+
/** @description kbps */
|
|
37216
37450
|
bitrate?: number;
|
|
37217
|
-
/** @description e.g. "H.264"
|
|
37451
|
+
/** @description e.g. "H.264" */
|
|
37218
37452
|
codec?: string;
|
|
37453
|
+
/** @description State, reported by the agent */
|
|
37454
|
+
connected?: boolean;
|
|
37455
|
+
continuousRecording?: boolean;
|
|
37456
|
+
/** @description Saved configuration, edited by users */
|
|
37219
37457
|
fieldOfView?: number;
|
|
37220
|
-
/** @description
|
|
37458
|
+
/** @description fps */
|
|
37221
37459
|
frameRate?: number;
|
|
37222
|
-
/** @description Indicates if the camera supports audio */
|
|
37223
37460
|
hasAudio?: boolean;
|
|
37224
|
-
/** @description Indicates if the camera supports backchannel audio */
|
|
37225
37461
|
hasBackChannel?: boolean;
|
|
37226
|
-
/** @description
|
|
37227
|
-
hasIO?: boolean;
|
|
37228
|
-
/** @description Camera ONVIF and PTZ capabilities */
|
|
37462
|
+
/** @description Capabilities, reported by the agent */
|
|
37229
37463
|
hasOnvif?: boolean;
|
|
37230
|
-
/** @description Indicates if the camera supports pan and tilt functionality */
|
|
37231
37464
|
hasPanTilt?: boolean;
|
|
37232
|
-
/** @description Indicates if the camera supports presets */
|
|
37233
|
-
hasPresets?: boolean;
|
|
37234
|
-
/** @description Indicates if the camera supports zoom functionality */
|
|
37235
37465
|
hasZoom?: boolean;
|
|
37466
|
+
/** @description Digital inputs and relay outputs (agent) */
|
|
37236
37467
|
ios?: components["schemas"]["models.IO"][];
|
|
37237
|
-
/** @description Presets
|
|
37468
|
+
/** @description Presets stored on the camera (agent) */
|
|
37469
|
+
onvifPresets?: components["schemas"]["models.CameraPreset"][];
|
|
37238
37470
|
presets?: components["schemas"]["models.CameraPreset"][];
|
|
37239
|
-
/** @description
|
|
37471
|
+
/** @description Stream, reported by the agent */
|
|
37240
37472
|
resolution?: string;
|
|
37241
|
-
/** @description Tours for the camera, used for automated movements through presets */
|
|
37242
37473
|
tours?: components["schemas"]["models.CameraTour"][];
|
|
37243
37474
|
};
|
|
37244
37475
|
"models.CameraPreset": {
|
|
@@ -37954,138 +38185,179 @@ export interface components {
|
|
|
37954
38185
|
timeRange2Min?: number;
|
|
37955
38186
|
};
|
|
37956
38187
|
"models.Device": {
|
|
37957
|
-
|
|
38188
|
+
agent?: components["schemas"]["models.DeviceAgent"];
|
|
38189
|
+
/** @description Liveness: the inputs the connection status is derived from, kept together.
|
|
38190
|
+
* Timestamps are points in time on the hub's clock (milliseconds since
|
|
38191
|
+
* epoch), written by every heartbeat; readers derive durations and status. */
|
|
37958
38192
|
agentLastSeen?: number;
|
|
37959
|
-
/** @description Deprecated - to be removed */
|
|
37960
38193
|
analytics?: components["schemas"]["models.DeprecatedHeartbeat"][];
|
|
37961
|
-
/** @description AtRuntimeMetadata
|
|
37962
|
-
* more verbose information about the device's current state, capabilities, or configuration.
|
|
37963
|
-
* for example the linked sites details, etc. */
|
|
38194
|
+
/** @description AtRuntimeMetadata is computed when the device is read and never stored. */
|
|
37964
38195
|
atRuntimeMetadata?: components["schemas"]["models.DeviceAtRuntimeMetadata"];
|
|
37965
|
-
/** @description
|
|
38196
|
+
/** @description Provisioning sets CreatedAt (first heartbeat) */
|
|
37966
38197
|
audit?: components["schemas"]["models.Audit"];
|
|
37967
|
-
/** @description
|
|
37968
|
-
|
|
37969
|
-
|
|
37970
|
-
*
|
|
37971
|
-
|
|
37972
|
-
|
|
37973
|
-
/** @description Type of deployment used e.g. "factory", "docker", "docker compose", "kubernetes" */
|
|
37974
|
-
deployment?: string;
|
|
37975
|
-
/** @description last time the device itself reported being online (timestamp in milliseconds) */
|
|
38198
|
+
/** @description Capabilities. Each is optional and any combination is valid, e.g. a camera
|
|
38199
|
+
* with a built-in humidity sensor sets both Camera and HumiditySensor.
|
|
38200
|
+
* Capability sub-documents hold capabilities and configuration only; live
|
|
38201
|
+
* readings go to a time-series collection. */
|
|
38202
|
+
camera?: components["schemas"]["models.CameraMetadata"];
|
|
38203
|
+
/** @description Last heartbeat in which the agent could reach the device itself */
|
|
37976
38204
|
deviceLastSeen?: number;
|
|
37977
|
-
/** @description threshold in milliseconds to consider a device offline, based on agentLastSeen */
|
|
37978
|
-
disconnectedThreshold?: number;
|
|
37979
|
-
/** @description FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc.
|
|
37980
|
-
* It is a map of feature names to permissions.
|
|
37981
|
-
* For example, "camera" can have permissions like "read", "write", "delete", etc.
|
|
37982
|
-
* This allows for fine-grained control over what features are accessible by users or groups.
|
|
37983
|
-
* FeaturePermissions can be used to implement Role-Based Access Control (RBAC) for devices. */
|
|
37984
38205
|
featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
|
|
37985
|
-
|
|
38206
|
+
gps?: components["schemas"]["models.GPSMetadata"];
|
|
37986
38207
|
groupIds?: string[];
|
|
37987
|
-
|
|
37988
|
-
healthyThreshold?: number;
|
|
37989
|
-
humiditySensorMetadata?: components["schemas"]["models.HumiditySensorMetadata"];
|
|
38208
|
+
humiditySensor?: components["schemas"]["models.HumiditySensorMetadata"];
|
|
37990
38209
|
id?: string;
|
|
37991
|
-
/** @description
|
|
37992
|
-
|
|
37993
|
-
/** @description Device
|
|
37994
|
-
* Note: DeviceId is a unique identifier for the device, it can be used to identify the device in the system.
|
|
37995
|
-
* DeviceType is used to identify the type of device, such as camera, sensor, access control, etc. */
|
|
38210
|
+
/** @description No defined meaning; never set true for devices */
|
|
38211
|
+
isActive?: boolean;
|
|
38212
|
+
/** @description Device key reported by the agent, unique within its project */
|
|
37996
38213
|
key?: string;
|
|
37997
|
-
|
|
37998
|
-
|
|
37999
|
-
|
|
38214
|
+
latestMedia?: components["schemas"]["models.DeviceMediaRef"];
|
|
38215
|
+
/** @description Latest media uploaded by the device, from any capability. Kept at the top
|
|
38216
|
+
* level: device lists sort on LatestMediaTimestamp. LatestMedia is a value,
|
|
38217
|
+
* not a pointer, so readers never need a nil check; an empty VideoFile means
|
|
38218
|
+
* the device has no media yet (the media pipeline does not store the Id). */
|
|
38000
38219
|
latestMediaTimestamp?: number;
|
|
38001
|
-
|
|
38002
|
-
/** @description Location
|
|
38220
|
+
lightSensor?: components["schemas"]["models.LightSensorMetadata"];
|
|
38221
|
+
/** @description Location is the fixed placement owners set (DevicePatch), e.g. an
|
|
38222
|
+
* address picked on a map. It is not a real-time position. */
|
|
38003
38223
|
location?: components["schemas"]["models.Location"];
|
|
38004
|
-
/** @description Metadata */
|
|
38005
38224
|
metadata?: components["schemas"]["models.DeviceMetadata"];
|
|
38006
|
-
/** @description
|
|
38225
|
+
/** @description Last notified state, owned by hub-monitor-device */
|
|
38226
|
+
monitor?: components["schemas"]["models.DeviceMonitor"];
|
|
38227
|
+
/** @description Lifecycle */
|
|
38228
|
+
mute?: number;
|
|
38229
|
+
/** @description Set by users or at provisioning; display falls back to Agent.CameraName */
|
|
38007
38230
|
name?: string;
|
|
38008
|
-
/** @description
|
|
38009
|
-
*
|
|
38010
|
-
* GroupId is used to identify the group of devices.
|
|
38011
|
-
* OrganisationId is used to identify the organisation that owns the device.
|
|
38012
|
-
* FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc. */
|
|
38231
|
+
/** @description Tenancy. Heartbeat credentials live on the project: the cloud key resolves
|
|
38232
|
+
* to an organisation and project, which must match these fields. */
|
|
38013
38233
|
organisationId?: string;
|
|
38014
|
-
/** @description
|
|
38015
|
-
* A nil or zero legacy value resolves to that organisation's default project;
|
|
38016
|
-
* it does not make the device organisation-wide. */
|
|
38234
|
+
/** @description nil or zero resolves to the organisation's default project */
|
|
38017
38235
|
projectId?: string;
|
|
38018
|
-
|
|
38019
|
-
* Note: Version is used to identify the version of the device software.
|
|
38020
|
-
* ReleaseHash is used to identify the release hash of the device software, it can be used to identify the specific build of the device software.
|
|
38021
|
-
* Deployment is used to identify the deployment type of the device, such as factory, docker, docker compose, kubernetes, etc. */
|
|
38022
|
-
repository?: string;
|
|
38236
|
+
schemaVersion?: number;
|
|
38023
38237
|
siteIds?: string[];
|
|
38024
|
-
|
|
38025
|
-
|
|
38026
|
-
/** @description @LEGACY FIELDS - to be removed in future versions */
|
|
38238
|
+
type?: components["schemas"]["models.DeviceType"];
|
|
38239
|
+
/** @description @LEGACY - removed once all readers use the fields above. */
|
|
38027
38240
|
user_id?: string;
|
|
38028
|
-
|
|
38241
|
+
};
|
|
38242
|
+
"models.DeviceAgent": {
|
|
38243
|
+
architecture?: string;
|
|
38244
|
+
bootTime?: number;
|
|
38245
|
+
/** @description Name configured on the agent */
|
|
38246
|
+
cameraName?: string;
|
|
38247
|
+
/** @description CloudPublicKey is the public key the agent presented in its last
|
|
38248
|
+
* heartbeat. Agents within a project can be on different keys (e.g. a
|
|
38249
|
+
* legacy user key after the project credentials were regenerated), so it
|
|
38250
|
+
* is recorded per device for routing and key status. Authentication still
|
|
38251
|
+
* resolves key -> project; private and symmetric keys never live on the
|
|
38252
|
+
* device. */
|
|
38253
|
+
cloudPublicKey?: string;
|
|
38254
|
+
/** @description Deployment is how the agent runs: "factory", "kubernetes", "docker",
|
|
38255
|
+
* "kios" or "raspberrypi". It replaces the agent's legacy enterprise flag,
|
|
38256
|
+
* which only meant running under Kerberos Factory or Kubernetes. */
|
|
38257
|
+
deployment?: string;
|
|
38258
|
+
e2eEncryption?: boolean;
|
|
38259
|
+
hostname?: string;
|
|
38260
|
+
hubEncryption?: boolean;
|
|
38261
|
+
ipAddresses?: string[];
|
|
38262
|
+
macAddresses?: string[];
|
|
38263
|
+
/** @description bytes */
|
|
38264
|
+
memoryFree?: number;
|
|
38265
|
+
/** @description bytes */
|
|
38266
|
+
memoryProcess?: number;
|
|
38267
|
+
/** @description bytes */
|
|
38268
|
+
memoryTotal?: number;
|
|
38269
|
+
/** @description bytes */
|
|
38270
|
+
memoryUsed?: number;
|
|
38271
|
+
/** @description Build hash of the agent */
|
|
38272
|
+
releaseHash?: string;
|
|
38273
|
+
repository?: string;
|
|
38274
|
+
/** @description StartedAt (agent process start) and BootTime (host boot) are points in
|
|
38275
|
+
* time on the hub's clock (milliseconds since epoch), displayed as agent and
|
|
38276
|
+
* host uptime (now - StartedAt, now - BootTime). Durations are never
|
|
38277
|
+
* stored: they are stale as soon as they are written. Agents report both as
|
|
38278
|
+
* human-readable durations ("10 hours"), so the hub derives them on a
|
|
38279
|
+
* detected restart or reboot; they are approximate until the next one. */
|
|
38280
|
+
startedAt?: number;
|
|
38281
|
+
/** @description Release tag of the agent */
|
|
38029
38282
|
version?: string;
|
|
38030
38283
|
};
|
|
38031
38284
|
"models.DeviceAtRuntimeMetadata": {
|
|
38032
|
-
|
|
38285
|
+
capabilities?: components["schemas"]["models.DeviceCapability"][];
|
|
38033
38286
|
groups?: components["schemas"]["models.GroupOption"][];
|
|
38034
|
-
/** @description Sites contains details about the sites that the device is linked to. */
|
|
38035
38287
|
sites?: components["schemas"]["models.SiteOption"][];
|
|
38036
|
-
|
|
38037
|
-
status?: string;
|
|
38288
|
+
status?: components["schemas"]["models.DeviceConnectionStatus"];
|
|
38038
38289
|
};
|
|
38290
|
+
/** @enum {string} */
|
|
38291
|
+
"models.DeviceCapability": "camera" | "lightSensor" | "humiditySensor" | "gps";
|
|
38292
|
+
/** @enum {string} */
|
|
38293
|
+
"models.DeviceConnectionStatus": "connected" | "idle" | "disconnected";
|
|
38039
38294
|
"models.DeviceData": {
|
|
38040
38295
|
activeDevices?: number;
|
|
38041
38296
|
totalDevices?: number;
|
|
38042
38297
|
};
|
|
38043
38298
|
"models.DeviceFeaturePermissions": {
|
|
38299
|
+
downloadRecordings?: components["schemas"]["models.PermissionLevel"];
|
|
38044
38300
|
floorPlans?: components["schemas"]["models.PermissionLevel"];
|
|
38045
38301
|
io?: components["schemas"]["models.PermissionLevel"];
|
|
38046
38302
|
liveview?: components["schemas"]["models.PermissionLevel"];
|
|
38047
38303
|
ptz?: components["schemas"]["models.PermissionLevel"];
|
|
38048
38304
|
remoteConfig?: components["schemas"]["models.PermissionLevel"];
|
|
38049
38305
|
};
|
|
38306
|
+
"models.DeviceHeartbeat": {
|
|
38307
|
+
/** @description Agent holds the agent-reported fields. StartedAt and BootTime are only
|
|
38308
|
+
* set when the receiver detected a restart or reboot; 0 keeps the stored
|
|
38309
|
+
* value. */
|
|
38310
|
+
agent?: components["schemas"]["models.DeviceAgent"];
|
|
38311
|
+
/** @description Camera holds the agent-reported camera fields; the user-owned ones
|
|
38312
|
+
* (FieldOfView, Presets, Tours) are ignored. Nil for devices without the
|
|
38313
|
+
* camera capability. */
|
|
38314
|
+
camera?: components["schemas"]["models.CameraMetadata"];
|
|
38315
|
+
/** @description ReceivedAt is when the hub received the heartbeat, on the hub's clock
|
|
38316
|
+
* (milliseconds since epoch). Agent clocks are not trusted. */
|
|
38317
|
+
receivedAt?: number;
|
|
38318
|
+
/** @description Type is the device's primary kind as known to the agent; empty keeps the
|
|
38319
|
+
* stored type. */
|
|
38320
|
+
type?: components["schemas"]["models.DeviceType"];
|
|
38321
|
+
};
|
|
38050
38322
|
"models.DeviceKey": {
|
|
38051
38323
|
key?: string;
|
|
38052
38324
|
name?: string;
|
|
38053
38325
|
};
|
|
38326
|
+
"models.DeviceMediaRef": {
|
|
38327
|
+
/** @description AtRuntimeMetadata carries the signed URLs and display time filled when
|
|
38328
|
+
* the device is read; never stored. */
|
|
38329
|
+
atRuntimeMetadata?: components["schemas"]["models.MediaAtRuntimeMetadata"];
|
|
38330
|
+
duration?: number;
|
|
38331
|
+
id?: string;
|
|
38332
|
+
spriteFile?: string;
|
|
38333
|
+
spriteProvider?: string;
|
|
38334
|
+
storageSolution?: string;
|
|
38335
|
+
thumbnailFile?: string;
|
|
38336
|
+
thumbnailProvider?: string;
|
|
38337
|
+
videoFile?: string;
|
|
38338
|
+
videoProvider?: string;
|
|
38339
|
+
};
|
|
38054
38340
|
"models.DeviceMetadata": {
|
|
38055
|
-
architecture?: string;
|
|
38056
|
-
bootTime?: string;
|
|
38057
|
-
/** @description e.g. "Nest", "Ring" */
|
|
38058
38341
|
brand?: string;
|
|
38059
|
-
/** @description e.g. "#FF5733"
|
|
38342
|
+
/** @description hex, e.g. "#FF5733" */
|
|
38060
38343
|
color?: string;
|
|
38061
|
-
/** @description e.g. "Outdoor camera with night vision" */
|
|
38062
38344
|
description?: string;
|
|
38063
|
-
e2eEncryption?: string;
|
|
38064
|
-
encrypted?: boolean;
|
|
38065
|
-
encryptedData?: number[];
|
|
38066
|
-
freeMemory?: string;
|
|
38067
|
-
/** @description Indicates if the device is hidden from UI */
|
|
38068
38345
|
hidden?: boolean;
|
|
38069
|
-
|
|
38070
|
-
hubEncryption?: string;
|
|
38071
|
-
/** @description Installation date in milliseconds since epoch */
|
|
38346
|
+
/** @description milliseconds since epoch */
|
|
38072
38347
|
installationDate?: number;
|
|
38073
|
-
/** @description
|
|
38074
|
-
ipAddress?: string;
|
|
38075
|
-
/** @description Last maintenance date in milliseconds since epoch */
|
|
38348
|
+
/** @description milliseconds since epoch */
|
|
38076
38349
|
lastMaintenance?: number;
|
|
38077
|
-
/** @description e.g. "00:1A:2B:3C:4D:5E" */
|
|
38078
|
-
macAddress?: string;
|
|
38079
|
-
/** @description e.g. "Nest Cam", "Ring Doorbell" */
|
|
38080
38350
|
model?: string;
|
|
38081
|
-
/** @description Floor plans this device is associated with */
|
|
38082
38351
|
onFloorPlans?: string[];
|
|
38083
|
-
processMemory?: string;
|
|
38084
|
-
totalMemory?: string;
|
|
38085
|
-
usedMemory?: string;
|
|
38086
38352
|
/** @description VLM holds the stable ("normal") scenes used as context for VLM analysis. */
|
|
38087
38353
|
vlm?: components["schemas"]["models.DeviceVLMMetadata"];
|
|
38088
38354
|
};
|
|
38355
|
+
"models.DeviceMonitor": {
|
|
38356
|
+
/** @description milliseconds since epoch */
|
|
38357
|
+
changedAt?: number;
|
|
38358
|
+
/** @description "active" or "inactive" */
|
|
38359
|
+
status?: string;
|
|
38360
|
+
};
|
|
38089
38361
|
"models.DeviceOption": {
|
|
38090
38362
|
id?: string;
|
|
38091
38363
|
text?: string;
|
|
@@ -38097,8 +38369,11 @@ export interface components {
|
|
|
38097
38369
|
description?: string;
|
|
38098
38370
|
featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
|
|
38099
38371
|
fieldOfView?: number;
|
|
38372
|
+
hidden?: boolean;
|
|
38100
38373
|
installationDate?: string;
|
|
38101
38374
|
lastMaintenance?: string;
|
|
38375
|
+
/** @description Replaces the whole location */
|
|
38376
|
+
location?: components["schemas"]["models.Location"];
|
|
38102
38377
|
model?: string;
|
|
38103
38378
|
name?: string;
|
|
38104
38379
|
onFloorPlans?: string[];
|
|
@@ -38133,6 +38408,12 @@ export interface components {
|
|
|
38133
38408
|
/** @description Absolute Y coordinate */
|
|
38134
38409
|
y?: number;
|
|
38135
38410
|
};
|
|
38411
|
+
"models.DeviceThresholds": {
|
|
38412
|
+
disconnected?: number;
|
|
38413
|
+
idle?: number;
|
|
38414
|
+
};
|
|
38415
|
+
/** @enum {string} */
|
|
38416
|
+
"models.DeviceType": "camera" | "sensor" | "access_control" | "gateway";
|
|
38136
38417
|
"models.DeviceVLMMetadata": {
|
|
38137
38418
|
schemaVersion?: number;
|
|
38138
38419
|
stableStates?: components["schemas"]["models.VLMStableState"][];
|
|
@@ -38278,22 +38559,21 @@ export interface components {
|
|
|
38278
38559
|
range?: string;
|
|
38279
38560
|
time?: string;
|
|
38280
38561
|
};
|
|
38281
|
-
"models.
|
|
38282
|
-
/** @description Accuracy is the accuracy of the GPS reading in meters. */
|
|
38283
|
-
accuracy?: number;
|
|
38284
|
-
/** @description Altitude is the current altitude of the device in meters. */
|
|
38285
|
-
altitude?: number;
|
|
38286
|
-
/** @description Heading is the direction of movement in degrees. */
|
|
38287
|
-
heading?: number;
|
|
38288
|
-
/** @description Latitude is the current latitude of the device. */
|
|
38562
|
+
"models.GPSFix": {
|
|
38289
38563
|
latitude?: number;
|
|
38290
|
-
/** @description Longitude is the current longitude of the device. */
|
|
38291
38564
|
longitude?: number;
|
|
38292
|
-
/** @description
|
|
38293
|
-
speed?: number;
|
|
38294
|
-
/** @description Timestamp is the time when the GPS data was recorded (milliseconds since epoch). */
|
|
38565
|
+
/** @description milliseconds since epoch */
|
|
38295
38566
|
timestamp?: number;
|
|
38296
38567
|
};
|
|
38568
|
+
"models.GPSMetadata": {
|
|
38569
|
+
/** @description Rated accuracy in meters */
|
|
38570
|
+
accuracy?: number;
|
|
38571
|
+
/** @description LastFix is a single overwritten snapshot so lists can show a position
|
|
38572
|
+
* without querying the time series. */
|
|
38573
|
+
lastFix?: components["schemas"]["models.GPSFix"];
|
|
38574
|
+
/** @description Fix rate */
|
|
38575
|
+
updateHz?: number;
|
|
38576
|
+
};
|
|
38297
38577
|
"models.GetAlertsInput": {
|
|
38298
38578
|
user?: components["schemas"]["models.User"];
|
|
38299
38579
|
};
|
|
@@ -38496,14 +38776,9 @@ export interface components {
|
|
|
38496
38776
|
region?: string;
|
|
38497
38777
|
};
|
|
38498
38778
|
"models.HumiditySensorMetadata": {
|
|
38499
|
-
|
|
38500
|
-
|
|
38501
|
-
|
|
38502
|
-
humidityRange?: string;
|
|
38503
|
-
/** @description Sensitivity indicates the sensitivity level of the humidity sensor (e.g. 1-100) */
|
|
38504
|
-
sensitivity?: number;
|
|
38505
|
-
/** @description Unit is the measurement unit, typically "%" */
|
|
38506
|
-
unit?: string;
|
|
38779
|
+
maxHumidity?: number;
|
|
38780
|
+
/** @description Measurable range, percent */
|
|
38781
|
+
minHumidity?: number;
|
|
38507
38782
|
};
|
|
38508
38783
|
"models.IO": {
|
|
38509
38784
|
/** @description Audit information */
|
|
@@ -38555,14 +38830,9 @@ export interface components {
|
|
|
38555
38830
|
label?: components["schemas"]["models.Label"];
|
|
38556
38831
|
};
|
|
38557
38832
|
"models.LightSensorMetadata": {
|
|
38558
|
-
|
|
38559
|
-
|
|
38560
|
-
|
|
38561
|
-
luxRange?: string;
|
|
38562
|
-
/** @description Sensitivity indicates the sensitivity level of the light sensor (e.g. 1-100) */
|
|
38563
|
-
sensitivity?: number;
|
|
38564
|
-
/** @description Unit is the measurement unit, typically "lux" */
|
|
38565
|
-
unit?: string;
|
|
38833
|
+
maxLux?: number;
|
|
38834
|
+
/** @description Measurable range */
|
|
38835
|
+
minLux?: number;
|
|
38566
38836
|
};
|
|
38567
38837
|
"models.Livestream": {
|
|
38568
38838
|
speech?: boolean;
|
|
@@ -39350,7 +39620,7 @@ export interface components {
|
|
|
39350
39620
|
videowall?: components["schemas"]["models.Videowall"];
|
|
39351
39621
|
};
|
|
39352
39622
|
/** @enum {string} */
|
|
39353
|
-
"models.Permission": "
|
|
39623
|
+
"models.Permission": "application" | "markers.read" | "markers.write" | "markers.all" | "days.read" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete";
|
|
39354
39624
|
/** @enum {integer} */
|
|
39355
39625
|
"models.PermissionLevel": 1 | 2 | 3 | 4 | 2 | 3 | 4 | 5 | 2 | 3 | 2 | 2 | 3 | 2 | 3 | 4;
|
|
39356
39626
|
"models.Permissions": {
|
|
@@ -41384,14 +41654,19 @@ export declare namespace models {
|
|
|
41384
41654
|
type DetectionSource = components['schemas']['models.DetectionSource'];
|
|
41385
41655
|
type Detections = components['schemas']['models.Detections'];
|
|
41386
41656
|
type Device = components['schemas']['models.Device'];
|
|
41657
|
+
type DeviceAgent = components['schemas']['models.DeviceAgent'];
|
|
41387
41658
|
type DeviceAtRuntimeMetadata = components['schemas']['models.DeviceAtRuntimeMetadata'];
|
|
41388
41659
|
type DeviceData = components['schemas']['models.DeviceData'];
|
|
41389
41660
|
type DeviceFeaturePermissions = components['schemas']['models.DeviceFeaturePermissions'];
|
|
41661
|
+
type DeviceHeartbeat = components['schemas']['models.DeviceHeartbeat'];
|
|
41390
41662
|
type DeviceKey = components['schemas']['models.DeviceKey'];
|
|
41663
|
+
type DeviceMediaRef = components['schemas']['models.DeviceMediaRef'];
|
|
41391
41664
|
type DeviceMetadata = components['schemas']['models.DeviceMetadata'];
|
|
41665
|
+
type DeviceMonitor = components['schemas']['models.DeviceMonitor'];
|
|
41392
41666
|
type DeviceOption = components['schemas']['models.DeviceOption'];
|
|
41393
41667
|
type DevicePatch = components['schemas']['models.DevicePatch'];
|
|
41394
41668
|
type DevicePlacement = components['schemas']['models.DevicePlacement'];
|
|
41669
|
+
type DeviceThresholds = components['schemas']['models.DeviceThresholds'];
|
|
41395
41670
|
type DeviceVLMMetadata = components['schemas']['models.DeviceVLMMetadata'];
|
|
41396
41671
|
type Devices = components['schemas']['models.Devices'];
|
|
41397
41672
|
type DirectionalTimeSeriesChart = components['schemas']['models.DirectionalTimeSeriesChart'];
|
|
@@ -41405,6 +41680,7 @@ export declare namespace models {
|
|
|
41405
41680
|
type FeaturePermissions = components['schemas']['models.FeaturePermissions'];
|
|
41406
41681
|
type FloorPlan = components['schemas']['models.FloorPlan'];
|
|
41407
41682
|
type FragmentedBytesRangeOnTime = components['schemas']['models.FragmentedBytesRangeOnTime'];
|
|
41683
|
+
type GPSFix = components['schemas']['models.GPSFix'];
|
|
41408
41684
|
type GPSMetadata = components['schemas']['models.GPSMetadata'];
|
|
41409
41685
|
type GetAlertsInput = components['schemas']['models.GetAlertsInput'];
|
|
41410
41686
|
type GetAlertsOutput = components['schemas']['models.GetAlertsOutput'];
|