@seamapi/http 2.38.0 → 2.39.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 (46) hide show
  1. package/lib/resources/access-grant.d.ts +2 -2
  2. package/lib/resources/access-method.d.ts +16 -1
  3. package/lib/resources/acs-entrance.d.ts +6 -2
  4. package/lib/resources/acs-system.d.ts +15 -0
  5. package/lib/resources/action-attempt.d.ts +332 -7
  6. package/lib/resources/connect-webview.d.ts +1 -1
  7. package/lib/resources/connected-account.d.ts +1 -1
  8. package/lib/resources/device-provider.d.ts +17 -1
  9. package/lib/resources/device.d.ts +112 -1
  10. package/lib/resources/phone.d.ts +702 -10
  11. package/lib/resources/unmanaged-access-grant.d.ts +2 -2
  12. package/lib/resources/unmanaged-access-method.d.ts +16 -1
  13. package/lib/resources/unmanaged-device.d.ts +17 -1
  14. package/lib/routes/connect-webviews/connect-webviews.d.ts +2 -2
  15. package/lib/routes/connected-accounts/connected-accounts.d.ts +1 -1
  16. package/lib/routes/customers/customers.d.ts +13 -0
  17. package/lib/routes/customers/customers.js +1 -0
  18. package/lib/routes/customers/customers.js.map +1 -1
  19. package/lib/routes/devices/devices.d.ts +3 -3
  20. package/lib/routes/devices/unmanaged/unmanaged.d.ts +3 -3
  21. package/lib/routes/seam-http-endpoints.d.ts +1 -0
  22. package/lib/routes/seam-http-endpoints.js +1 -0
  23. package/lib/routes/seam-http-endpoints.js.map +1 -1
  24. package/lib/version.d.ts +1 -1
  25. package/lib/version.js +1 -1
  26. package/package.json +2 -2
  27. package/src/lib/resources/access-grant.ts +2 -2
  28. package/src/lib/resources/access-method.ts +19 -1
  29. package/src/lib/resources/acs-entrance.ts +17 -12
  30. package/src/lib/resources/acs-system.ts +18 -0
  31. package/src/lib/resources/action-attempt.ts +425 -24
  32. package/src/lib/resources/connect-webview.ts +6 -1
  33. package/src/lib/resources/connected-account.ts +6 -1
  34. package/src/lib/resources/device-provider.ts +17 -0
  35. package/src/lib/resources/device.ts +127 -0
  36. package/src/lib/resources/phone.ts +855 -22
  37. package/src/lib/resources/unmanaged-access-grant.ts +2 -2
  38. package/src/lib/resources/unmanaged-access-method.ts +19 -1
  39. package/src/lib/resources/unmanaged-device.ts +17 -0
  40. package/src/lib/routes/connect-webviews/connect-webviews.ts +7 -1
  41. package/src/lib/routes/connected-accounts/connected-accounts.ts +6 -1
  42. package/src/lib/routes/customers/customers.ts +13 -0
  43. package/src/lib/routes/devices/devices.ts +3 -0
  44. package/src/lib/routes/devices/unmanaged/unmanaged.ts +3 -0
  45. package/src/lib/routes/seam-http-endpoints.ts +1 -0
  46. package/src/lib/version.ts +1 -1
