@awarevue/api-types 2.0.82 → 2.0.84

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 (131) hide show
  1. package/dist/alarm-automation.d.ts +21 -37
  2. package/dist/api/agent-protocol/protocol.d.ts +1000 -10986
  3. package/dist/api/agent-protocol/protocol.js +114 -57
  4. package/dist/api/commands/alarm.d.ts +40 -248
  5. package/dist/api/commands/all.d.ts +393 -4642
  6. package/dist/api/commands/camera-lift.d.ts +8 -32
  7. package/dist/api/commands/camera.d.ts +82 -373
  8. package/dist/api/commands/display.d.ts +21 -373
  9. package/dist/api/commands/door.d.ts +16 -64
  10. package/dist/api/commands/io-board.d.ts +4 -40
  11. package/dist/api/commands/nvr-exporter.d.ts +104 -1380
  12. package/dist/api/commands/nvr-recorder.d.ts +400 -5288
  13. package/dist/api/commands/pbx.d.ts +4 -56
  14. package/dist/api/commands/presence-tracker.d.ts +12 -128
  15. package/dist/api/commands/server.d.ts +114 -1382
  16. package/dist/api/commands/server.js +1 -1
  17. package/dist/api/error.d.ts +77 -443
  18. package/dist/api/error.js +1 -1
  19. package/dist/api/events/alarm.d.ts +20 -148
  20. package/dist/api/events/all.d.ts +74 -526
  21. package/dist/api/events/all.js +1 -1
  22. package/dist/api/events/camera.d.ts +46 -470
  23. package/dist/api/events/display.d.ts +1 -5
  24. package/dist/api/events/door.d.ts +34 -146
  25. package/dist/api/events/intercom-terminal.d.ts +22 -42
  26. package/dist/api/events/io-board.d.ts +2 -18
  27. package/dist/api/events/nvr-exporter.d.ts +4 -32
  28. package/dist/api/events/panic-button.d.ts +2 -10
  29. package/dist/api/events/presence-tracker.d.ts +4 -88
  30. package/dist/api/events/reader.d.ts +2 -22
  31. package/dist/api/events/server.d.ts +6 -34
  32. package/dist/api/mqtt/payloads.d.ts +4 -26
  33. package/dist/api/queries/all.d.ts +188 -1622
  34. package/dist/api/queries/nvr-analytics-server.d.ts +61 -373
  35. package/dist/api/queries/nvr-exporter.d.ts +9 -73
  36. package/dist/api/queries/nvr-recorder.d.ts +300 -2828
  37. package/dist/api/rest/access-rule.d.ts +10 -86
  38. package/dist/api/rest/agreement.d.ts +3 -18
  39. package/dist/api/rest/api-keys.d.ts +3 -17
  40. package/dist/api/rest/app.d.ts +3 -51
  41. package/dist/api/rest/auth.d.ts +3 -19
  42. package/dist/api/rest/automation.d.ts +11 -236
  43. package/dist/api/rest/bookmarks.d.ts +8 -56
  44. package/dist/api/rest/camera.d.ts +12 -70
  45. package/dist/api/rest/cast.d.ts +1 -7
  46. package/dist/api/rest/custom-field.d.ts +21 -24
  47. package/dist/api/rest/device-group.d.ts +8 -32
  48. package/dist/api/rest/device.d.ts +104 -176
  49. package/dist/api/rest/io-device.d.ts +7 -75
  50. package/dist/api/rest/io-device.js +2 -2
  51. package/dist/api/rest/layout.d.ts +4 -102
  52. package/dist/api/rest/macros.d.ts +6 -82
  53. package/dist/api/rest/media.d.ts +17 -141
  54. package/dist/api/rest/notifications.d.ts +7 -15
  55. package/dist/api/rest/person-agreement.d.ts +1 -9
  56. package/dist/api/rest/person-presence.d.ts +8 -50
  57. package/dist/api/rest/person-type.d.ts +6 -39
  58. package/dist/api/rest/person.d.ts +18 -96
  59. package/dist/api/rest/query.d.ts +5 -15
  60. package/dist/api/rest/schedule.d.ts +78 -216
  61. package/dist/api/rest/security-level.d.ts +6 -43
  62. package/dist/api/rest/template.d.ts +10 -20
  63. package/dist/api/rest/token-conversion.d.ts +11 -28
  64. package/dist/api/rest/user.d.ts +15 -97
  65. package/dist/api/rest/view.d.ts +24 -496
  66. package/dist/api/rest/webrtc-playback.d.ts +3 -25
  67. package/dist/api/rest/zone.d.ts +5 -21
  68. package/dist/api/ws/device-communication.d.ts +10 -62
  69. package/dist/api/ws/notifications.d.ts +7 -33
  70. package/dist/api/ws/progress.d.ts +10 -72
  71. package/dist/api/ws/web-rtc-signaling.d.ts +33 -279
  72. package/dist/objects/access-rule.d.ts +12 -132
  73. package/dist/objects/access-rule.js +1 -1
  74. package/dist/objects/agent-metadata.d.ts +36 -146
  75. package/dist/objects/agent-metadata.js +1 -2
  76. package/dist/objects/agreement.d.ts +1 -13
  77. package/dist/objects/all.d.ts +20 -1
  78. package/dist/objects/api-key.d.ts +1 -13
  79. package/dist/objects/automation-rule.d.ts +9 -168
  80. package/dist/objects/automation-rule.js +2 -2
  81. package/dist/objects/bookmark.d.ts +3 -33
  82. package/dist/objects/bookmark.js +1 -1
  83. package/dist/objects/credential.d.ts +13 -13
  84. package/dist/objects/credential.js +1 -1
  85. package/dist/objects/custom-field.d.ts +19 -15
  86. package/dist/objects/device/alarm.d.ts +1 -1
  87. package/dist/objects/device/any-device.d.ts +1333 -4451
  88. package/dist/objects/device/camera-lift.d.ts +1 -1
  89. package/dist/objects/device/camera.d.ts +29 -125
  90. package/dist/objects/device/camera.js +1 -1
  91. package/dist/objects/device/device-import.d.ts +307 -1735
  92. package/dist/objects/device/device-relation.d.ts +70 -58
  93. package/dist/objects/device/display.d.ts +1 -1
  94. package/dist/objects/device/door.d.ts +9 -14
  95. package/dist/objects/device/intercom-terminal.d.ts +10 -59
  96. package/dist/objects/device/io-board.d.ts +3 -9
  97. package/dist/objects/device/motion-sensor.d.ts +1 -1
  98. package/dist/objects/device/nvr-analytics-server.d.ts +2 -6
  99. package/dist/objects/device/nvr-exporter.d.ts +3 -9
  100. package/dist/objects/device/nvr-recorder.d.ts +16 -68
  101. package/dist/objects/device/panic-button.d.ts +1 -1
  102. package/dist/objects/device/pbx.d.ts +1 -5
  103. package/dist/objects/device/system.d.ts +1 -1
  104. package/dist/objects/device/system.js +1 -1
  105. package/dist/objects/device-group.d.ts +2 -16
  106. package/dist/objects/layout.d.ts +3 -75
  107. package/dist/objects/macro.d.ts +3 -59
  108. package/dist/objects/macro.js +2 -2
  109. package/dist/objects/notification.d.ts +6 -24
  110. package/dist/objects/notification.js +1 -1
  111. package/dist/objects/person-agreement.d.ts +1 -13
  112. package/dist/objects/person-presence.d.ts +11 -165
  113. package/dist/objects/person-type.d.ts +2 -22
  114. package/dist/objects/person.d.ts +21 -153
  115. package/dist/objects/person.js +3 -3
  116. package/dist/objects/role.d.ts +3 -15
  117. package/dist/objects/schedule.d.ts +152 -314
  118. package/dist/objects/schedule.js +1 -1
  119. package/dist/objects/security-level.d.ts +1 -21
  120. package/dist/objects/template.d.ts +9 -13
  121. package/dist/objects/token-conversion.d.ts +8 -18
  122. package/dist/objects/user.d.ts +2 -20
  123. package/dist/objects/view.d.ts +52 -682
  124. package/dist/objects/world-object.d.ts +1 -7
  125. package/dist/objects/zone.d.ts +5 -29
  126. package/dist/objects/zone.js +1 -1
  127. package/dist/package.json +3 -3
  128. package/dist/permissions.d.ts +1 -1
  129. package/dist/primitives.d.ts +113 -551
  130. package/dist/primitives.js +1 -1
  131. package/package.json +3 -3
