@seamapi/types 1.331.0 → 1.332.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/dist/connect.cjs +731 -98
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +1643 -71
- package/lib/seam/connect/models/devices/device.d.ts +380 -16
- package/lib/seam/connect/models/devices/device.js +125 -5
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/phone.d.ts +235 -11
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +235 -11
- package/lib/seam/connect/openapi.d.ts +42 -27
- package/lib/seam/connect/openapi.js +668 -95
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1025 -56
- package/package.json +1 -1
- package/src/lib/seam/connect/models/devices/device.ts +143 -6
- package/src/lib/seam/connect/openapi.ts +706 -76
- package/src/lib/seam/connect/route-types.ts +1318 -77
|
@@ -5861,12 +5861,203 @@ export default {
|
|
|
5861
5861
|
warnings: {
|
|
5862
5862
|
description: '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.',
|
|
5863
5863
|
items: {
|
|
5864
|
-
|
|
5865
|
-
|
|
5866
|
-
|
|
5867
|
-
|
|
5868
|
-
|
|
5869
|
-
|
|
5864
|
+
oneOf: [
|
|
5865
|
+
{
|
|
5866
|
+
description: 'Backup access code unhealthy.',
|
|
5867
|
+
properties: {
|
|
5868
|
+
message: { type: 'string' },
|
|
5869
|
+
warning_code: {
|
|
5870
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5871
|
+
enum: ['partial_backup_access_code_pool'],
|
|
5872
|
+
type: 'string',
|
|
5873
|
+
},
|
|
5874
|
+
},
|
|
5875
|
+
required: ['message', 'warning_code'],
|
|
5876
|
+
type: 'object',
|
|
5877
|
+
},
|
|
5878
|
+
{
|
|
5879
|
+
description: 'Too many backup codes.',
|
|
5880
|
+
properties: {
|
|
5881
|
+
message: { type: 'string' },
|
|
5882
|
+
warning_code: {
|
|
5883
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5884
|
+
enum: ['many_active_backup_codes'],
|
|
5885
|
+
type: 'string',
|
|
5886
|
+
},
|
|
5887
|
+
},
|
|
5888
|
+
required: ['message', 'warning_code'],
|
|
5889
|
+
type: 'object',
|
|
5890
|
+
},
|
|
5891
|
+
{
|
|
5892
|
+
description: 'A Salto Lock displaying an unknown device type.',
|
|
5893
|
+
properties: {
|
|
5894
|
+
message: { type: 'string' },
|
|
5895
|
+
warning_code: {
|
|
5896
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5897
|
+
enum: ['salto_unknown_device_type'],
|
|
5898
|
+
type: 'string',
|
|
5899
|
+
},
|
|
5900
|
+
},
|
|
5901
|
+
required: ['message', 'warning_code'],
|
|
5902
|
+
type: 'object',
|
|
5903
|
+
},
|
|
5904
|
+
{
|
|
5905
|
+
description: 'Wyze Lock is not connected to a gateway.',
|
|
5906
|
+
properties: {
|
|
5907
|
+
message: { type: 'string' },
|
|
5908
|
+
warning_code: {
|
|
5909
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5910
|
+
enum: ['wyze_device_missing_gateway'],
|
|
5911
|
+
type: 'string',
|
|
5912
|
+
},
|
|
5913
|
+
},
|
|
5914
|
+
required: ['message', 'warning_code'],
|
|
5915
|
+
type: 'object',
|
|
5916
|
+
},
|
|
5917
|
+
{
|
|
5918
|
+
description: 'Device is offline, but has some functionality available.',
|
|
5919
|
+
properties: {
|
|
5920
|
+
message: { type: 'string' },
|
|
5921
|
+
warning_code: {
|
|
5922
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5923
|
+
enum: ['functional_offline_device'],
|
|
5924
|
+
type: 'string',
|
|
5925
|
+
},
|
|
5926
|
+
},
|
|
5927
|
+
required: ['message', 'warning_code'],
|
|
5928
|
+
type: 'object',
|
|
5929
|
+
},
|
|
5930
|
+
{
|
|
5931
|
+
description: 'Third-party integration detected.',
|
|
5932
|
+
properties: {
|
|
5933
|
+
message: { type: 'string' },
|
|
5934
|
+
warning_code: {
|
|
5935
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5936
|
+
enum: ['third_party_integration_detected'],
|
|
5937
|
+
type: 'string',
|
|
5938
|
+
},
|
|
5939
|
+
},
|
|
5940
|
+
required: ['message', 'warning_code'],
|
|
5941
|
+
type: 'object',
|
|
5942
|
+
},
|
|
5943
|
+
{
|
|
5944
|
+
description: 'Nest thermostat in manual eco mode.',
|
|
5945
|
+
properties: {
|
|
5946
|
+
message: { type: 'string' },
|
|
5947
|
+
warning_code: {
|
|
5948
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5949
|
+
enum: ['nest_thermostat_in_manual_eco_mode'],
|
|
5950
|
+
type: 'string',
|
|
5951
|
+
},
|
|
5952
|
+
},
|
|
5953
|
+
required: ['message', 'warning_code'],
|
|
5954
|
+
type: 'object',
|
|
5955
|
+
},
|
|
5956
|
+
{
|
|
5957
|
+
description: 'Remote Unlock feature not enabled in settings.',
|
|
5958
|
+
properties: {
|
|
5959
|
+
message: { type: 'string' },
|
|
5960
|
+
warning_code: {
|
|
5961
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5962
|
+
enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
|
|
5963
|
+
type: 'string',
|
|
5964
|
+
},
|
|
5965
|
+
},
|
|
5966
|
+
required: ['message', 'warning_code'],
|
|
5967
|
+
type: 'object',
|
|
5968
|
+
},
|
|
5969
|
+
{
|
|
5970
|
+
description: 'Gateway signal is weak.',
|
|
5971
|
+
properties: {
|
|
5972
|
+
message: { type: 'string' },
|
|
5973
|
+
warning_code: {
|
|
5974
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5975
|
+
enum: ['ttlock_weak_gateway_signal'],
|
|
5976
|
+
type: 'string',
|
|
5977
|
+
},
|
|
5978
|
+
},
|
|
5979
|
+
required: ['message', 'warning_code'],
|
|
5980
|
+
type: 'object',
|
|
5981
|
+
},
|
|
5982
|
+
{
|
|
5983
|
+
description: 'Temperature threshold exceeded.',
|
|
5984
|
+
properties: {
|
|
5985
|
+
message: { type: 'string' },
|
|
5986
|
+
warning_code: {
|
|
5987
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
5988
|
+
enum: ['temperature_threshold_exceeded'],
|
|
5989
|
+
type: 'string',
|
|
5990
|
+
},
|
|
5991
|
+
},
|
|
5992
|
+
required: ['message', 'warning_code'],
|
|
5993
|
+
type: 'object',
|
|
5994
|
+
},
|
|
5995
|
+
{
|
|
5996
|
+
description: 'Device appears to be unresponsive.',
|
|
5997
|
+
properties: {
|
|
5998
|
+
message: { type: 'string' },
|
|
5999
|
+
warning_code: {
|
|
6000
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6001
|
+
enum: ['device_communication_degraded'],
|
|
6002
|
+
type: 'string',
|
|
6003
|
+
},
|
|
6004
|
+
},
|
|
6005
|
+
required: ['message', 'warning_code'],
|
|
6006
|
+
type: 'object',
|
|
6007
|
+
},
|
|
6008
|
+
{
|
|
6009
|
+
description: 'Scheduled maintenance window detected.',
|
|
6010
|
+
properties: {
|
|
6011
|
+
message: { type: 'string' },
|
|
6012
|
+
warning_code: {
|
|
6013
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6014
|
+
enum: ['scheduled_maintenance_window'],
|
|
6015
|
+
type: 'string',
|
|
6016
|
+
},
|
|
6017
|
+
},
|
|
6018
|
+
required: ['message', 'warning_code'],
|
|
6019
|
+
type: 'object',
|
|
6020
|
+
},
|
|
6021
|
+
{
|
|
6022
|
+
description: 'Device has flaky connection.',
|
|
6023
|
+
properties: {
|
|
6024
|
+
message: { type: 'string' },
|
|
6025
|
+
warning_code: {
|
|
6026
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6027
|
+
enum: ['device_has_flaky_connection'],
|
|
6028
|
+
type: 'string',
|
|
6029
|
+
},
|
|
6030
|
+
},
|
|
6031
|
+
required: ['message', 'warning_code'],
|
|
6032
|
+
type: 'object',
|
|
6033
|
+
},
|
|
6034
|
+
{
|
|
6035
|
+
description: 'Lock is in Office Mode. Access Codes will not unlock doors.',
|
|
6036
|
+
properties: {
|
|
6037
|
+
message: { type: 'string' },
|
|
6038
|
+
warning_code: {
|
|
6039
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6040
|
+
enum: ['salto_office_mode'],
|
|
6041
|
+
type: 'string',
|
|
6042
|
+
},
|
|
6043
|
+
},
|
|
6044
|
+
required: ['message', 'warning_code'],
|
|
6045
|
+
type: 'object',
|
|
6046
|
+
},
|
|
6047
|
+
{
|
|
6048
|
+
description: 'Lock is in Privacy Mode. Access Codes will not unlock doors.',
|
|
6049
|
+
properties: {
|
|
6050
|
+
message: { type: 'string' },
|
|
6051
|
+
warning_code: {
|
|
6052
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
6053
|
+
enum: ['salto_privacy_mode'],
|
|
6054
|
+
type: 'string',
|
|
6055
|
+
},
|
|
6056
|
+
},
|
|
6057
|
+
required: ['message', 'warning_code'],
|
|
6058
|
+
type: 'object',
|
|
6059
|
+
},
|
|
6060
|
+
],
|
|
5870
6061
|
},
|
|
5871
6062
|
type: 'array',
|
|
5872
6063
|
},
|
|
@@ -10339,89 +10530,280 @@ export default {
|
|
|
10339
10530
|
warnings: {
|
|
10340
10531
|
description: '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.',
|
|
10341
10532
|
items: {
|
|
10342
|
-
|
|
10343
|
-
|
|
10344
|
-
|
|
10345
|
-
|
|
10346
|
-
|
|
10347
|
-
|
|
10348
|
-
|
|
10349
|
-
|
|
10350
|
-
|
|
10351
|
-
|
|
10352
|
-
|
|
10353
|
-
|
|
10354
|
-
|
|
10355
|
-
|
|
10356
|
-
|
|
10357
|
-
|
|
10358
|
-
|
|
10359
|
-
|
|
10360
|
-
|
|
10361
|
-
|
|
10362
|
-
|
|
10363
|
-
|
|
10364
|
-
|
|
10365
|
-
|
|
10366
|
-
|
|
10367
|
-
|
|
10368
|
-
|
|
10369
|
-
|
|
10370
|
-
|
|
10371
|
-
|
|
10372
|
-
|
|
10373
|
-
|
|
10374
|
-
|
|
10375
|
-
|
|
10376
|
-
|
|
10377
|
-
|
|
10378
|
-
|
|
10379
|
-
|
|
10380
|
-
|
|
10381
|
-
|
|
10382
|
-
|
|
10383
|
-
|
|
10384
|
-
|
|
10385
|
-
|
|
10386
|
-
|
|
10387
|
-
|
|
10388
|
-
|
|
10389
|
-
|
|
10390
|
-
|
|
10391
|
-
|
|
10392
|
-
|
|
10393
|
-
|
|
10394
|
-
|
|
10395
|
-
|
|
10396
|
-
|
|
10397
|
-
|
|
10398
|
-
|
|
10399
|
-
|
|
10400
|
-
|
|
10401
|
-
|
|
10402
|
-
|
|
10403
|
-
|
|
10404
|
-
|
|
10405
|
-
|
|
10406
|
-
|
|
10407
|
-
|
|
10408
|
-
|
|
10409
|
-
|
|
10410
|
-
|
|
10411
|
-
|
|
10412
|
-
|
|
10413
|
-
|
|
10414
|
-
|
|
10415
|
-
|
|
10416
|
-
|
|
10417
|
-
|
|
10418
|
-
|
|
10419
|
-
|
|
10420
|
-
|
|
10421
|
-
|
|
10422
|
-
|
|
10423
|
-
|
|
10424
|
-
|
|
10533
|
+
oneOf: [
|
|
10534
|
+
{
|
|
10535
|
+
description: 'Backup access code unhealthy.',
|
|
10536
|
+
properties: {
|
|
10537
|
+
message: { type: 'string' },
|
|
10538
|
+
warning_code: {
|
|
10539
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10540
|
+
enum: ['partial_backup_access_code_pool'],
|
|
10541
|
+
type: 'string',
|
|
10542
|
+
},
|
|
10543
|
+
},
|
|
10544
|
+
required: ['message', 'warning_code'],
|
|
10545
|
+
type: 'object',
|
|
10546
|
+
},
|
|
10547
|
+
{
|
|
10548
|
+
description: 'Too many backup codes.',
|
|
10549
|
+
properties: {
|
|
10550
|
+
message: { type: 'string' },
|
|
10551
|
+
warning_code: {
|
|
10552
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10553
|
+
enum: ['many_active_backup_codes'],
|
|
10554
|
+
type: 'string',
|
|
10555
|
+
},
|
|
10556
|
+
},
|
|
10557
|
+
required: ['message', 'warning_code'],
|
|
10558
|
+
type: 'object',
|
|
10559
|
+
},
|
|
10560
|
+
{
|
|
10561
|
+
description: 'A Salto Lock displaying an unknown device type.',
|
|
10562
|
+
properties: {
|
|
10563
|
+
message: { type: 'string' },
|
|
10564
|
+
warning_code: {
|
|
10565
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10566
|
+
enum: ['salto_unknown_device_type'],
|
|
10567
|
+
type: 'string',
|
|
10568
|
+
},
|
|
10569
|
+
},
|
|
10570
|
+
required: ['message', 'warning_code'],
|
|
10571
|
+
type: 'object',
|
|
10572
|
+
},
|
|
10573
|
+
{
|
|
10574
|
+
description: 'Wyze Lock is not connected to a gateway.',
|
|
10575
|
+
properties: {
|
|
10576
|
+
message: { type: 'string' },
|
|
10577
|
+
warning_code: {
|
|
10578
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10579
|
+
enum: ['wyze_device_missing_gateway'],
|
|
10580
|
+
type: 'string',
|
|
10581
|
+
},
|
|
10582
|
+
},
|
|
10583
|
+
required: ['message', 'warning_code'],
|
|
10584
|
+
type: 'object',
|
|
10585
|
+
},
|
|
10586
|
+
{
|
|
10587
|
+
description: 'Device is offline, but has some functionality available.',
|
|
10588
|
+
properties: {
|
|
10589
|
+
message: { type: 'string' },
|
|
10590
|
+
warning_code: {
|
|
10591
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10592
|
+
enum: ['functional_offline_device'],
|
|
10593
|
+
type: 'string',
|
|
10594
|
+
},
|
|
10595
|
+
},
|
|
10596
|
+
required: ['message', 'warning_code'],
|
|
10597
|
+
type: 'object',
|
|
10598
|
+
},
|
|
10599
|
+
{
|
|
10600
|
+
description: 'Third-party integration detected.',
|
|
10601
|
+
properties: {
|
|
10602
|
+
message: { type: 'string' },
|
|
10603
|
+
warning_code: {
|
|
10604
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10605
|
+
enum: ['third_party_integration_detected'],
|
|
10606
|
+
type: 'string',
|
|
10607
|
+
},
|
|
10608
|
+
},
|
|
10609
|
+
required: ['message', 'warning_code'],
|
|
10610
|
+
type: 'object',
|
|
10611
|
+
},
|
|
10612
|
+
{
|
|
10613
|
+
description: 'Nest thermostat in manual eco mode.',
|
|
10614
|
+
properties: {
|
|
10615
|
+
message: { type: 'string' },
|
|
10616
|
+
warning_code: {
|
|
10617
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10618
|
+
enum: ['nest_thermostat_in_manual_eco_mode'],
|
|
10619
|
+
type: 'string',
|
|
10620
|
+
},
|
|
10621
|
+
},
|
|
10622
|
+
required: ['message', 'warning_code'],
|
|
10623
|
+
type: 'object',
|
|
10624
|
+
},
|
|
10625
|
+
{
|
|
10626
|
+
description: 'Remote Unlock feature not enabled in settings.',
|
|
10627
|
+
properties: {
|
|
10628
|
+
message: { type: 'string' },
|
|
10629
|
+
warning_code: {
|
|
10630
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10631
|
+
enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
|
|
10632
|
+
type: 'string',
|
|
10633
|
+
},
|
|
10634
|
+
},
|
|
10635
|
+
required: ['message', 'warning_code'],
|
|
10636
|
+
type: 'object',
|
|
10637
|
+
},
|
|
10638
|
+
{
|
|
10639
|
+
description: 'Gateway signal is weak.',
|
|
10640
|
+
properties: {
|
|
10641
|
+
message: { type: 'string' },
|
|
10642
|
+
warning_code: {
|
|
10643
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10644
|
+
enum: ['ttlock_weak_gateway_signal'],
|
|
10645
|
+
type: 'string',
|
|
10646
|
+
},
|
|
10647
|
+
},
|
|
10648
|
+
required: ['message', 'warning_code'],
|
|
10649
|
+
type: 'object',
|
|
10650
|
+
},
|
|
10651
|
+
{
|
|
10652
|
+
description: 'Temperature threshold exceeded.',
|
|
10653
|
+
properties: {
|
|
10654
|
+
message: { type: 'string' },
|
|
10655
|
+
warning_code: {
|
|
10656
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10657
|
+
enum: ['temperature_threshold_exceeded'],
|
|
10658
|
+
type: 'string',
|
|
10659
|
+
},
|
|
10660
|
+
},
|
|
10661
|
+
required: ['message', 'warning_code'],
|
|
10662
|
+
type: 'object',
|
|
10663
|
+
},
|
|
10664
|
+
{
|
|
10665
|
+
description: 'Device appears to be unresponsive.',
|
|
10666
|
+
properties: {
|
|
10667
|
+
message: { type: 'string' },
|
|
10668
|
+
warning_code: {
|
|
10669
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10670
|
+
enum: ['device_communication_degraded'],
|
|
10671
|
+
type: 'string',
|
|
10672
|
+
},
|
|
10673
|
+
},
|
|
10674
|
+
required: ['message', 'warning_code'],
|
|
10675
|
+
type: 'object',
|
|
10676
|
+
},
|
|
10677
|
+
{
|
|
10678
|
+
description: 'Scheduled maintenance window detected.',
|
|
10679
|
+
properties: {
|
|
10680
|
+
message: { type: 'string' },
|
|
10681
|
+
warning_code: {
|
|
10682
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10683
|
+
enum: ['scheduled_maintenance_window'],
|
|
10684
|
+
type: 'string',
|
|
10685
|
+
},
|
|
10686
|
+
},
|
|
10687
|
+
required: ['message', 'warning_code'],
|
|
10688
|
+
type: 'object',
|
|
10689
|
+
},
|
|
10690
|
+
{
|
|
10691
|
+
description: 'Device has flaky connection.',
|
|
10692
|
+
properties: {
|
|
10693
|
+
message: { type: 'string' },
|
|
10694
|
+
warning_code: {
|
|
10695
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10696
|
+
enum: ['device_has_flaky_connection'],
|
|
10697
|
+
type: 'string',
|
|
10698
|
+
},
|
|
10699
|
+
},
|
|
10700
|
+
required: ['message', 'warning_code'],
|
|
10701
|
+
type: 'object',
|
|
10702
|
+
},
|
|
10703
|
+
{
|
|
10704
|
+
description: 'Lock is in Office Mode. Access Codes will not unlock doors.',
|
|
10705
|
+
properties: {
|
|
10706
|
+
message: { type: 'string' },
|
|
10707
|
+
warning_code: {
|
|
10708
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10709
|
+
enum: ['salto_office_mode'],
|
|
10710
|
+
type: 'string',
|
|
10711
|
+
},
|
|
10712
|
+
},
|
|
10713
|
+
required: ['message', 'warning_code'],
|
|
10714
|
+
type: 'object',
|
|
10715
|
+
},
|
|
10716
|
+
{
|
|
10717
|
+
description: 'Lock is in Privacy Mode. Access Codes will not unlock doors.',
|
|
10718
|
+
properties: {
|
|
10719
|
+
message: { type: 'string' },
|
|
10720
|
+
warning_code: {
|
|
10721
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
10722
|
+
enum: ['salto_privacy_mode'],
|
|
10723
|
+
type: 'string',
|
|
10724
|
+
},
|
|
10725
|
+
},
|
|
10726
|
+
required: ['message', 'warning_code'],
|
|
10727
|
+
type: 'object',
|
|
10728
|
+
},
|
|
10729
|
+
],
|
|
10730
|
+
},
|
|
10731
|
+
type: 'array',
|
|
10732
|
+
},
|
|
10733
|
+
workspace_id: {
|
|
10734
|
+
description: 'Unique identifier for the Seam workspace associated with the device.',
|
|
10735
|
+
format: 'uuid',
|
|
10736
|
+
type: 'string',
|
|
10737
|
+
},
|
|
10738
|
+
},
|
|
10739
|
+
required: [
|
|
10740
|
+
'device_id',
|
|
10741
|
+
'device_type',
|
|
10742
|
+
'display_name',
|
|
10743
|
+
'capabilities_supported',
|
|
10744
|
+
'properties',
|
|
10745
|
+
'location',
|
|
10746
|
+
'workspace_id',
|
|
10747
|
+
'errors',
|
|
10748
|
+
'warnings',
|
|
10749
|
+
'created_at',
|
|
10750
|
+
'is_managed',
|
|
10751
|
+
'custom_metadata',
|
|
10752
|
+
],
|
|
10753
|
+
type: 'object',
|
|
10754
|
+
'x-route-path': '/phones',
|
|
10755
|
+
},
|
|
10756
|
+
service_health: {
|
|
10757
|
+
properties: {
|
|
10758
|
+
description: { type: 'string' },
|
|
10759
|
+
service: { type: 'string' },
|
|
10760
|
+
status: { enum: ['healthy', 'degraded', 'down'], type: 'string' },
|
|
10761
|
+
},
|
|
10762
|
+
required: ['service', 'status', 'description'],
|
|
10763
|
+
type: 'object',
|
|
10764
|
+
'x-route-path': '/health',
|
|
10765
|
+
},
|
|
10766
|
+
thermostat_schedule: {
|
|
10767
|
+
description: 'Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time.',
|
|
10768
|
+
properties: {
|
|
10769
|
+
climate_preset_key: {
|
|
10770
|
+
description: 'Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule.',
|
|
10771
|
+
type: 'string',
|
|
10772
|
+
},
|
|
10773
|
+
created_at: {
|
|
10774
|
+
description: 'Date and time at which the thermostat schedule was created.',
|
|
10775
|
+
format: 'date-time',
|
|
10776
|
+
type: 'string',
|
|
10777
|
+
},
|
|
10778
|
+
device_id: {
|
|
10779
|
+
description: 'ID of the desired thermostat device.',
|
|
10780
|
+
format: 'uuid',
|
|
10781
|
+
type: 'string',
|
|
10782
|
+
},
|
|
10783
|
+
ends_at: {
|
|
10784
|
+
description: 'Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
|
|
10785
|
+
format: 'date-time',
|
|
10786
|
+
type: 'string',
|
|
10787
|
+
},
|
|
10788
|
+
errors: {
|
|
10789
|
+
description: 'Array of errors associated with the thermostat schedule. 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.',
|
|
10790
|
+
items: {
|
|
10791
|
+
properties: {
|
|
10792
|
+
error_code: { type: 'string' },
|
|
10793
|
+
message: { type: 'string' },
|
|
10794
|
+
},
|
|
10795
|
+
required: ['error_code', 'message'],
|
|
10796
|
+
type: 'object',
|
|
10797
|
+
},
|
|
10798
|
+
type: 'array',
|
|
10799
|
+
},
|
|
10800
|
+
max_override_period_minutes: {
|
|
10801
|
+
description: "Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions).",
|
|
10802
|
+
minimum: 0,
|
|
10803
|
+
type: 'integer',
|
|
10804
|
+
},
|
|
10805
|
+
name: {
|
|
10806
|
+
description: 'User-friendly name to identify the thermostat schedule.',
|
|
10425
10807
|
type: 'string',
|
|
10426
10808
|
},
|
|
10427
10809
|
starts_at: {
|
|
@@ -11191,12 +11573,203 @@ export default {
|
|
|
11191
11573
|
warnings: {
|
|
11192
11574
|
description: '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.',
|
|
11193
11575
|
items: {
|
|
11194
|
-
|
|
11195
|
-
|
|
11196
|
-
|
|
11197
|
-
|
|
11198
|
-
|
|
11199
|
-
|
|
11576
|
+
oneOf: [
|
|
11577
|
+
{
|
|
11578
|
+
description: 'Backup access code unhealthy.',
|
|
11579
|
+
properties: {
|
|
11580
|
+
message: { type: 'string' },
|
|
11581
|
+
warning_code: {
|
|
11582
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11583
|
+
enum: ['partial_backup_access_code_pool'],
|
|
11584
|
+
type: 'string',
|
|
11585
|
+
},
|
|
11586
|
+
},
|
|
11587
|
+
required: ['message', 'warning_code'],
|
|
11588
|
+
type: 'object',
|
|
11589
|
+
},
|
|
11590
|
+
{
|
|
11591
|
+
description: 'Too many backup codes.',
|
|
11592
|
+
properties: {
|
|
11593
|
+
message: { type: 'string' },
|
|
11594
|
+
warning_code: {
|
|
11595
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11596
|
+
enum: ['many_active_backup_codes'],
|
|
11597
|
+
type: 'string',
|
|
11598
|
+
},
|
|
11599
|
+
},
|
|
11600
|
+
required: ['message', 'warning_code'],
|
|
11601
|
+
type: 'object',
|
|
11602
|
+
},
|
|
11603
|
+
{
|
|
11604
|
+
description: 'A Salto Lock displaying an unknown device type.',
|
|
11605
|
+
properties: {
|
|
11606
|
+
message: { type: 'string' },
|
|
11607
|
+
warning_code: {
|
|
11608
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11609
|
+
enum: ['salto_unknown_device_type'],
|
|
11610
|
+
type: 'string',
|
|
11611
|
+
},
|
|
11612
|
+
},
|
|
11613
|
+
required: ['message', 'warning_code'],
|
|
11614
|
+
type: 'object',
|
|
11615
|
+
},
|
|
11616
|
+
{
|
|
11617
|
+
description: 'Wyze Lock is not connected to a gateway.',
|
|
11618
|
+
properties: {
|
|
11619
|
+
message: { type: 'string' },
|
|
11620
|
+
warning_code: {
|
|
11621
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11622
|
+
enum: ['wyze_device_missing_gateway'],
|
|
11623
|
+
type: 'string',
|
|
11624
|
+
},
|
|
11625
|
+
},
|
|
11626
|
+
required: ['message', 'warning_code'],
|
|
11627
|
+
type: 'object',
|
|
11628
|
+
},
|
|
11629
|
+
{
|
|
11630
|
+
description: 'Device is offline, but has some functionality available.',
|
|
11631
|
+
properties: {
|
|
11632
|
+
message: { type: 'string' },
|
|
11633
|
+
warning_code: {
|
|
11634
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11635
|
+
enum: ['functional_offline_device'],
|
|
11636
|
+
type: 'string',
|
|
11637
|
+
},
|
|
11638
|
+
},
|
|
11639
|
+
required: ['message', 'warning_code'],
|
|
11640
|
+
type: 'object',
|
|
11641
|
+
},
|
|
11642
|
+
{
|
|
11643
|
+
description: 'Third-party integration detected.',
|
|
11644
|
+
properties: {
|
|
11645
|
+
message: { type: 'string' },
|
|
11646
|
+
warning_code: {
|
|
11647
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11648
|
+
enum: ['third_party_integration_detected'],
|
|
11649
|
+
type: 'string',
|
|
11650
|
+
},
|
|
11651
|
+
},
|
|
11652
|
+
required: ['message', 'warning_code'],
|
|
11653
|
+
type: 'object',
|
|
11654
|
+
},
|
|
11655
|
+
{
|
|
11656
|
+
description: 'Nest thermostat in manual eco mode.',
|
|
11657
|
+
properties: {
|
|
11658
|
+
message: { type: 'string' },
|
|
11659
|
+
warning_code: {
|
|
11660
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11661
|
+
enum: ['nest_thermostat_in_manual_eco_mode'],
|
|
11662
|
+
type: 'string',
|
|
11663
|
+
},
|
|
11664
|
+
},
|
|
11665
|
+
required: ['message', 'warning_code'],
|
|
11666
|
+
type: 'object',
|
|
11667
|
+
},
|
|
11668
|
+
{
|
|
11669
|
+
description: 'Remote Unlock feature not enabled in settings.',
|
|
11670
|
+
properties: {
|
|
11671
|
+
message: { type: 'string' },
|
|
11672
|
+
warning_code: {
|
|
11673
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11674
|
+
enum: ['ttlock_lock_gateway_unlocking_not_enabled'],
|
|
11675
|
+
type: 'string',
|
|
11676
|
+
},
|
|
11677
|
+
},
|
|
11678
|
+
required: ['message', 'warning_code'],
|
|
11679
|
+
type: 'object',
|
|
11680
|
+
},
|
|
11681
|
+
{
|
|
11682
|
+
description: 'Gateway signal is weak.',
|
|
11683
|
+
properties: {
|
|
11684
|
+
message: { type: 'string' },
|
|
11685
|
+
warning_code: {
|
|
11686
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11687
|
+
enum: ['ttlock_weak_gateway_signal'],
|
|
11688
|
+
type: 'string',
|
|
11689
|
+
},
|
|
11690
|
+
},
|
|
11691
|
+
required: ['message', 'warning_code'],
|
|
11692
|
+
type: 'object',
|
|
11693
|
+
},
|
|
11694
|
+
{
|
|
11695
|
+
description: 'Temperature threshold exceeded.',
|
|
11696
|
+
properties: {
|
|
11697
|
+
message: { type: 'string' },
|
|
11698
|
+
warning_code: {
|
|
11699
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11700
|
+
enum: ['temperature_threshold_exceeded'],
|
|
11701
|
+
type: 'string',
|
|
11702
|
+
},
|
|
11703
|
+
},
|
|
11704
|
+
required: ['message', 'warning_code'],
|
|
11705
|
+
type: 'object',
|
|
11706
|
+
},
|
|
11707
|
+
{
|
|
11708
|
+
description: 'Device appears to be unresponsive.',
|
|
11709
|
+
properties: {
|
|
11710
|
+
message: { type: 'string' },
|
|
11711
|
+
warning_code: {
|
|
11712
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11713
|
+
enum: ['device_communication_degraded'],
|
|
11714
|
+
type: 'string',
|
|
11715
|
+
},
|
|
11716
|
+
},
|
|
11717
|
+
required: ['message', 'warning_code'],
|
|
11718
|
+
type: 'object',
|
|
11719
|
+
},
|
|
11720
|
+
{
|
|
11721
|
+
description: 'Scheduled maintenance window detected.',
|
|
11722
|
+
properties: {
|
|
11723
|
+
message: { type: 'string' },
|
|
11724
|
+
warning_code: {
|
|
11725
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11726
|
+
enum: ['scheduled_maintenance_window'],
|
|
11727
|
+
type: 'string',
|
|
11728
|
+
},
|
|
11729
|
+
},
|
|
11730
|
+
required: ['message', 'warning_code'],
|
|
11731
|
+
type: 'object',
|
|
11732
|
+
},
|
|
11733
|
+
{
|
|
11734
|
+
description: 'Device has flaky connection.',
|
|
11735
|
+
properties: {
|
|
11736
|
+
message: { type: 'string' },
|
|
11737
|
+
warning_code: {
|
|
11738
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11739
|
+
enum: ['device_has_flaky_connection'],
|
|
11740
|
+
type: 'string',
|
|
11741
|
+
},
|
|
11742
|
+
},
|
|
11743
|
+
required: ['message', 'warning_code'],
|
|
11744
|
+
type: 'object',
|
|
11745
|
+
},
|
|
11746
|
+
{
|
|
11747
|
+
description: 'Lock is in Office Mode. Access Codes will not unlock doors.',
|
|
11748
|
+
properties: {
|
|
11749
|
+
message: { type: 'string' },
|
|
11750
|
+
warning_code: {
|
|
11751
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11752
|
+
enum: ['salto_office_mode'],
|
|
11753
|
+
type: 'string',
|
|
11754
|
+
},
|
|
11755
|
+
},
|
|
11756
|
+
required: ['message', 'warning_code'],
|
|
11757
|
+
type: 'object',
|
|
11758
|
+
},
|
|
11759
|
+
{
|
|
11760
|
+
description: 'Lock is in Privacy Mode. Access Codes will not unlock doors.',
|
|
11761
|
+
properties: {
|
|
11762
|
+
message: { type: 'string' },
|
|
11763
|
+
warning_code: {
|
|
11764
|
+
description: 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
|
|
11765
|
+
enum: ['salto_privacy_mode'],
|
|
11766
|
+
type: 'string',
|
|
11767
|
+
},
|
|
11768
|
+
},
|
|
11769
|
+
required: ['message', 'warning_code'],
|
|
11770
|
+
type: 'object',
|
|
11771
|
+
},
|
|
11772
|
+
],
|
|
11200
11773
|
},
|
|
11201
11774
|
type: 'array',
|
|
11202
11775
|
},
|