@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
@@ -3,15 +3,7 @@ export declare const sAutomationRuleCommand: z.ZodObject<{
3
3
  command: z.ZodString;
4
4
  target: z.ZodString;
5
5
  params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
6
- }, "strip", z.ZodTypeAny, {
7
- params: Record<string, unknown>;
8
- command: string;
9
- target: string;
10
- }, {
11
- params: Record<string, unknown>;
12
- command: string;
13
- target: string;
14
- }>;
6
+ }, z.core.$strip>;
15
7
  export declare const sAutomationRuleBody: z.ZodObject<{
16
8
  onEvent: z.ZodString;
17
9
  runIf: z.ZodOptional<z.ZodString>;
@@ -19,32 +11,8 @@ export declare const sAutomationRuleBody: z.ZodObject<{
19
11
  command: z.ZodString;
20
12
  target: z.ZodString;
21
13
  params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
22
- }, "strip", z.ZodTypeAny, {
23
- params: Record<string, unknown>;
24
- command: string;
25
- target: string;
26
- }, {
27
- params: Record<string, unknown>;
28
- command: string;
29
- target: string;
30
- }>, "many">;
31
- }, "strip", z.ZodTypeAny, {
32
- onEvent: string;
33
- commands: {
34
- params: Record<string, unknown>;
35
- command: string;
36
- target: string;
37
- }[];
38
- runIf?: string | undefined;
39
- }, {
40
- onEvent: string;
41
- commands: {
42
- params: Record<string, unknown>;
43
- command: string;
44
- target: string;
45
- }[];
46
- runIf?: string | undefined;
47
- }>;
14
+ }, z.core.$strip>>;
15
+ }, z.core.$strip>;
48
16
  export declare const sAutomationRuleProps: z.ZodObject<{
49
17
  displayName: z.ZodString;
50
18
  description: z.ZodOptional<z.ZodString>;
@@ -56,74 +24,14 @@ export declare const sAutomationRuleProps: z.ZodObject<{
56
24
  command: z.ZodString;
57
25
  target: z.ZodString;
58
26
  params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
59
- }, "strip", z.ZodTypeAny, {
60
- params: Record<string, unknown>;
61
- command: string;
62
- target: string;
63
- }, {
64
- params: Record<string, unknown>;
65
- command: string;
66
- target: string;
67
- }>, "many">;
68
- }, "strip", z.ZodTypeAny, {
69
- onEvent: string;
70
- commands: {
71
- params: Record<string, unknown>;
72
- command: string;
73
- target: string;
74
- }[];
75
- runIf?: string | undefined;
76
- }, {
77
- onEvent: string;
78
- commands: {
79
- params: Record<string, unknown>;
80
- command: string;
81
- target: string;
82
- }[];
83
- runIf?: string | undefined;
84
- }>;
27
+ }, z.core.$strip>>;
28
+ }, z.core.$strip>;
85
29
  enabled: z.ZodBoolean;
86
30
  exclusivityGroup: z.ZodNullable<z.ZodString>;
87
31
  score: z.ZodNullable<z.ZodNumber>;
88
32
  module: z.ZodNullable<z.ZodString>;
89
33
  metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