package/dist/api/error.js CHANGED
@@ -18,7 +18,7 @@ exports.sNotFoundMeta = zod_1.z.object({
18
18
  });
19
19
  exports.sInvalidMeta = zod_1.z.object({
20
20
  subject: zod_1.z.string(),
21
- fieldErrors: zod_1.z.record(zod_1.z.string()), // key → human msg
21
+ fieldErrors: zod_1.z.record(zod_1.z.string(), zod_1.z.string()), // key → human msg
22
22
  });
23
23
  exports.sConflictMeta = zod_1.z.object({
24
24
  subject: zod_1.z.string(),
@@ -2,212 +2,84 @@ import { z } from 'zod';
2
2
  export declare const sAlarmTriggeredEvent: z.ZodObject<{
3
3
  kind: z.ZodLiteral<"alarm-triggered">;
4
4
  alarmId: z.ZodString;
5
- }, "strip", z.ZodTypeAny, {
6
- kind: "alarm-triggered";
7
- alarmId: string;
8
- }, {
9
- kind: "alarm-triggered";
10
- alarmId: string;
11
- }>;
5
+ }, z.core.$strip>;
12
6
  export declare const sAlarmAcknowledgedEvent: z.ZodObject<{
13
7
  kind: z.ZodLiteral<"alarm-acknowledged">;
14
8
  alarmId: z.ZodString;
15
9
  userId: z.ZodOptional<z.ZodString>;
16
10
  personId: z.ZodOptional<z.ZodString>;
17
- }, "strip", z.ZodTypeAny, {
18
- kind: "alarm-acknowledged";
19
- alarmId: string;
20
- personId?: string | undefined;
21
- userId?: string | undefined;
22
- }, {
23
- kind: "alarm-acknowledged";
24
- alarmId: string;
25
- personId?: string | undefined;
26
- userId?: string | undefined;
27
- }>;
11
+ }, z.core.$strip>;
28
12
  export declare const sAlarmArmedAllEvent: z.ZodObject<{
29
13
  kind: z.ZodLiteral<"alarm-armed-all">;
30
14
  userId: z.ZodOptional<z.ZodString>;
31
15
  personId: z.ZodOptional<z.ZodString>;
32
- }, "strip", z.ZodTypeAny, {
33
- kind: "alarm-armed-all";
34
- personId?: string | undefined;
35
- userId?: string | undefined;
36
- }, {
37
- kind: "alarm-armed-all";
38
- personId?: string | undefined;
39
- userId?: string | undefined;
40
- }>;
16
+ }, z.core.$strip>;
41
17
  export declare const sAlarmDisarmedAllEvent: z.ZodObject<{
42
18
  kind: z.ZodLiteral<"alarm-disarmed-all">;
43
19
  userId: z.ZodOptional<z.ZodString>;
44
20
  personId: z.ZodOptional<z.ZodString>;
45
- }, "strip", z.ZodTypeAny, {
46
- kind: "alarm-disarmed-all";
47
- personId?: string | undefined;
48
- userId?: string | undefined;
49
- }, {
50
- kind: "alarm-disarmed-all";
51
- personId?: string | undefined;
52
- userId?: string | undefined;
53
- }>;
21
+ }, z.core.$strip>;
54
22
  export declare const sAlarmArmedEvent: z.ZodObject<{
55
23
  kind: z.ZodLiteral<"alarm-armed">;
56
- subjects: z.ZodArray<z.ZodString, "many">;
24
+ subjects: z.ZodArray<z.ZodString>;
57
25
  userId: z.ZodOptional<z.ZodString>;
58
26
  personId: z.ZodOptional<z.ZodString>;
59
- }, "strip", z.ZodTypeAny, {
60
- kind: "alarm-armed";
61
- subjects: string[];
62
- personId?: string | undefined;
63
- userId?: string | undefined;
64
- }, {
65
- kind: "alarm-armed";
66
- subjects: string[];
67
- personId?: string | undefined;
68
- userId?: string | undefined;
69
- }>;
27
+ }, z.core.$strip>;
70
28
  export declare const sAlarmDisarmedEvent: z.ZodObject<{
71
29
  kind: z.ZodLiteral<"alarm-disarmed">;
72
- subjects: z.ZodArray<z.ZodString, "many">;
30
+ subjects: z.ZodArray<z.ZodString>;
73
31
  userId: z.ZodOptional<z.ZodString>;
74
32
  personId: z.ZodOptional<z.ZodString>;
75
- }, "strip", z.ZodTypeAny, {
76
- kind: "alarm-disarmed";
77
- subjects: string[];
78
- personId?: string | undefined;
79
- userId?: string | undefined;
80
- }, {
81
- kind: "alarm-disarmed";
82
- subjects: string[];
83
- personId?: string | undefined;
84
- userId?: string | undefined;
85
- }>;
33
+ }, z.core.$strip>;
86
34
  export declare const sAlarmArmReleasedEvent: z.ZodObject<{
87
35
  kind: z.ZodLiteral<"alarm-arm-released">;
88
36
  userId: z.ZodOptional<z.ZodString>;
89
37
  personId: z.ZodOptional<z.ZodString>;
90
- }, "strip", z.ZodTypeAny, {
91
- kind: "alarm-arm-released";
92
- personId?: string | undefined;
93
- userId?: string | undefined;
94
- }, {
95
- kind: "alarm-arm-released";
96
- personId?: string | undefined;
97
- userId?: string | undefined;
98
- }>;
38
+ }, z.core.$strip>;
99
39
  export declare const sAlarmRearmedEvent: z.ZodObject<{
100
40
  kind: z.ZodLiteral<"alarm-rearmed">;
101
- }, "strip", z.ZodTypeAny, {
102
- kind: "alarm-rearmed";
103
- }, {
104
- kind: "alarm-rearmed";
105
- }>;
41
+ }, z.core.$strip>;
106
42
  export declare const alarmEventSchemasByKind: {
107
43
  readonly 'alarm-triggered': z.ZodObject<{
108
44
  kind: z.ZodLiteral<"alarm-triggered">;
109
45
  alarmId: z.ZodString;
110
- }, "strip", z.ZodTypeAny, {
111
- kind: "alarm-triggered";
112
- alarmId: string;
113
- }, {
114
- kind: "alarm-triggered";
115
- alarmId: string;
116
- }>;
46
+ }, z.core.$strip>;
117
47
  readonly 'alarm-acknowledged': z.ZodObject<{
118
48
  kind: z.ZodLiteral<"alarm-acknowledged">;
119
49
  alarmId: z.ZodString;
120
50
  userId: z.ZodOptional<z.ZodString>;
121
51
  personId: z.ZodOptional<z.ZodString>;
122
- }, "strip", z.ZodTypeAny, {
123
- kind: "alarm-acknowledged";
124
- alarmId: string;
125
- personId?: string | undefined;
126
- userId?: string | undefined;
127
- }, {
128
- kind: "alarm-acknowledged";
129
- alarmId: string;
130
- personId?: string | undefined;
131
- userId?: string | undefined;
132
- }>;
52
+ }, z.core.$strip>;
133
53
  readonly 'alarm-armed-all': z.ZodObject<{
134
54
  kind: z.ZodLiteral<"alarm-armed-all">;
135
55
  userId: z.ZodOptional<z.ZodString>;
136
56
  personId: z.ZodOptional<z.ZodString>;
137
- }, "strip", z.ZodTypeAny, {
138
- kind: "alarm-armed-all";
139
- personId?: string | undefined;
140
- userId?: string | undefined;
141
- }, {
142
- kind: "alarm-armed-all";
143
- personId?: string | undefined;
144
- userId?: string | undefined;
145
- }>;
57
+ }, z.core.$strip>;
146
58
  readonly 'alarm-disarmed-all': z.ZodObject<{
147
59
  kind: z.ZodLiteral<"alarm-disarmed-all">;
148
60
  userId: z.ZodOptional<z.ZodString>;
149
61
  personId: z.ZodOptional<z.ZodString>;
150
- }, "strip", z.ZodTypeAny, {
151
- kind: "alarm-disarmed-all";
152
- personId?: string | undefined;
153
- userId?: string | undefined;
154
- }, {
155
- kind: "alarm-disarmed-all";
156
- personId?: string | undefined;
157
- userId?: string | undefined;
158
- }>;
62
+ }, z.core.$strip>;
159
63
  readonly 'alarm-armed': z.ZodObject<{
160
64
  kind: z.ZodLiteral<"alarm-armed">;
161
- subjects: z.ZodArray<z.ZodString, "many">;
65
+ subjects: z.ZodArray<z.ZodString>;
162
66
  userId: z.ZodOptional<z.ZodString>;
163
67
  personId: z.ZodOptional<z.ZodString>;
164
- }, "strip", z.ZodTypeAny, {
165
- kind: "alarm-armed";
166
- subjects: string[];
167
- personId?: string | undefined;
168
- userId?: string | undefined;
169
- }, {
170
- kind: "alarm-armed";
171
- subjects: string[];
172
- personId?: string | undefined;
173
- userId?: string | undefined;
174
- }>;
68
+ }, z.core.$strip>;
175
69
  readonly 'alarm-disarmed': z.ZodObject<{
176
70
  kind: z.ZodLiteral<"alarm-disarmed">;
177
- subjects: z.ZodArray<z.ZodString, "many">;
71
+ subjects: z.ZodArray<z.ZodString>;
178
72
  userId: z.ZodOptional<z.ZodString>;
179
73
  personId: z.ZodOptional<z.ZodString>;
180
- }, "strip", z.ZodTypeAny, {
181
- kind: "alarm-disarmed";
182
- subjects: string[];
183
- personId?: string | undefined;
184
- userId?: string | undefined;
185
- }, {
186
- kind: "alarm-disarmed";
187
- subjects: string[];
188
- personId?: string | undefined;
189
- userId?: string | undefined;
190
- }>;
74
+ }, z.core.$strip>;
191
75
  readonly 'alarm-arm-released': z.ZodObject<{
192
76
  kind: z.ZodLiteral<"alarm-arm-released">;
193
77
  userId: z.ZodOptional<z.ZodString>;
194
78
  personId: z.ZodOptional<z.ZodString>;
195
- }, "strip", z.ZodTypeAny, {
196
- kind: "alarm-arm-released";
197
- personId?: string | undefined;
198
- userId?: string | undefined;
199
- }, {
200
- kind: "alarm-arm-released";
201
- personId?: string | undefined;
202
- userId?: string | undefined;
203
- }>;
79
+ }, z.core.$strip>;
204
80
  readonly 'alarm-rearmed': z.ZodObject<{
205
81
  kind: z.ZodLiteral<"alarm-rearmed">;
206
- }, "strip", z.ZodTypeAny, {
207
- kind: "alarm-rearmed";
208
- }, {
209
- kind: "alarm-rearmed";
210
- }>;
82
+ }, z.core.$strip>;
211
83
  };
212
84
  export type AlarmTriggeredEvent = z.infer<typeof sAlarmTriggeredEvent>;
213
85
  export type AlarmAcknowledgedEvent = z.infer<typeof sAlarmAcknowledgedEvent>;