@awarevue/api-types 1.0.1

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 (132) hide show
  1. package/dist/access-control/access-rule.d.ts +243 -0
  2. package/dist/access-control/access-rule.js +49 -0
  3. package/dist/access-control/credential.d.ts +14 -0
  4. package/dist/access-control/credential.js +12 -0
  5. package/dist/access-control/index.d.ts +7 -0
  6. package/dist/access-control/index.js +23 -0
  7. package/dist/access-control/person-presence.d.ts +249 -0
  8. package/dist/access-control/person-presence.js +61 -0
  9. package/dist/access-control/person.d.ts +209 -0
  10. package/dist/access-control/person.js +49 -0
  11. package/dist/access-control/schedule.d.ts +500 -0
  12. package/dist/access-control/schedule.js +65 -0
  13. package/dist/access-control/sync.d.ts +3 -0
  14. package/dist/access-control/sync.js +2 -0
  15. package/dist/access-control/zone.d.ts +65 -0
  16. package/dist/access-control/zone.js +28 -0
  17. package/dist/agent-communication/index.d.ts +1 -0
  18. package/dist/agent-communication/index.js +17 -0
  19. package/dist/agent-communication/protocol.d.ts +1692 -0
  20. package/dist/agent-communication/protocol.js +341 -0
  21. package/dist/api/alarm.d.ts +23 -0
  22. package/dist/api/alarm.js +2 -0
  23. package/dist/api/auth.d.ts +31 -0
  24. package/dist/api/auth.js +19 -0
  25. package/dist/api/index.d.ts +4 -0
  26. package/dist/api/index.js +20 -0
  27. package/dist/api/media.d.ts +187 -0
  28. package/dist/api/media.js +59 -0
  29. package/dist/api/query.d.ts +33 -0
  30. package/dist/api/query.js +41 -0
  31. package/dist/app.d.ts +12 -0
  32. package/dist/app.js +8 -0
  33. package/dist/automation.d.ts +334 -0
  34. package/dist/automation.js +49 -0
  35. package/dist/aware-config.d.ts +3 -0
  36. package/dist/aware-config.js +2 -0
  37. package/dist/custom-field.d.ts +52 -0
  38. package/dist/custom-field.js +19 -0
  39. package/dist/device/alarm.d.ts +265 -0
  40. package/dist/device/alarm.js +66 -0
  41. package/dist/device/any-device.d.ts +2376 -0
  42. package/dist/device/any-device.js +185 -0
  43. package/dist/device/camera-lift.d.ts +17 -0
  44. package/dist/device/camera-lift.js +7 -0
  45. package/dist/device/camera.d.ts +829 -0
  46. package/dist/device/camera.js +120 -0
  47. package/dist/device/device-gateway.d.ts +3 -0
  48. package/dist/device/device-gateway.js +4 -0
  49. package/dist/device/door.d.ts +217 -0
  50. package/dist/device/door.js +57 -0
  51. package/dist/device/index.d.ts +15 -0
  52. package/dist/device/index.js +31 -0
  53. package/dist/device/intercom-operator.d.ts +13 -0
  54. package/dist/device/intercom-operator.js +5 -0
  55. package/dist/device/intercom-terminal.d.ts +244 -0
  56. package/dist/device/intercom-terminal.js +48 -0
  57. package/dist/device/io-board.d.ts +55 -0
  58. package/dist/device/io-board.js +19 -0
  59. package/dist/device/motion-sensor.d.ts +8 -0
  60. package/dist/device/motion-sensor.js +8 -0
  61. package/dist/device/panic-button.d.ts +26 -0
  62. package/dist/device/panic-button.js +14 -0
  63. package/dist/device/pbx.d.ts +20 -0
  64. package/dist/device/pbx.js +11 -0
  65. package/dist/device/presence-tracker.d.ts +127 -0
  66. package/dist/device/presence-tracker.js +27 -0
  67. package/dist/device/reader/commands.d.ts +1 -0
  68. package/dist/device/reader/commands.js +2 -0
  69. package/dist/device/reader/events.d.ts +37 -0
  70. package/dist/device/reader/events.js +13 -0
  71. package/dist/device/reader/index.d.ts +3 -0
  72. package/dist/device/reader/index.js +19 -0
  73. package/dist/device/reader/specs.d.ts +2 -0
  74. package/dist/device/reader/specs.js +4 -0
  75. package/dist/device/server.d.ts +73 -0
  76. package/dist/device/server.js +33 -0
  77. package/dist/device-command.d.ts +23 -0
  78. package/dist/device-command.js +110 -0
  79. package/dist/device-event.d.ts +682 -0
  80. package/dist/device-event.js +87 -0
  81. package/dist/device-factory.d.ts +112 -0
  82. package/dist/device-factory.js +25 -0
  83. package/dist/device-group.d.ts +74 -0
  84. package/dist/device-group.js +31 -0
  85. package/dist/device-import.d.ts +1412 -0
  86. package/dist/device-import.js +33 -0
  87. package/dist/device-relation.d.ts +30 -0
  88. package/dist/device-relation.js +68 -0
  89. package/dist/device-state.d.ts +10 -0
  90. package/dist/device-state.js +2 -0
  91. package/dist/error.d.ts +13 -0
  92. package/dist/error.js +10 -0
  93. package/dist/file.d.ts +3 -0
  94. package/dist/file.js +2 -0
  95. package/dist/index.d.ts +28 -0
  96. package/dist/index.js +44 -0
  97. package/dist/layout.d.ts +188 -0
  98. package/dist/layout.js +40 -0
  99. package/dist/macros.d.ts +160 -0
  100. package/dist/macros.js +26 -0
  101. package/dist/messages/device-communication.d.ts +121 -0
  102. package/dist/messages/device-communication.js +63 -0
  103. package/dist/messages/index.d.ts +5 -0
  104. package/dist/messages/index.js +21 -0
  105. package/dist/messages/progress.d.ts +118 -0
  106. package/dist/messages/progress.js +51 -0
  107. package/dist/messages/provider-api/index.d.ts +1 -0
  108. package/dist/messages/provider-api/index.js +17 -0
  109. package/dist/messages/provider-api/sync-protocol.d.ts +83 -0
  110. package/dist/messages/provider-api/sync-protocol.js +2 -0
  111. package/dist/messages/web-rtc-signaling.d.ts +265 -0
  112. package/dist/messages/web-rtc-signaling.js +82 -0
  113. package/dist/messages/web-socket.d.ts +7 -0
  114. package/dist/messages/web-socket.js +5 -0
  115. package/dist/milestone.d.ts +5 -0
  116. package/dist/milestone.js +2 -0
  117. package/dist/module-config.d.ts +27 -0
  118. package/dist/module-config.js +2 -0
  119. package/dist/orchid.d.ts +19 -0
  120. package/dist/orchid.js +2 -0
  121. package/dist/package.json +40 -0
  122. package/dist/permissions.d.ts +6 -0
  123. package/dist/permissions.js +168 -0
  124. package/dist/template.d.ts +50 -0
  125. package/dist/template.js +21 -0
  126. package/dist/user.d.ts +184 -0
  127. package/dist/user.js +56 -0
  128. package/dist/view.d.ts +775 -0
  129. package/dist/view.js +74 -0
  130. package/dist/webrtc-playback.d.ts +20 -0
  131. package/dist/webrtc-playback.js +14 -0
  132. package/package.json +40 -0