90
- }, "strip", z.ZodTypeAny, {
91
- code: string | null;
92
- displayName: string;
93
- body: {
94
- onEvent: string;
95
- commands: {
96
- params: Record<string, unknown>;
97
- command: string;
98
- target: string;
99
- }[];
100
- runIf?: string | undefined;
101
- };
102
- enabled: boolean;
103
- exclusivityGroup: string | null;
104
- score: number | null;
105
- module: string | null;
106
- metadata: Record<string, unknown>;
107
- description?: string | undefined;
108
- }, {
109
- code: string | null;
110
- displayName: string;
111
- body: {
112
- onEvent: string;
113
- commands: {
114
- params: Record<string, unknown>;
115
- command: string;
116
- target: string;
117
- }[];
118
- runIf?: string | undefined;
119
- };
120
- enabled: boolean;
121
- exclusivityGroup: string | null;
122
- score: number | null;
123
- module: string | null;
124
- metadata: Record<string, unknown>;
125
- description?: string | undefined;
126
- }>;
34
+ }, z.core.$strip>;
127
35
  export declare const sAutomationRuleDto: z.ZodObject<{
128
36
  displayName: z.ZodString;
129
37
  description: z.ZodOptional<z.ZodString>;
@@ -135,84 +43,17 @@ export declare const sAutomationRuleDto: z.ZodObject<{
135
43
  command: z.ZodString;
136
44
  target: z.ZodString;
137
45
  params: z.ZodRecord<z.ZodString, z.ZodUnknown>;
138
- }, "strip", z.ZodTypeAny, {
139
- params: Record<string, unknown>;
140
- command: string;
141
- target: string;
142
- }, {
143
- params: Record<string, unknown>;
144
- command: string;
145
- target: string;
146
- }>, "many">;
147
- }, "strip", z.ZodTypeAny, {
148
- onEvent: string;
149
- commands: {
150
- params: Record<string, unknown>;
151
- command: string;
152
- target: string;
153
- }[];
154
- runIf?: string | undefined;
155
- }, {
156
- onEvent: string;
157
- commands: {
158
- params: Record<string, unknown>;
159
- command: string;
160
- target: string;
161
- }[];
162
- runIf?: string | undefined;
163
- }>;
46
+ }, z.core.$strip>>;
47
+ }, z.core.$strip>;
164
48
  enabled: z.ZodBoolean;
165
49
  exclusivityGroup: z.ZodNullable<z.ZodString>;
166
50
  score: z.ZodNullable<z.ZodNumber>;
167
51
  module: z.ZodNullable<z.ZodString>;
168
52
  metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
169
- } & {
170
53
  id: z.ZodString;
171
54
  createdOn: z.ZodString;
172
55
  lastModifiedOn: z.ZodString;
173
- }, "strip", z.ZodTypeAny, {
174
- code: string | null;
175
- id: string;
176
- displayName: string;
177
- createdOn: string;
178
- lastModifiedOn: string;
179
- body: {
180
- onEvent: string;
181
- commands: {
182
- params: Record<string, unknown>;
183
- command: string;
184
- target: string;
185
- }[];
186
- runIf?: string | undefined;
187
- };
188
- enabled: boolean;
189
- exclusivityGroup: string | null;
190
- score: number | null;
191
- module: string | null;
192
- metadata: Record<string, unknown>;
193
- description?: string | undefined;
194
- }, {
195
- code: string | null;
196
- id: string;
197
- displayName: string;
198
- createdOn: string;
199
- lastModifiedOn: string;
200
- body: {
201
- onEvent: string;
202
- commands: {
203
- params: Record<string, unknown>;
204
- command: string;
205
- target: string;
206
- }[];
207
- runIf?: string | undefined;
208
- };
209
- enabled: boolean;
210
- exclusivityGroup: string | null;
211
- score: number | null;
212
- module: string | null;
213
- metadata: Record<string, unknown>;
214
- description?: string | undefined;
215
- }>;
56
+ }, z.core.$strip>;
216
57
  export type AutomationRuleBody = z.infer<typeof sAutomationRuleBody>;
217
58
  export type AutomationRuleProps = z.infer<typeof sAutomationRuleProps>;
218
59
  export type AutomationRuleDto = z.infer<typeof sAutomationRuleDto>;
@@ -6,7 +6,7 @@ exports.sAutomationRuleCommand = zod_1.z.object({
6
6
  command: zod_1.z.string().nonempty().describe('The command to be executed'),
7
7
  target: zod_1.z.string().nonempty().describe('The target of the command'),
8
8
  params: zod_1.z
9
- .record(zod_1.z.unknown())
9
+ .record(zod_1.z.string(), zod_1.z.unknown())
10
10
  .describe('The parameters of the command depending on what it is'),
11
11
  });