@@ -33,24 +33,356 @@ export type Phone = {
33
33
  display_name: string
34
34
 
35
35
  /**
36
- * Errors associated with the phone.
36
+ * Array of errors associated with the device. Each error object within the array contains two fields: `error_code` and `message`. `error_code` is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
37
37
  */
38
- errors: Array<{
38
+ errors: Array<
39
39
  /**
40
- * Date and time at which Seam created the error.
40
+ * Indicates that the account is disconnected.
41
41
  */
42
- created_at: string
42
+ | {
43
+ /**
44
+ * Date and time at which Seam created the error.
45
+ */
46
+ created_at: string
43
47
 
44
- /**
45
- * Unique identifier of the type of error.
48
+ /**
49
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
50
+ */
51
+ error_code: 'account_disconnected'
52
+
53
+ /**
54
+ * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
55
+ */
56
+ is_connected_account_error: true
57
+
58
+ /**
59
+ * Indicates that the error is not a device error.
60
+ */
61
+ is_device_error: false
62
+
63
+ /**
64
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
65
+ */
66
+ message: string
67
+ } /**
68
+ * Indicates that the Salto site user limit has been reached.
46
69
  */
47
- error_code: string
70
+ | {
71
+ /**
72
+ * Date and time at which Seam created the error.
73
+ */
74
+ created_at: string
48
75
 
49
- /**
50
- * Detailed description of the error.
76
+ /**
77
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
78
+ */
79
+ error_code: 'salto_ks_subscription_limit_exceeded'
80
+
81
+ /**
82
+ * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
83
+ */
84
+ is_connected_account_error: true
85
+
86
+ /**
87
+ * Indicates that the error is not a device error.
88
+ */
89
+ is_device_error: false
90
+
91
+ /**
92
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
93
+ */
94
+ message: string
95
+ } /**
96
+ * Indicates that the provider's system to which this device belongs is not letting Seam act on it, so Seam cannot manage access codes or unlock the device. The error message says which of three causes applies. Seam's integration user may not have sufficient permissions on the provider's system, or may have been suspended there: grant the integration user the required permissions in the provider's system, or reauthorize the connected account in Seam. The provider account or site may not have a valid subscription with the provider: set up or renew that subscription with the provider. Or the provider may have rejected the credential Seam uses to operate the device's hub: contact Seam support to re-activate it.
97
+ */
98
+ | {
99
+ /**
100
+ * Date and time at which Seam created the error.
101
+ */
102
+ created_at: string
103
+
104
+ /**
105
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
106
+ */
107
+ error_code: 'insufficient_permissions'
108
+
109
+ /**
110
+ * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
111
+ */
112
+ is_connected_account_error: true
113
+
114
+ /**
115
+ * Indicates that the error is not a device error.
116
+ */
117
+ is_device_error: false
118
+
119
+ /**
120
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
121
+ */
122
+ message: string
123
+ } /**
124
+ * Indicates that one or more dormakaba sites associated with the connected account could not be connected. Contact dormakaba support.
125
+ */
126
+ | {
127
+ /**
128
+ * Date and time at which Seam created the error.
129
+ */
130
+ created_at: string
131
+
132
+ /**
133
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
134
+ */
135
+ error_code: 'dormakaba_sites_disconnected'
136
+
137
+ /**
138
+ * Indicates that the error is a [connected account](https://www.seam.co/docs/api/connected_accounts/object) error.
139
+ */
140
+ is_connected_account_error: true
141
+
142
+ /**
143
+ * Indicates that the error is not a device error.
144
+ */
145
+ is_device_error: false
146
+
147
+ /**
148
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
149
+ */
150
+ message: string
151
+ } /**
152
+ * Indicates that the device is offline.
153
+ */
154
+ | {
155
+ /**
156
+ * Date and time at which Seam created the error.
157
+ */
158
+ created_at: string
159
+
160
+ /**
161
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
162
+ */
163
+ error_code: 'device_offline'
164
+
165
+ /**
166
+ * Indicates that the error is a device error.
167
+ */
168
+ is_device_error: true
169
+
170
+ /**
171
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
172
+ */
173
+ message: string
174
+ } /**
175
+ * Indicates that the device has been removed.
176
+ */
177
+ | {
178
+ /**
179
+ * Date and time at which Seam created the error.
180
+ */
181
+ created_at: string
182
+
183
+ /**
184
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
185
+ */
186
+ error_code: 'device_removed'
187
+
188
+ /**
189
+ * Indicates that the error is a device error.
190
+ */
191
+ is_device_error: true
192
+
193
+ /**
194
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
195
+ */
196
+ message: string
197
+ } /**
198
+ * Indicates that the hub is disconnected.
199
+ */
200
+ | {
201
+ /**
202
+ * Date and time at which Seam created the error.
203
+ */
204
+ created_at: string
205
+
206
+ /**
207
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
208
+ */
209
+ error_code: 'hub_disconnected'
210
+
211
+ /**
212
+ * Indicates that the error is a device error.
213
+ */
214
+ is_device_error: true
215
+
216
+ /**
217
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
218
+ */
219
+ message: string
220
+ } /**
221
+ * Indicates that the device is disconnected.
222
+ */
223
+ | {
224
+ /**
225
+ * Date and time at which Seam created the error.
226
+ */
227
+ created_at: string
228
+
229
+ /**
230
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
231
+ */
232
+ error_code: 'device_disconnected'
233
+
234
+ /**
235
+ * Indicates that the error is a device error.
236
+ */
237
+ is_device_error: true
238
+
239
+ /**
240
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
241
+ */
242
+ message: string
243
+ } /**
244
+ * Indicates that the [backup access code pool](https://www.seam.co/docs/low-level-apis/smart-locks/access-codes/backup-access-codes) is empty.
245
+ */
246
+ | {
247
+ /**
248
+ * Date and time at which Seam created the error.
249
+ */
250
+ created_at: string
251
+
252
+ /**
253
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
254
+ */
255
+ error_code: 'empty_backup_access_code_pool'
256
+
257
+ /**
258
+ * Indicates that the error is a device error.
259
+ */
260
+ is_device_error: true
261
+
262
+ /**
263
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
264
+ */
265
+ message: string
266
+ } /**
267
+ * Indicates that the user is not authorized to use the August lock.
268
+ */
269
+ | {
270
+ /**
271
+ * Date and time at which Seam created the error.
272
+ */
273
+ created_at: string
274
+
275
+ /**
276
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
277
+ */
278
+ error_code: 'august_lock_not_authorized'
279
+
280
+ /**
281
+ * Indicates that the error is a device error.
282
+ */
283
+ is_device_error: true
284
+
285
+ /**
286
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
287
+ */
288
+ message: string
289
+ } /**
290
+ * Indicates that device credentials are missing.
291
+ */
292
+ | {
293
+ /**
294
+ * Date and time at which Seam created the error.
295
+ */
296
+ created_at: string
297
+
298
+ /**
299
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
300
+ */
301
+ error_code: 'missing_device_credentials'
302
+
303
+ /**
304
+ * Indicates that the error is a device error.
305
+ */
306
+ is_device_error: true
307
+
308
+ /**
309
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
310
+ */
311
+ message: string
312
+ } /**
313
+ * Indicates that the auxiliary heat is running.
51
314
  */
52
- message: string
53
- }>
315
+ | {
316
+ /**
317
+ * Date and time at which Seam created the error.
318
+ */
319
+ created_at: string
320
+
321
+ /**
322
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
323
+ */
324
+ error_code: 'auxiliary_heat_running'
325
+
326
+ /**
327
+ * Indicates that the error is a device error.
328
+ */
329
+ is_device_error: true
330
+
331
+ /**
332
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
333
+ */
334
+ message: string
335
+ } /**
336
+ * Indicates that a subscription is required to connect.
337
+ */
338
+ | {
339
+ /**
340
+ * Date and time at which Seam created the error.
341
+ */
342
+ created_at: string
343
+
344
+ /**
345
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
346
+ */
347
+ error_code: 'subscription_required'
348
+
349
+ /**
350
+ * Indicates that the error is a device error.
351
+ */
352
+ is_device_error: true
353
+
354
+ /**
355
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
356
+ */
357
+ message: string
358
+ } /**
359
+ * Indicates that the Seam API cannot communicate with [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge), for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also [Troubleshooting Your Access Control System](https://www.seam.co/docs/low-level-apis/access-systems/troubleshooting-your-access-control-system#acs_system-errors-seam_bridge_disconnected).
360
+ */
361
+ | {
362
+ /**
363
+ * Date and time at which Seam created the error.
364
+ */
365
+ created_at: string
366
+
367
+ /**
368
+ * Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
369
+ */
370
+ error_code: 'bridge_disconnected'
371
+
372
+ /**
373
+ * Indicates whether the error is related to [Seam Bridge](https://www.seam.co/docs/capability-guides/seam-bridge).
374
+ */
375
+ is_bridge_error?: boolean | undefined
376
+ /**
377
+ * Indicates whether the error is related specifically to the connected account.
378
+ */
379
+ is_connected_account_error?: boolean | undefined
380
+ /**
381
+ * Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
382
+ */
383
+ message: string
384
+ }
385
+ >
54
386
 
55
387
  /**
56
388
  * Optional nickname to describe the phone, settable through Seam.
@@ -100,24 +432,525 @@ export type Phone = {
100
432
  }
101
433
 
102
434
  /**
103
- * Warnings associated with the phone.
435
+ * Array of warnings associated with the device. Each warning object within the array contains two fields: `warning_code` and `message`. `warning_code` is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. `message` provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
104
436
  */
105
- warnings: Array<{
437
+ warnings: Array<
106
438
  /**
107
- * Date and time at which Seam created the warning.
439
+ * Indicates that the backup access code is unhealthy.
108
440
  */
109
- created_at: string
441
+ | {
442
+ /**
443
+ * Date and time at which Seam created the warning.
444
+ */
445
+ created_at: string
110
446
 
111
- /**
112
- * Detailed description of the warning.
447
+ /**
448
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
449
+ */
450
+ message: string
451
+
452
+ /**
453
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
454
+ */
455
+ warning_code: 'partial_backup_access_code_pool'
456
+ } /**
457
+ * Indicates that there are too many backup codes.
113
458
  */
114
- message: string
459
+ | {
460
+ /**
461
+ * Date and time at which Seam created the warning.
462
+ */
463
+ created_at: string
115
464
 
116
- /**
117
- * Unique identifier of the type of warning.
465
+ /**
466
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
467
+ */
468
+ message: string
469
+
470
+ /**
471
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
472
+ */
473
+ warning_code: 'many_active_backup_codes'
474
+ } /**
475
+ * Indicates that a third-party integration has been detected.
118
476
  */
119
- warning_code: string
120
- }>
477
+ | {
478
+ /**
479
+ * Date and time at which Seam created the warning.
480
+ */
481
+ created_at: string
482
+
483
+ /**
484
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
485
+ */
486
+ message: string
487
+
488
+ /**
489
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
490
+ */
491
+ warning_code: 'third_party_integration_detected'
492
+ } /**
493
+ * Indicates that the Remote Unlock feature is not enabled in the settings."
494
+ */
495
+ | {
496
+ /**
497
+ * Date and time at which Seam created the warning.
498
+ */
499
+ created_at: string
500
+
501
+ /**
502
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
503
+ */
504
+ message: string
505
+
506
+ /**
507
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
508
+ */
509
+ warning_code: 'ttlock_lock_gateway_unlocking_not_enabled'
510
+ } /**
511
+ * Indicates that the gateway signal is weak.
512
+ */
513
+ | {
514
+ /**
515
+ * Date and time at which Seam created the warning.
516
+ */
517
+ created_at: string
518
+
519
+ /**
520
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
521
+ */
522
+ message: string
523
+
524
+ /**
525
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
526
+ */
527
+ warning_code: 'ttlock_weak_gateway_signal'
528
+ } /**
529
+ * Indicates that the device is in power saving mode and may have limited functionality.
530
+ */
531
+ | {
532
+ /**
533
+ * Date and time at which Seam created the warning.
534
+ */
535
+ created_at: string
536
+
537
+ /**
538
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
539
+ */
540
+ message: string
541
+
542
+ /**
543
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
544
+ */
545
+ warning_code: 'power_saving_mode'
546
+ } /**
547
+ * Indicates that the temperature threshold has been exceeded.
548
+ */
549
+ | {
550
+ /**
551
+ * Date and time at which Seam created the warning.
552
+ */
553
+ created_at: string
554
+
555
+ /**
556
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
557
+ */
558
+ message: string
559
+
560
+ /**
561
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
562
+ */
563
+ warning_code: 'temperature_threshold_exceeded'
564
+ } /**
565
+ * Indicates that the device appears to be unresponsive.
566
+ */
567
+ | {
568
+ /**
569
+ * Date and time at which Seam created the warning.
570
+ */
571
+ created_at: string
572
+
573
+ /**
574
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
575
+ */
576
+ message: string
577
+
578
+ /**
579
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
580
+ */
581
+ warning_code: 'device_communication_degraded'
582
+ } /**
583
+ * Indicates that a scheduled maintenance window has been detected.
584
+ */
585
+ | {
586
+ /**
587
+ * Date and time at which Seam created the warning.
588
+ */
589
+ created_at: string
590
+
591
+ /**
592
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
593
+ */
594
+ message: string
595
+
596
+ /**
597
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
598
+ */
599
+ warning_code: 'scheduled_maintenance_window'
600
+ } /**
601
+ * Indicates that the device has a flaky connection.
602
+ */
603
+ | {
604
+ /**
605
+ * Date and time at which Seam created the warning.
606
+ */
607
+ created_at: string
608
+
609
+ /**
610
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
611
+ */
612
+ message: string
613
+
614
+ /**
615
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
616
+ */
617
+ warning_code: 'device_has_flaky_connection'
618
+ } /**
619
+ * Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.
620
+ */
621
+ | {
622
+ /**
623
+ * Date and time at which Seam created the warning.
624
+ */
625
+ created_at: string
626
+
627
+ /**
628
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
629
+ */
630
+ message: string
631
+
632
+ /**
633
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
634
+ */
635
+ warning_code: 'salto_ks_office_mode'
636
+ } /**
637
+ * Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
638
+ */
639
+ | {
640
+ /**
641
+ * Date and time at which Seam created the warning.
642
+ */
643
+ created_at: string
644
+
645
+ /**
646
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
647
+ */
648
+ message: string
649
+
650
+ /**
651
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
652
+ */
653
+ warning_code: 'salto_ks_privacy_mode'
654
+ } /**
655
+ * Indicates that the lock is in Privacy Mode. Access codes and remote unlock are blocked until Privacy Mode is disabled.
656
+ */
657
+ | {
658
+ /**
659
+ * Date and time at which Seam created the warning.
660
+ */
661
+ created_at: string
662
+
663
+ /**
664
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
665
+ */
666
+ message: string
667
+
668
+ /**
669
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
670
+ */
671
+ warning_code: 'privacy_mode'
672
+ } /**
673
+ * Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
674
+ */
675
+ | {
676
+ /**
677
+ * Date and time at which Seam created the warning.
678
+ */
679
+ created_at: string
680
+
681
+ /**
682
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
683
+ */
684
+ message: string
685
+
686
+ /**
687
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
688
+ */
689
+ warning_code: 'salto_ks_subscription_limit_almost_reached'
690
+ } /**
691
+ * Indicates that a change in the reported device model has been detected for this Salto KS lock, which may occur after an IQ hub reset. Access code support may be affected. See https://help.getseam.com/articles/5098842588-salto-ks-lock-loses-access-code-support for troubleshooting steps.
692
+ */
693
+ | {
694
+ /**
695
+ * Date and time at which Seam created the warning.
696
+ */
697
+ created_at: string
698
+
699
+ /**
700
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
701
+ */
702
+ message: string
703
+
704
+ /**
705
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
706
+ */
707
+ warning_code: 'salto_ks_lock_access_code_support_removed'
708
+ } /**
709
+ * Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.
710
+ */
711
+ | {
712
+ /**
713
+ * Date and time at which Seam created the warning.
714
+ */
715
+ created_at: string
716
+
717
+ /**
718
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
719
+ */
720
+ message: string
721
+
722
+ /**
723
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
724
+ */
725
+ warning_code: 'unknown_issue_with_phone'
726
+ } /**
727
+ * Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.
728
+ */
729
+ | {
730
+ /**
731
+ * Date and time at which Seam created the warning.
732
+ */
733
+ created_at: string
734
+
735
+ /**
736
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
737
+ */
738
+ message: string
739
+
740
+ /**
741
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
742
+ */
743
+ warning_code: 'lockly_time_zone_not_configured'
744
+ } /**
745
+ * Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.
746
+ */
747
+ | {
748
+ /**
749
+ * Date and time at which Seam created the warning.
750
+ */
751
+ created_at: string
752
+
753
+ /**
754
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
755
+ */
756
+ message: string
757
+
758
+ /**
759
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
760
+ */
761
+ warning_code: 'ultraloq_time_zone_unknown'
762
+ } /**
763
+ * Indicates that Seam does not know the device's time zone. Set a time zone to enable time-bound access codes.
764
+ */
765
+ | {
766
+ /**
767
+ * Date and time at which Seam created the warning.
768
+ */
769
+ created_at: string
770
+
771
+ /**
772
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
773
+ */
774
+ message: string
775
+
776
+ /**
777
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
778
+ */
779
+ warning_code: 'time_zone_unknown'
780
+ } /**
781
+ * Indicates that the device's configured time zone does not match its hardware UTC offset. Time-bound access codes may activate at the wrong local time.
782
+ */
783
+ | {
784
+ /**
785
+ * Date and time at which Seam created the warning.
786
+ */
787
+ created_at: string
788
+
789
+ /**
790
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
791
+ */
792
+ message: string
793
+
794
+ /**
795
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
796
+ */
797
+ warning_code: 'time_zone_mismatch'
798
+ } /**
799
+ * Indicates that the 2N device does not have a time zone configured. Configure a time zone on the device to enable access codes.
800
+ */
801
+ | {
802
+ /**
803
+ * Date and time at which Seam created the warning.
804
+ */
805
+ created_at: string
806
+
807
+ /**
808
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
809
+ */
810
+ message: string
811
+
812
+ /**
813
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
814
+ */
815
+ warning_code: 'two_n_device_missing_timezone'
816
+ } /**
817
+ * Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.
818
+ */
819
+ | {
820
+ /**
821
+ * Date and time at which Seam created the warning.
822
+ */
823
+ created_at: string
824
+
825
+ /**
826
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
827
+ */
828
+ message: string
829
+
830
+ /**
831
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
832
+ */
833
+ warning_code: 'hub_required_for_additional_capabilities'
834
+ } /**
835
+ * Indicates a provider-specific issue that may affect device functionality.
836
+ */
837
+ | {
838
+ /**
839
+ * Date and time at which Seam created the warning.
840
+ */
841
+ created_at: string
842
+
843
+ /**
844
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
845
+ */
846
+ message: string
847
+
848
+ /**
849
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
850
+ */
851
+ warning_code: 'provider_issue'
852
+ } /**
853
+ * Indicates that the key is in a locker that does not support the access codes API.
854
+ */
855
+ | {
856
+ /**
857
+ * Date and time at which Seam created the warning.
858
+ */
859
+ created_at: string
860
+
861
+ /**
862
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
863
+ */
864
+ message: string
865
+
866
+ /**
867
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
868
+ */
869
+ warning_code: 'keynest_unsupported_locker'
870
+ } /**
871
+ * Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.
872
+ */
873
+ | {
874
+ /**
875
+ * Date and time at which Seam created the warning.
876
+ */
877
+ created_at: string
878
+
879
+ /**
880
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
881
+ */
882
+ message: string
883
+
884
+ /**
885
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
886
+ */
887
+ warning_code: 'accessory_keypad_setup_required'
888
+ } /**
889
+ * Indicates that the accessory keypad paired with this lock has a low or critically low battery. Replace its batteries so guests can keep entering their access codes.
890
+ */
891
+ | {
892
+ /**
893
+ * Date and time at which Seam created the warning.
894
+ */
895
+ created_at: string
896
+
897
+ /**
898
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
899
+ */
900
+ message: string
901
+
902
+ /**
903
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
904
+ */
905
+ warning_code: 'accessory_keypad_low_battery'
906
+ } /**
907
+ * Indicates that the device may optimistically be reported as online because the provider does not reliably report its online status.
908
+ */
909
+ | {
910
+ /**
911
+ * Date and time at which Seam created the warning.
912
+ */
913
+ created_at: string
914
+
915
+ /**
916
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
917
+ */
918
+ message: string
919
+
920
+ /**
921
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
922
+ */
923
+ warning_code: 'unreliable_online_status'
924
+ } /**
925
+ * Indicates that the device has reached its maximum number of active access codes. Delete existing codes before creating new ones.
926
+ */
927
+ | {
928
+ /**
929
+ * Number of active access codes on the device when the warning was set.
930
+ */
931
+ active_access_code_count: number
932
+
933
+ /**
934
+ * Date and time at which Seam created the warning.
935
+ */
936
+ created_at: string
937
+
938
+ /**
939
+ * Maximum number of active access codes supported by the device.
940
+ */
941
+ max_active_access_code_count: number
942
+
943
+ /**
944
+ * Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
945
+ */
946
+ message: string
947
+
948
+ /**
949
+ * Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
950
+ */
951
+ warning_code: 'max_access_codes_reached'
952
+ }
953
+ >
121
954
 
122
955
  /**
123
956
  * ID of the workspace that contains the phone.