@uug-ai/models 1.0.34 → 1.0.35
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 +48 -24
- package/package.json +1 -1
package/dist/types.d.ts
CHANGED
|
@@ -5085,9 +5085,11 @@ export interface components {
|
|
|
5085
5085
|
audit?: components["schemas"]["models.Audit"];
|
|
5086
5086
|
author?: string;
|
|
5087
5087
|
content?: string;
|
|
5088
|
-
/**
|
|
5088
|
+
/**
|
|
5089
|
+
* @description RBAC information
|
|
5089
5090
|
* DeviceId is a unique identifier for the device, it can be used to identify the device in the system.
|
|
5090
|
-
* OrganisationId is used to identify the organisation that owns the device.
|
|
5091
|
+
* OrganisationId is used to identify the organisation that owns the device.
|
|
5092
|
+
*/
|
|
5091
5093
|
deviceId?: string;
|
|
5092
5094
|
id?: string;
|
|
5093
5095
|
organisationId?: string;
|
|
@@ -5125,9 +5127,11 @@ export interface components {
|
|
|
5125
5127
|
username?: string;
|
|
5126
5128
|
};
|
|
5127
5129
|
"models.Device": {
|
|
5128
|
-
/**
|
|
5130
|
+
/**
|
|
5131
|
+
* @description AtRuntimeMetadata contains metadata that is generated at runtime, which can include
|
|
5129
5132
|
* more verbose information about the device's current state, capabilities, or configuration.
|
|
5130
|
-
* for example the linked sites details, etc.
|
|
5133
|
+
* for example the linked sites details, etc.
|
|
5134
|
+
*/
|
|
5131
5135
|
atRuntimeMetadata?: components["schemas"]["models.DeviceAtRuntimeMetadata"];
|
|
5132
5136
|
/** @description Audit information */
|
|
5133
5137
|
audit?: components["schemas"]["models.Audit"];
|
|
@@ -5138,11 +5142,13 @@ export interface components {
|
|
|
5138
5142
|
deviceId?: string;
|
|
5139
5143
|
/** @description e.g. "camera", "sensor", "access_control" */
|
|
5140
5144
|
deviceType?: string;
|
|
5141
|
-
/**
|
|
5145
|
+
/**
|
|
5146
|
+
* @description FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc.
|
|
5142
5147
|
* It is a map of feature names to permissions.
|
|
5143
5148
|
* For example, "camera" can have permissions like "read", "write", "delete", etc.
|
|
5144
5149
|
* This allows for fine-grained control over what features are accessible by users or groups.
|
|
5145
|
-
* FeaturePermissions can be used to implement Role-Based Access Control (RBAC) for devices.
|
|
5150
|
+
* FeaturePermissions can be used to implement Role-Based Access Control (RBAC) for devices.
|
|
5151
|
+
*/
|
|
5146
5152
|
featurePermissions?: components["schemas"]["models.DeviceFeaturePermissions"];
|
|
5147
5153
|
groupId?: string;
|
|
5148
5154
|
id?: string;
|
|
@@ -5152,27 +5158,35 @@ export interface components {
|
|
|
5152
5158
|
locationMetadata?: components["schemas"]["models.DeviceLocationMetadata"];
|
|
5153
5159
|
/** @description Metadata */
|
|
5154
5160
|
metadata?: components["schemas"]["models.DeviceMetadata"];
|
|
5155
|
-
/**
|
|
5161
|
+
/**
|
|
5162
|
+
* @description Device information
|
|
5156
5163
|
* Note: DeviceId is a unique identifier for the device, it can be used to identify the device in the system.
|
|
5157
|
-
* DeviceType is used to identify the type of device, such as camera, sensor, access control, etc.
|
|
5164
|
+
* DeviceType is used to identify the type of device, such as camera, sensor, access control, etc.
|
|
5165
|
+
*/
|
|
5158
5166
|
name?: string;
|
|
5159
5167
|
organisationId?: string;
|
|
5160
5168
|
/** @description e.g. "v1.0.0-abcdef123456" */
|
|
5161
5169
|
releaseHash?: string;
|
|
5162
|
-
/**
|
|
5170
|
+
/**
|
|
5171
|
+
* @description RBAC information
|
|
5163
5172
|
* Note: SiteId is used to identify the site where the device is located.
|
|
5164
5173
|
* GroupId is used to identify the group of devices.
|
|
5165
5174
|
* OrganisationId is used to identify the organisation that owns the device.
|
|
5166
|
-
* FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc.
|
|
5175
|
+
* FeaturePermissions is used to identify the permissions of the device, such as read, write, delete, etc.
|
|
5176
|
+
*/
|
|
5167
5177
|
siteId?: string;
|
|
5168
|
-
/**
|
|
5178
|
+
/**
|
|
5179
|
+
* @description Device status
|
|
5169
5180
|
* Note: Status is used to identify the status of the device, such as online, offline, maintenance, etc.
|
|
5170
|
-
* LastSeenTimestamp is used to identify the last time the device was seen online.
|
|
5181
|
+
* LastSeenTimestamp is used to identify the last time the device was seen online.
|
|
5182
|
+
*/
|
|
5171
5183
|
status?: string;
|
|
5172
|
-
/**
|
|
5184
|
+
/**
|
|
5185
|
+
* @description Versioning information
|
|
5173
5186
|
* Note: Version is used to identify the version of the device software.
|
|
5174
5187
|
* 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.
|
|
5175
|
-
* Deployment is used to identify the deployment type of the device, such as factory, docker, docker compose, kubernetes, etc.
|
|
5188
|
+
* Deployment is used to identify the deployment type of the device, such as factory, docker, docker compose, kubernetes, etc.
|
|
5189
|
+
*/
|
|
5176
5190
|
version?: string;
|
|
5177
5191
|
};
|
|
5178
5192
|
"models.DeviceAtRuntimeMetadata": Record<string, never>;
|
|
@@ -5433,15 +5447,19 @@ export interface components {
|
|
|
5433
5447
|
tags?: string[];
|
|
5434
5448
|
};
|
|
5435
5449
|
"models.Media": {
|
|
5436
|
-
/**
|
|
5450
|
+
/**
|
|
5451
|
+
* @description AtRuntimeMetadata contains metadata that is generated at runtime, which can include
|
|
5437
5452
|
* more verbose information about the device's current state, capabilities, or configuration.
|
|
5438
|
-
* for example the linked sites details, etc.
|
|
5453
|
+
* for example the linked sites details, etc.
|
|
5454
|
+
*/
|
|
5439
5455
|
atRuntimeMetadata?: components["schemas"]["models.MediaAtRuntimeMetadata"];
|
|
5440
5456
|
/** @description Audit information */
|
|
5441
5457
|
audit?: components["schemas"]["models.Audit"];
|
|
5442
|
-
/**
|
|
5458
|
+
/**
|
|
5459
|
+
* @description RBAC information
|
|
5443
5460
|
* DeviceId is a unique identifier for the device, it can be used to identify the device in the system.
|
|
5444
|
-
* OrganisationId is used to identify the organisation that owns the device.
|
|
5461
|
+
* OrganisationId is used to identify the organisation that owns the device.
|
|
5462
|
+
*/
|
|
5445
5463
|
deviceId?: string;
|
|
5446
5464
|
duration?: number;
|
|
5447
5465
|
endTimestamp?: number;
|
|
@@ -5454,8 +5472,10 @@ export interface components {
|
|
|
5454
5472
|
spriteProvider?: string;
|
|
5455
5473
|
/** @description Time window of media file. */
|
|
5456
5474
|
startTimestamp?: number;
|
|
5457
|
-
/**
|
|
5458
|
-
*
|
|
5475
|
+
/**
|
|
5476
|
+
* @description Media file information (by default "vault", however might change
|
|
5477
|
+
* in the future (integration with other storage solutions, next to Vault).
|
|
5478
|
+
*/
|
|
5459
5479
|
storageSolution?: string;
|
|
5460
5480
|
thumbnailFile?: string;
|
|
5461
5481
|
thumbnailProvider?: string;
|
|
@@ -5499,9 +5519,11 @@ export interface components {
|
|
|
5499
5519
|
};
|
|
5500
5520
|
date?: number;
|
|
5501
5521
|
eventStage?: components["schemas"]["models.EventStage"];
|
|
5502
|
-
/**
|
|
5522
|
+
/**
|
|
5523
|
+
* @description Stages of the pipeline, e.g., event, monitor, sequence, analysis, throttler, notification
|
|
5503
5524
|
* Idea is that we persist relevant data in each stage, so we have a good understanding what is used
|
|
5504
|
-
* or computed at which stage.
|
|
5525
|
+
* or computed at which stage.
|
|
5526
|
+
*/
|
|
5505
5527
|
events?: string[];
|
|
5506
5528
|
fileName?: string;
|
|
5507
5529
|
monitorStage?: components["schemas"]["models.MonitorStage"];
|
|
@@ -5595,8 +5617,10 @@ export interface components {
|
|
|
5595
5617
|
name?: string;
|
|
5596
5618
|
/** @description RBAC information */
|
|
5597
5619
|
organisationId?: string;
|
|
5598
|
-
/**
|
|
5599
|
-
*
|
|
5620
|
+
/**
|
|
5621
|
+
* @description Media file information (by default "vault", however might change
|
|
5622
|
+
* in the future (integration with other storage solutions, next to Vault).
|
|
5623
|
+
*/
|
|
5600
5624
|
storageSolution?: string;
|
|
5601
5625
|
vaultAccessKey?: string;
|
|
5602
5626
|
vaultSecretKey?: string;
|