12
12
  exports.sAutomationRuleBody = zod_1.z.object({
@@ -43,7 +43,7 @@ exports.sAutomationRuleProps = zod_1.z.object({
43
43
  .string()
44
44
  .nullable()
45
45
  .describe('The module the automation rule belongs to'),
46
- metadata: zod_1.z.record(zod_1.z.unknown()),
46
+ metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
47
47
  });
48
48
  exports.sAutomationRuleDto = exports.sAutomationRuleProps.merge(zod_1.z.object({
49
49
  id: zod_1.z.string().describe('The ID of the automation rule'),
@@ -4,47 +4,17 @@ export declare const sBookmarkProps: z.ZodObject<{
4
4
  label: z.ZodString;
5
5
  deviceId: z.ZodString;
6
6
  metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
7
- }, "strip", z.ZodTypeAny, {
8
- deviceId: string;
9
- metadata: Record<string, unknown>;
10
- timestamp: number;
11
- label: string;
12
- }, {
13
- deviceId: string;
14
- metadata: Record<string, unknown>;
15
- timestamp: number;
16
- label: string;
17
- }>;
7
+ }, z.core.$strip>;
18
8
  export declare const sBookmarkDto: z.ZodIntersection<z.ZodObject<{
19
9
  timestamp: z.ZodNumber;
20
10
  label: z.ZodString;
21
11
  deviceId: z.ZodString;
22
12
  metadata: z.ZodRecord<z.ZodString, z.ZodUnknown>;
23
- }, "strip", z.ZodTypeAny, {
24
- deviceId: string;
25
- metadata: Record<string, unknown>;
26
- timestamp: number;
27
- label: string;
28
- }, {
29
- deviceId: string;
30
- metadata: Record<string, unknown>;
31
- timestamp: number;
32
- label: string;
33
- }>, z.ZodObject<{
13
+ }, z.core.$strip>, z.ZodObject<{
34
14
  id: z.ZodString;
35
15
  createdBy: z.ZodString;
36
16
  createdOn: z.ZodString;
37
17
  lastModifiedOn: z.ZodString;
38
- }, "strip", z.ZodTypeAny, {
39
- id: string;
40
- createdOn: string;
41
- lastModifiedOn: string;
42
- createdBy: string;
43
- }, {
44
- id: string;
45
- createdOn: string;
46
- lastModifiedOn: string;
47
- createdBy: string;
48
- }>>;
18
+ }, z.core.$strip>>;
49
19
  export type BookmarkProps = z.infer<typeof sBookmarkProps>;
50
20
  export type BookmarkDto = z.infer<typeof sBookmarkDto>;
@@ -6,7 +6,7 @@ exports.sBookmarkProps = zod_1.z.object({
6
6
  timestamp: zod_1.z.number().min(0),
7
7
  label: zod_1.z.string().nonempty(),
8
8
  deviceId: zod_1.z.string().nonempty(),
9
- metadata: zod_1.z.record(zod_1.z.unknown()),
9
+ metadata: zod_1.z.record(zod_1.z.string(), zod_1.z.unknown()),
10
10
  });
11
11
  exports.sBookmarkDto = exports.sBookmarkProps.and(zod_1.z.object({
12
12
  id: zod_1.z.string().nonempty(),
@@ -1,19 +1,19 @@
1
1
  import z from 'zod';
2
- export declare const sCredentialType: z.ZodEnum<["card", "pin", "fingerprint"]>;
3
- export declare const sCredentialValue: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
2
+ export declare const sCredentialType: z.ZodEnum<{
3
+ card: "card";
4
+ pin: "pin";
5
+ fingerprint: "fingerprint";
6
+ }>;
7
+ export declare const sCredentialValue: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
4
8
  export declare const sAssignedCredential: z.ZodObject<{
5
- type: z.ZodEnum<["card", "pin", "fingerprint"]>;
6
- value: z.ZodUnion<[z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
9
+ type: z.ZodEnum<{
10
+ card: "card";
11
+ pin: "pin";
12
+ fingerprint: "fingerprint";
13
+ }>;
14
+ value: z.ZodUnion<readonly [z.ZodString, z.ZodRecord<z.ZodString, z.ZodUnknown>]>;
7
15
  note: z.ZodNullable<z.ZodString>;
8
- }, "strip", z.ZodTypeAny, {
9
- value: string | Record<string, unknown>;
10
- type: "card" | "pin" | "fingerprint";
11
- note: string | null;
12
- }, {
13
- value: string | Record<string, unknown>;
14
- type: "card" | "pin" | "fingerprint";
15
- note: string | null;
16
- }>;
16
+ }, z.core.$strip>;
17
17
  export type CredentialType = z.infer<typeof sCredentialType>;
18
18
  export type CredentialValue = z.infer<typeof sCredentialValue>;
19
19
  export type AssignedCredential = z.infer<typeof sAssignedCredential>;
@@ -8,7 +8,7 @@ const zod_1 = __importDefault(require("zod"));
8
8
  exports.sCredentialType = zod_1.default.enum(['card', 'pin', 'fingerprint']);
9
9
  exports.sCredentialValue = zod_1.default.union([
10
10
  zod_1.default.string().nonempty(),
11
- zod_1.default.record(zod_1.default.unknown()),
11
+ zod_1.default.record(zod_1.default.string(), zod_1.default.unknown()),
12
12
  ]);
13
13
  exports.sAssignedCredential = zod_1.default.object({
14
14
  type: exports.sCredentialType,
@@ -1,20 +1,24 @@
1
1
  import { z } from 'zod';
2
- export declare const CustomFieldTypeEnum: z.ZodEnum<["string", "number", "boolean", "date"]>;
3
- export declare const CustomFieldExtendsTypeEnum: z.ZodEnum<["person"]>;
2
+ export declare const CustomFieldTypeEnum: z.ZodEnum<{
3
+ string: "string";
4
+ number: "number";
5
+ boolean: "boolean";
6
+ date: "date";
7
+ }>;
8
+ export declare const CustomFieldExtendsTypeEnum: z.ZodEnum<{
9
+ person: "person";
10
+ }>;
4
11
  export declare const sCustomFieldDto: z.ZodObject<{
5
12
  id: z.ZodString;
6
13
  name: z.ZodString;
7
- type: z.ZodEnum<["string", "number", "boolean", "date"]>;
8
- extendsType: z.ZodEnum<["person"]>;
9
- }, "strip", z.ZodTypeAny, {
10
- type: "string" | "number" | "boolean" | "date";
11
- id: string;
12
- name: string;
13
- extendsType: "person";
14
- }, {
15
- type: "string" | "number" | "boolean" | "date";
16
- id: string;
17
- name: string;
18
- extendsType: "person";
19
- }>;
14
+ type: z.ZodEnum<{
15
+ string: "string";
16
+ number: "number";
17
+ boolean: "boolean";
18
+ date: "date";
19
+ }>;
20
+ extendsType: z.ZodEnum<{
21
+ person: "person";
22
+ }>;
23
+ }, z.core.$strip>;
20
24
  export type CustomFieldDto = z.infer<typeof sCustomFieldDto>;
@@ -1,6 +1,6 @@
1
1
  import { z } from 'zod';
2
2
  export declare const ALARM: "alarm";
3
- export declare const sAlarmSpecs: z.ZodObject<{}, "strip", z.ZodTypeAny, {}, {}>;
3
+ export declare const sAlarmSpecs: z.ZodObject<{}, z.core.$strip>;
4
4
  export type AlarmSpecs = z.infer<typeof sAlarmSpecs>;
5
5
  export type AlarmStateDto = {
6
6
  activeAlarmId: string | null;