@seamapi/types 1.417.0 → 1.418.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -767,6 +767,7 @@ export default {
767
767
  'is_connected_account_error',
768
768
  ],
769
769
  type: 'object',
770
+ 'x-variant-group-key': 'locks',
770
771
  },
771
772
  {
772
773
  description: 'Indicates that the device is offline.',
@@ -922,6 +923,7 @@ export default {
922
923
  'error_code',
923
924
  ],
924
925
  type: 'object',
926
+ 'x-variant-group-key': 'access_codes',
925
927
  },
926
928
  {
927
929
  description: 'Indicates that the user is not authorized to use the August lock.',
@@ -953,6 +955,7 @@ export default {
953
955
  'error_code',
954
956
  ],
955
957
  type: 'object',
958
+ 'x-variant-group-key': 'locks',
956
959
  },
957
960
  {
958
961
  description: 'Indicates that the lock is not connected to a bridge.',
@@ -984,9 +987,10 @@ export default {
984
987
  'error_code',
985
988
  ],
986
989
  type: 'object',
990
+ 'x-variant-group-key': 'locks',
987
991
  },
988
992
  {
989
- description: 'Indicates that the lock is not paired with a gateway.',
993
+ description: '\n Indicates that the lock is not paired with a gateway.\n ',
990
994
  properties: {
991
995
  created_at: {
992
996
  description: 'Date and time at which Seam created the error.',
@@ -1048,7 +1052,7 @@ export default {
1048
1052
  type: 'object',
1049
1053
  },
1050
1054
  {
1051
- description: 'Indicates that the auxiliary heat is running.',
1055
+ description: '\n Indicates that the auxiliary heat is running.\n ',
1052
1056
  properties: {
1053
1057
  created_at: {
1054
1058
  description: 'Date and time at which Seam created the error.',
@@ -1110,7 +1114,7 @@ export default {
1110
1114
  type: 'object',
1111
1115
  },
1112
1116
  {
1113
- description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
1117
+ description: '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
1114
1118
  properties: {
1115
1119
  created_at: {
1116
1120
  description: 'Date and time at which Seam created the error.',
@@ -1201,6 +1205,15 @@ export default {
1201
1205
  ],
1202
1206
  },
1203
1207
  type: 'array',
1208
+ 'x-variant-groups': {
1209
+ access_codes: { name: 'Access Codes' },
1210
+ hardware: { name: 'Hardware' },
1211
+ locks: { name: 'Locks' },
1212
+ noise_sensors: { name: 'Noise Sensors' },
1213
+ phones: { name: 'Phones' },
1214
+ provider_metadata: { name: 'Provider Metadata' },
1215
+ thermostats: { name: 'Thermostats' },
1216
+ },
1204
1217
  },
1205
1218
  is_backup: {
1206
1219
  description: 'Indicates whether the access code is a backup code.',
@@ -1523,6 +1536,15 @@ export default {
1523
1536
  ],
1524
1537
  },
1525
1538
  type: 'array',
1539
+ 'x-variant-groups': {
1540
+ access_codes: { name: 'Access Codes' },
1541
+ hardware: { name: 'Hardware' },
1542
+ locks: { name: 'Locks' },
1543
+ noise_sensors: { name: 'Noise Sensors' },
1544
+ phones: { name: 'Phones' },
1545
+ provider_metadata: { name: 'Provider Metadata' },
1546
+ thermostats: { name: 'Thermostats' },
1547
+ },
1526
1548
  },
1527
1549
  },
1528
1550
  required: [
@@ -8361,6 +8383,7 @@ export default {
8361
8383
  'is_connected_account_error',
8362
8384
  ],
8363
8385
  type: 'object',
8386
+ 'x-variant-group-key': 'locks',
8364
8387
  },
8365
8388
  {
8366
8389
  description: 'Indicates that the device is offline.',
@@ -8516,6 +8539,7 @@ export default {
8516
8539
  'error_code',
8517
8540
  ],
8518
8541
  type: 'object',
8542
+ 'x-variant-group-key': 'access_codes',
8519
8543
  },
8520
8544
  {
8521
8545
  description: 'Indicates that the user is not authorized to use the August lock.',
@@ -8547,6 +8571,7 @@ export default {
8547
8571
  'error_code',
8548
8572
  ],
8549
8573
  type: 'object',
8574
+ 'x-variant-group-key': 'locks',
8550
8575
  },
8551
8576
  {
8552
8577
  description: 'Indicates that the lock is not connected to a bridge.',
@@ -8578,9 +8603,10 @@ export default {
8578
8603
  'error_code',
8579
8604
  ],
8580
8605
  type: 'object',
8606
+ 'x-variant-group-key': 'locks',
8581
8607
  },
8582
8608
  {
8583
- description: 'Indicates that the lock is not paired with a gateway.',
8609
+ description: '\n Indicates that the lock is not paired with a gateway.\n ',
8584
8610
  properties: {
8585
8611
  created_at: {
8586
8612
  description: 'Date and time at which Seam created the error.',
@@ -8642,7 +8668,7 @@ export default {
8642
8668
  type: 'object',
8643
8669
  },
8644
8670
  {
8645
- description: 'Indicates that the auxiliary heat is running.',
8671
+ description: '\n Indicates that the auxiliary heat is running.\n ',
8646
8672
  properties: {
8647
8673
  created_at: {
8648
8674
  description: 'Date and time at which Seam created the error.',
@@ -8704,7 +8730,7 @@ export default {
8704
8730
  type: 'object',
8705
8731
  },
8706
8732
  {
8707
- description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
8733
+ description: '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
8708
8734
  properties: {
8709
8735
  created_at: {
8710
8736
  description: 'Date and time at which Seam created the error.',
@@ -8795,6 +8821,15 @@ export default {
8795
8821
  ],
8796
8822
  },
8797
8823
  type: 'array',
8824
+ 'x-variant-groups': {
8825
+ access_codes: { name: 'Access Codes' },
8826
+ hardware: { name: 'Hardware' },
8827
+ locks: { name: 'Locks' },
8828
+ noise_sensors: { name: 'Noise Sensors' },
8829
+ phones: { name: 'Phones' },
8830
+ provider_metadata: { name: 'Provider Metadata' },
8831
+ thermostats: { name: 'Thermostats' },
8832
+ },
8798
8833
  },
8799
8834
  is_managed: {
8800
8835
  description: 'Indicates whether Seam manages the device. See also [Managed and Unmanaged Devices](https://docs.seam.co/latest/core-concepts/devices/managed-and-unmanaged-devices).',
@@ -10855,6 +10890,7 @@ export default {
10855
10890
  },
10856
10891
  required: ['message', 'created_at', 'warning_code'],
10857
10892
  type: 'object',
10893
+ 'x-variant-group-key': 'access_codes',
10858
10894
  },
10859
10895
  {
10860
10896
  description: 'Indicates that there are too many backup codes.',
@@ -10876,9 +10912,10 @@ export default {
10876
10912
  },
10877
10913
  required: ['message', 'created_at', 'warning_code'],
10878
10914
  type: 'object',
10915
+ 'x-variant-group-key': 'access_codes',
10879
10916
  },
10880
10917
  {
10881
- description: 'Indicates that the Wyze Lock is not connected to a gateway.',
10918
+ description: '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
10882
10919
  properties: {
10883
10920
  created_at: {
10884
10921
  description: 'Date and time at which Seam created the warning.',
@@ -10960,9 +10997,10 @@ export default {
10960
10997
  },
10961
10998
  required: ['message', 'created_at', 'warning_code'],
10962
10999
  type: 'object',
11000
+ 'x-variant-group-key': 'thermostats',
10963
11001
  },
10964
11002
  {
10965
- description: 'Indicates that the Remote Unlock feature is not enabled in the settings.',
11003
+ description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
10966
11004
  properties: {
10967
11005
  created_at: {
10968
11006
  description: 'Date and time at which Seam created the warning.',
@@ -10981,9 +11019,10 @@ export default {
10981
11019
  },
10982
11020
  required: ['message', 'created_at', 'warning_code'],
10983
11021
  type: 'object',
11022
+ 'x-variant-group-key': 'locks',
10984
11023
  },
10985
11024
  {
10986
- description: 'Indicates that the gateway signal is weak.',
11025
+ description: '\n Indicates that the gateway signal is weak.\n ',
10987
11026
  properties: {
10988
11027
  created_at: {
10989
11028
  description: 'Date and time at which Seam created the warning.',
@@ -11023,6 +11062,7 @@ export default {
11023
11062
  },
11024
11063
  required: ['message', 'created_at', 'warning_code'],
11025
11064
  type: 'object',
11065
+ 'x-variant-group-key': 'thermostats',
11026
11066
  },
11027
11067
  {
11028
11068
  description: 'Indicates that the device appears to be unresponsive.',
@@ -11170,6 +11210,7 @@ export default {
11170
11210
  },
11171
11211
  required: ['message', 'created_at', 'warning_code'],
11172
11212
  type: 'object',
11213
+ 'x-variant-group-key': 'phones',
11173
11214
  },
11174
11215
  {
11175
11216
  description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
@@ -11195,6 +11236,15 @@ export default {
11195
11236
  ],
11196
11237
  },
11197
11238
  type: 'array',
11239
+ 'x-variant-groups': {
11240
+ access_codes: { name: 'Access Codes' },
11241
+ hardware: { name: 'Hardware' },
11242
+ locks: { name: 'Locks' },
11243
+ noise_sensors: { name: 'Noise Sensors' },
11244
+ phones: { name: 'Phones' },
11245
+ provider_metadata: { name: 'Provider Metadata' },
11246
+ thermostats: { name: 'Thermostats' },
11247
+ },
11198
11248
  },
11199
11249
  workspace_id: {
11200
11250
  description: 'Unique identifier for the Seam workspace associated with the device.',
@@ -18106,6 +18156,7 @@ export default {
18106
18156
  'is_connected_account_error',
18107
18157
  ],
18108
18158
  type: 'object',
18159
+ 'x-variant-group-key': 'locks',
18109
18160
  },
18110
18161
  {
18111
18162
  description: 'Indicates that the device is offline.',
@@ -18261,6 +18312,7 @@ export default {
18261
18312
  'error_code',
18262
18313
  ],
18263
18314
  type: 'object',
18315
+ 'x-variant-group-key': 'access_codes',
18264
18316
  },
18265
18317
  {
18266
18318
  description: 'Indicates that the user is not authorized to use the August lock.',
@@ -18292,6 +18344,7 @@ export default {
18292
18344
  'error_code',
18293
18345
  ],
18294
18346
  type: 'object',
18347
+ 'x-variant-group-key': 'locks',
18295
18348
  },
18296
18349
  {
18297
18350
  description: 'Indicates that the lock is not connected to a bridge.',
@@ -18323,9 +18376,10 @@ export default {
18323
18376
  'error_code',
18324
18377
  ],
18325
18378
  type: 'object',
18379
+ 'x-variant-group-key': 'locks',
18326
18380
  },
18327
18381
  {
18328
- description: 'Indicates that the lock is not paired with a gateway.',
18382
+ description: '\n Indicates that the lock is not paired with a gateway.\n ',
18329
18383
  properties: {
18330
18384
  created_at: {
18331
18385
  description: 'Date and time at which Seam created the error.',
@@ -18387,7 +18441,7 @@ export default {
18387
18441
  type: 'object',
18388
18442
  },
18389
18443
  {
18390
- description: 'Indicates that the auxiliary heat is running.',
18444
+ description: '\n Indicates that the auxiliary heat is running.\n ',
18391
18445
  properties: {
18392
18446
  created_at: {
18393
18447
  description: 'Date and time at which Seam created the error.',
@@ -18449,7 +18503,7 @@ export default {
18449
18503
  type: 'object',
18450
18504
  },
18451
18505
  {
18452
- description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
18506
+ description: '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
18453
18507
  properties: {
18454
18508
  created_at: {
18455
18509
  description: 'Date and time at which Seam created the error.',
@@ -18540,6 +18594,15 @@ export default {
18540
18594
  ],
18541
18595
  },
18542
18596
  type: 'array',
18597
+ 'x-variant-groups': {
18598
+ access_codes: { name: 'Access Codes' },
18599
+ hardware: { name: 'Hardware' },
18600
+ locks: { name: 'Locks' },
18601
+ noise_sensors: { name: 'Noise Sensors' },
18602
+ phones: { name: 'Phones' },
18603
+ provider_metadata: { name: 'Provider Metadata' },
18604
+ thermostats: { name: 'Thermostats' },
18605
+ },
18543
18606
  },
18544
18607
  is_managed: {
18545
18608
  description: 'Indicates that Seam does not manage the access code.',
@@ -18828,6 +18891,15 @@ export default {
18828
18891
  ],
18829
18892
  },
18830
18893
  type: 'array',
18894
+ 'x-variant-groups': {
18895
+ access_codes: { name: 'Access Codes' },
18896
+ hardware: { name: 'Hardware' },
18897
+ locks: { name: 'Locks' },
18898
+ noise_sensors: { name: 'Noise Sensors' },
18899
+ phones: { name: 'Phones' },
18900
+ provider_metadata: { name: 'Provider Metadata' },
18901
+ thermostats: { name: 'Thermostats' },
18902
+ },
18831
18903
  },
18832
18904
  },
18833
18905
  required: [
@@ -20117,6 +20189,7 @@ export default {
20117
20189
  'is_connected_account_error',
20118
20190
  ],
20119
20191
  type: 'object',
20192
+ 'x-variant-group-key': 'locks',
20120
20193
  },
20121
20194
  {
20122
20195
  description: 'Indicates that the device is offline.',
@@ -20272,6 +20345,7 @@ export default {
20272
20345
  'error_code',
20273
20346
  ],
20274
20347
  type: 'object',
20348
+ 'x-variant-group-key': 'access_codes',
20275
20349
  },
20276
20350
  {
20277
20351
  description: 'Indicates that the user is not authorized to use the August lock.',
@@ -20303,6 +20377,7 @@ export default {
20303
20377
  'error_code',
20304
20378
  ],
20305
20379
  type: 'object',
20380
+ 'x-variant-group-key': 'locks',
20306
20381
  },
20307
20382
  {
20308
20383
  description: 'Indicates that the lock is not connected to a bridge.',
@@ -20334,9 +20409,10 @@ export default {
20334
20409
  'error_code',
20335
20410
  ],
20336
20411
  type: 'object',
20412
+ 'x-variant-group-key': 'locks',
20337
20413
  },
20338
20414
  {
20339
- description: 'Indicates that the lock is not paired with a gateway.',
20415
+ description: '\n Indicates that the lock is not paired with a gateway.\n ',
20340
20416
  properties: {
20341
20417
  created_at: {
20342
20418
  description: 'Date and time at which Seam created the error.',
@@ -20398,7 +20474,7 @@ export default {
20398
20474
  type: 'object',
20399
20475
  },
20400
20476
  {
20401
- description: 'Indicates that the auxiliary heat is running.',
20477
+ description: '\n Indicates that the auxiliary heat is running.\n ',
20402
20478
  properties: {
20403
20479
  created_at: {
20404
20480
  description: 'Date and time at which Seam created the error.',
@@ -20460,7 +20536,7 @@ export default {
20460
20536
  type: 'object',
20461
20537
  },
20462
20538
  {
20463
- description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
20539
+ description: '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
20464
20540
  properties: {
20465
20541
  created_at: {
20466
20542
  description: 'Date and time at which Seam created the error.',
@@ -20551,6 +20627,15 @@ export default {
20551
20627
  ],
20552
20628
  },
20553
20629
  type: 'array',
20630
+ 'x-variant-groups': {
20631
+ access_codes: { name: 'Access Codes' },
20632
+ hardware: { name: 'Hardware' },
20633
+ locks: { name: 'Locks' },
20634
+ noise_sensors: { name: 'Noise Sensors' },
20635
+ phones: { name: 'Phones' },
20636
+ provider_metadata: { name: 'Provider Metadata' },
20637
+ thermostats: { name: 'Thermostats' },
20638
+ },
20554
20639
  },
20555
20640
  is_managed: { enum: [false], type: 'boolean' },
20556
20641
  location: {
@@ -20737,6 +20822,7 @@ export default {
20737
20822
  },
20738
20823
  required: ['message', 'created_at', 'warning_code'],
20739
20824
  type: 'object',
20825
+ 'x-variant-group-key': 'access_codes',
20740
20826
  },
20741
20827
  {
20742
20828
  description: 'Indicates that there are too many backup codes.',
@@ -20758,9 +20844,10 @@ export default {
20758
20844
  },
20759
20845
  required: ['message', 'created_at', 'warning_code'],
20760
20846
  type: 'object',
20847
+ 'x-variant-group-key': 'access_codes',
20761
20848
  },
20762
20849
  {
20763
- description: 'Indicates that the Wyze Lock is not connected to a gateway.',
20850
+ description: '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
20764
20851
  properties: {
20765
20852
  created_at: {
20766
20853
  description: 'Date and time at which Seam created the warning.',
@@ -20842,9 +20929,10 @@ export default {
20842
20929
  },
20843
20930
  required: ['message', 'created_at', 'warning_code'],
20844
20931
  type: 'object',
20932
+ 'x-variant-group-key': 'thermostats',
20845
20933
  },
20846
20934
  {
20847
- description: 'Indicates that the Remote Unlock feature is not enabled in the settings.',
20935
+ description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
20848
20936
  properties: {
20849
20937
  created_at: {
20850
20938
  description: 'Date and time at which Seam created the warning.',
@@ -20863,9 +20951,10 @@ export default {
20863
20951
  },
20864
20952
  required: ['message', 'created_at', 'warning_code'],
20865
20953
  type: 'object',
20954
+ 'x-variant-group-key': 'locks',
20866
20955
  },
20867
20956
  {
20868
- description: 'Indicates that the gateway signal is weak.',
20957
+ description: '\n Indicates that the gateway signal is weak.\n ',
20869
20958
  properties: {
20870
20959
  created_at: {
20871
20960
  description: 'Date and time at which Seam created the warning.',
@@ -20905,6 +20994,7 @@ export default {
20905
20994
  },
20906
20995
  required: ['message', 'created_at', 'warning_code'],
20907
20996
  type: 'object',
20997
+ 'x-variant-group-key': 'thermostats',
20908
20998
  },
20909
20999
  {
20910
21000
  description: 'Indicates that the device appears to be unresponsive.',
@@ -21052,6 +21142,7 @@ export default {
21052
21142
  },
21053
21143
  required: ['message', 'created_at', 'warning_code'],
21054
21144
  type: 'object',
21145
+ 'x-variant-group-key': 'phones',
21055
21146
  },
21056
21147
  {
21057
21148
  description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
@@ -21077,6 +21168,15 @@ export default {
21077
21168
  ],
21078
21169
  },
21079
21170
  type: 'array',
21171
+ 'x-variant-groups': {
21172
+ access_codes: { name: 'Access Codes' },
21173
+ hardware: { name: 'Hardware' },
21174
+ locks: { name: 'Locks' },
21175
+ noise_sensors: { name: 'Noise Sensors' },
21176
+ phones: { name: 'Phones' },
21177
+ provider_metadata: { name: 'Provider Metadata' },
21178
+ thermostats: { name: 'Thermostats' },
21179
+ },
21080
21180
  },
21081
21181
  workspace_id: {
21082
21182
  description: 'Unique identifier for the Seam workspace associated with the device.',