@seamapi/http 2.23.7 → 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.
Files changed (194) hide show
  1. package/README.md +5 -0
  2. package/lib/request-parameters.d.ts +1 -1
  3. package/lib/request-parameters.js +3 -3
  4. package/lib/request-parameters.js.map +1 -1
  5. package/lib/resolve-action-attempt.d.ts +2 -0
  6. package/lib/resolve-action-attempt.js +25 -27
  7. package/lib/resolve-action-attempt.js.map +1 -1
  8. package/lib/routes/access-codes/access-codes.d.ts +5 -5
  9. package/lib/routes/access-codes/access-codes.js +20 -1
  10. package/lib/routes/access-codes/access-codes.js.map +1 -1
  11. package/lib/routes/access-codes/simulate/simulate.d.ts +2 -2
  12. package/lib/routes/access-codes/simulate/simulate.js +2 -1
  13. package/lib/routes/access-codes/simulate/simulate.js.map +1 -1
  14. package/lib/routes/access-codes/unmanaged/unmanaged.d.ts +4 -4
  15. package/lib/routes/access-codes/unmanaged/unmanaged.js +6 -1
  16. package/lib/routes/access-codes/unmanaged/unmanaged.js.map +1 -1
  17. package/lib/routes/access-grants/access-grants.d.ts +6 -6
  18. package/lib/routes/access-grants/access-grants.js +19 -1
  19. package/lib/routes/access-grants/access-grants.js.map +1 -1
  20. package/lib/routes/access-grants/unmanaged/unmanaged.d.ts +3 -3
  21. package/lib/routes/access-grants/unmanaged/unmanaged.js +4 -1
  22. package/lib/routes/access-grants/unmanaged/unmanaged.js.map +1 -1
  23. package/lib/routes/access-methods/access-methods.d.ts +5 -5
  24. package/lib/routes/access-methods/access-methods.js +19 -1
  25. package/lib/routes/access-methods/access-methods.js.map +1 -1
  26. package/lib/routes/access-methods/unmanaged/unmanaged.d.ts +2 -2
  27. package/lib/routes/access-methods/unmanaged/unmanaged.js +3 -1
  28. package/lib/routes/access-methods/unmanaged/unmanaged.js.map +1 -1
  29. package/lib/routes/acs/access-groups/access-groups.d.ts +2 -2
  30. package/lib/routes/acs/access-groups/access-groups.js +8 -1
  31. package/lib/routes/acs/access-groups/access-groups.js.map +1 -1
  32. package/lib/routes/acs/acs.d.ts +2 -2
  33. package/lib/routes/acs/acs.js.map +1 -1
  34. package/lib/routes/acs/credentials/credentials.d.ts +3 -3
  35. package/lib/routes/acs/credentials/credentials.js +9 -1
  36. package/lib/routes/acs/credentials/credentials.js.map +1 -1
  37. package/lib/routes/acs/encoders/encoders.d.ts +3 -3
  38. package/lib/routes/acs/encoders/encoders.js +6 -1
  39. package/lib/routes/acs/encoders/encoders.js.map +1 -1
  40. package/lib/routes/acs/encoders/simulate/simulate.d.ts +2 -2
  41. package/lib/routes/acs/encoders/simulate/simulate.js +5 -1
  42. package/lib/routes/acs/encoders/simulate/simulate.js.map +1 -1
  43. package/lib/routes/acs/entrances/entrances.d.ts +3 -3
  44. package/lib/routes/acs/entrances/entrances.js +6 -1
  45. package/lib/routes/acs/entrances/entrances.js.map +1 -1
  46. package/lib/routes/acs/systems/systems.d.ts +2 -2
  47. package/lib/routes/acs/systems/systems.js +5 -1
  48. package/lib/routes/acs/systems/systems.js.map +1 -1
  49. package/lib/routes/acs/users/users.d.ts +10 -10
  50. package/lib/routes/acs/users/users.js +46 -1
  51. package/lib/routes/acs/users/users.js.map +1 -1
  52. package/lib/routes/action-attempts/action-attempts.d.ts +3 -3
  53. package/lib/routes/action-attempts/action-attempts.js +3 -1
  54. package/lib/routes/action-attempts/action-attempts.js.map +1 -1
  55. package/lib/routes/client-sessions/client-sessions.d.ts +3 -3
  56. package/lib/routes/client-sessions/client-sessions.js +15 -1
  57. package/lib/routes/client-sessions/client-sessions.js.map +1 -1
  58. package/lib/routes/connect-webviews/connect-webviews.d.ts +3 -3
  59. package/lib/routes/connect-webviews/connect-webviews.js +5 -1
  60. package/lib/routes/connect-webviews/connect-webviews.js.map +1 -1
  61. package/lib/routes/connected-accounts/connected-accounts.d.ts +4 -4
  62. package/lib/routes/connected-accounts/connected-accounts.js +6 -1
  63. package/lib/routes/connected-accounts/connected-accounts.js.map +1 -1
  64. package/lib/routes/connected-accounts/simulate/simulate.d.ts +2 -2
  65. package/lib/routes/connected-accounts/simulate/simulate.js +2 -1
  66. package/lib/routes/connected-accounts/simulate/simulate.js.map +1 -1
  67. package/lib/routes/customers/customers.d.ts +2 -2
  68. package/lib/routes/customers/customers.js +4 -1
  69. package/lib/routes/customers/customers.js.map +1 -1
  70. package/lib/routes/devices/devices.d.ts +4 -4
  71. package/lib/routes/devices/devices.js +6 -1
  72. package/lib/routes/devices/devices.js.map +1 -1
  73. package/lib/routes/devices/simulate/simulate.d.ts +2 -2
  74. package/lib/routes/devices/simulate/simulate.js +7 -1
  75. package/lib/routes/devices/simulate/simulate.js.map +1 -1
  76. package/lib/routes/devices/unmanaged/unmanaged.d.ts +4 -4
  77. package/lib/routes/devices/unmanaged/unmanaged.js +4 -1
  78. package/lib/routes/devices/unmanaged/unmanaged.js.map +1 -1
  79. package/lib/routes/events/events.d.ts +4 -4
  80. package/lib/routes/events/events.js +31 -1
  81. package/lib/routes/events/events.js.map +1 -1
  82. package/lib/routes/instant-keys/instant-keys.d.ts +3 -3
  83. package/lib/routes/instant-keys/instant-keys.js +4 -1
  84. package/lib/routes/instant-keys/instant-keys.js.map +1 -1
  85. package/lib/routes/locks/locks.d.ts +3 -3
  86. package/lib/routes/locks/locks.js +6 -1
  87. package/lib/routes/locks/locks.js.map +1 -1
  88. package/lib/routes/locks/simulate/simulate.d.ts +2 -2
  89. package/lib/routes/locks/simulate/simulate.js +3 -1
  90. package/lib/routes/locks/simulate/simulate.js.map +1 -1
  91. package/lib/routes/noise-sensors/noise-sensors.d.ts +2 -2
  92. package/lib/routes/noise-sensors/noise-sensors.js +2 -1
  93. package/lib/routes/noise-sensors/noise-sensors.js.map +1 -1
  94. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.d.ts +2 -2
  95. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js +6 -1
  96. package/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.js.map +1 -1
  97. package/lib/routes/noise-sensors/simulate/simulate.d.ts +2 -2
  98. package/lib/routes/noise-sensors/simulate/simulate.js +2 -1
  99. package/lib/routes/noise-sensors/simulate/simulate.js.map +1 -1
  100. package/lib/routes/phones/phones.d.ts +2 -2
  101. package/lib/routes/phones/phones.js +4 -1
  102. package/lib/routes/phones/phones.js.map +1 -1
  103. package/lib/routes/phones/simulate/simulate.d.ts +2 -2
  104. package/lib/routes/phones/simulate/simulate.js +2 -1
  105. package/lib/routes/phones/simulate/simulate.js.map +1 -1
  106. package/lib/routes/seam-http-endpoints.d.ts +2 -2
  107. package/lib/routes/seam-http-endpoints.js.map +1 -1
  108. package/lib/routes/seam-http.d.ts +2 -2
  109. package/lib/routes/seam-http.js.map +1 -1
  110. package/lib/routes/spaces/spaces.d.ts +5 -5
  111. package/lib/routes/spaces/spaces.js +18 -1
  112. package/lib/routes/spaces/spaces.js.map +1 -1
  113. package/lib/routes/thermostats/daily-programs/daily-programs.d.ts +2 -2
  114. package/lib/routes/thermostats/daily-programs/daily-programs.js +4 -1
  115. package/lib/routes/thermostats/daily-programs/daily-programs.js.map +1 -1
  116. package/lib/routes/thermostats/schedules/schedules.d.ts +2 -2
  117. package/lib/routes/thermostats/schedules/schedules.js +6 -1
  118. package/lib/routes/thermostats/schedules/schedules.js.map +1 -1
  119. package/lib/routes/thermostats/simulate/simulate.d.ts +2 -2
  120. package/lib/routes/thermostats/simulate/simulate.js +3 -1
  121. package/lib/routes/thermostats/simulate/simulate.js.map +1 -1
  122. package/lib/routes/thermostats/thermostats.d.ts +2 -2
  123. package/lib/routes/thermostats/thermostats.js +15 -1
  124. package/lib/routes/thermostats/thermostats.js.map +1 -1
  125. package/lib/routes/user-identities/unmanaged/unmanaged.d.ts +3 -3
  126. package/lib/routes/user-identities/unmanaged/unmanaged.js +4 -1
  127. package/lib/routes/user-identities/unmanaged/unmanaged.js.map +1 -1
  128. package/lib/routes/user-identities/user-identities.d.ts +5 -5
  129. package/lib/routes/user-identities/user-identities.js +21 -1
  130. package/lib/routes/user-identities/user-identities.js.map +1 -1
  131. package/lib/routes/webhooks/webhooks.d.ts +2 -2
  132. package/lib/routes/webhooks/webhooks.js +6 -1
  133. package/lib/routes/webhooks/webhooks.js.map +1 -1
  134. package/lib/routes/workspaces/workspaces.d.ts +2 -2
  135. package/lib/routes/workspaces/workspaces.js +6 -1
  136. package/lib/routes/workspaces/workspaces.js.map +1 -1
  137. package/lib/seam-http-request.d.ts +7 -2
  138. package/lib/seam-http-request.js +11 -5
  139. package/lib/seam-http-request.js.map +1 -1
  140. package/lib/seam-paginator.d.ts +2 -2
  141. package/lib/seam-paginator.js +12 -8
  142. package/lib/seam-paginator.js.map +1 -1
  143. package/lib/version.d.ts +1 -1
  144. package/lib/version.js +1 -1
  145. package/package.json +1 -1
  146. package/src/lib/request-parameters.ts +5 -2
  147. package/src/lib/resolve-action-attempt.ts +34 -37
  148. package/src/lib/routes/access-codes/access-codes.ts +94 -59
  149. package/src/lib/routes/access-codes/simulate/simulate.ts +6 -2
  150. package/src/lib/routes/access-codes/unmanaged/unmanaged.ts +28 -17
  151. package/src/lib/routes/access-grants/access-grants.ts +101 -71
  152. package/src/lib/routes/access-grants/unmanaged/unmanaged.ts +9 -3
  153. package/src/lib/routes/access-methods/access-methods.ts +83 -51
  154. package/src/lib/routes/access-methods/unmanaged/unmanaged.ts +7 -2
  155. package/src/lib/routes/acs/access-groups/access-groups.ts +12 -2
  156. package/src/lib/routes/acs/acs.ts +2 -2
  157. package/src/lib/routes/acs/credentials/credentials.ts +14 -3
  158. package/src/lib/routes/acs/encoders/encoders.ts +11 -3
  159. package/src/lib/routes/acs/encoders/simulate/simulate.ts +9 -2
  160. package/src/lib/routes/acs/entrances/entrances.ts +11 -3
  161. package/src/lib/routes/acs/systems/systems.ts +9 -2
  162. package/src/lib/routes/acs/users/users.ts +214 -137
  163. package/src/lib/routes/action-attempts/action-attempts.ts +8 -3
  164. package/src/lib/routes/client-sessions/client-sessions.ts +54 -29
  165. package/src/lib/routes/connect-webviews/connect-webviews.ts +10 -3
  166. package/src/lib/routes/connected-accounts/connected-accounts.ts +24 -13
  167. package/src/lib/routes/connected-accounts/simulate/simulate.ts +6 -2
  168. package/src/lib/routes/customers/customers.ts +8 -2
  169. package/src/lib/routes/devices/devices.ts +27 -13
  170. package/src/lib/routes/devices/simulate/simulate.ts +11 -2
  171. package/src/lib/routes/devices/unmanaged/unmanaged.ts +22 -13
  172. package/src/lib/routes/events/events.ts +427 -362
  173. package/src/lib/routes/instant-keys/instant-keys.ts +21 -12
  174. package/src/lib/routes/locks/locks.ts +23 -12
  175. package/src/lib/routes/locks/simulate/simulate.ts +7 -2
  176. package/src/lib/routes/noise-sensors/noise-sensors.ts +6 -2
  177. package/src/lib/routes/noise-sensors/noise-thresholds/noise-thresholds.ts +10 -2
  178. package/src/lib/routes/noise-sensors/simulate/simulate.ts +6 -2
  179. package/src/lib/routes/phones/phones.ts +8 -2
  180. package/src/lib/routes/phones/simulate/simulate.ts +6 -2
  181. package/src/lib/routes/seam-http-endpoints.ts +2 -2
  182. package/src/lib/routes/seam-http.ts +2 -2
  183. package/src/lib/routes/spaces/spaces.ts +73 -44
  184. package/src/lib/routes/thermostats/daily-programs/daily-programs.ts +8 -2
  185. package/src/lib/routes/thermostats/schedules/schedules.ts +10 -2
  186. package/src/lib/routes/thermostats/simulate/simulate.ts +7 -2
  187. package/src/lib/routes/thermostats/thermostats.ts +19 -2
  188. package/src/lib/routes/user-identities/unmanaged/unmanaged.ts +9 -3
  189. package/src/lib/routes/user-identities/user-identities.ts +60 -28
  190. package/src/lib/routes/webhooks/webhooks.ts +10 -2
  191. package/src/lib/routes/workspaces/workspaces.ts +10 -2
  192. package/src/lib/seam-http-request.ts +24 -6
  193. package/src/lib/seam-paginator.ts +22 -12
  194. 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 { SeamHttpRequest } from 'lib/seam-http-request.js'
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: SeamHttpRequest<TResponse, TResponseKey>,
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
- * Unique identifier for the device that triggered the event that you want to get.
204
- */
205
- device_id?: string | undefined
206
- /**
207
- * Unique identifier for the event that you want to get.
208
- */
209
- event_id?: string | undefined
210
- /**
211
- * Type of the event that you want to get.
212
- */
213
- event_type?: string | undefined
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
- * ID of the access code for which you want to list events.
228
- */
229
- access_code_id?: string | undefined
230
- /**
231
- * IDs of the access codes for which you want to list events.
232
- */
233
- access_code_ids?: Array<string> | undefined
234
- /**
235
- * ID of the access grant for which you want to list events.
236
- */
237
- access_grant_id?: string | undefined
238
- /**
239
- * IDs of the access grants for which you want to list events.
240
- */
241
- access_grant_ids?: Array<string> | undefined
242
- /**
243
- * ID of the access method for which you want to list events.
244
- */
245
- access_method_id?: string | undefined
246
- /**
247
- * IDs of the access methods for which you want to list events.
248
- */
249
- access_method_ids?: Array<string> | undefined
250
- /**
251
- * ID of the ACS access group for which you want to list events.
252
- */
253
- acs_access_group_id?: string | undefined
254
- /**
255
- * ID of the ACS credential for which you want to list events.
256
- */
257
- acs_credential_id?: string | undefined
258
- /**
259
- * ID of the ACS encoder for which you want to list events.
260
- */
261
- acs_encoder_id?: string | undefined
262
- /**
263
- * ID of the ACS entrance for which you want to list events.
264
- */
265
- acs_entrance_id?: string | undefined
266
- /**
267
- * ID of the access system for which you want to list events.
268
- */
269
- acs_system_id?: string | undefined
270
- /**
271
- * IDs of the access systems for which you want to list events.
272
- */
273
- acs_system_ids?: Array<string> | undefined
274
- /**
275
- * ID of the ACS user for which you want to list events.
276
- */
277
- acs_user_id?: string | undefined
278
- /**
279
- * Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`.
280
- */
281
- between?: Array<string> | undefined
282
- /**
283
- * ID of the Connect Webview for which you want to list events.
284
- */
285
- connect_webview_id?: string | undefined
286
- /**
287
- * ID of the connected account for which you want to list events.
288
- */
289
- connected_account_id?: string | undefined
290
- /**
291
- * Customer key for which you want to list events.
292
- */
293
- customer_key?: string | undefined
294
- /**
295
- * ID of the device for which you want to list events.
296
- */
297
- device_id?: string | undefined
298
- /**
299
- * IDs of the devices for which you want to list events.
300
- */
301
- device_ids?: Array<string> | undefined
302
- /**
303
- * IDs of the events that you want to list.
304
- */
305
- event_ids?: Array<string> | undefined
306
- /**
307
- * Type of the events that you want to list.
308
- */
309
- event_type?:
310
- | 'access_code.created'
311
- | 'access_code.changed'
312
- | 'access_code.name_changed'
313
- | 'access_code.code_changed'
314
- | 'access_code.time_frame_changed'
315
- | 'access_code.mutations_requested'
316
- | 'access_code.scheduled_on_device'
317
- | 'access_code.set_on_device'
318
- | 'access_code.removed_from_device'
319
- | 'access_code.delay_in_setting_on_device'
320
- | 'access_code.failed_to_set_on_device'
321
- | 'access_code.issued'
322
- | 'access_code.delay_in_issuing'
323
- | 'access_code.failed_to_issue'
324
- | 'access_code.failed_to_update'
325
- | 'access_code.failed_to_expire'
326
- | 'access_code.deleted'
327
- | 'access_code.delay_in_removing_from_device'
328
- | 'access_code.failed_to_remove_from_device'
329
- | 'access_code.modified_external_to_seam'
330
- | 'access_code.deleted_external_to_seam'
331
- | 'access_code.backup_access_code_pulled'
332
- | 'access_code.unmanaged.converted_to_managed'
333
- | 'access_code.unmanaged.failed_to_convert_to_managed'
334
- | 'access_code.unmanaged.created'
335
- | 'access_code.unmanaged.removed'
336
- | 'access_grant.created'
337
- | 'access_grant.deleted'
338
- | 'access_grant.access_granted_to_all_doors'
339
- | 'access_grant.access_granted_to_door'
340
- | 'access_grant.access_to_door_lost'
341
- | 'access_grant.access_times_changed'
342
- | 'access_grant.could_not_create_requested_access_methods'
343
- | 'access_method.issued'
344
- | 'access_method.revoked'
345
- | 'access_method.card_encoding_required'
346
- | 'access_method.deleted'
347
- | 'access_method.reissued'
348
- | 'access_method.created'
349
- | 'access_method.delay_in_issuing'
350
- | 'access_method.failed_to_issue'
351
- | 'acs_system.connected'
352
- | 'acs_system.added'
353
- | 'acs_system.disconnected'
354
- | 'acs_credential.deleted'
355
- | 'acs_credential.issued'
356
- | 'acs_credential.reissued'
357
- | 'acs_credential.invalidated'
358
- | 'acs_user.created'
359
- | 'acs_user.deleted'
360
- | 'acs_encoder.added'
361
- | 'acs_encoder.removed'
362
- | 'acs_access_group.deleted'
363
- | 'acs_entrance.added'
364
- | 'acs_entrance.removed'
365
- | 'client_session.deleted'
366
- | 'connected_account.connected'
367
- | 'connected_account.created'
368
- | 'connected_account.successful_login'
369
- | 'connected_account.disconnected'
370
- | 'connected_account.completed_first_sync'
371
- | 'connected_account.deleted'
372
- | 'connected_account.completed_first_sync_after_reconnection'
373
- | 'connected_account.reauthorization_requested'
374
- | 'action_attempt.lock_door.succeeded'
375
- | 'action_attempt.lock_door.failed'
376
- | 'action_attempt.unlock_door.succeeded'
377
- | 'action_attempt.unlock_door.failed'
378
- | 'action_attempt.simulate_keypad_code_entry.succeeded'
379
- | 'action_attempt.simulate_keypad_code_entry.failed'
380
- | 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
381
- | 'action_attempt.simulate_manual_lock_via_keypad.failed'
382
- | 'connect_webview.login_succeeded'
383
- | 'connect_webview.login_failed'
384
- | 'device.connected'
385
- | 'device.added'
386
- | 'device.converted_to_unmanaged'
387
- | 'device.unmanaged.converted_to_managed'
388
- | 'device.unmanaged.connected'
389
- | 'device.disconnected'
390
- | 'device.unmanaged.disconnected'
391
- | 'device.tampered'
392
- | 'device.low_battery'
393
- | 'device.battery_status_changed'
394
- | 'device.removed'
395
- | 'device.deleted'
396
- | 'device.third_party_integration_detected'
397
- | 'device.third_party_integration_no_longer_detected'
398
- | 'device.salto.privacy_mode_activated'
399
- | 'device.salto.privacy_mode_deactivated'
400
- | 'device.connection_became_flaky'
401
- | 'device.connection_stabilized'
402
- | 'device.error.subscription_required'
403
- | 'device.error.subscription_required.resolved'
404
- | 'device.accessory_keypad_connected'
405
- | 'device.accessory_keypad_disconnected'
406
- | 'noise_sensor.noise_threshold_triggered'
407
- | 'lock.locked'
408
- | 'lock.unlocked'
409
- | 'lock.access_denied'
410
- | 'thermostat.climate_preset_activated'
411
- | 'thermostat.manually_adjusted'
412
- | 'thermostat.temperature_threshold_exceeded'
413
- | 'thermostat.temperature_threshold_no_longer_exceeded'
414
- | 'thermostat.temperature_reached_set_point'
415
- | 'thermostat.temperature_changed'
416
- | 'device.name_changed'
417
- | 'camera.activated'
418
- | 'device.doorbell_rang'
419
- | 'enrollment_automation.deleted'
420
- | 'phone.deactivated'
421
- | 'space.device_membership_changed'
422
- | 'space.created'
423
- | 'space.deleted'
424
- | undefined
425
- /**
426
- * Types of the events that you want to list.
427
- */
428
- event_types?:
429
- | Array<
430
- | 'access_code.created'
431
- | 'access_code.changed'
432
- | 'access_code.name_changed'
433
- | 'access_code.code_changed'
434
- | 'access_code.time_frame_changed'
435
- | 'access_code.mutations_requested'
436
- | 'access_code.scheduled_on_device'
437
- | 'access_code.set_on_device'
438
- | 'access_code.removed_from_device'
439
- | 'access_code.delay_in_setting_on_device'
440
- | 'access_code.failed_to_set_on_device'
441
- | 'access_code.issued'
442
- | 'access_code.delay_in_issuing'
443
- | 'access_code.failed_to_issue'
444
- | 'access_code.failed_to_update'
445
- | 'access_code.failed_to_expire'
446
- | 'access_code.deleted'
447
- | 'access_code.delay_in_removing_from_device'
448
- | 'access_code.failed_to_remove_from_device'
449
- | 'access_code.modified_external_to_seam'
450
- | 'access_code.deleted_external_to_seam'
451
- | 'access_code.backup_access_code_pulled'
452
- | 'access_code.unmanaged.converted_to_managed'
453
- | 'access_code.unmanaged.failed_to_convert_to_managed'
454
- | 'access_code.unmanaged.created'
455
- | 'access_code.unmanaged.removed'
456
- | 'access_grant.created'
457
- | 'access_grant.deleted'
458
- | 'access_grant.access_granted_to_all_doors'
459
- | 'access_grant.access_granted_to_door'
460
- | 'access_grant.access_to_door_lost'
461
- | 'access_grant.access_times_changed'
462
- | 'access_grant.could_not_create_requested_access_methods'
463
- | 'access_method.issued'
464
- | 'access_method.revoked'
465
- | 'access_method.card_encoding_required'
466
- | 'access_method.deleted'
467
- | 'access_method.reissued'
468
- | 'access_method.created'
469
- | 'access_method.delay_in_issuing'
470
- | 'access_method.failed_to_issue'
471
- | 'acs_system.connected'
472
- | 'acs_system.added'
473
- | 'acs_system.disconnected'
474
- | 'acs_credential.deleted'
475
- | 'acs_credential.issued'
476
- | 'acs_credential.reissued'
477
- | 'acs_credential.invalidated'
478
- | 'acs_user.created'
479
- | 'acs_user.deleted'
480
- | 'acs_encoder.added'
481
- | 'acs_encoder.removed'
482
- | 'acs_access_group.deleted'
483
- | 'acs_entrance.added'
484
- | 'acs_entrance.removed'
485
- | 'client_session.deleted'
486
- | 'connected_account.connected'
487
- | 'connected_account.created'
488
- | 'connected_account.successful_login'
489
- | 'connected_account.disconnected'
490
- | 'connected_account.completed_first_sync'
491
- | 'connected_account.deleted'
492
- | 'connected_account.completed_first_sync_after_reconnection'
493
- | 'connected_account.reauthorization_requested'
494
- | 'action_attempt.lock_door.succeeded'
495
- | 'action_attempt.lock_door.failed'
496
- | 'action_attempt.unlock_door.succeeded'
497
- | 'action_attempt.unlock_door.failed'
498
- | 'action_attempt.simulate_keypad_code_entry.succeeded'
499
- | 'action_attempt.simulate_keypad_code_entry.failed'
500
- | 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
501
- | 'action_attempt.simulate_manual_lock_via_keypad.failed'
502
- | 'connect_webview.login_succeeded'
503
- | 'connect_webview.login_failed'
504
- | 'device.connected'
505
- | 'device.added'
506
- | 'device.converted_to_unmanaged'
507
- | 'device.unmanaged.converted_to_managed'
508
- | 'device.unmanaged.connected'
509
- | 'device.disconnected'
510
- | 'device.unmanaged.disconnected'
511
- | 'device.tampered'
512
- | 'device.low_battery'
513
- | 'device.battery_status_changed'
514
- | 'device.removed'
515
- | 'device.deleted'
516
- | 'device.third_party_integration_detected'
517
- | 'device.third_party_integration_no_longer_detected'
518
- | 'device.salto.privacy_mode_activated'
519
- | 'device.salto.privacy_mode_deactivated'
520
- | 'device.connection_became_flaky'
521
- | 'device.connection_stabilized'
522
- | 'device.error.subscription_required'
523
- | 'device.error.subscription_required.resolved'
524
- | 'device.accessory_keypad_connected'
525
- | 'device.accessory_keypad_disconnected'
526
- | 'noise_sensor.noise_threshold_triggered'
527
- | 'lock.locked'
528
- | 'lock.unlocked'
529
- | 'lock.access_denied'
530
- | 'thermostat.climate_preset_activated'
531
- | 'thermostat.manually_adjusted'
532
- | 'thermostat.temperature_threshold_exceeded'
533
- | 'thermostat.temperature_threshold_no_longer_exceeded'
534
- | 'thermostat.temperature_reached_set_point'
535
- | 'thermostat.temperature_changed'
536
- | 'device.name_changed'
537
- | 'camera.activated'
538
- | 'device.doorbell_rang'
539
- | 'enrollment_automation.deleted'
540
- | 'phone.deactivated'
541
- | 'space.device_membership_changed'
542
- | 'space.created'
543
- | 'space.deleted'
544
- >
545
- | undefined
546
- /**
547
- * Numerical limit on the number of events to return.
548
- */
549
- limit?: number | undefined
550
- /**
551
- * Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`.
552
- */
553
- since?: string | undefined
554
- /**
555
- * ID of the space for which you want to list events.
556
- */
557
- space_id?: string | undefined
558
- /**
559
- * IDs of the spaces for which you want to list events.
560
- */
561
- space_ids?: Array<string> | undefined
562
- /**
563
- * Offset for the events that you want to list.
564
- */
565
- unstable_offset?: number | undefined
566
- /**
567
- * ID of the user identity for which you want to list events.
568
- */
569
- user_identity_id?: string | undefined
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.