@seamapi/types 1.416.2 → 1.418.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 (18) hide show
  1. package/dist/connect.cjs +244 -79
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +423 -4
  4. package/lib/seam/connect/models/acs/acs-entrance.d.ts +3 -0
  5. package/lib/seam/connect/models/acs/acs-entrance.js +4 -0
  6. package/lib/seam/connect/models/acs/acs-entrance.js.map +1 -1
  7. package/lib/seam/connect/models/devices/device.js +131 -67
  8. package/lib/seam/connect/models/devices/device.js.map +1 -1
  9. package/lib/seam/connect/models/phones/phone-session.d.ts +16 -0
  10. package/lib/seam/connect/openapi.d.ts +408 -4
  11. package/lib/seam/connect/openapi.js +94 -18
  12. package/lib/seam/connect/openapi.js.map +1 -1
  13. package/lib/seam/connect/route-types.d.ts +12 -0
  14. package/package.json +1 -1
  15. package/src/lib/seam/connect/models/acs/acs-entrance.ts +6 -0
  16. package/src/lib/seam/connect/models/devices/device.ts +202 -150
  17. package/src/lib/seam/connect/openapi.ts +102 -18
  18. package/src/lib/seam/connect/route-types.ts +12 -0
package/lib/seam/connect/openapi.js CHANGED
@@ -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.',
@@ -2308,6 +2312,11 @@ export default {
2308
2312
  required: ['door_type', 'door_name'],
2309
2313
  type: 'object',
2310
2314
  },
2315
+ connected_account_id: {
2316
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
2317
+ format: 'uuid',
2318
+ type: 'string',
2319
+ },
2311
2320
  created_at: {
2312
2321
  description: 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
2313
2322
  format: 'date-time',
@@ -2487,6 +2496,7 @@ export default {
2487
2496
  'acs_entrance_id',
2488
2497
  'created_at',
2489
2498
  'display_name',
2499
+ 'connected_account_id',
2490
2500
  'errors',
2491
2501
  ],
2492
2502
  type: 'object',
@@ -8355,6 +8365,7 @@ export default {
8355
8365
  'is_connected_account_error',
8356
8366
  ],
8357
8367
  type: 'object',
8368
+ 'x-variant-group-key': 'locks',
8358
8369
  },
8359
8370
  {
8360
8371
  description: 'Indicates that the device is offline.',
@@ -8510,6 +8521,7 @@ export default {
8510
8521
  'error_code',
8511
8522
  ],
8512
8523
  type: 'object',
8524
+ 'x-variant-group-key': 'access_codes',
8513
8525
  },
8514
8526
  {
8515
8527
  description: 'Indicates that the user is not authorized to use the August lock.',
@@ -8541,6 +8553,7 @@ export default {
8541
8553
  'error_code',
8542
8554
  ],
8543
8555
  type: 'object',
8556
+ 'x-variant-group-key': 'locks',
8544
8557
  },
8545
8558
  {
8546
8559
  description: 'Indicates that the lock is not connected to a bridge.',
@@ -8572,9 +8585,10 @@ export default {
8572
8585
  'error_code',
8573
8586
  ],
8574
8587
  type: 'object',
8588
+ 'x-variant-group-key': 'locks',
8575
8589
  },
