@awarevue/api-types 2.0.53 → 2.0.54

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 (67) hide show
  1. package/dist/api/agent-protocol/protocol.d.ts +853 -840
  2. package/dist/api/agent-protocol/protocol.js +14 -1
  3. package/dist/api/commands/all.d.ts +224 -224
  4. package/dist/api/commands/camera.d.ts +16 -16
  5. package/dist/api/commands/display.d.ts +48 -48
  6. package/dist/api/commands/nvr-exporter.d.ts +194 -194
  7. package/dist/api/commands/server.d.ts +202 -202
  8. package/dist/api/events/all.d.ts +30 -30
  9. package/dist/api/events/camera.d.ts +42 -42
  10. package/dist/api/events/door.d.ts +4 -4
  11. package/dist/api/events/intercom-terminal.d.ts +8 -8
  12. package/dist/api/events/io-board.d.ts +4 -4
  13. package/dist/api/queries/all.d.ts +225 -225
  14. package/dist/api/queries/camera.d.ts +8 -8
  15. package/dist/api/queries/nvr-analytics-server.d.ts +36 -36
  16. package/dist/api/queries/nvr-exporter.d.ts +18 -18
  17. package/dist/api/queries/nvr-recorder.d.ts +398 -398
  18. package/dist/api/rest/agreement.d.ts +5 -5
  19. package/dist/api/rest/automation.d.ts +46 -46
  20. package/dist/api/rest/bookmarks.d.ts +12 -12
  21. package/dist/api/rest/custom-field.d.ts +5 -5
  22. package/dist/api/rest/device.d.ts +6 -6
  23. package/dist/api/rest/io-device.d.ts +14 -14
  24. package/dist/api/rest/layout.d.ts +16 -16
  25. package/dist/api/rest/macros.d.ts +13 -13
  26. package/dist/api/rest/media.d.ts +16 -16
  27. package/dist/api/rest/person.d.ts +12 -12
  28. package/dist/api/rest/query.d.ts +2 -2
  29. package/dist/api/rest/schedule.d.ts +24 -24
  30. package/dist/api/rest/security-level.d.ts +10 -10
  31. package/dist/api/rest/template.d.ts +4 -4
  32. package/dist/api/rest/token-conversion.d.ts +5 -5
  33. package/dist/api/rest/user.d.ts +17 -17
  34. package/dist/api/rest/view.d.ts +44 -44
  35. package/dist/api/ws/device-communication.d.ts +6 -6
  36. package/dist/api/ws/notifications.d.ts +4 -4
  37. package/dist/api/ws/progress.d.ts +15 -15
  38. package/dist/api/ws/web-rtc-signaling.d.ts +2 -2
  39. package/dist/objects/access-rule.d.ts +2 -2
  40. package/dist/objects/agent-metadata.d.ts +16 -16
  41. package/dist/objects/agreement.d.ts +2 -2
  42. package/dist/objects/api-key.d.ts +2 -2
  43. package/dist/objects/automation-rule.d.ts +34 -34
  44. package/dist/objects/bookmark.d.ts +8 -8
  45. package/dist/objects/credential.d.ts +2 -2
  46. package/dist/objects/custom-field.d.ts +2 -2
  47. package/dist/objects/device/any-device.d.ts +205 -205
  48. package/dist/objects/device/camera.d.ts +26 -26
  49. package/dist/objects/device/device-import.d.ts +277 -277
  50. package/dist/objects/device/door.d.ts +2 -2
  51. package/dist/objects/device/intercom-terminal.d.ts +2 -2
  52. package/dist/objects/layout.d.ts +16 -16
  53. package/dist/objects/macro.d.ts +14 -14
  54. package/dist/objects/notification.d.ts +4 -4
  55. package/dist/objects/person-presence.d.ts +12 -12
  56. package/dist/objects/person.d.ts +14 -14
  57. package/dist/objects/role.d.ts +2 -2
  58. package/dist/objects/schedule.d.ts +36 -36
  59. package/dist/objects/security-level.d.ts +6 -6
  60. package/dist/objects/template.d.ts +2 -2
  61. package/dist/objects/token-conversion.d.ts +2 -2
  62. package/dist/objects/user.d.ts +4 -4
  63. package/dist/objects/view.d.ts +58 -58
  64. package/dist/objects/zone.d.ts +2 -2
  65. package/dist/package.json +1 -1
  66. package/dist/primitives.d.ts +60 -60
  67. package/package.json +1 -1
