@seamapi/http 2.23.6 → 2.24.0
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/README.md +5 -0
- package/lib/request-parameters.d.ts +1 -1
- package/lib/request-parameters.js +3 -3
- package/lib/request-parameters.js.map +1 -1
- package/lib/resolve-action-attempt.d.ts +2 -0
- package/lib/resolve-action-attempt.js +25 -27
- package/lib/resolve-action-attempt.js.map +1 -1
- package/lib/routes/access-codes/access-codes.d.ts +5 -5
- package/lib/routes/access-codes/access-codes.js +20 -1
- package/lib/routes/access-codes/access-codes.js.map +1 -1
- package/lib/routes/access-codes/simulate/simulate.d.ts +2 -2
- package/lib/routes/access-codes/simulate/simulate.js +2 -1
- package/lib/routes/access-codes/simulate/simulate.js.map +1 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/access-codes/unmanaged/unmanaged.js +6 -1
- package/lib/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-grants/access-grants.d.ts +6 -6
- package/lib/routes/access-grants/access-grants.js +19 -1
- package/lib/routes/access-grants/access-grants.js.map +1 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/access-grants/unmanaged/unmanaged.js +4 -1
- package/lib/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/access-methods/access-methods.d.ts +5 -5
- package/lib/routes/access-methods/access-methods.js +22 -4
- package/lib/routes/access-methods/access-methods.js.map +1 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.d.ts +2 -2
- package/lib/routes/access-methods/unmanaged/unmanaged.js +3 -1
- package/lib/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/acs/access-groups/access-groups.d.ts +2 -2
- package/lib/routes/acs/access-groups/access-groups.js +8 -1
- package/lib/routes/acs/access-groups/access-groups.js.map +1 -1
- package/lib/routes/acs/acs.d.ts +2 -2
- package/lib/routes/acs/acs.js.map +1 -1
- package/lib/routes/acs/credentials/credentials.d.ts +3 -3
- package/lib/routes/acs/credentials/credentials.js +9 -1
- package/lib/routes/acs/credentials/credentials.js.map +1 -1
- package/lib/routes/acs/encoders/encoders.d.ts +3 -3
- package/lib/routes/acs/encoders/encoders.js +9 -4
- package/lib/routes/acs/encoders/encoders.js.map +1 -1
- package/lib/routes/acs/encoders/simulate/simulate.d.ts +2 -2
- package/lib/routes/acs/encoders/simulate/simulate.js +5 -1
- package/lib/routes/acs/encoders/simulate/simulate.js.map +1 -1
- package/lib/routes/acs/entrances/entrances.d.ts +3 -3
- package/lib/routes/acs/entrances/entrances.js +7 -2
- package/lib/routes/acs/entrances/entrances.js.map +1 -1
- package/lib/routes/acs/systems/systems.d.ts +2 -2
- package/lib/routes/acs/systems/systems.js +5 -1
- package/lib/routes/acs/systems/systems.js.map +1 -1
- package/lib/routes/acs/users/users.d.ts +10 -10
- package/lib/routes/acs/users/users.js +46 -1
- package/lib/routes/acs/users/users.js.map +1 -1
- package/lib/routes/action-attempts/action-attempts.d.ts +3 -3
- package/lib/routes/action-attempts/action-attempts.js +4 -2
- package/lib/routes/action-attempts/action-attempts.js.map +1 -1
- package/lib/routes/client-sessions/client-sessions.d.ts +3 -3
- package/lib/routes/client-sessions/client-sessions.js +15 -1
- package/lib/routes/client-sessions/client-sessions.js.map +1 -1
- package/lib/routes/connect-webviews/connect-webviews.d.ts +3 -3
- package/lib/routes/connect-webviews/connect-webviews.js +5 -1
- package/lib/routes/connect-webviews/connect-webviews.js.map +1 -1
- package/lib/routes/connected-accounts/connected-accounts.d.ts +4 -4
- package/lib/routes/connected-accounts/connected-accounts.js +6 -1
- package/lib/routes/connected-accounts/connected-accounts.js.map +1 -1
- package/lib/routes/connected-accounts/simulate/simulate.d.ts +2 -2
- package/lib/routes/connected-accounts/simulate/simulate.js +2 -1
- package/lib/routes/connected-accounts/simulate/simulate.js.map +1 -1
- package/lib/routes/customers/customers.d.ts +2 -2
- package/lib/routes/customers/customers.js +4 -1
- package/lib/routes/customers/customers.js.map +1 -1
- package/lib/routes/devices/devices.d.ts +4 -4
- package/lib/routes/devices/devices.js +6 -1
- package/lib/routes/devices/devices.js.map +1 -1
- package/lib/routes/devices/simulate/simulate.d.ts +2 -2
- package/lib/routes/devices/simulate/simulate.js +7 -1
- package/lib/routes/devices/simulate/simulate.js.map +1 -1
- package/lib/routes/devices/unmanaged/unmanaged.d.ts +4 -4
- package/lib/routes/devices/unmanaged/unmanaged.js +4 -1
- package/lib/routes/devices/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/events/events.d.ts +4 -4
- package/lib/routes/events/events.js +31 -1
- package/lib/routes/events/events.js.map +1 -1
- package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
- package/lib/routes/instant-keys/instant-keys.js +4 -1
- package/lib/routes/instant-keys/instant-keys.js.map +1 -1
- package/lib/routes/locks/locks.d.ts +3 -3
- package/lib/routes/locks/locks.js +9 -4
- package/lib/routes/locks/locks.js.map +1 -1
- package/lib/routes/locks/simulate/simulate.d.ts +2 -2
- package/lib/routes/locks/simulate/simulate.js +5 -3
- package/lib/routes/locks/simulate/simulate.js.map +1 -1
- package/lib/routes/noise-sensors/noise-sensors.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-sensors.js +2 -1
- package/lib/routes/noise-sensors/noise-sensors.js.map +1 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +2 -2
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +6 -1
- package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
- package/lib/routes/noise-sensors/simulate/simulate.d.ts +2 -2
- package/lib/routes/noise-sensors/simulate/simulate.js +2 -1
- package/lib/routes/noise-sensors/simulate/simulate.js.map +1 -1
- package/lib/routes/phones/phones.d.ts +2 -2
- package/lib/routes/phones/phones.js +4 -1
- package/lib/routes/phones/phones.js.map +1 -1
- package/lib/routes/phones/simulate/simulate.d.ts +2 -2
- package/lib/routes/phones/simulate/simulate.js +2 -1
- package/lib/routes/phones/simulate/simulate.js.map +1 -1
- package/lib/routes/seam-http-endpoints.d.ts +2 -2
- package/lib/routes/seam-http-endpoints.js.map +1 -1
- package/lib/routes/seam-http.d.ts +2 -2
- package/lib/routes/seam-http.js.map +1 -1
- package/lib/routes/spaces/spaces.d.ts +5 -5
- package/lib/routes/spaces/spaces.js +18 -1
- package/lib/routes/spaces/spaces.js.map +1 -1
- package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
- package/lib/routes/thermostats/daily-programs/daily-programs.js +5 -2
- package/lib/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
- package/lib/routes/thermostats/schedules/schedules.d.ts +2 -2
- package/lib/routes/thermostats/schedules/schedules.js +6 -1
- package/lib/routes/thermostats/schedules/schedules.js.map +1 -1
- package/lib/routes/thermostats/simulate/simulate.d.ts +2 -2
- package/lib/routes/thermostats/simulate/simulate.js +3 -1
- package/lib/routes/thermostats/simulate/simulate.js.map +1 -1
- package/lib/routes/thermostats/thermostats.d.ts +2 -2
- package/lib/routes/thermostats/thermostats.js +23 -9
- package/lib/routes/thermostats/thermostats.js.map +1 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
- package/lib/routes/user-identities/unmanaged/unmanaged.js +4 -1
- package/lib/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
- package/lib/routes/user-identities/user-identities.d.ts +5 -5
- package/lib/routes/user-identities/user-identities.js +21 -1
- package/lib/routes/user-identities/user-identities.js.map +1 -1
- package/lib/routes/webhooks/webhooks.d.ts +2 -2
- package/lib/routes/webhooks/webhooks.js +6 -1
- package/lib/routes/webhooks/webhooks.js.map +1 -1
- package/lib/routes/workspaces/workspaces.d.ts +2 -2
- package/lib/routes/workspaces/workspaces.js +7 -2
- package/lib/routes/workspaces/workspaces.js.map +1 -1
- package/lib/seam-http-request.d.ts +8 -3
- package/lib/seam-http-request.js +15 -6
- package/lib/seam-http-request.js.map +1 -1
- package/lib/seam-paginator.d.ts +2 -2
- package/lib/seam-paginator.js +12 -8
- package/lib/seam-paginator.js.map +1 -1
- package/lib/version.d.ts +1 -1
- package/lib/version.js +1 -1
- package/package.json +1 -1
- package/src/lib/request-parameters.ts +5 -2
- package/src/lib/resolve-action-attempt.ts +34 -37
- package/src/lib/routes/access-codes/access-codes.ts +94 -59
- package/src/lib/routes/access-codes/simulate/simulate.ts +6 -2
- package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +28 -17
- package/src/lib/routes/access-grants/access-grants.ts +101 -71
- package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/access-methods/access-methods.ts +98 -63
- package/src/lib/routes/access-methods/unmanaged/unmanaged.ts +7 -2
- package/src/lib/routes/acs/access-groups/access-groups.ts +12 -2
- package/src/lib/routes/acs/acs.ts +2 -2
- package/src/lib/routes/acs/credentials/credentials.ts +14 -3
- package/src/lib/routes/acs/encoders/encoders.ts +26 -15
- package/src/lib/routes/acs/encoders/simulate/simulate.ts +9 -2
- package/src/lib/routes/acs/entrances/entrances.ts +16 -7
- package/src/lib/routes/acs/systems/systems.ts +9 -2
- package/src/lib/routes/acs/users/users.ts +214 -137
- package/src/lib/routes/action-attempts/action-attempts.ts +13 -7
- package/src/lib/routes/client-sessions/client-sessions.ts +54 -29
- package/src/lib/routes/connect-webviews/connect-webviews.ts +10 -3
- package/src/lib/routes/connected-accounts/connected-accounts.ts +24 -13
- package/src/lib/routes/connected-accounts/simulate/simulate.ts +6 -2
- package/src/lib/routes/customers/customers.ts +8 -2
- package/src/lib/routes/devices/devices.ts +27 -13
- package/src/lib/routes/devices/simulate/simulate.ts +11 -2
- package/src/lib/routes/devices/unmanaged/unmanaged.ts +22 -13
- package/src/lib/routes/events/events.ts +427 -362
- package/src/lib/routes/instant-keys/instant-keys.ts +21 -12
- package/src/lib/routes/locks/locks.ts +38 -24
- package/src/lib/routes/locks/simulate/simulate.ts +17 -10
- package/src/lib/routes/noise-sensors/noise-sensors.ts +6 -2
- package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +10 -2
- package/src/lib/routes/noise-sensors/simulate/simulate.ts +6 -2
- package/src/lib/routes/phones/phones.ts +8 -2
- package/src/lib/routes/phones/simulate/simulate.ts +6 -2
- package/src/lib/routes/seam-http-endpoints.ts +2 -2
- package/src/lib/routes/seam-http.ts +2 -2
- package/src/lib/routes/spaces/spaces.ts +73 -44
- package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +13 -6
- package/src/lib/routes/thermostats/schedules/schedules.ts +10 -2
- package/src/lib/routes/thermostats/simulate/simulate.ts +7 -2
- package/src/lib/routes/thermostats/thermostats.ts +59 -34
- package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +9 -3
- package/src/lib/routes/user-identities/user-identities.ts +60 -28
- package/src/lib/routes/webhooks/webhooks.ts +10 -2
- package/src/lib/routes/workspaces/workspaces.ts +15 -6
- package/src/lib/seam-http-request.ts +30 -8
- package/src/lib/seam-paginator.ts +22 -12
- package/src/lib/version.ts +1 -1
|
@@ -31,7 +31,10 @@ import {
|
|
|
31
31
|
import type { RequireAtLeastOne } from 'lib/request-parameters.js'
|
|
32
32
|
import type { SeamEvent } from 'lib/resources/event.js'
|
|
33
33
|
import { SeamHttpClientSessions } from 'lib/routes/client-sessions/index.js'
|
|
34
|
-
import {
|
|
34
|
+
import {
|
|
35
|
+
SeamHttpRequest,
|
|
36
|
+
type SeamPaginatedRequest,
|
|
37
|
+
} from 'lib/seam-http-request.js'
|
|
35
38
|
import { SeamPaginator } from 'lib/seam-paginator.js'
|
|
36
39
|
|
|
37
40
|
export class SeamHttpEvents {
|
|
@@ -135,7 +138,7 @@ export class SeamHttpEvents {
|
|
|
135
138
|
}
|
|
136
139
|
|
|
137
140
|
createPaginator<const TResponse, const TResponseKey extends keyof TResponse>(
|
|
138
|
-
request:
|
|
141
|
+
request: SeamPaginatedRequest<TResponse, TResponseKey>,
|
|
139
142
|
): SeamPaginator<TResponse, TResponseKey> {
|
|
140
143
|
return new SeamPaginator<TResponse, TResponseKey>(this, request)
|
|
141
144
|
}
|
|
@@ -173,6 +176,7 @@ export class SeamHttpEvents {
|
|
|
173
176
|
parameters,
|
|
174
177
|
hasRequiredParameters: true,
|
|
175
178
|
requiredParameterNames: [],
|
|
179
|
+
atLeastOneParameterNames: ['device_id', 'event_id', 'event_type'],
|
|
176
180
|
responseKey: 'event',
|
|
177
181
|
options,
|
|
178
182
|
})
|
|
@@ -192,26 +196,58 @@ export class SeamHttpEvents {
|
|
|
192
196
|
parameters,
|
|
193
197
|
hasRequiredParameters: true,
|
|
194
198
|
requiredParameterNames: [],
|
|
199
|
+
atLeastOneParameterNames: [
|
|
200
|
+
'access_code_id',
|
|
201
|
+
'access_code_ids',
|
|
202
|
+
'access_grant_id',
|
|
203
|
+
'access_grant_ids',
|
|
204
|
+
'access_method_id',
|
|
205
|
+
'access_method_ids',
|
|
206
|
+
'acs_access_group_id',
|
|
207
|
+
'acs_credential_id',
|
|
208
|
+
'acs_encoder_id',
|
|
209
|
+
'acs_entrance_id',
|
|
210
|
+
'acs_system_id',
|
|
211
|
+
'acs_system_ids',
|
|
212
|
+
'acs_user_id',
|
|
213
|
+
'between',
|
|
214
|
+
'connect_webview_id',
|
|
215
|
+
'connected_account_id',
|
|
216
|
+
'customer_key',
|
|
217
|
+
'device_id',
|
|
218
|
+
'device_ids',
|
|
219
|
+
'event_ids',
|
|
220
|
+
'event_type',
|
|
221
|
+
'event_types',
|
|
222
|
+
'since',
|
|
223
|
+
'space_id',
|
|
224
|
+
'space_ids',
|
|
225
|
+
'unstable_offset',
|
|
226
|
+
'user_identity_id',
|
|
227
|
+
],
|
|
195
228
|
responseKey: 'events',
|
|
196
229
|
options,
|
|
197
230
|
})
|
|
198
231
|
}
|
|
199
232
|
}
|
|
200
233
|
|
|
201
|
-
export type EventsGetParameters = RequireAtLeastOne<
|
|
202
|
-
|
|
203
|
-
|
|
204
|
-
|
|
205
|
-
|
|
206
|
-
|
|
207
|
-
|
|
208
|
-
|
|
209
|
-
|
|
210
|
-
|
|
211
|
-
|
|
212
|
-
|
|
213
|
-
|
|
214
|
-
|
|
234
|
+
export type EventsGetParameters = RequireAtLeastOne<
|
|
235
|
+
{
|
|
236
|
+
/**
|
|
237
|
+
* Unique identifier for the device that triggered the event that you want to get.
|
|
238
|
+
*/
|
|
239
|
+
device_id?: string | undefined
|
|
240
|
+
/**
|
|
241
|
+
* Unique identifier for the event that you want to get.
|
|
242
|
+
*/
|
|
243
|
+
event_id?: string | undefined
|
|
244
|
+
/**
|
|
245
|
+
* Type of the event that you want to get.
|
|
246
|
+
*/
|
|
247
|
+
event_type?: string | undefined
|
|
248
|
+
},
|
|
249
|
+
'device_id' | 'event_id' | 'event_type'
|
|
250
|
+
>
|
|
215
251
|
|
|
216
252
|
/**
|
|
217
253
|
* @deprecated Use EventsGetRequest instead.
|
|
@@ -222,352 +258,381 @@ export type EventsGetRequest = SeamHttpRequest<EventsGetResponse, 'event'>
|
|
|
222
258
|
|
|
223
259
|
export interface EventsGetOptions {}
|
|
224
260
|
|
|
225
|
-
export type EventsListParameters = RequireAtLeastOne<
|
|
226
|
-
|
|
227
|
-
|
|
228
|
-
|
|
229
|
-
|
|
230
|
-
|
|
231
|
-
|
|
232
|
-
|
|
233
|
-
|
|
234
|
-
|
|
235
|
-
|
|
236
|
-
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
247
|
-
|
|
248
|
-
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
|
|
257
|
-
|
|
258
|
-
|
|
259
|
-
|
|
260
|
-
|
|
261
|
-
|
|
262
|
-
|
|
263
|
-
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
|
|
272
|
-
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
|
|
286
|
-
|
|
287
|
-
|
|
288
|
-
|
|
289
|
-
|
|
290
|
-
|
|
291
|
-
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
296
|
-
|
|
297
|
-
|
|
298
|
-
|
|
299
|
-
|
|
300
|
-
|
|
301
|
-
|
|
302
|
-
|
|
303
|
-
|
|
304
|
-
|
|
305
|
-
|
|
306
|
-
|
|
307
|
-
|
|
308
|
-
|
|
309
|
-
|
|
310
|
-
|
|
311
|
-
|
|
312
|
-
|
|
313
|
-
|
|
314
|
-
|
|
315
|
-
|
|
316
|
-
|
|
317
|
-
|
|
318
|
-
|
|
319
|
-
|
|
320
|
-
|
|
321
|
-
|
|
322
|
-
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
|
|
363
|
-
|
|
364
|
-
|
|
365
|
-
|
|
366
|
-
|
|
367
|
-
|
|
368
|
-
|
|
369
|
-
|
|
370
|
-
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
|
|
374
|
-
|
|
375
|
-
|
|
376
|
-
|
|
377
|
-
|
|
378
|
-
|
|
379
|
-
|
|
380
|
-
|
|
381
|
-
|
|
382
|
-
|
|
383
|
-
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
|
|
394
|
-
|
|
395
|
-
|
|
396
|
-
|
|
397
|
-
|
|
398
|
-
|
|
399
|
-
|
|
400
|
-
|
|
401
|
-
|
|
402
|
-
|
|
403
|
-
|
|
404
|
-
|
|
405
|
-
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
|
|
409
|
-
|
|
410
|
-
|
|
411
|
-
|
|
412
|
-
|
|
413
|
-
|
|
414
|
-
|
|
415
|
-
|
|
416
|
-
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
|
|
428
|
-
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
439
|
-
|
|
440
|
-
|
|
441
|
-
|
|
442
|
-
|
|
443
|
-
|
|
444
|
-
|
|
445
|
-
|
|
446
|
-
|
|
447
|
-
|
|
448
|
-
|
|
449
|
-
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
|
|
453
|
-
|
|
454
|
-
|
|
455
|
-
|
|
456
|
-
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
460
|
-
|
|
461
|
-
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
|
|
470
|
-
|
|
471
|
-
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
|
|
475
|
-
|
|
476
|
-
|
|
477
|
-
|
|
478
|
-
|
|
479
|
-
|
|
480
|
-
|
|
481
|
-
|
|
482
|
-
|
|
483
|
-
|
|
484
|
-
|
|
485
|
-
|
|
486
|
-
|
|
487
|
-
|
|
488
|
-
|
|
489
|
-
|
|
490
|
-
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
502
|
-
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
508
|
-
|
|
509
|
-
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
|
|
517
|
-
|
|
518
|
-
|
|
519
|
-
|
|
520
|
-
|
|
521
|
-
|
|
522
|
-
|
|
523
|
-
|
|
524
|
-
|
|
525
|
-
|
|
526
|
-
|
|
527
|
-
|
|
528
|
-
|
|
529
|
-
|
|
530
|
-
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
536
|
-
|
|
537
|
-
|
|
538
|
-
|
|
539
|
-
|
|
540
|
-
|
|
541
|
-
|
|
542
|
-
|
|
543
|
-
|
|
544
|
-
|
|
545
|
-
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
|
|
554
|
-
|
|
555
|
-
|
|
556
|
-
|
|
557
|
-
|
|
558
|
-
|
|
559
|
-
|
|
560
|
-
|
|
561
|
-
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
|
|
568
|
-
|
|
569
|
-
|
|
570
|
-
|
|
261
|
+
export type EventsListParameters = RequireAtLeastOne<
|
|
262
|
+
{
|
|
263
|
+
/**
|
|
264
|
+
* ID of the access code for which you want to list events.
|
|
265
|
+
*/
|
|
266
|
+
access_code_id?: string | undefined
|
|
267
|
+
/**
|
|
268
|
+
* IDs of the access codes for which you want to list events.
|
|
269
|
+
*/
|
|
270
|
+
access_code_ids?: Array<string> | undefined
|
|
271
|
+
/**
|
|
272
|
+
* ID of the access grant for which you want to list events.
|
|
273
|
+
*/
|
|
274
|
+
access_grant_id?: string | undefined
|
|
275
|
+
/**
|
|
276
|
+
* IDs of the access grants for which you want to list events.
|
|
277
|
+
*/
|
|
278
|
+
access_grant_ids?: Array<string> | undefined
|
|
279
|
+
/**
|
|
280
|
+
* ID of the access method for which you want to list events.
|
|
281
|
+
*/
|
|
282
|
+
access_method_id?: string | undefined
|
|
283
|
+
/**
|
|
284
|
+
* IDs of the access methods for which you want to list events.
|
|
285
|
+
*/
|
|
286
|
+
access_method_ids?: Array<string> | undefined
|
|
287
|
+
/**
|
|
288
|
+
* ID of the ACS access group for which you want to list events.
|
|
289
|
+
*/
|
|
290
|
+
acs_access_group_id?: string | undefined
|
|
291
|
+
/**
|
|
292
|
+
* ID of the ACS credential for which you want to list events.
|
|
293
|
+
*/
|
|
294
|
+
acs_credential_id?: string | undefined
|
|
295
|
+
/**
|
|
296
|
+
* ID of the ACS encoder for which you want to list events.
|
|
297
|
+
*/
|
|
298
|
+
acs_encoder_id?: string | undefined
|
|
299
|
+
/**
|
|
300
|
+
* ID of the ACS entrance for which you want to list events.
|
|
301
|
+
*/
|
|
302
|
+
acs_entrance_id?: string | undefined
|
|
303
|
+
/**
|
|
304
|
+
* ID of the access system for which you want to list events.
|
|
305
|
+
*/
|
|
306
|
+
acs_system_id?: string | undefined
|
|
307
|
+
/**
|
|
308
|
+
* IDs of the access systems for which you want to list events.
|
|
309
|
+
*/
|
|
310
|
+
acs_system_ids?: Array<string> | undefined
|
|
311
|
+
/**
|
|
312
|
+
* ID of the ACS user for which you want to list events.
|
|
313
|
+
*/
|
|
314
|
+
acs_user_id?: string | undefined
|
|
315
|
+
/**
|
|
316
|
+
* Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
|
|
317
|
+
*/
|
|
318
|
+
between?: Array<string> | undefined
|
|
319
|
+
/**
|
|
320
|
+
* ID of the Connect Webview for which you want to list events.
|
|
321
|
+
*/
|
|
322
|
+
connect_webview_id?: string | undefined
|
|
323
|
+
/**
|
|
324
|
+
* ID of the connected account for which you want to list events.
|
|
325
|
+
*/
|
|
326
|
+
connected_account_id?: string | undefined
|
|
327
|
+
/**
|
|
328
|
+
* Customer key for which you want to list events.
|
|
329
|
+
*/
|
|
330
|
+
customer_key?: string | undefined
|
|
331
|
+
/**
|
|
332
|
+
* ID of the device for which you want to list events.
|
|
333
|
+
*/
|
|
334
|
+
device_id?: string | undefined
|
|
335
|
+
/**
|
|
336
|
+
* IDs of the devices for which you want to list events.
|
|
337
|
+
*/
|
|
338
|
+
device_ids?: Array<string> | undefined
|
|
339
|
+
/**
|
|
340
|
+
* IDs of the events that you want to list.
|
|
341
|
+
*/
|
|
342
|
+
event_ids?: Array<string> | undefined
|
|
343
|
+
/**
|
|
344
|
+
* Type of the events that you want to list.
|
|
345
|
+
*/
|
|
346
|
+
event_type?:
|
|
347
|
+
| 'access_code.created'
|
|
348
|
+
| 'access_code.changed'
|
|
349
|
+
| 'access_code.name_changed'
|
|
350
|
+
| 'access_code.code_changed'
|
|
351
|
+
| 'access_code.time_frame_changed'
|
|
352
|
+
| 'access_code.mutations_requested'
|
|
353
|
+
| 'access_code.scheduled_on_device'
|
|
354
|
+
| 'access_code.set_on_device'
|
|
355
|
+
| 'access_code.removed_from_device'
|
|
356
|
+
| 'access_code.delay_in_setting_on_device'
|
|
357
|
+
| 'access_code.failed_to_set_on_device'
|
|
358
|
+
| 'access_code.issued'
|
|
359
|
+
| 'access_code.delay_in_issuing'
|
|
360
|
+
| 'access_code.failed_to_issue'
|
|
361
|
+
| 'access_code.failed_to_update'
|
|
362
|
+
| 'access_code.failed_to_expire'
|
|
363
|
+
| 'access_code.deleted'
|
|
364
|
+
| 'access_code.delay_in_removing_from_device'
|
|
365
|
+
| 'access_code.failed_to_remove_from_device'
|
|
366
|
+
| 'access_code.modified_external_to_seam'
|
|
367
|
+
| 'access_code.deleted_external_to_seam'
|
|
368
|
+
| 'access_code.backup_access_code_pulled'
|
|
369
|
+
| 'access_code.unmanaged.converted_to_managed'
|
|
370
|
+
| 'access_code.unmanaged.failed_to_convert_to_managed'
|
|
371
|
+
| 'access_code.unmanaged.created'
|
|
372
|
+
| 'access_code.unmanaged.removed'
|
|
373
|
+
| 'access_grant.created'
|
|
374
|
+
| 'access_grant.deleted'
|
|
375
|
+
| 'access_grant.access_granted_to_all_doors'
|
|
376
|
+
| 'access_grant.access_granted_to_door'
|
|
377
|
+
| 'access_grant.access_to_door_lost'
|
|
378
|
+
| 'access_grant.access_times_changed'
|
|
379
|
+
| 'access_grant.could_not_create_requested_access_methods'
|
|
380
|
+
| 'access_method.issued'
|
|
381
|
+
| 'access_method.revoked'
|
|
382
|
+
| 'access_method.card_encoding_required'
|
|
383
|
+
| 'access_method.deleted'
|
|
384
|
+
| 'access_method.reissued'
|
|
385
|
+
| 'access_method.created'
|
|
386
|
+
| 'access_method.delay_in_issuing'
|
|
387
|
+
| 'access_method.failed_to_issue'
|
|
388
|
+
| 'acs_system.connected'
|
|
389
|
+
| 'acs_system.added'
|
|
390
|
+
| 'acs_system.disconnected'
|
|
391
|
+
| 'acs_credential.deleted'
|
|
392
|
+
| 'acs_credential.issued'
|
|
393
|
+
| 'acs_credential.reissued'
|
|
394
|
+
| 'acs_credential.invalidated'
|
|
395
|
+
| 'acs_user.created'
|
|
396
|
+
| 'acs_user.deleted'
|
|
397
|
+
| 'acs_encoder.added'
|
|
398
|
+
| 'acs_encoder.removed'
|
|
399
|
+
| 'acs_access_group.deleted'
|
|
400
|
+
| 'acs_entrance.added'
|
|
401
|
+
| 'acs_entrance.removed'
|
|
402
|
+
| 'client_session.deleted'
|
|
403
|
+
| 'connected_account.connected'
|
|
404
|
+
| 'connected_account.created'
|
|
405
|
+
| 'connected_account.successful_login'
|
|
406
|
+
| 'connected_account.disconnected'
|
|
407
|
+
| 'connected_account.completed_first_sync'
|
|
408
|
+
| 'connected_account.deleted'
|
|
409
|
+
| 'connected_account.completed_first_sync_after_reconnection'
|
|
410
|
+
| 'connected_account.reauthorization_requested'
|
|
411
|
+
| 'action_attempt.lock_door.succeeded'
|
|
412
|
+
| 'action_attempt.lock_door.failed'
|
|
413
|
+
| 'action_attempt.unlock_door.succeeded'
|
|
414
|
+
| 'action_attempt.unlock_door.failed'
|
|
415
|
+
| 'action_attempt.simulate_keypad_code_entry.succeeded'
|
|
416
|
+
| 'action_attempt.simulate_keypad_code_entry.failed'
|
|
417
|
+
| 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
|
|
418
|
+
| 'action_attempt.simulate_manual_lock_via_keypad.failed'
|
|
419
|
+
| 'connect_webview.login_succeeded'
|
|
420
|
+
| 'connect_webview.login_failed'
|
|
421
|
+
| 'device.connected'
|
|
422
|
+
| 'device.added'
|
|
423
|
+
| 'device.converted_to_unmanaged'
|
|
424
|
+
| 'device.unmanaged.converted_to_managed'
|
|
425
|
+
| 'device.unmanaged.connected'
|
|
426
|
+
| 'device.disconnected'
|
|
427
|
+
| 'device.unmanaged.disconnected'
|
|
428
|
+
| 'device.tampered'
|
|
429
|
+
| 'device.low_battery'
|
|
430
|
+
| 'device.battery_status_changed'
|
|
431
|
+
| 'device.removed'
|
|
432
|
+
| 'device.deleted'
|
|
433
|
+
| 'device.third_party_integration_detected'
|
|
434
|
+
| 'device.third_party_integration_no_longer_detected'
|
|
435
|
+
| 'device.salto.privacy_mode_activated'
|
|
436
|
+
| 'device.salto.privacy_mode_deactivated'
|
|
437
|
+
| 'device.connection_became_flaky'
|
|
438
|
+
| 'device.connection_stabilized'
|
|
439
|
+
| 'device.error.subscription_required'
|
|
440
|
+
| 'device.error.subscription_required.resolved'
|
|
441
|
+
| 'device.accessory_keypad_connected'
|
|
442
|
+
| 'device.accessory_keypad_disconnected'
|
|
443
|
+
| 'noise_sensor.noise_threshold_triggered'
|
|
444
|
+
| 'lock.locked'
|
|
445
|
+
| 'lock.unlocked'
|
|
446
|
+
| 'lock.access_denied'
|
|
447
|
+
| 'thermostat.climate_preset_activated'
|
|
448
|
+
| 'thermostat.manually_adjusted'
|
|
449
|
+
| 'thermostat.temperature_threshold_exceeded'
|
|
450
|
+
| 'thermostat.temperature_threshold_no_longer_exceeded'
|
|
451
|
+
| 'thermostat.temperature_reached_set_point'
|
|
452
|
+
| 'thermostat.temperature_changed'
|
|
453
|
+
| 'device.name_changed'
|
|
454
|
+
| 'camera.activated'
|
|
455
|
+
| 'device.doorbell_rang'
|
|
456
|
+
| 'enrollment_automation.deleted'
|
|
457
|
+
| 'phone.deactivated'
|
|
458
|
+
| 'space.device_membership_changed'
|
|
459
|
+
| 'space.created'
|
|
460
|
+
| 'space.deleted'
|
|
461
|
+
| undefined
|
|
462
|
+
/**
|
|
463
|
+
* Types of the events that you want to list.
|
|
464
|
+
*/
|
|
465
|
+
event_types?:
|
|
466
|
+
| Array<
|
|
467
|
+
| 'access_code.created'
|
|
468
|
+
| 'access_code.changed'
|
|
469
|
+
| 'access_code.name_changed'
|
|
470
|
+
| 'access_code.code_changed'
|
|
471
|
+
| 'access_code.time_frame_changed'
|
|
472
|
+
| 'access_code.mutations_requested'
|
|
473
|
+
| 'access_code.scheduled_on_device'
|
|
474
|
+
| 'access_code.set_on_device'
|
|
475
|
+
| 'access_code.removed_from_device'
|
|
476
|
+
| 'access_code.delay_in_setting_on_device'
|
|
477
|
+
| 'access_code.failed_to_set_on_device'
|
|
478
|
+
| 'access_code.issued'
|
|
479
|
+
| 'access_code.delay_in_issuing'
|
|
480
|
+
| 'access_code.failed_to_issue'
|
|
481
|
+
| 'access_code.failed_to_update'
|
|
482
|
+
| 'access_code.failed_to_expire'
|
|
483
|
+
| 'access_code.deleted'
|
|
484
|
+
| 'access_code.delay_in_removing_from_device'
|
|
485
|
+
| 'access_code.failed_to_remove_from_device'
|
|
486
|
+
| 'access_code.modified_external_to_seam'
|
|
487
|
+
| 'access_code.deleted_external_to_seam'
|
|
488
|
+
| 'access_code.backup_access_code_pulled'
|
|
489
|
+
| 'access_code.unmanaged.converted_to_managed'
|
|
490
|
+
| 'access_code.unmanaged.failed_to_convert_to_managed'
|
|
491
|
+
| 'access_code.unmanaged.created'
|
|
492
|
+
| 'access_code.unmanaged.removed'
|
|
493
|
+
| 'access_grant.created'
|
|
494
|
+
| 'access_grant.deleted'
|
|
495
|
+
| 'access_grant.access_granted_to_all_doors'
|
|
496
|
+
| 'access_grant.access_granted_to_door'
|
|
497
|
+
| 'access_grant.access_to_door_lost'
|
|
498
|
+
| 'access_grant.access_times_changed'
|
|
499
|
+
| 'access_grant.could_not_create_requested_access_methods'
|
|
500
|
+
| 'access_method.issued'
|
|
501
|
+
| 'access_method.revoked'
|
|
502
|
+
| 'access_method.card_encoding_required'
|
|
503
|
+
| 'access_method.deleted'
|
|
504
|
+
| 'access_method.reissued'
|
|
505
|
+
| 'access_method.created'
|
|
506
|
+
| 'access_method.delay_in_issuing'
|
|
507
|
+
| 'access_method.failed_to_issue'
|
|
508
|
+
| 'acs_system.connected'
|
|
509
|
+
| 'acs_system.added'
|
|
510
|
+
| 'acs_system.disconnected'
|
|
511
|
+
| 'acs_credential.deleted'
|
|
512
|
+
| 'acs_credential.issued'
|
|
513
|
+
| 'acs_credential.reissued'
|
|
514
|
+
| 'acs_credential.invalidated'
|
|
515
|
+
| 'acs_user.created'
|
|
516
|
+
| 'acs_user.deleted'
|
|
517
|
+
| 'acs_encoder.added'
|
|
518
|
+
| 'acs_encoder.removed'
|
|
519
|
+
| 'acs_access_group.deleted'
|
|
520
|
+
| 'acs_entrance.added'
|
|
521
|
+
| 'acs_entrance.removed'
|
|
522
|
+
| 'client_session.deleted'
|
|
523
|
+
| 'connected_account.connected'
|
|
524
|
+
| 'connected_account.created'
|
|
525
|
+
| 'connected_account.successful_login'
|
|
526
|
+
| 'connected_account.disconnected'
|
|
527
|
+
| 'connected_account.completed_first_sync'
|
|
528
|
+
| 'connected_account.deleted'
|
|
529
|
+
| 'connected_account.completed_first_sync_after_reconnection'
|
|
530
|
+
| 'connected_account.reauthorization_requested'
|
|
531
|
+
| 'action_attempt.lock_door.succeeded'
|
|
532
|
+
| 'action_attempt.lock_door.failed'
|
|
533
|
+
| 'action_attempt.unlock_door.succeeded'
|
|
534
|
+
| 'action_attempt.unlock_door.failed'
|
|
535
|
+
| 'action_attempt.simulate_keypad_code_entry.succeeded'
|
|
536
|
+
| 'action_attempt.simulate_keypad_code_entry.failed'
|
|
537
|
+
| 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
|
|
538
|
+
| 'action_attempt.simulate_manual_lock_via_keypad.failed'
|
|
539
|
+
| 'connect_webview.login_succeeded'
|
|
540
|
+
| 'connect_webview.login_failed'
|
|
541
|
+
| 'device.connected'
|
|
542
|
+
| 'device.added'
|
|
543
|
+
| 'device.converted_to_unmanaged'
|
|
544
|
+
| 'device.unmanaged.converted_to_managed'
|
|
545
|
+
| 'device.unmanaged.connected'
|
|
546
|
+
| 'device.disconnected'
|
|
547
|
+
| 'device.unmanaged.disconnected'
|
|
548
|
+
| 'device.tampered'
|
|
549
|
+
| 'device.low_battery'
|
|
550
|
+
| 'device.battery_status_changed'
|
|
551
|
+
| 'device.removed'
|
|
552
|
+
| 'device.deleted'
|
|
553
|
+
| 'device.third_party_integration_detected'
|
|
554
|
+
| 'device.third_party_integration_no_longer_detected'
|
|
555
|
+
| 'device.salto.privacy_mode_activated'
|
|
556
|
+
| 'device.salto.privacy_mode_deactivated'
|
|
557
|
+
| 'device.connection_became_flaky'
|
|
558
|
+
| 'device.connection_stabilized'
|
|
559
|
+
| 'device.error.subscription_required'
|
|
560
|
+
| 'device.error.subscription_required.resolved'
|
|
561
|
+
| 'device.accessory_keypad_connected'
|
|
562
|
+
| 'device.accessory_keypad_disconnected'
|
|
563
|
+
| 'noise_sensor.noise_threshold_triggered'
|
|
564
|
+
| 'lock.locked'
|
|
565
|
+
| 'lock.unlocked'
|
|
566
|
+
| 'lock.access_denied'
|
|
567
|
+
| 'thermostat.climate_preset_activated'
|
|
568
|
+
| 'thermostat.manually_adjusted'
|
|
569
|
+
| 'thermostat.temperature_threshold_exceeded'
|
|
570
|
+
| 'thermostat.temperature_threshold_no_longer_exceeded'
|
|
571
|
+
| 'thermostat.temperature_reached_set_point'
|
|
572
|
+
| 'thermostat.temperature_changed'
|
|
573
|
+
| 'device.name_changed'
|
|
574
|
+
| 'camera.activated'
|
|
575
|
+
| 'device.doorbell_rang'
|
|
576
|
+
| 'enrollment_automation.deleted'
|
|
577
|
+
| 'phone.deactivated'
|
|
578
|
+
| 'space.device_membership_changed'
|
|
579
|
+
| 'space.created'
|
|
580
|
+
| 'space.deleted'
|
|
581
|
+
>
|
|
582
|
+
| undefined
|
|
583
|
+
/**
|
|
584
|
+
* Numerical limit on the number of events to return.
|
|
585
|
+
*/
|
|
586
|
+
limit?: number | undefined
|
|
587
|
+
/**
|
|
588
|
+
* Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.
|
|
589
|
+
*/
|
|
590
|
+
since?: string | undefined
|
|
591
|
+
/**
|
|
592
|
+
* ID of the space for which you want to list events.
|
|
593
|
+
*/
|
|
594
|
+
space_id?: string | undefined
|
|
595
|
+
/**
|
|
596
|
+
* IDs of the spaces for which you want to list events.
|
|
597
|
+
*/
|
|
598
|
+
space_ids?: Array<string> | undefined
|
|
599
|
+
/**
|
|
600
|
+
* Offset for the events that you want to list.
|
|
601
|
+
*/
|
|
602
|
+
unstable_offset?: number | undefined
|
|
603
|
+
/**
|
|
604
|
+
* ID of the user identity for which you want to list events.
|
|
605
|
+
*/
|
|
606
|
+
user_identity_id?: string | undefined
|
|
607
|
+
},
|
|
608
|
+
| 'access_code_id'
|
|
609
|
+
| 'access_code_ids'
|
|
610
|
+
| 'access_grant_id'
|
|
611
|
+
| 'access_grant_ids'
|
|
612
|
+
| 'access_method_id'
|
|
613
|
+
| 'access_method_ids'
|
|
614
|
+
| 'acs_access_group_id'
|
|
615
|
+
| 'acs_credential_id'
|
|
616
|
+
| 'acs_encoder_id'
|
|
617
|
+
| 'acs_entrance_id'
|
|
618
|
+
| 'acs_system_id'
|
|
619
|
+
| 'acs_system_ids'
|
|
620
|
+
| 'acs_user_id'
|
|
621
|
+
| 'between'
|
|
622
|
+
| 'connect_webview_id'
|
|
623
|
+
| 'connected_account_id'
|
|
624
|
+
| 'customer_key'
|
|
625
|
+
| 'device_id'
|
|
626
|
+
| 'device_ids'
|
|
627
|
+
| 'event_ids'
|
|
628
|
+
| 'event_type'
|
|
629
|
+
| 'event_types'
|
|
630
|
+
| 'since'
|
|
631
|
+
| 'space_id'
|
|
632
|
+
| 'space_ids'
|
|
633
|
+
| 'unstable_offset'
|
|
634
|
+
| 'user_identity_id'
|
|
635
|
+
>
|
|
571
636
|
|
|
572
637
|
/**
|
|
573
638
|
* @deprecated Use EventsListRequest instead.
|