8576
8590
  {
8577
- description: 'Indicates that the lock is not paired with a gateway.',
8591
+ description: '\n Indicates that the lock is not paired with a gateway.\n ',
8578
8592
  properties: {
8579
8593
  created_at: {
8580
8594
  description: 'Date and time at which Seam created the error.',
@@ -8636,7 +8650,7 @@ export default {
8636
8650
  type: 'object',
8637
8651
  },
8638
8652
  {
8639
- description: 'Indicates that the auxiliary heat is running.',
8653
+ description: '\n Indicates that the auxiliary heat is running.\n ',
8640
8654
  properties: {
8641
8655
  created_at: {
8642
8656
  description: 'Date and time at which Seam created the error.',
@@ -8698,7 +8712,7 @@ export default {
8698
8712
  type: 'object',
8699
8713
  },
8700
8714
  {
8701
- description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
8715
+ description: '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
8702
8716
  properties: {
8703
8717
  created_at: {
8704
8718
  description: 'Date and time at which Seam created the error.',
@@ -8789,6 +8803,15 @@ export default {
8789
8803
  ],
8790
8804
  },
8791
8805
  type: 'array',
8806
+ 'x-variant-groups': {
8807
+ access_codes: { name: 'Access Codes' },
8808
+ hardware: { name: 'Hardware' },
8809
+ locks: { name: 'Locks' },
8810
+ noise_sensors: { name: 'Noise Sensors' },
8811
+ phones: { name: 'Phones' },
8812
+ provider_metadata: { name: 'Provider Metadata' },
8813
+ thermostats: { name: 'Thermostats' },
8814
+ },
8792
8815
  },
8793
8816
  is_managed: {
8794
8817
  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).',
@@ -10849,6 +10872,7 @@ export default {
10849
10872
  },
10850
10873
  required: ['message', 'created_at', 'warning_code'],
10851
10874
  type: 'object',
10875
+ 'x-variant-group-key': 'access_codes',
10852
10876
  },
10853
10877
  {
10854
10878
  description: 'Indicates that there are too many backup codes.',
@@ -10870,9 +10894,10 @@ export default {
10870
10894
  },
10871
10895
  required: ['message', 'created_at', 'warning_code'],
10872
10896
  type: 'object',
10897
+ 'x-variant-group-key': 'access_codes',
10873
10898
  },
10874
10899
  {
10875
- description: 'Indicates that the Wyze Lock is not connected to a gateway.',
10900
+ description: '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
10876
10901
  properties: {
10877
10902
  created_at: {
10878
10903
  description: 'Date and time at which Seam created the warning.',
@@ -10954,9 +10979,10 @@ export default {
10954
10979
  },
10955
10980
  required: ['message', 'created_at', 'warning_code'],
10956
10981
  type: 'object',
10982
+ 'x-variant-group-key': 'thermostats',
10957
10983
  },
10958
10984
  {
10959
- description: 'Indicates that the Remote Unlock feature is not enabled in the settings.',
10985
+ description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
10960
10986
  properties: {
10961
10987
  created_at: {
10962
10988
  description: 'Date and time at which Seam created the warning.',
@@ -10975,9 +11001,10 @@ export default {
10975
11001
  },
10976
11002
  required: ['message', 'created_at', 'warning_code'],
10977
11003
  type: 'object',
11004
+ 'x-variant-group-key': 'locks',
10978
11005
  },
10979
11006
  {
10980
- description: 'Indicates that the gateway signal is weak.',
11007
+ description: '\n Indicates that the gateway signal is weak.\n ',
10981
11008
  properties: {
10982
11009
  created_at: {
10983
11010
  description: 'Date and time at which Seam created the warning.',
@@ -11017,6 +11044,7 @@ export default {
11017
11044
  },
11018
11045
  required: ['message', 'created_at', 'warning_code'],
11019
11046
  type: 'object',
11047
+ 'x-variant-group-key': 'thermostats',
11020
11048
  },
11021
11049
  {
11022
11050
  description: 'Indicates that the device appears to be unresponsive.',
@@ -11164,6 +11192,7 @@ export default {
11164
11192
  },
11165
11193
  required: ['message', 'created_at', 'warning_code'],
11166
11194
  type: 'object',
11195
+ 'x-variant-group-key': 'phones',
11167
11196
  },
11168
11197
  {
11169
11198
  description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
@@ -11189,6 +11218,15 @@ export default {
11189
11218
  ],
11190
11219
  },
11191
11220
  type: 'array',
11221
+ 'x-variant-groups': {
11222
+ access_codes: { name: 'Access Codes' },
11223
+ hardware: { name: 'Hardware' },
11224
+ locks: { name: 'Locks' },
11225
+ noise_sensors: { name: 'Noise Sensors' },
11226
+ phones: { name: 'Phones' },
11227
+ provider_metadata: { name: 'Provider Metadata' },
11228
+ thermostats: { name: 'Thermostats' },
11229
+ },
11192
11230
  },
11193
11231
  workspace_id: {
11194
11232
  description: 'Unique identifier for the Seam workspace associated with the device.',
@@ -16564,6 +16602,11 @@ export default {
16564
16602
  required: ['door_type', 'door_name'],
16565
16603
  type: 'object',
16566
16604
  },
16605
+ connected_account_id: {
16606
+ description: 'ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details).',
16607
+ format: 'uuid',
16608
+ type: 'string',
16609
+ },
16567
16610
  created_at: {
16568
16611
  description: 'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
16569
16612
  format: 'date-time',
@@ -16743,6 +16786,7 @@ export default {
16743
16786
  'acs_entrance_id',
16744
16787
  'created_at',
16745
16788
  'display_name',
16789
+ 'connected_account_id',
16746
16790
  'errors',
16747
16791
  ],
16748
16792
  type: 'object',
@@ -18094,6 +18138,7 @@ export default {
18094
18138
  'is_connected_account_error',
18095
18139
  ],
18096
18140
  type: 'object',
18141
+ 'x-variant-group-key': 'locks',
18097
18142
  },
18098
18143
  {
18099
18144
  description: 'Indicates that the device is offline.',
@@ -18249,6 +18294,7 @@ export default {
18249
18294
  'error_code',
18250
18295
  ],
18251
18296
  type: 'object',
18297
+ 'x-variant-group-key': 'access_codes',
18252
18298
  },
18253
18299
  {
18254
18300
  description: 'Indicates that the user is not authorized to use the August lock.',
@@ -18280,6 +18326,7 @@ export default {
18280
18326
  'error_code',
18281
18327
  ],
18282
18328
  type: 'object',
18329
+ 'x-variant-group-key': 'locks',
18283
18330
  },
18284
18331
  {
18285
18332
  description: 'Indicates that the lock is not connected to a bridge.',
@@ -18311,9 +18358,10 @@ export default {
18311
18358
  'error_code',
18312
18359
  ],
18313
18360
  type: 'object',
18361
+ 'x-variant-group-key': 'locks',
18314
18362
  },
18315
18363
  {
18316
- description: 'Indicates that the lock is not paired with a gateway.',
18364
+ description: '\n Indicates that the lock is not paired with a gateway.\n ',
18317
18365
  properties: {
18318
18366
  created_at: {
18319
18367
  description: 'Date and time at which Seam created the error.',
@@ -18375,7 +18423,7 @@ export default {
18375
18423
  type: 'object',
18376
18424
  },
18377
18425
  {
18378
- description: 'Indicates that the auxiliary heat is running.',
18426
+ description: '\n Indicates that the auxiliary heat is running.\n ',
18379
18427
  properties: {
18380
18428
  created_at: {
18381
18429
  description: 'Date and time at which Seam created the error.',
@@ -18437,7 +18485,7 @@ export default {
18437
18485
  type: 'object',
18438
18486
  },
18439
18487
  {
18440
- description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
18488
+ description: '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
18441
18489
  properties: {
18442
18490
  created_at: {
18443
18491
  description: 'Date and time at which Seam created the error.',
@@ -20105,6 +20153,7 @@ export default {
20105
20153
  'is_connected_account_error',
20106
20154
  ],
20107
20155
  type: 'object',
20156
+ 'x-variant-group-key': 'locks',
20108
20157
  },
20109
20158
  {
20110
20159
  description: 'Indicates that the device is offline.',
@@ -20260,6 +20309,7 @@ export default {
20260
20309
  'error_code',
20261
20310
  ],
20262
20311
  type: 'object',
20312
+ 'x-variant-group-key': 'access_codes',
20263
20313
  },
20264
20314
  {
20265
20315
  description: 'Indicates that the user is not authorized to use the August lock.',
@@ -20291,6 +20341,7 @@ export default {
20291
20341
  'error_code',
20292
20342
  ],
20293
20343
  type: 'object',
20344
+ 'x-variant-group-key': 'locks',
20294
20345
  },
20295
20346
  {
20296
20347
  description: 'Indicates that the lock is not connected to a bridge.',
@@ -20322,9 +20373,10 @@ export default {
20322
20373
  'error_code',
20323
20374
  ],
20324
20375
  type: 'object',
20376
+ 'x-variant-group-key': 'locks',
20325
20377
  },
20326
20378
  {
20327
- description: 'Indicates that the lock is not paired with a gateway.',
20379
+ description: '\n Indicates that the lock is not paired with a gateway.\n ',
20328
20380
  properties: {
20329
20381
  created_at: {
20330
20382
  description: 'Date and time at which Seam created the error.',
@@ -20386,7 +20438,7 @@ export default {
20386
20438
  type: 'object',
20387
20439
  },
20388
20440
  {
20389
- description: 'Indicates that the auxiliary heat is running.',
20441
+ description: '\n Indicates that the auxiliary heat is running.\n ',
20390
20442
  properties: {
20391
20443
  created_at: {
20392
20444
  description: 'Date and time at which Seam created the error.',
@@ -20448,7 +20500,7 @@ export default {
20448
20500
  type: 'object',
20449
20501
  },
20450
20502
  {
20451
- description: 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
20503
+ description: '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
20452
20504
  properties: {
20453
20505
  created_at: {
20454
20506
  description: 'Date and time at which Seam created the error.',
@@ -20539,6 +20591,15 @@ export default {
20539
20591
  ],
20540
20592
  },
20541
20593
  type: 'array',
20594
+ 'x-variant-groups': {
20595
+ access_codes: { name: 'Access Codes' },
20596
+ hardware: { name: 'Hardware' },
20597
+ locks: { name: 'Locks' },
20598
+ noise_sensors: { name: 'Noise Sensors' },
20599
+ phones: { name: 'Phones' },
20600
+ provider_metadata: { name: 'Provider Metadata' },
20601
+ thermostats: { name: 'Thermostats' },
20602
+ },
20542
20603
  },
20543
20604
  is_managed: { enum: [false], type: 'boolean' },
20544
20605
  location: {
@@ -20725,6 +20786,7 @@ export default {
20725
20786
  },
20726
20787
  required: ['message', 'created_at', 'warning_code'],
20727
20788
  type: 'object',
20789
+ 'x-variant-group-key': 'access_codes',
20728
20790
  },
20729
20791
  {
20730
20792
  description: 'Indicates that there are too many backup codes.',
@@ -20746,9 +20808,10 @@ export default {
20746
20808
  },
20747
20809
  required: ['message', 'created_at', 'warning_code'],
20748
20810
  type: 'object',
20811
+ 'x-variant-group-key': 'access_codes',
20749
20812
  },
20750
20813
  {
20751
- description: 'Indicates that the Wyze Lock is not connected to a gateway.',
20814
+ description: '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
20752
20815
  properties: {
20753
20816
  created_at: {
20754
20817
  description: 'Date and time at which Seam created the warning.',
@@ -20830,9 +20893,10 @@ export default {
20830
20893
  },
20831
20894
  required: ['message', 'created_at', 'warning_code'],
20832
20895
  type: 'object',
20896
+ 'x-variant-group-key': 'thermostats',
20833
20897
  },
20834
20898
  {
20835
- description: 'Indicates that the Remote Unlock feature is not enabled in the settings.',
20899
+ description: 'Indicates that the Remote Unlock feature is not enabled in the settings."',
20836
20900
  properties: {
20837
20901
  created_at: {
20838
20902
  description: 'Date and time at which Seam created the warning.',
@@ -20851,9 +20915,10 @@ export default {
20851
20915
  },
20852
20916
  required: ['message', 'created_at', 'warning_code'],
20853
20917
  type: 'object',
20918
+ 'x-variant-group-key': 'locks',
20854
20919
  },
20855
20920
  {
20856
- description: 'Indicates that the gateway signal is weak.',
20921
+ description: '\n Indicates that the gateway signal is weak.\n ',
20857
20922
  properties: {
20858
20923
  created_at: {
20859
20924
  description: 'Date and time at which Seam created the warning.',
@@ -20893,6 +20958,7 @@ export default {
20893
20958
  },
20894
20959
  required: ['message', 'created_at', 'warning_code'],
20895
20960
  type: 'object',
20961
+ 'x-variant-group-key': 'thermostats',
20896
20962
  },
20897
20963
  {
20898
20964
  description: 'Indicates that the device appears to be unresponsive.',
@@ -21040,6 +21106,7 @@ export default {
21040
21106
  },
21041
21107
  required: ['message', 'created_at', 'warning_code'],
21042
21108
  type: 'object',
21109
+ 'x-variant-group-key': 'phones',
21043
21110
  },
21044
21111
  {
21045
21112
  description: 'Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.',
@@ -21065,6 +21132,15 @@ export default {
21065
21132
  ],
21066
21133
  },
21067
21134
  type: 'array',
21135
+ 'x-variant-groups': {
21136
+ access_codes: { name: 'Access Codes' },
21137
+ hardware: { name: 'Hardware' },
21138
+ locks: { name: 'Locks' },
21139
+ noise_sensors: { name: 'Noise Sensors' },
21140
+ phones: { name: 'Phones' },
21141
+ provider_metadata: { name: 'Provider Metadata' },
21142
+ thermostats: { name: 'Thermostats' },
21143
+ },
21068
21144
  },
21069
21145
  workspace_id: {
21070
21146
  description: 'Unique identifier for the Seam workspace associated with the device.',