package/dist/api/queries/camera.d.ts CHANGED
@@ -11,32 +11,32 @@ export declare const sRtspDataResponse: z.ZodObject<{
11
11
  resolution: z.ZodNullable<z.ZodString>;
12
12
  rtspUrl: z.ZodString;
13
13
  }, "strip", z.ZodTypeAny, {
14
- resolution: string | null;
15
14
  displayName: string;
16
15
  rtspUrl: string;
17
16
  streamId: string;
18
- }, {
19
17
  resolution: string | null;
18
+ }, {
20
19
  displayName: string;
21
20
  rtspUrl: string;
22
21
  streamId: string;
22
+ resolution: string | null;
23
23
  }>, "many">;
24
24
  }, "strip", z.ZodTypeAny, {
25
25
  streams: {
26
- resolution: string | null;
27
26
  displayName: string;
28
27
  rtspUrl: string;
29
28
  streamId: string;
29
+ resolution: string | null;
30
30
  }[];
31
31
  username: string;
32
32
  password: string;
33
33
  cameraName: string;
34
34
  }, {
35
35
  streams: {
36
- resolution: string | null;
37
36
  displayName: string;
38
37
  rtspUrl: string;
39
38
  streamId: string;
39
+ resolution: string | null;
40
40
  }[];
41
41
  username: string;
42
42
  password: string;
@@ -58,32 +58,32 @@ export declare const cameraResponseSchemas: {
58
58
  resolution: z.ZodNullable<z.ZodString>;
59
59
  rtspUrl: z.ZodString;
60
60
  }, "strip", z.ZodTypeAny, {
61
- resolution: string | null;
62
61
  displayName: string;
63
62
  rtspUrl: string;
64
63
  streamId: string;
65
- }, {
66
64
  resolution: string | null;
65
+ }, {
67
66
  displayName: string;
68
67
  rtspUrl: string;
69
68
  streamId: string;
69
+ resolution: string | null;
70
70
  }>, "many">;
71
71
  }, "strip", z.ZodTypeAny, {
72
72
  streams: {
73
- resolution: string | null;
74
73
  displayName: string;
75
74
  rtspUrl: string;
76
75
  streamId: string;
76
+ resolution: string | null;
77
77
  }[];
78
78
  username: string;
79
79
  password: string;
80
80
  cameraName: string;
81
81
  }, {
82
82
  streams: {
83
- resolution: string | null;
84
83
  displayName: string;
85
84
  rtspUrl: string;
86
85
  streamId: string;
86
+ resolution: string | null;
87
87
  }[];
88
88
  username: string;
89
89
  password: string;
package/dist/api/queries/nvr-analytics-server.d.ts CHANGED
@@ -11,20 +11,20 @@ export declare const sMediaSearchArgs: z.ZodObject<{
11
11
  timeTo: z.ZodOptional<z.ZodNumber>;
12
12
  sortBy: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"time_asc">, z.ZodLiteral<"time_desc">, z.ZodLiteral<"relevance">]>>;
13
13
  }, "strip", z.ZodTypeAny, {
14
- label?: string[] | undefined;
15
- q?: string | undefined;
16
14
  devices?: any[] | undefined;
15
+ label?: string[] | undefined;
17
16
  limit?: number | undefined;
17
+ q?: string | undefined;
18
18
  timeFrom?: number | undefined;
19
19
  timeTo?: number | undefined;
20
20
  similarTo?: string | undefined;
21
21
  subLabel?: string[] | undefined;
22
22
  sortBy?: "time_asc" | "time_desc" | "relevance" | undefined;
23
23
  }, {
24
- label?: string[] | undefined;
25
- q?: string | undefined;
26
24
  devices?: any[] | undefined;
25
+ label?: string[] | undefined;
27
26
  limit?: number | undefined;
27
+ q?: string | undefined;
28
28
  timeFrom?: number | undefined;
29
29
  timeTo?: number | undefined;
30
30
  similarTo?: string | undefined;
@@ -42,22 +42,22 @@ export declare const sMediaSearchMatch: z.ZodObject<{
42
42
  startTime: z.ZodNumber;
43
43
  endTime: z.ZodNullable<z.ZodNumber>;
44
44
  }, "strip", z.ZodTypeAny, {
45
- endTime: number | null;
46
- startTime: number;
47
45
  foreignRef: string;
48
46
  provider: string;
49
47
  objectKind: string;
50
48
  probability: number;
49
+ startTime: number;
50
+ endTime: number | null;
51
51
  providerAssignedRef: string;
52
52
  relevance: number;
53
53
  subLabel: string;
54
54
  }, {
55
- endTime: number | null;
56
- startTime: number;
57
55
  foreignRef: string;
58
56
  provider: string;
59
57
  objectKind: string;
60
58
  probability: number;
59
+ startTime: number;
60
+ endTime: number | null;
61
61
  providerAssignedRef: string;
62
62
  relevance: number;
63
63
  subLabel: string;
@@ -73,22 +73,22 @@ export declare const sMediaSearchResponse: z.ZodArray<z.ZodObject<{
73
73
  startTime: z.ZodNumber;
74
74
  endTime: z.ZodNullable<z.ZodNumber>;
75
75
  }, "strip", z.ZodTypeAny, {
76
- endTime: number | null;
77
- startTime: number;
78
76
  foreignRef: string;
79
77
  provider: string;
80
78
  objectKind: string;
81
79
  probability: number;
80
+ startTime: number;
81
+ endTime: number | null;
82
82
  providerAssignedRef: string;
83
83
  relevance: number;
84
84
  subLabel: string;
85
85
  }, {
86
- endTime: number | null;
87
- startTime: number;
88
86
  foreignRef: string;
89
87
  provider: string;
90
88
  objectKind: string;
91
89
  probability: number;
90
+ startTime: number;
91
+ endTime: number | null;
92
92
  providerAssignedRef: string;
93
93
  relevance: number;
94
94
  subLabel: string;
@@ -108,11 +108,11 @@ export declare const sScenePreviewClipResponse: z.ZodNullable<z.ZodObject<{
108
108
  mimeType: z.ZodString;
109
109
  data: z.ZodString;
110
110
  }, "strip", z.ZodTypeAny, {
111
- data: string;
112
111
  mimeType: string;
113
- }, {
114
112
  data: string;
113
+ }, {
115
114
  mimeType: string;
115
+ data: string;
116
116
  }>>;
117
117
  export type ScenePreviewClipArgs = z.infer<typeof sScenePreviewClipArgs>;
118
118
  export type ScenePreviewClipResponse = z.infer<typeof sScenePreviewClipResponse>;
@@ -140,11 +140,11 @@ export declare const sObjectSnapshotResponse: z.ZodNullable<z.ZodObject<{
140
140
  mimeType: z.ZodString;
141
141
  data: z.ZodString;
142
142
  }, "strip", z.ZodTypeAny, {
143
- data: string;
144
143
  mimeType: string;
145
- }, {
146
144
  data: string;
145
+ }, {
147
146
  mimeType: string;
147
+ data: string;
148
148
  }>>;
149
149
  export type ObjectSnapshotArgs = z.infer<typeof sObjectSnapshotArgs>;
150
150
  export type ObjectSnapshotResponse = z.infer<typeof sObjectSnapshotResponse>;
@@ -160,11 +160,11 @@ export declare const sObjectThumbnailResponse: z.ZodNullable<z.ZodObject<{
160
160
  mimeType: z.ZodString;
161
161
  data: z.ZodString;
162
162
  }, "strip", z.ZodTypeAny, {
163
- data: string;
164
163
  mimeType: string;
165
- }, {
166
164
  data: string;
165
+ }, {
167
166
  mimeType: string;
167
+ data: string;
168
168
  }>>;
169
169
  export type ObjectThumbnailArgs = z.infer<typeof sObjectThumbnailArgs>;
170
170
  export type ObjectThumbnailResponse = z.infer<typeof sObjectThumbnailResponse>;
@@ -285,11 +285,11 @@ export declare const sMediaFaceImageResponse: z.ZodNullable<z.ZodObject<{
285
285
  mimeType: z.ZodString;
286
286
  data: z.ZodString;
287
287
  }, "strip", z.ZodTypeAny, {
288
- data: string;
289
288
  mimeType: string;
290
- }, {
291
289
  data: string;
290
+ }, {
292
291
  mimeType: string;
292
+ data: string;
293
293
  }>>;
294
294
  export type MediaFaceImageResponse = z.infer<typeof sMediaFaceImageResponse>;
295
295
  export declare const QUERY_MEDIA_FACE_TRAIN = "cctv:media-face-train";
@@ -327,20 +327,20 @@ export declare const nvrAnalyticsRequestSchemas: {
327
327
  timeTo: z.ZodOptional<z.ZodNumber>;
328
328
  sortBy: z.ZodOptional<z.ZodUnion<[z.ZodLiteral<"time_asc">, z.ZodLiteral<"time_desc">, z.ZodLiteral<"relevance">]>>;
329
329
  }, "strip", z.ZodTypeAny, {
330
- label?: string[] | undefined;
331
- q?: string | undefined;
332
330
  devices?: any[] | undefined;
331
+ label?: string[] | undefined;
333
332
  limit?: number | undefined;
333
+ q?: string | undefined;
334
334
  timeFrom?: number | undefined;
335
335
  timeTo?: number | undefined;
336
336
  similarTo?: string | undefined;
337
337
  subLabel?: string[] | undefined;
338
338
  sortBy?: "time_asc" | "time_desc" | "relevance" | undefined;
339
339
  }, {
340
- label?: string[] | undefined;
341
- q?: string | undefined;
342
340
  devices?: any[] | undefined;
341
+ label?: string[] | undefined;
343
342
  limit?: number | undefined;
343
+ q?: string | undefined;
344
344
  timeFrom?: number | undefined;
345
345
  timeTo?: number | undefined;
346
346
  similarTo?: string | undefined;
@@ -450,22 +450,22 @@ export declare const nvrAnalyticsResponseSchemas: {
450
450
  startTime: z.ZodNumber;
451
451
  endTime: z.ZodNullable<z.ZodNumber>;
452
452
  }, "strip", z.ZodTypeAny, {
453
- endTime: number | null;
454
- startTime: number;
455
453
  foreignRef: string;
456
454
  provider: string;
457
455
  objectKind: string;
458
456
  probability: number;
457
+ startTime: number;
458
+ endTime: number | null;
459
459
  providerAssignedRef: string;
460
460
  relevance: number;
461
461
  subLabel: string;
462
462
  }, {
463
- endTime: number | null;
464
- startTime: number;
465
463
  foreignRef: string;
466
464
  provider: string;
467
465
  objectKind: string;
468
466
  probability: number;
467
+ startTime: number;
468
+ endTime: number | null;
469
469
  providerAssignedRef: string;
470
470
  relevance: number;
471
471
  subLabel: string;
@@ -474,31 +474,31 @@ export declare const nvrAnalyticsResponseSchemas: {
474
474
  mimeType: z.ZodString;
475
475
  data: z.ZodString;
476
476
  }, "strip", z.ZodTypeAny, {
477
- data: string;
478
477
  mimeType: string;
479
- }, {
480
478
  data: string;
479
+ }, {
481
480
  mimeType: string;
481
+ data: string;
482
482
  }>>;
483
483
  readonly "cctv:object-snapshot": z.ZodNullable<z.ZodObject<{
484
484
  mimeType: z.ZodString;
485
485
  data: z.ZodString;
486
486
  }, "strip", z.ZodTypeAny, {
487
- data: string;
488
487
  mimeType: string;
489
- }, {
490
488
  data: string;
489
+ }, {
491
490
  mimeType: string;
491
+ data: string;
492
492
  }>>;
493
493
  readonly "cctv:object-thumbnail": z.ZodNullable<z.ZodObject<{
494
494
  mimeType: z.ZodString;
495
495
  data: z.ZodString;
496
496
  }, "strip", z.ZodTypeAny, {
497
- data: string;
498
497
  mimeType: string;
499
- }, {
500
498
  data: string;
499
+ }, {
501
500
  mimeType: string;
501
+ data: string;
502
502
  }>>;
503
503
  readonly "cctv:object-labels": z.ZodArray<z.ZodString, "many">;
504
504
  readonly "cctv:media-faces": z.ZodRecord<z.ZodString, z.ZodArray<z.ZodString, "many">>;
@@ -547,11 +547,11 @@ export declare const nvrAnalyticsResponseSchemas: {
547
547
  mimeType: z.ZodString;
548
548
  data: z.ZodString;
549
549
  }, "strip", z.ZodTypeAny, {
550
- data: string;
551
550
  mimeType: string;
552
- }, {
553
551
  data: string;
552
+ }, {
554
553
  mimeType: string;
554
+ data: string;
555
555
  }>>;
556
556
  readonly "cctv:media-face-train": z.ZodObject<{
557
557
  success: z.ZodBoolean;
package/dist/api/queries/nvr-exporter.d.ts CHANGED
@@ -27,19 +27,19 @@ export declare const sExportItem: z.ZodObject<{
27
27
  size: z.ZodOptional<z.ZodString>;
28
28
  expires: z.ZodOptional<z.ZodNumber>;
29
29
  }, "strip", z.ZodTypeAny, {
30
+ status: string;
31
+ id: string;
30
32
  name: string;
31
- endTime: number;
32
33
  startTime: number;
33
- id: string;
34
- status: string;
34
+ endTime: number;
35
35
  size?: string | undefined;
36
36
  expires?: number | undefined;
37
37
  }, {
38
+ status: string;
39
+ id: string;
38
40
  name: string;
39
- endTime: number;
40
41
  startTime: number;
41
- id: string;
42
- status: string;
42
+ endTime: number;
43
43
  size?: string | undefined;
44
44
  expires?: number | undefined;
45
45
  }>;
@@ -52,19 +52,19 @@ export declare const sGetExportsResponse: z.ZodArray<z.ZodObject<{
52
52
  size: z.ZodOptional<z.ZodString>;
53
53
  expires: z.ZodOptional<z.ZodNumber>;
54
54
  }, "strip", z.ZodTypeAny, {
55
+ status: string;
56
+ id: string;
55
57
  name: string;
56
- endTime: number;
57
58
  startTime: number;
58
- id: string;
59
- status: string;
59
+ endTime: number;
60
60
  size?: string | undefined;
61
61
  expires?: number | undefined;
62
62
  }, {
63
+ status: string;
64
+ id: string;
63
65
  name: string;
64
- endTime: number;
65
66
  startTime: number;
66
- id: string;
67
- status: string;
67
+ endTime: number;
68
68
  size?: string | undefined;
69
69
  expires?: number | undefined;
70
70
  }>, "many">;
@@ -98,19 +98,19 @@ export declare const nvrExporterResponseSchemas: {
98
98
  size: z.ZodOptional<z.ZodString>;
99
99
  expires: z.ZodOptional<z.ZodNumber>;
100
100
  }, "strip", z.ZodTypeAny, {
101
+ status: string;
102
+ id: string;
101
103
  name: string;
102
- endTime: number;
103
104
  startTime: number;
104
- id: string;
105
- status: string;
105
+ endTime: number;
106
106
  size?: string | undefined;
107
107
  expires?: number | undefined;
108
108
  }, {
109
+ status: string;
110
+ id: string;
109
111
  name: string;
110
- endTime: number;
111
112
  startTime: number;
112
- id: string;
113
- status: string;
113
+ endTime: number;
114
114
  size?: string | undefined;
115
115
  expires?: number | undefined;
116
116
  }>, "many">;