@uug-ai/models 1.7.71 → 1.7.73

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 (2) hide show
  1. package/dist/types.d.ts +613 -128
  2. 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;
@@ -7608,6 +7647,45 @@ export interface paths {
7608
7647
  patch?: never;
7609
7648
  trace?: never;
7610
7649
  };
7650
+ "/internal/devicemediaref": {
7651
+ parameters: {
7652
+ query?: never;
7653
+ header?: never;
7654
+ path?: never;
7655
+ cookie?: never;
7656
+ };
7657
+ /**
7658
+ * Get DeviceMediaRef (schema generation only)
7659
+ * @description Internal endpoint used only to ensure DeviceMediaRef schema is generated in OpenAPI spec
7660
+ */
7661
+ get: {
7662
+ parameters: {
7663
+ query?: never;
7664
+ header?: never;
7665
+ path?: never;
7666
+ cookie?: never;
7667
+ };
7668
+ requestBody?: never;
7669
+ responses: {
7670
+ /** @description OK */
7671
+ 200: {
7672
+ headers: {
7673
+ [name: string]: unknown;
7674
+ };
7675
+ content: {
7676
+ "application/json": components["schemas"]["models.DeviceMediaRef"];
7677
+ };
7678
+ };
7679
+ };
7680
+ };
7681
+ put?: never;
7682
+ post?: never;
7683
+ delete?: never;
7684
+ options?: never;
7685
+ head?: never;
7686
+ patch?: never;
7687
+ trace?: never;
7688
+ };
7611
7689
  "/internal/devicemetadata": {
7612
7690
  parameters: {
7613
7691
  query?: never;
@@ -7803,6 +7881,45 @@ export interface paths {
7803
7881
  patch?: never;
7804
7882
  trace?: never;
7805
7883
  };
7884
+ "/internal/devicethresholds": {
7885
+ parameters: {
7886
+ query?: never;
7887
+ header?: never;
7888
+ path?: never;
7889
+ cookie?: never;
7890
+ };
7891
+ /**
7892
+ * Get DeviceThresholds (schema generation only)
7893
+ * @description Internal endpoint used only to ensure DeviceThresholds schema is generated in OpenAPI spec
7894
+ */
7895
+ get: {
7896
+ parameters: {
7897
+ query?: never;
7898
+ header?: never;
7899
+ path?: never;
7900
+ cookie?: never;
7901
+ };
7902
+ requestBody?: never;
7903
+ responses: {
7904
+ /** @description OK */
7905
+ 200: {
7906
+ headers: {
7907
+ [name: string]: unknown;
7908
+ };
7909
+ content: {
7910
+ "application/json": components["schemas"]["models.DeviceThresholds"];
7911
+ };
7912
+ };
7913
+ };
7914
+ };
7915
+ put?: never;
7916
+ post?: never;
7917
+ delete?: never;
7918
+ options?: never;
7919
+ head?: never;
7920
+ patch?: never;
7921
+ trace?: never;
7922
+ };
7806
7923
  "/internal/devicevlmmetadata": {
7807
7924
  parameters: {
7808
7925
  query?: never;
@@ -18489,6 +18606,45 @@ export interface paths {
18489
18606
  patch?: never;
18490
18607
  trace?: never;
18491
18608
  };
18609
+ "/internal/gpsfix": {
18610
+ parameters: {
18611
+ query?: never;
18612
+ header?: never;
18613
+ path?: never;
18614
+ cookie?: never;
18615
+ };
18616
+ /**
18617
+ * Get GPSFix (schema generation only)
18618
+ * @description Internal endpoint used only to ensure GPSFix schema is generated in OpenAPI spec
18619
+ */
18620
+ get: {
18621
+ parameters: {
18622
+ query?: never;
18623
+ header?: never;
18624
+ path?: never;
18625
+ cookie?: never;
18626
+ };
18627
+ requestBody?: never;
18628
+ responses: {
18629
+ /** @description OK */
18630
+ 200: {
18631
+ headers: {
18632
+ [name: string]: unknown;
18633
+ };
18634
+ content: {
18635
+ "application/json": components["schemas"]["models.GPSFix"];
18636
+ };
18637
+ };
18638
+ };
18639
+ };
18640
+ put?: never;
18641
+ post?: never;
18642
+ delete?: never;
18643
+ options?: never;
18644
+ head?: never;
18645
+ patch?: never;
18646
+ trace?: never;
18647
+ };
18492
18648
  "/internal/gpsmetadata": {
18493
18649
  parameters: {
18494
18650
  query?: never;
@@ -30774,6 +30930,240 @@ export interface paths {
30774
30930
  patch?: never;
30775
30931
  trace?: never;
30776
30932
  };
30933
+ "/internal/workflowanprdetection": {
30934
+ parameters: {
30935
+ query?: never;
30936
+ header?: never;
30937
+ path?: never;
30938
+ cookie?: never;
30939
+ };
30940
+ /**
30941
+ * Get WorkflowAnprDetection (schema generation only)
30942
+ * @description Internal endpoint used only to ensure WorkflowAnprDetection schema is generated in OpenAPI spec
30943
+ */
30944
+ get: {
30945
+ parameters: {
30946
+ query?: never;
30947
+ header?: never;
30948
+ path?: never;
30949
+ cookie?: never;
30950
+ };
30951
+ requestBody?: never;
30952
+ responses: {
30953
+ /** @description OK */
30954
+ 200: {
30955
+ headers: {
30956
+ [name: string]: unknown;
30957
+ };
30958
+ content: {
30959
+ "application/json": components["schemas"]["models.WorkflowAnprDetection"];
30960
+ };
30961
+ };
30962
+ };
30963
+ };
30964
+ put?: never;
30965
+ post?: never;
30966
+ delete?: never;
30967
+ options?: never;
30968
+ head?: never;
30969
+ patch?: never;
30970
+ trace?: never;
30971
+ };
30972
+ "/internal/workflowanprmarker": {
30973
+ parameters: {
30974
+ query?: never;
30975
+ header?: never;
30976
+ path?: never;
30977
+ cookie?: never;
30978
+ };
30979
+ /**
30980
+ * Get WorkflowAnprMarker (schema generation only)
30981
+ * @description Internal endpoint used only to ensure WorkflowAnprMarker schema is generated in OpenAPI spec
30982
+ */
30983
+ get: {
30984
+ parameters: {
30985
+ query?: never;
30986
+ header?: never;
30987
+ path?: never;
30988
+ cookie?: never;
30989
+ };
30990
+ requestBody?: never;
30991
+ responses: {
30992
+ /** @description OK */
30993
+ 200: {
30994
+ headers: {
30995
+ [name: string]: unknown;
30996
+ };
30997
+ content: {
30998
+ "application/json": components["schemas"]["models.WorkflowAnprMarker"];
30999
+ };
31000
+ };
31001
+ };
31002
+ };
31003
+ put?: never;
31004
+ post?: never;
31005
+ delete?: never;
31006
+ options?: never;
31007
+ head?: never;
31008
+ patch?: never;
31009
+ trace?: never;
31010
+ };
31011
+ "/internal/workflowanprmarkermetadata": {
31012
+ parameters: {
31013
+ query?: never;
31014
+ header?: never;
31015
+ path?: never;
31016
+ cookie?: never;
31017
+ };
31018
+ /**
31019
+ * Get WorkflowAnprMarkerMetadata (schema generation only)
31020
+ * @description Internal endpoint used only to ensure WorkflowAnprMarkerMetadata schema is generated in OpenAPI spec
31021
+ */
31022
+ get: {
31023
+ parameters: {
31024
+ query?: never;
31025
+ header?: never;
31026
+ path?: never;
31027
+ cookie?: never;
31028
+ };
31029
+ requestBody?: never;
31030
+ responses: {
31031
+ /** @description OK */
31032
+ 200: {
31033
+ headers: {
31034
+ [name: string]: unknown;
31035
+ };
31036
+ content: {
31037
+ "application/json": components["schemas"]["models.WorkflowAnprMarkerMetadata"];
31038
+ };
31039
+ };
31040
+ };
31041
+ };
31042
+ put?: never;
31043
+ post?: never;
31044
+ delete?: never;
31045
+ options?: never;
31046
+ head?: never;
31047
+ patch?: never;
31048
+ trace?: never;
31049
+ };
31050
+ "/internal/workflowanprresult": {
31051
+ parameters: {
31052
+ query?: never;
31053
+ header?: never;
31054
+ path?: never;
31055
+ cookie?: never;
31056
+ };
31057
+ /**
31058
+ * Get WorkflowAnprResult (schema generation only)
31059
+ * @description Internal endpoint used only to ensure WorkflowAnprResult schema is generated in OpenAPI spec
31060
+ */
31061
+ get: {
31062
+ parameters: {
31063
+ query?: never;
31064
+ header?: never;
31065
+ path?: never;
31066
+ cookie?: never;
31067
+ };
31068
+ requestBody?: never;
31069
+ responses: {
31070
+ /** @description OK */
31071
+ 200: {
31072
+ headers: {
31073
+ [name: string]: unknown;
31074
+ };
31075
+ content: {
31076
+ "application/json": components["schemas"]["models.WorkflowAnprResult"];
31077
+ };
31078
+ };
31079
+ };
31080
+ };
31081
+ put?: never;
31082
+ post?: never;
31083
+ delete?: never;
31084
+ options?: never;
31085
+ head?: never;
31086
+ patch?: never;
31087
+ trace?: never;
31088
+ };
31089
+ "/internal/workflowanprtrack": {
31090
+ parameters: {
31091
+ query?: never;
31092
+ header?: never;
31093
+ path?: never;
31094
+ cookie?: never;
31095
+ };
31096
+ /**
31097
+ * Get WorkflowAnprTrack (schema generation only)
31098
+ * @description Internal endpoint used only to ensure WorkflowAnprTrack schema is generated in OpenAPI spec
31099
+ */
31100
+ get: {
31101
+ parameters: {
31102
+ query?: never;
31103
+ header?: never;
31104
+ path?: never;
31105
+ cookie?: never;
31106
+ };
31107
+ requestBody?: never;
31108
+ responses: {
31109
+ /** @description OK */
31110
+ 200: {
31111
+ headers: {
31112
+ [name: string]: unknown;
31113
+ };
31114
+ content: {
31115
+ "application/json": components["schemas"]["models.WorkflowAnprTrack"];
31116
+ };
31117
+ };
31118
+ };
31119
+ };
31120
+ put?: never;
31121
+ post?: never;
31122
+ delete?: never;
31123
+ options?: never;
31124
+ head?: never;
31125
+ patch?: never;
31126
+ trace?: never;
31127
+ };
31128
+ "/internal/workflowanprtrackmeta": {
31129
+ parameters: {
31130
+ query?: never;
31131
+ header?: never;
31132
+ path?: never;
31133
+ cookie?: never;
31134
+ };
31135
+ /**
31136
+ * Get WorkflowAnprTrackMeta (schema generation only)
31137
+ * @description Internal endpoint used only to ensure WorkflowAnprTrackMeta schema is generated in OpenAPI spec
31138
+ */
31139
+ get: {
31140
+ parameters: {
31141
+ query?: never;
31142
+ header?: never;
31143
+ path?: never;
31144
+ cookie?: never;
31145
+ };
31146
+ requestBody?: never;
31147
+ responses: {
31148
+ /** @description OK */
31149
+ 200: {
31150
+ headers: {
31151
+ [name: string]: unknown;
31152
+ };
31153
+ content: {
31154
+ "application/json": components["schemas"]["models.WorkflowAnprTrackMeta"];
31155
+ };
31156
+ };
31157
+ };
31158
+ };
31159
+ put?: never;
31160
+ post?: never;
31161
+ delete?: never;
31162
+ options?: never;
31163
+ head?: never;
31164
+ patch?: never;
31165
+ trace?: never;
31166
+ };
30777
31167
  "/internal/workflowcallback": {
30778
31168
  parameters: {
30779
31169
  query?: never;
@@ -36660,7 +37050,7 @@ export interface components {
36660
37050
  userId?: string;
36661
37051
  };
36662
37052
  /** @enum {string} */
36663
- "models.AccessTokenScope": "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "application" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "markers.read" | "markers.write" | "markers.all" | "days.read";
37053
+ "models.AccessTokenScope": "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "markers.read" | "markers.write" | "markers.all" | "application" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "days.read";
36664
37054
  "models.Account": {
36665
37055
  account?: components["schemas"]["models.AccountBody"];
36666
37056
  };
@@ -36978,33 +37368,30 @@ export interface components {
36978
37368
  /** @enum {string} */
36979
37369
  "models.BaseRole": "guest" | "editor" | "admin" | "owner" | "application";
36980
37370
  "models.CameraMetadata": {
36981
- /** @description Bitrate in kbps */
37371
+ /** @description kbps */
36982
37372
  bitrate?: number;
36983
- /** @description e.g. "H.264", "H.265" */
37373
+ /** @description e.g. "H.264" */
36984
37374
  codec?: string;
37375
+ /** @description State, reported by the agent */
37376
+ connected?: boolean;
37377
+ continuousRecording?: boolean;
37378
+ /** @description Saved configuration, edited by users */
36985
37379
  fieldOfView?: number;
36986
- /** @description Frame rate in fps */
37380
+ /** @description fps */
36987
37381
  frameRate?: number;
36988
- /** @description Indicates if the camera supports audio */
36989
37382
  hasAudio?: boolean;
36990
- /** @description Indicates if the camera supports backchannel audio */
36991
37383
  hasBackChannel?: boolean;
36992
- /** @description Indicates if the camera has input/output capabilities */
36993
- hasIO?: boolean;
36994
- /** @description Camera ONVIF and PTZ capabilities */
37384
+ /** @description Capabilities, reported by the agent */
36995
37385
  hasOnvif?: boolean;
36996
- /** @description Indicates if the camera supports pan and tilt functionality */
36997
37386
  hasPanTilt?: boolean;
36998
- /** @description Indicates if the camera supports presets */
36999
- hasPresets?: boolean;
37000
- /** @description Indicates if the camera supports zoom functionality */
37001
37387
  hasZoom?: boolean;
37388
+ /** @description Digital inputs and relay outputs (agent) */
37002
37389
  ios?: components["schemas"]["models.IO"][];
37003
- /** @description Presets for the camera, used for quick positioning */
37390
+ /** @description Presets stored on the camera (agent) */
37391
+ onvifPresets?: components["schemas"]["models.CameraPreset"][];
37004
37392
  presets?: components["schemas"]["models.CameraPreset"][];
37005
- /** @description e.g. "1920x1080", "1280x720" */
37393
+ /** @description Stream, reported by the agent */
37006
37394
  resolution?: string;
37007
- /** @description Tours for the camera, used for automated movements through presets */
37008
37395
  tours?: components["schemas"]["models.CameraTour"][];
37009
37396
  };
37010
37397
  "models.CameraPreset": {
@@ -37720,88 +38107,96 @@ export interface components {
37720
38107
  timeRange2Min?: number;
37721
38108
  };
37722
38109
  "models.Device": {
37723
- /** @description last time the agent reported being online (timestamp in milliseconds) */
38110
+ agent?: components["schemas"]["models.DeviceAgent"];
38111
+ /** @description Last heartbeat from the agent */
37724
38112
  agentLastSeen?: number;
37725
- /** @description Deprecated - to be removed */
37726
38113
  analytics?: components["schemas"]["models.DeprecatedHeartbeat"][];
37727
- /** @description AtRuntimeMetadata contains metadata that is generated at runtime, which can include
37728
- * more verbose information about the device's current state, capabilities, or configuration.
37729
- * for example the linked sites details, etc. */
38114
+ /** @description AtRuntimeMetadata is computed when the device is read and never stored. */
37730
38115
  atRuntimeMetadata?: components["schemas"]["models.DeviceAtRuntimeMetadata"];
37731
- /** @description Audit information */
37732
38116
  audit?: components["schemas"]["models.Audit"];
37733
- /** @description Device Specific Metadata */
37734
- cameraMetadata?: components["schemas"]["models.CameraMetadata"];
37735
- /** @description Device status
37736
- * Note: Status is used to identify the status of the device, such as online, offline, maintenance, etc."
37737
- * LastSeenTimestamp is used to identify the last time the device was seen online. */
38117
+ /** @description Capabilities. Each is optional and any combination is valid, e.g. a camera
38118
+ * with a built-in humidity sensor sets both Camera and HumiditySensor.
38119
+ * Capability sub-documents hold capabilities and configuration only; live
38120
+ * readings go to a time-series collection. */
38121
+ camera?: components["schemas"]["models.CameraMetadata"];
38122
+ /** @description Liveness (milliseconds since epoch) */
37738
38123
  connectionStart?: number;
37739
- /** @description Type of deployment used e.g. "factory", "docker", "docker compose", "kubernetes" */
37740
- deployment?: string;
37741
- /** @description last time the device itself reported being online (timestamp in milliseconds) */
38124
+ /** @description Last time the agent could reach the device itself */
37742
38125
  deviceLastSeen?: number;
37743
- /** @description threshold in milliseconds to consider a device offline, based on agentLastSeen */
37744
- disconnectedThreshold?: number;
37745
- /** @description FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc.
37746
- * It is a map of feature names to permissions.
37747
- * For example, "camera" can have permissions like "read", "write", "delete", etc.
37748
- * This allows for fine-grained control over what features are accessible by users or groups.
37749
- * FeaturePermissions can be used to implement Role-Based Access Control (RBAC) for devices. */
38126
+ /** @description Licence concept; moves to the organisation */
38127
+ enterprise?: boolean;
37750
38128
  featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
37751
- gpsMetadata?: components["schemas"]["models.GPSMetadata"];
38129
+ gps?: components["schemas"]["models.GPSMetadata"];
37752
38130
  groupIds?: string[];
37753
- /** @description threshold in milliseconds to consider a device healthy, based on agentLastSeen */
37754
- healthyThreshold?: number;
37755
- humiditySensorMetadata?: components["schemas"]["models.HumiditySensorMetadata"];
38131
+ humiditySensor?: components["schemas"]["models.HumiditySensorMetadata"];
37756
38132
  id?: string;
37757
- /** @description threshold in milliseconds to consider a device idle, based on deviceLastSeen */
37758
- idleThreshold?: number;
37759
- /** @description Device information
37760
- * Note: DeviceId is a unique identifier for the device, it can be used to identify the device in the system.
37761
- * DeviceType is used to identify the type of device, such as camera, sensor, access control, etc. */
38133
+ /** @description No defined meaning; never set true for devices */
38134
+ isActive?: boolean;
38135
+ /** @description Device key reported by the agent, unique within its project */
37762
38136
  key?: string;
37763
- /** @description Latest Media information */
37764
- latestMedia?: components["schemas"]["models.Media"];
37765
- /** @description Timestamp of the latest media captured by the device (milliseconds since epoch) */
38137
+ latestMedia?: components["schemas"]["models.DeviceMediaRef"];
38138
+ /** @description Latest media uploaded by the device, from any capability. Kept at the top
38139
+ * level: device lists sort on LatestMediaTimestamp. LatestMedia is a value,
38140
+ * not a pointer, so readers never need a nil check; an empty Id means the
38141
+ * device has no media yet. */
37766
38142
  latestMediaTimestamp?: number;
37767
- lightSensorMetadata?: components["schemas"]["models.LightSensorMetadata"];
37768
- /** @description Location of the device, not real time postion. e.g. "Office 1st Floor", "Lobby", "Kilian's Car", etc. */
38143
+ lightSensor?: components["schemas"]["models.LightSensorMetadata"];
38144
+ /** @description Fixed placement, not a real-time position */
37769
38145
  location?: components["schemas"]["models.Location"];
37770
- /** @description Metadata */
37771
38146
  metadata?: components["schemas"]["models.DeviceMetadata"];
38147
+ /** @description Lifecycle */
38148
+ mute?: number;
37772
38149
  /** @description e.g. "Front Door Camera" */
37773
38150
  name?: string;
37774
- /** @description RBAC information
37775
- * Note: SiteId is used to identify the site where the device is located.
37776
- * GroupId is used to identify the group of devices.
37777
- * OrganisationId is used to identify the organisation that owns the device.
37778
- * FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc. */
38151
+ /** @description Tenancy. Heartbeat credentials live on the project: the cloud key resolves
38152
+ * to an organisation and project, which must match these fields. */
37779
38153
  organisationId?: string;
37780
- /** @description ProjectId places the device in exactly one project within its organisation.
37781
- * A nil or zero legacy value resolves to that organisation's default project;
37782
- * it does not make the device organisation-wide. */
38154
+ /** @description nil or zero resolves to the organisation's default project */
37783
38155
  projectId?: string;
37784
- /** @description Versioning information
37785
- * Note: Version is used to identify the version of the device software.
37786
- * 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.
37787
- * Deployment is used to identify the deployment type of the device, such as factory, docker, docker compose, kubernetes, etc. */
37788
- repository?: string;
38156
+ schemaVersion?: number;
37789
38157
  siteIds?: string[];
37790
- /** @description Type of device e.g. "camera", "sensor", "access_control" */
37791
- type?: string;
37792
- /** @description @LEGACY FIELDS - to be removed in future versions */
38158
+ /** @description Optional override; nil uses project defaults */
38159
+ thresholds?: components["schemas"]["models.DeviceThresholds"];
38160
+ type?: components["schemas"]["models.DeviceType"];
38161
+ /** @description @LEGACY - removed once all readers use the fields above. */
37793
38162
  user_id?: string;
37794
- /** @description Version of the agent, injected on build. Reflects the release tag of the agent. */
38163
+ };
38164
+ "models.DeviceAgent": {
38165
+ architecture?: string;
38166
+ /** @description milliseconds since epoch */
38167
+ bootTime?: number;
38168
+ /** @description e.g. "factory", "docker", "kubernetes" */
38169
+ deployment?: string;
38170
+ e2eEncryption?: boolean;
38171
+ hostname?: string;
38172
+ hubEncryption?: boolean;
38173
+ ipAddresses?: string[];
38174
+ macAddresses?: string[];
38175
+ /** @description bytes */
38176
+ memoryFree?: number;
38177
+ /** @description bytes */
38178
+ memoryProcess?: number;
38179
+ /** @description bytes */
38180
+ memoryTotal?: number;
38181
+ /** @description bytes */
38182
+ memoryUsed?: number;
38183
+ /** @description Build hash of the agent */
38184
+ releaseHash?: string;
38185
+ repository?: string;
38186
+ uptimeSeconds?: number;
38187
+ /** @description Release tag of the agent */
37795
38188
  version?: string;
37796
38189
  };
37797
38190
  "models.DeviceAtRuntimeMetadata": {
37798
- /** @description Groups contains details about the groups that the device is linked to. */
38191
+ capabilities?: components["schemas"]["models.DeviceCapability"][];
37799
38192
  groups?: components["schemas"]["models.GroupOption"][];
37800
- /** @description Sites contains details about the sites that the device is linked to. */
37801
38193
  sites?: components["schemas"]["models.SiteOption"][];
37802
- /** @description Status is derived from the last seen timestamps and thresholds. */
37803
- status?: string;
38194
+ status?: components["schemas"]["models.DeviceConnectionStatus"];
37804
38195
  };
38196
+ /** @enum {string} */
38197
+ "models.DeviceCapability": "camera" | "lightSensor" | "humiditySensor" | "gps";
38198
+ /** @enum {string} */
38199
+ "models.DeviceConnectionStatus": "connected" | "healthy" | "idle" | "disconnected";
37805
38200
  "models.DeviceData": {
37806
38201
  activeDevices?: number;
37807
38202
  totalDevices?: number;
@@ -37817,38 +38212,32 @@ export interface components {
37817
38212
  key?: string;
37818
38213
  name?: string;
37819
38214
  };
38215
+ "models.DeviceMediaRef": {
38216
+ /** @description AtRuntimeMetadata carries the signed URLs and display time filled when
38217
+ * the device is read; never stored. */
38218
+ atRuntimeMetadata?: components["schemas"]["models.MediaAtRuntimeMetadata"];
38219
+ duration?: number;
38220
+ id?: string;
38221
+ spriteFile?: string;
38222
+ spriteProvider?: string;
38223
+ storageSolution?: string;
38224
+ thumbnailFile?: string;
38225
+ thumbnailProvider?: string;
38226
+ videoFile?: string;
38227
+ videoProvider?: string;
38228
+ };
37820
38229
  "models.DeviceMetadata": {
37821
- architecture?: string;
37822
- bootTime?: string;
37823
- /** @description e.g. "Nest", "Ring" */
37824
38230
  brand?: string;
37825
- /** @description e.g. "#FF5733" (hex color code) */
38231
+ /** @description hex, e.g. "#FF5733" */
37826
38232
  color?: string;
37827
- /** @description e.g. "Outdoor camera with night vision" */
37828
38233
  description?: string;
37829
- e2eEncryption?: string;
37830
- encrypted?: boolean;
37831
- encryptedData?: number[];
37832
- freeMemory?: string;
37833
- /** @description Indicates if the device is hidden from UI */
37834
38234
  hidden?: boolean;
37835
- hostname?: string;
37836
- hubEncryption?: string;
37837
- /** @description Installation date in milliseconds since epoch */
38235
+ /** @description milliseconds since epoch */
37838
38236
  installationDate?: number;
37839
- /** @description e.g. "192.168.1.1" */
37840
- ipAddress?: string;
37841
- /** @description Last maintenance date in milliseconds since epoch */
38237
+ /** @description milliseconds since epoch */
37842
38238
  lastMaintenance?: number;
37843
- /** @description e.g. "00:1A:2B:3C:4D:5E" */
37844
- macAddress?: string;
37845
- /** @description e.g. "Nest Cam", "Ring Doorbell" */
37846
38239
  model?: string;
37847
- /** @description Floor plans this device is associated with */
37848
38240
  onFloorPlans?: string[];
37849
- processMemory?: string;
37850
- totalMemory?: string;
37851
- usedMemory?: string;
37852
38241
  /** @description VLM holds the stable ("normal") scenes used as context for VLM analysis. */
37853
38242
  vlm?: components["schemas"]["models.DeviceVLMMetadata"];
37854
38243
  };
@@ -37863,6 +38252,7 @@ export interface components {
37863
38252
  description?: string;
37864
38253
  featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
37865
38254
  fieldOfView?: number;
38255
+ hidden?: boolean;
37866
38256
  installationDate?: string;
37867
38257
  lastMaintenance?: string;
37868
38258
  model?: string;
@@ -37899,6 +38289,13 @@ export interface components {
37899
38289
  /** @description Absolute Y coordinate */
37900
38290
  y?: number;
37901
38291
  };
38292
+ "models.DeviceThresholds": {
38293
+ disconnected?: number;
38294
+ healthy?: number;
38295
+ idle?: number;
38296
+ };
38297
+ /** @enum {string} */
38298
+ "models.DeviceType": "camera" | "sensor" | "access_control" | "gateway";
37902
38299
  "models.DeviceVLMMetadata": {
37903
38300
  schemaVersion?: number;
37904
38301
  stableStates?: components["schemas"]["models.VLMStableState"][];
@@ -38044,22 +38441,21 @@ export interface components {
38044
38441
  range?: string;
38045
38442
  time?: string;
38046
38443
  };
38047
- "models.GPSMetadata": {
38048
- /** @description Accuracy is the accuracy of the GPS reading in meters. */
38049
- accuracy?: number;
38050
- /** @description Altitude is the current altitude of the device in meters. */
38051
- altitude?: number;
38052
- /** @description Heading is the direction of movement in degrees. */
38053
- heading?: number;
38054
- /** @description Latitude is the current latitude of the device. */
38444
+ "models.GPSFix": {
38055
38445
  latitude?: number;
38056
- /** @description Longitude is the current longitude of the device. */
38057
38446
  longitude?: number;
38058
- /** @description Speed is the current speed of the device in meters per second. */
38059
- speed?: number;
38060
- /** @description Timestamp is the time when the GPS data was recorded (milliseconds since epoch). */
38447
+ /** @description milliseconds since epoch */
38061
38448
  timestamp?: number;
38062
38449
  };
38450
+ "models.GPSMetadata": {
38451
+ /** @description Rated accuracy in meters */
38452
+ accuracy?: number;
38453
+ /** @description LastFix is a single overwritten snapshot so lists can show a position
38454
+ * without querying the time series. */
38455
+ lastFix?: components["schemas"]["models.GPSFix"];
38456
+ /** @description Fix rate */
38457
+ updateHz?: number;
38458
+ };
38063
38459
  "models.GetAlertsInput": {
38064
38460
  user?: components["schemas"]["models.User"];
38065
38461
  };
@@ -38262,14 +38658,9 @@ export interface components {
38262
38658
  region?: string;
38263
38659
  };
38264
38660
  "models.HumiditySensorMetadata": {
38265
- /** @description CurrentHumidity is the latest measured humidity level in percentage */
38266
- currentHumidity?: number;
38267
- /** @description HumidityRange specifies the measurable range in percentage (e.g. "0-100") */
38268
- humidityRange?: string;
38269
- /** @description Sensitivity indicates the sensitivity level of the humidity sensor (e.g. 1-100) */
38270
- sensitivity?: number;
38271
- /** @description Unit is the measurement unit, typically "%" */
38272
- unit?: string;
38661
+ maxHumidity?: number;
38662
+ /** @description Measurable range, percent */
38663
+ minHumidity?: number;
38273
38664
  };
38274
38665
  "models.IO": {
38275
38666
  /** @description Audit information */
@@ -38321,14 +38712,9 @@ export interface components {
38321
38712
  label?: components["schemas"]["models.Label"];
38322
38713
  };
38323
38714
  "models.LightSensorMetadata": {
38324
- /** @description CurrentLux is the latest measured light level in lux */
38325
- currentLux?: number;
38326
- /** @description LuxRange specifies the measurable range in lux (e.g. "0-10000") */
38327
- luxRange?: string;
38328
- /** @description Sensitivity indicates the sensitivity level of the light sensor (e.g. 1-100) */
38329
- sensitivity?: number;
38330
- /** @description Unit is the measurement unit, typically "lux" */
38331
- unit?: string;
38715
+ maxLux?: number;
38716
+ /** @description Measurable range */
38717
+ minLux?: number;
38332
38718
  };
38333
38719
  "models.Livestream": {
38334
38720
  speech?: boolean;
@@ -39116,7 +39502,7 @@ export interface components {
39116
39502
  videowall?: components["schemas"]["models.Videowall"];
39117
39503
  };
39118
39504
  /** @enum {string} */
39119
- "models.Permission": "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "application" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "markers.read" | "markers.write" | "markers.all" | "days.read";
39505
+ "models.Permission": "workflow-runs.create" | "workflow-runs.read" | "workflow-runs.update" | "markers.read" | "markers.write" | "markers.all" | "application" | "workflows.read" | "workflows.create" | "workflows.update" | "workflows.delete" | "cases.read" | "cases.create" | "cases.update" | "cases.share" | "cases.export" | "cases.runWorkflow" | "cases.delete" | "media.read" | "media.update" | "media.export" | "media.share" | "media.redact" | "media.delete" | "days.read";
39120
39506
  /** @enum {integer} */
39121
39507
  "models.PermissionLevel": 1 | 2 | 3 | 4 | 2 | 3 | 4 | 5 | 2 | 3 | 2 | 2 | 3 | 2 | 3 | 4;
39122
39508
  "models.Permissions": {
@@ -39485,18 +39871,25 @@ export interface components {
39485
39871
  startMatched?: boolean;
39486
39872
  };
39487
39873
  "models.StageParam": {
39488
- /** @description Default is applied when a node supplies no value for this parameter. */
39874
+ /** @description Default is the value used when a node supplies none. Authoring APIs store
39875
+ * it on the node with ApplyParamDefaults, so what an editor shows is what a
39876
+ * worker receives; workers keep their own deployment defaults for nodes
39877
+ * without a value. */
39489
39878
  default?: unknown;
39490
39879
  description?: string;
39491
39880
  label?: string;
39881
+ maximum?: number;
39882
+ /** @description Minimum and Maximum bound a StageParamNumber value, inclusively. */
39883
+ minimum?: number;
39492
39884
  name?: string;
39493
- /** @description Options enumerates the permitted values when Type is StageParamSelect. */
39885
+ /** @description Options enumerates the permitted values when Type is StageParamSelect or
39886
+ * StageParamMultiSelect. */
39494
39887
  options?: string[];
39495
39888
  required?: boolean;
39496
39889
  type?: components["schemas"]["models.StageParamType"];
39497
39890
  };
39498
39891
  /** @enum {string} */
39499
- "models.StageParamType": "string" | "number" | "boolean" | "select" | "secret";
39892
+ "models.StageParamType": "string" | "number" | "boolean" | "select" | "multiselect" | "secret";
39500
39893
  "models.StagePort": {
39501
39894
  label?: string;
39502
39895
  name?: string;
@@ -40345,6 +40738,88 @@ export interface components {
40345
40738
  userId?: string;
40346
40739
  username?: string;
40347
40740
  };
40741
+ "models.WorkflowAnprDetection": {
40742
+ analysisId?: string;
40743
+ categories?: number[];
40744
+ coordinateSpace?: string;
40745
+ media?: number[];
40746
+ mediaKey?: string;
40747
+ name?: string;
40748
+ schemaVersion?: string;
40749
+ source?: number[];
40750
+ task?: string;
40751
+ /** @description one per vehicle that passed the movement gates */
40752
+ tracks?: components["schemas"]["models.WorkflowAnprTrack"][];
40753
+ };
40754
+ "models.WorkflowAnprMarker": {
40755
+ atRuntimeMetadata?: number[];
40756
+ audit?: number[];
40757
+ categories?: number[];
40758
+ description?: string;
40759
+ detections?: number[];
40760
+ deviceId?: string;
40761
+ /** @description seconds the vehicle was visible */
40762
+ duration?: number;
40763
+ endTimestamp?: number;
40764
+ events?: number[];
40765
+ groupId?: string;
40766
+ id?: string;
40767
+ mediaKeys?: string[];
40768
+ metadata?: components["schemas"]["models.WorkflowAnprMarkerMetadata"];
40769
+ /** @description the plate, or "anpr unread" */
40770
+ name?: string;
40771
+ organisationId?: string;
40772
+ projectId?: number[];
40773
+ siteId?: string;
40774
+ startTimestamp?: number;
40775
+ synchronize?: number[];
40776
+ tags?: number[];
40777
+ };
40778
+ "models.WorkflowAnprMarkerMetadata": {
40779
+ boundingBox?: number[];
40780
+ comments?: number[];
40781
+ /** @description OCR confidence: ~0-1 for fast, 0.5 for tesseract, unclamped for http */
40782
+ confidence?: number;
40783
+ /** @description fast, tesseract, tesseract+opencv or http */
40784
+ engine?: string;
40785
+ modelVersion?: string;
40786
+ raw?: number[];
40787
+ /** @description always anpr */
40788
+ source?: string;
40789
+ };
40790
+ "models.WorkflowAnprResult": {
40791
+ /** @description exactly one detection run per stage result */
40792
+ detections?: components["schemas"]["models.WorkflowAnprDetection"][];
40793
+ /** @description one per vehicle, same vehicles as the tracks */
40794
+ markers?: components["schemas"]["models.WorkflowAnprMarker"][];
40795
+ /** @description media description update, when a plate was read */
40796
+ "media-patchs"?: number[][];
40797
+ };
40798
+ "models.WorkflowAnprTrack": {
40799
+ boxes?: number[];
40800
+ classId?: number[];
40801
+ color?: string;
40802
+ /** @description constant 0.9 */
40803
+ confidence?: number;
40804
+ deletedFrames?: number[];
40805
+ id?: string;
40806
+ /** @description the plate, or "unread" */
40807
+ label?: string;
40808
+ meta?: components["schemas"]["models.WorkflowAnprTrackMeta"];
40809
+ shape?: string;
40810
+ };
40811
+ "models.WorkflowAnprTrackMeta": {
40812
+ /** @description the classify label (ANPR_PLATE_CLASSES), not recognised by ANPR */
40813
+ classifiedAs?: string;
40814
+ /** @description uppercase A-Z0-9, 4-10 characters, no separators; "" when unread */
40815
+ plate?: string;
40816
+ /** @description always hub-anpr */
40817
+ recognisedBy?: string;
40818
+ /** @description always !unread */
40819
+ recognisedOcr?: boolean;
40820
+ /** @description no plate was read */
40821
+ unread?: boolean;
40822
+ };
40348
40823
  "models.WorkflowCallback": {
40349
40824
  method?: string;
40350
40825
  resultSchema?: string;
@@ -41061,14 +41536,17 @@ export declare namespace models {
41061
41536
  type DetectionSource = components['schemas']['models.DetectionSource'];
41062
41537
  type Detections = components['schemas']['models.Detections'];
41063
41538
  type Device = components['schemas']['models.Device'];
41539
+ type DeviceAgent = components['schemas']['models.DeviceAgent'];
41064
41540
  type DeviceAtRuntimeMetadata = components['schemas']['models.DeviceAtRuntimeMetadata'];
41065
41541
  type DeviceData = components['schemas']['models.DeviceData'];
41066
41542
  type DeviceFeaturePermissions = components['schemas']['models.DeviceFeaturePermissions'];
41067
41543
  type DeviceKey = components['schemas']['models.DeviceKey'];
41544
+ type DeviceMediaRef = components['schemas']['models.DeviceMediaRef'];
41068
41545
  type DeviceMetadata = components['schemas']['models.DeviceMetadata'];
41069
41546
  type DeviceOption = components['schemas']['models.DeviceOption'];
41070
41547
  type DevicePatch = components['schemas']['models.DevicePatch'];
41071
41548
  type DevicePlacement = components['schemas']['models.DevicePlacement'];
41549
+ type DeviceThresholds = components['schemas']['models.DeviceThresholds'];
41072
41550
  type DeviceVLMMetadata = components['schemas']['models.DeviceVLMMetadata'];
41073
41551
  type Devices = components['schemas']['models.Devices'];
41074
41552
  type DirectionalTimeSeriesChart = components['schemas']['models.DirectionalTimeSeriesChart'];
@@ -41082,6 +41560,7 @@ export declare namespace models {
41082
41560
  type FeaturePermissions = components['schemas']['models.FeaturePermissions'];
41083
41561
  type FloorPlan = components['schemas']['models.FloorPlan'];
41084
41562
  type FragmentedBytesRangeOnTime = components['schemas']['models.FragmentedBytesRangeOnTime'];
41563
+ type GPSFix = components['schemas']['models.GPSFix'];
41085
41564
  type GPSMetadata = components['schemas']['models.GPSMetadata'];
41086
41565
  type GetAlertsInput = components['schemas']['models.GetAlertsInput'];
41087
41566
  type GetAlertsOutput = components['schemas']['models.GetAlertsOutput'];
@@ -41273,6 +41752,12 @@ export declare namespace models {
41273
41752
  type Webhook = components['schemas']['models.Webhook'];
41274
41753
  type WeeklySchedule = components['schemas']['models.WeeklySchedule'];
41275
41754
  type Workflow = components['schemas']['models.Workflow'];
41755
+ type WorkflowAnprDetection = components['schemas']['models.WorkflowAnprDetection'];
41756
+ type WorkflowAnprMarker = components['schemas']['models.WorkflowAnprMarker'];
41757
+ type WorkflowAnprMarkerMetadata = components['schemas']['models.WorkflowAnprMarkerMetadata'];
41758
+ type WorkflowAnprResult = components['schemas']['models.WorkflowAnprResult'];
41759
+ type WorkflowAnprTrack = components['schemas']['models.WorkflowAnprTrack'];
41760
+ type WorkflowAnprTrackMeta = components['schemas']['models.WorkflowAnprTrackMeta'];
41276
41761
  type WorkflowCallback = components['schemas']['models.WorkflowCallback'];
41277
41762
  type WorkflowClassifyInput = components['schemas']['models.WorkflowClassifyInput'];
41278
41763
  type WorkflowClassifyInputDetail = components['schemas']['models.WorkflowClassifyInputDetail'];
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uug-ai/models",
3
- "version": "1.7.71",
3
+ "version": "1.7.73",
4
4
  "description": "TypeScript type definitions for Go models",
5
5
  "main": "dist/types.js",
6
6
  "types": "dist/types.d.ts",