@@ -0,0 +1,209 @@
1
+ import z from 'zod';
2
+ export declare const sPersonAccessRule: z.ZodObject<{
3
+ id: z.ZodString;
4
+ displayName: z.ZodString;
5
+ }, "strip", z.ZodTypeAny, {
6
+ id: string;
7
+ displayName: string;
8
+ }, {
9
+ id: string;
10
+ displayName: string;
11
+ }>;
12
+ export declare const sPersonDto: z.ZodObject<{
13
+ id: z.ZodString;
14
+ firstName: z.ZodString;
15
+ lastName: z.ZodString;
16
+ position: z.ZodNullable<z.ZodString>;
17
+ validFrom: z.ZodNullable<z.ZodString>;
18
+ validTo: z.ZodNullable<z.ZodString>;
19
+ accessSuspended: z.ZodBoolean;
20
+ archived: z.ZodBoolean;
21
+ staffMember: z.ZodBoolean;
22
+ createdOn: z.ZodString;
23
+ lastModifiedOn: z.ZodString;
24
+ avatarId: z.ZodNullable<z.ZodString>;
25
+ credentials: z.ZodArray<z.ZodObject<{
26
+ type: z.ZodEnum<["card", "pin", "login-password"]>;
27
+ value: z.ZodString;
28
+ }, "strip", z.ZodTypeAny, {
29
+ type: "card" | "pin" | "login-password";
30
+ value: string;
31
+ }, {
32
+ type: "card" | "pin" | "login-password";
33
+ value: string;
34
+ }>, "many">;
35
+ accessRules: z.ZodArray<z.ZodObject<{
36
+ id: z.ZodString;
37
+ displayName: z.ZodString;
38
+ }, "strip", z.ZodTypeAny, {
39
+ id: string;
40
+ displayName: string;
41
+ }, {
42
+ id: string;
43
+ displayName: string;
44
+ }>, "many">;
45
+ customFields: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
46
+ refs: z.ZodRecord<z.ZodString, z.ZodString>;
47
+ version: z.ZodNumber;
48
+ }, "strip", z.ZodTypeAny, {
49
+ id: string;
50
+ position: string | null;
51
+ version: number;
52
+ createdOn: string;
53
+ lastModifiedOn: string;
54
+ firstName: string;
55
+ lastName: string;
56
+ avatarId: string | null;
57
+ refs: Record<string, string>;
58
+ validFrom: string | null;
59
+ validTo: string | null;
60
+ accessSuspended: boolean;
61
+ archived: boolean;
62
+ staffMember: boolean;
63
+ credentials: {
64
+ type: "card" | "pin" | "login-password";
65
+ value: string;
66
+ }[];
67
+ accessRules: {
68
+ id: string;
69
+ displayName: string;
70
+ }[];
71
+ customFields: Record<string, string> | null;
72
+ }, {
73
+ id: string;
74
+ position: string | null;
75
+ version: number;
76
+ createdOn: string;
77
+ lastModifiedOn: string;
78
+ firstName: string;
79
+ lastName: string;
80
+ avatarId: string | null;
81
+ refs: Record<string, string>;
82
+ validFrom: string | null;
83
+ validTo: string | null;
84
+ accessSuspended: boolean;
85
+ archived: boolean;
86
+ staffMember: boolean;
87
+ credentials: {
88
+ type: "card" | "pin" | "login-password";
89
+ value: string;
90
+ }[];
91
+ accessRules: {
92
+ id: string;
93
+ displayName: string;
94
+ }[];
95
+ customFields: Record<string, string> | null;
96
+ }>;
97
+ export declare const sCreatePersonRequest: z.ZodObject<{
98
+ firstName: z.ZodString;
99
+ lastName: z.ZodString;
100
+ position: z.ZodNullable<z.ZodString>;
101
+ accessSuspended: z.ZodBoolean;
102
+ staffMember: z.ZodBoolean;
103
+ validFrom: z.ZodNullable<z.ZodString>;
104
+ validTo: z.ZodNullable<z.ZodString>;
105
+ avatarId: z.ZodNullable<z.ZodString>;
106
+ credentials: z.ZodArray<z.ZodObject<{
107
+ type: z.ZodEnum<["card", "pin", "login-password"]>;
108
+ value: z.ZodString;
109
+ }, "strip", z.ZodTypeAny, {
110
+ type: "card" | "pin" | "login-password";
111
+ value: string;
112
+ }, {
113
+ type: "card" | "pin" | "login-password";
114
+ value: string;
115
+ }>, "many">;
116
+ accessRules: z.ZodArray<z.ZodString, "many">;
117
+ customFields: z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>;
118
+ }, "strip", z.ZodTypeAny, {
119
+ position: string | null;
120
+ firstName: string;
121
+ lastName: string;
122
+ avatarId: string | null;
123
+ validFrom: string | null;
124
+ validTo: string | null;
125
+ accessSuspended: boolean;
126
+ staffMember: boolean;
127
+ credentials: {
128
+ type: "card" | "pin" | "login-password";
129
+ value: string;
130
+ }[];
131
+ accessRules: string[];
132
+ customFields: Record<string, string> | null;
133
+ }, {
134
+ position: string | null;
135
+ firstName: string;
136
+ lastName: string;
137
+ avatarId: string | null;
138
+ validFrom: string | null;
139
+ validTo: string | null;
140
+ accessSuspended: boolean;
141
+ staffMember: boolean;
142
+ credentials: {
143
+ type: "card" | "pin" | "login-password";
144
+ value: string;
145
+ }[];
146
+ accessRules: string[];
147
+ customFields: Record<string, string> | null;
148
+ }>;
149
+ export declare const sUpdatePersonRequest: z.ZodObject<{
150
+ firstName: z.ZodOptional<z.ZodString>;
151
+ lastName: z.ZodOptional<z.ZodString>;
152
+ position: z.ZodOptional<z.ZodNullable<z.ZodString>>;
153
+ accessSuspended: z.ZodOptional<z.ZodBoolean>;
154
+ staffMember: z.ZodOptional<z.ZodBoolean>;
155
+ validFrom: z.ZodOptional<z.ZodNullable<z.ZodString>>;
156
+ validTo: z.ZodOptional<z.ZodNullable<z.ZodString>>;
157
+ avatarId: z.ZodOptional<z.ZodNullable<z.ZodString>>;
158
+ credentials: z.ZodOptional<z.ZodArray<z.ZodObject<{
159
+ type: z.ZodEnum<["card", "pin", "login-password"]>;
160
+ value: z.ZodString;
161
+ }, "strip", z.ZodTypeAny, {
162
+ type: "card" | "pin" | "login-password";
163
+ value: string;
164
+ }, {
165
+ type: "card" | "pin" | "login-password";
166
+ value: string;
167
+ }>, "many">>;
168
+ accessRules: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
169
+ customFields: z.ZodOptional<z.ZodNullable<z.ZodRecord<z.ZodString, z.ZodString>>>;
170
+ archived: z.ZodOptional<z.ZodBoolean>;
171
+ }, "strip", z.ZodTypeAny, {
172
+ position?: string | null | undefined;
173
+ firstName?: string | undefined;
174
+ lastName?: string | undefined;
175
+ avatarId?: string | null | undefined;
176
+ validFrom?: string | null | undefined;
177
+ validTo?: string | null | undefined;
178
+ accessSuspended?: boolean | undefined;
179
+ archived?: boolean | undefined;
180
+ staffMember?: boolean | undefined;
181
+ credentials?: {
182
+ type: "card" | "pin" | "login-password";
183
+ value: string;
184
+ }[] | undefined;
185
+ accessRules?: string[] | undefined;
186
+ customFields?: Record<string, string> | null | undefined;
187
+ }, {
188
+ position?: string | null | undefined;
189
+ firstName?: string | undefined;
190
+ lastName?: string | undefined;
191
+ avatarId?: string | null | undefined;
192
+ validFrom?: string | null | undefined;
193
+ validTo?: string | null | undefined;
194
+ accessSuspended?: boolean | undefined;
195
+ archived?: boolean | undefined;
196
+ staffMember?: boolean | undefined;
197
+ credentials?: {
198
+ type: "card" | "pin" | "login-password";
199
+ value: string;
200
+ }[] | undefined;
201
+ accessRules?: string[] | undefined;
202
+ customFields?: Record<string, string> | null | undefined;
203
+ }>;
204
+ export type PersonAccessRuleDto = z.infer<typeof sPersonAccessRule>;
205
+ export type PersonDto = z.infer<typeof sPersonDto>;
206
+ export type CreatePersonRequest = z.infer<typeof sCreatePersonRequest>;
207
+ export type UpdatePersonRequest = {
208
+ id: string;
209
+ } & z.infer<typeof sUpdatePersonRequest>;
@@ -0,0 +1,49 @@
1
+ "use strict";
2
+ var __importDefault = (this && this.__importDefault) || function (mod) {
3
+ return (mod && mod.__esModule) ? mod : { "default": mod };
4
+ };
5
+ Object.defineProperty(exports, "__esModule", { value: true });
6
+ exports.sUpdatePersonRequest = exports.sCreatePersonRequest = exports.sPersonDto = exports.sPersonAccessRule = void 0;
7
+ const credential_1 = require("./credential");
8
+ const zod_1 = __importDefault(require("zod"));
9
+ exports.sPersonAccessRule = zod_1.default.object({
10
+ id: zod_1.default.string(),
11
+ displayName: zod_1.default.string(),
12
+ });
13
+ exports.sPersonDto = zod_1.default.object({
14
+ id: zod_1.default.string(),
15
+ firstName: zod_1.default.string().min(1).max(64),
16
+ lastName: zod_1.default.string().min(1).max(64),
17
+ position: zod_1.default.string().nullable(),
18
+ validFrom: zod_1.default.string().datetime().nullable(),
19
+ validTo: zod_1.default.string().datetime().nullable(),
20
+ accessSuspended: zod_1.default.boolean(),
21
+ archived: zod_1.default.boolean(),
22
+ staffMember: zod_1.default.boolean(),
23
+ createdOn: zod_1.default.string(),
24
+ lastModifiedOn: zod_1.default.string(),
25
+ avatarId: zod_1.default.string().nullable(),
26
+ credentials: zod_1.default.array(credential_1.sAssignedCredential),
27
+ accessRules: zod_1.default.array(exports.sPersonAccessRule),
28
+ customFields: zod_1.default.record(zod_1.default.string()).nullable(),
29
+ refs: zod_1.default.record(zod_1.default.string()),
30
+ version: zod_1.default.number(),
31
+ });
32
+ exports.sCreatePersonRequest = zod_1.default.object({
33
+ firstName: zod_1.default.string().min(1).max(64),
34
+ lastName: zod_1.default.string().min(1).max(64),
35
+ position: zod_1.default.string().nullable(),
36
+ accessSuspended: zod_1.default.boolean(),
37
+ staffMember: zod_1.default.boolean(),
38
+ validFrom: zod_1.default.string().datetime().nullable(),
39
+ validTo: zod_1.default.string().datetime().nullable(),
40
+ avatarId: zod_1.default.string().nullable(),
41
+ credentials: zod_1.default.array(credential_1.sAssignedCredential),
42
+ accessRules: zod_1.default.array(zod_1.default.string().nonempty()),
43
+ customFields: zod_1.default.record(zod_1.default.string()).nullable(),
44
+ });
45
+ exports.sUpdatePersonRequest = exports.sCreatePersonRequest
46
+ .extend({
47
+ archived: zod_1.default.boolean(),
48
+ })
49
+ .partial();