@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/src/lib/seam/connect/openapi.ts CHANGED
@@ -891,6 +891,7 @@ export default {
891
891
  'is_connected_account_error',
892
892
  ],
893
893
  type: 'object',
894
+ 'x-variant-group-key': 'locks',
894
895
  },
895
896
  {
896
897
  description: 'Indicates that the device is offline.',
@@ -1067,6 +1068,7 @@ export default {
1067
1068
  'error_code',
1068
1069
  ],
1069
1070
  type: 'object',
1071
+ 'x-variant-group-key': 'access_codes',
1070
1072
  },
1071
1073
  {
1072
1074
  description:
@@ -1103,6 +1105,7 @@ export default {
1103
1105
  'error_code',
1104
1106
  ],
1105
1107
  type: 'object',
1108
+ 'x-variant-group-key': 'locks',
1106
1109
  },
1107
1110
  {
1108
1111
  description:
@@ -1139,10 +1142,11 @@ export default {
1139
1142
  'error_code',
1140
1143
  ],
1141
1144
  type: 'object',
1145
+ 'x-variant-group-key': 'locks',
1142
1146
  },
1143
1147
  {
1144
1148
  description:
1145
- 'Indicates that the lock is not paired with a gateway.',
1149
+ '\n Indicates that the lock is not paired with a gateway.\n ',
1146
1150
  properties: {
1147
1151
  created_at: {
1148
1152
  description:
@@ -1212,7 +1216,8 @@ export default {
1212
1216
  type: 'object',
1213
1217
  },
1214
1218
  {
1215
- description: 'Indicates that the auxiliary heat is running.',
1219
+ description:
1220
+ '\n Indicates that the auxiliary heat is running.\n ',
1216
1221
  properties: {
1217
1222
  created_at: {
1218
1223
  description:
@@ -1284,7 +1289,7 @@ export default {
1284
1289
  },
1285
1290
  {
1286
1291
  description:
1287
- 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
1292
+ '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
1288
1293
  properties: {
1289
1294
  created_at: {
1290
1295
  description:
@@ -2653,6 +2658,12 @@ export default {
2653
2658
  required: ['door_type', 'door_name'],
2654
2659
  type: 'object',
2655
2660
  },
2661
+ connected_account_id: {
2662
+ description:
2663
+ '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).',
2664
+ format: 'uuid',
2665
+ type: 'string',
2666
+ },
2656
2667
  created_at: {
2657
2668
  description:
2658
2669
  'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
@@ -2855,6 +2866,7 @@ export default {
2855
2866
  'acs_entrance_id',
2856
2867
  'created_at',
2857
2868
  'display_name',
2869
+ 'connected_account_id',
2858
2870
  'errors',
2859
2871
  ],
2860
2872
  type: 'object',
@@ -9456,6 +9468,7 @@ export default {
9456
9468
  'is_connected_account_error',
9457
9469
  ],
9458
9470
  type: 'object',
9471
+ 'x-variant-group-key': 'locks',
9459
9472
  },
9460
9473
  {
9461
9474
  description: 'Indicates that the device is offline.',
@@ -9632,6 +9645,7 @@ export default {
9632
9645
  'error_code',
9633
9646
  ],
9634
9647
  type: 'object',
9648
+ 'x-variant-group-key': 'access_codes',
9635
9649
  },
9636
9650
  {
9637
9651
  description:
@@ -9668,6 +9682,7 @@ export default {
9668
9682
  'error_code',
9669
9683
  ],
9670
9684
  type: 'object',
9685
+ 'x-variant-group-key': 'locks',
9671
9686
  },
9672
9687
  {
9673
9688
  description:
@@ -9704,10 +9719,11 @@ export default {
9704
9719
  'error_code',
9705
9720
  ],
9706
9721
  type: 'object',
9722
+ 'x-variant-group-key': 'locks',
9707
9723
  },
9708
9724
  {
9709
9725
  description:
9710
- 'Indicates that the lock is not paired with a gateway.',
9726
+ '\n Indicates that the lock is not paired with a gateway.\n ',
9711
9727
  properties: {
9712
9728
  created_at: {
9713
9729
  description:
@@ -9777,7 +9793,8 @@ export default {
9777
9793
  type: 'object',
9778
9794
  },
9779
9795
  {
9780
- description: 'Indicates that the auxiliary heat is running.',
9796
+ description:
9797
+ '\n Indicates that the auxiliary heat is running.\n ',
9781
9798
  properties: {
9782
9799
  created_at: {
9783
9800
  description:
@@ -9849,7 +9866,7 @@ export default {
9849
9866
  },
9850
9867
  {
9851
9868
  description:
9852
- 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
9869
+ '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
9853
9870
  properties: {
9854
9871
  created_at: {
9855
9872
  description:
@@ -9956,6 +9973,15 @@ export default {
9956
9973
  ],
9957
9974
  },
9958
9975
  type: 'array',
9976
+ 'x-variant-groups': {
9977
+ access_codes: { name: 'Access Codes' },
9978
+ hardware: { name: 'Hardware' },
9979
+ locks: { name: 'Locks' },
9980
+ noise_sensors: { name: 'Noise Sensors' },
9981
+ phones: { name: 'Phones' },
9982
+ provider_metadata: { name: 'Provider Metadata' },
9983
+ thermostats: { name: 'Thermostats' },
9984
+ },
9959
9985
  },
9960
9986
  is_managed: {
9961
9987
  description:
@@ -12244,6 +12270,7 @@ export default {
12244
12270
  },
12245
12271
  required: ['message', 'created_at', 'warning_code'],
12246
12272
  type: 'object',
12273
+ 'x-variant-group-key': 'access_codes',
12247
12274
  },
12248
12275
  {
12249
12276
  description:
@@ -12269,10 +12296,11 @@ export default {
12269
12296
  },
12270
12297
  required: ['message', 'created_at', 'warning_code'],
12271
12298
  type: 'object',
12299
+ 'x-variant-group-key': 'access_codes',
12272
12300
  },
12273
12301
  {
12274
12302
  description:
12275
- 'Indicates that the Wyze Lock is not connected to a gateway.',
12303
+ '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
12276
12304
  properties: {
12277
12305
  created_at: {
12278
12306
  description:
@@ -12369,10 +12397,11 @@ export default {
12369
12397
  },
12370
12398
  required: ['message', 'created_at', 'warning_code'],
12371
12399
  type: 'object',
12400
+ 'x-variant-group-key': 'thermostats',
12372
12401
  },
12373
12402
  {
12374
12403
  description:
12375
- 'Indicates that the Remote Unlock feature is not enabled in the settings.',
12404
+ 'Indicates that the Remote Unlock feature is not enabled in the settings."',
12376
12405
  properties: {
12377
12406
  created_at: {
12378
12407
  description:
@@ -12394,9 +12423,11 @@ export default {
12394
12423
  },
12395
12424
  required: ['message', 'created_at', 'warning_code'],
12396
12425
  type: 'object',
12426
+ 'x-variant-group-key': 'locks',
12397
12427
  },
12398
12428
  {
12399
- description: 'Indicates that the gateway signal is weak.',
12429
+ description:
12430
+ '\n Indicates that the gateway signal is weak.\n ',
12400
12431
  properties: {
12401
12432
  created_at: {
12402
12433
  description:
@@ -12443,6 +12474,7 @@ export default {
12443
12474
  },
12444
12475
  required: ['message', 'created_at', 'warning_code'],
12445
12476
  type: 'object',
12477
+ 'x-variant-group-key': 'thermostats',
12446
12478
  },
12447
12479
  {
12448
12480
  description:
@@ -12618,6 +12650,7 @@ export default {
12618
12650
  },
12619
12651
  required: ['message', 'created_at', 'warning_code'],
12620
12652
  type: 'object',
12653
+ 'x-variant-group-key': 'phones',
12621
12654
  },
12622
12655
  {
12623
12656
  description:
@@ -12647,6 +12680,15 @@ export default {
12647
12680
  ],
12648
12681
  },
12649
12682
  type: 'array',
12683
+ 'x-variant-groups': {
12684
+ access_codes: { name: 'Access Codes' },
12685
+ hardware: { name: 'Hardware' },
12686
+ locks: { name: 'Locks' },
12687
+ noise_sensors: { name: 'Noise Sensors' },
12688
+ phones: { name: 'Phones' },
12689
+ provider_metadata: { name: 'Provider Metadata' },
12690
+ thermostats: { name: 'Thermostats' },
12691
+ },
12650
12692
  },
12651
12693
  workspace_id: {
12652
12694
  description:
@@ -18367,6 +18409,12 @@ export default {
18367
18409
  required: ['door_type', 'door_name'],
18368
18410
  type: 'object',
18369
18411
  },
18412
+ connected_account_id: {
18413
+ description:
18414
+ '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).',
18415
+ format: 'uuid',
18416
+ type: 'string',
18417
+ },
18370
18418
  created_at: {
18371
18419
  description:
18372
18420
  'Date and time at which the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) was created.',
@@ -18577,6 +18625,7 @@ export default {
18577
18625
  'acs_entrance_id',
18578
18626
  'created_at',
18579
18627
  'display_name',
18628
+ 'connected_account_id',
18580
18629
  'errors',
18581
18630
  ],
18582
18631
  type: 'object',
@@ -20136,6 +20185,7 @@ export default {
20136
20185
  'is_connected_account_error',
20137
20186
  ],
20138
20187
  type: 'object',
20188
+ 'x-variant-group-key': 'locks',
20139
20189
  },
20140
20190
  {
20141
20191
  description: 'Indicates that the device is offline.',
@@ -20312,6 +20362,7 @@ export default {
20312
20362
  'error_code',
20313
20363
  ],
20314
20364
  type: 'object',
20365
+ 'x-variant-group-key': 'access_codes',
20315
20366
  },
20316
20367
  {
20317
20368
  description:
@@ -20348,6 +20399,7 @@ export default {
20348
20399
  'error_code',
20349
20400
  ],
20350
20401
  type: 'object',
20402
+ 'x-variant-group-key': 'locks',
20351
20403
  },
20352
20404
  {
20353
20405
  description:
@@ -20384,10 +20436,11 @@ export default {
20384
20436
  'error_code',
20385
20437
  ],
20386
20438
  type: 'object',
20439
+ 'x-variant-group-key': 'locks',
20387
20440
  },
20388
20441
  {
20389
20442
  description:
20390
- 'Indicates that the lock is not paired with a gateway.',
20443
+ '\n Indicates that the lock is not paired with a gateway.\n ',
20391
20444
  properties: {
20392
20445
  created_at: {
20393
20446
  description:
@@ -20457,7 +20510,8 @@ export default {
20457
20510
  type: 'object',
20458
20511
  },
20459
20512
  {
20460
- description: 'Indicates that the auxiliary heat is running.',
20513
+ description:
20514
+ '\n Indicates that the auxiliary heat is running.\n ',
20461
20515
  properties: {
20462
20516
  created_at: {
20463
20517
  description:
@@ -20529,7 +20583,7 @@ export default {
20529
20583
  },
20530
20584
  {
20531
20585
  description:
20532
- 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
20586
+ '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
20533
20587
  properties: {
20534
20588
  created_at: {
20535
20589
  description:
@@ -22423,6 +22477,7 @@ export default {
22423
22477
  'is_connected_account_error',
22424
22478
  ],
22425
22479
  type: 'object',
22480
+ 'x-variant-group-key': 'locks',
22426
22481
  },
22427
22482
  {
22428
22483
  description: 'Indicates that the device is offline.',
@@ -22599,6 +22654,7 @@ export default {
22599
22654
  'error_code',
22600
22655
  ],
22601
22656
  type: 'object',
22657
+ 'x-variant-group-key': 'access_codes',
22602
22658
  },
22603
22659
  {
22604
22660
  description:
@@ -22635,6 +22691,7 @@ export default {
22635
22691
  'error_code',
22636
22692
  ],
22637
22693
  type: 'object',
22694
+ 'x-variant-group-key': 'locks',
22638
22695
  },
22639
22696
  {
22640
22697
  description:
@@ -22671,10 +22728,11 @@ export default {
22671
22728
  'error_code',
22672
22729
  ],
22673
22730
  type: 'object',
22731
+ 'x-variant-group-key': 'locks',
22674
22732
  },
22675
22733
  {
22676
22734
  description:
22677
- 'Indicates that the lock is not paired with a gateway.',
22735
+ '\n Indicates that the lock is not paired with a gateway.\n ',
22678
22736
  properties: {
22679
22737
  created_at: {
22680
22738
  description:
@@ -22744,7 +22802,8 @@ export default {
22744
22802
  type: 'object',
22745
22803
  },
22746
22804
  {
22747
- description: 'Indicates that the auxiliary heat is running.',
22805
+ description:
22806
+ '\n Indicates that the auxiliary heat is running.\n ',
22748
22807
  properties: {
22749
22808
  created_at: {
22750
22809
  description:
@@ -22816,7 +22875,7 @@ export default {
22816
22875
  },
22817
22876
  {
22818
22877
  description:
22819
- 'Indicates that the Lockly lock is not connected to a Wi-Fi bridge.',
22878
+ '\n Indicates that the Lockly lock is not connected to a Wi-Fi bridge.\n ',
22820
22879
  properties: {
22821
22880
  created_at: {
22822
22881
  description:
@@ -22923,6 +22982,15 @@ export default {
22923
22982
  ],
22924
22983
  },
22925
22984
  type: 'array',
22985
+ 'x-variant-groups': {
22986
+ access_codes: { name: 'Access Codes' },
22987
+ hardware: { name: 'Hardware' },
22988
+ locks: { name: 'Locks' },
22989
+ noise_sensors: { name: 'Noise Sensors' },
22990
+ phones: { name: 'Phones' },
22991
+ provider_metadata: { name: 'Provider Metadata' },
22992
+ thermostats: { name: 'Thermostats' },
22993
+ },
22926
22994
  },
22927
22995
  is_managed: { enum: [false], type: 'boolean' },
22928
22996
  location: {
@@ -23129,6 +23197,7 @@ export default {
23129
23197
  },
23130
23198
  required: ['message', 'created_at', 'warning_code'],
23131
23199
  type: 'object',
23200
+ 'x-variant-group-key': 'access_codes',
23132
23201
  },
23133
23202
  {
23134
23203
  description:
@@ -23154,10 +23223,11 @@ export default {
23154
23223
  },
23155
23224
  required: ['message', 'created_at', 'warning_code'],
23156
23225
  type: 'object',
23226
+ 'x-variant-group-key': 'access_codes',
23157
23227
  },
23158
23228
  {
23159
23229
  description:
23160
- 'Indicates that the Wyze Lock is not connected to a gateway.',
23230
+ '\n Indicates that the Wyze Lock is not connected to a gateway.\n ',
23161
23231
  properties: {
23162
23232
  created_at: {
23163
23233
  description:
@@ -23254,10 +23324,11 @@ export default {
23254
23324
  },
23255
23325
  required: ['message', 'created_at', 'warning_code'],
23256
23326
  type: 'object',
23327
+ 'x-variant-group-key': 'thermostats',
23257
23328
  },
23258
23329
  {
23259
23330
  description:
23260
- 'Indicates that the Remote Unlock feature is not enabled in the settings.',
23331
+ 'Indicates that the Remote Unlock feature is not enabled in the settings."',
23261
23332
  properties: {
23262
23333
  created_at: {
23263
23334
  description:
@@ -23279,9 +23350,11 @@ export default {
23279
23350
  },
23280
23351
  required: ['message', 'created_at', 'warning_code'],
23281
23352
  type: 'object',
23353
+ 'x-variant-group-key': 'locks',
23282
23354
  },
23283
23355
  {
23284
- description: 'Indicates that the gateway signal is weak.',
23356
+ description:
23357
+ '\n Indicates that the gateway signal is weak.\n ',
23285
23358
  properties: {
23286
23359
  created_at: {
23287
23360
  description:
@@ -23328,6 +23401,7 @@ export default {
23328
23401
  },
23329
23402
  required: ['message', 'created_at', 'warning_code'],
23330
23403
  type: 'object',
23404
+ 'x-variant-group-key': 'thermostats',
23331
23405
  },
23332
23406
  {
23333
23407
  description:
@@ -23503,6 +23577,7 @@ export default {
23503
23577
  },
23504
23578
  required: ['message', 'created_at', 'warning_code'],
23505
23579
  type: 'object',
23580
+ 'x-variant-group-key': 'phones',
23506
23581
  },
23507
23582
  {
23508
23583
  description:
@@ -23532,6 +23607,15 @@ export default {
23532
23607
  ],
23533
23608
  },
23534
23609
  type: 'array',
23610
+ 'x-variant-groups': {
23611
+ access_codes: { name: 'Access Codes' },
23612
+ hardware: { name: 'Hardware' },
23613
+ locks: { name: 'Locks' },
23614
+ noise_sensors: { name: 'Noise Sensors' },
23615
+ phones: { name: 'Phones' },
23616
+ provider_metadata: { name: 'Provider Metadata' },
23617
+ thermostats: { name: 'Thermostats' },
23618
+ },
23535
23619
  },
23536
23620
  workspace_id: {
23537
23621
  description:
package/src/lib/seam/connect/route-types.ts CHANGED
@@ -11791,6 +11791,8 @@ export interface Routes {
11791
11791
  created_at: string
11792
11792
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
11793
11793
  display_name: string
11794
+ /** 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). */
11795
+ connected_account_id: string
11794
11796
  /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
11795
11797
  errors: Array<{
11796
11798
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
@@ -13312,6 +13314,8 @@ export interface Routes {
13312
13314
  created_at: string
13313
13315
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
13314
13316
  display_name: string
13317
+ /** 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). */
13318
+ connected_account_id: string
13315
13319
  /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
13316
13320
  errors: Array<{
13317
13321
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
@@ -18836,6 +18840,8 @@ export interface Routes {
18836
18840
  created_at: string
18837
18841
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18838
18842
  display_name: string
18843
+ /** 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). */
18844
+ connected_account_id: string
18839
18845
  /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18840
18846
  errors: Array<{
18841
18847
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
@@ -18987,6 +18993,8 @@ export interface Routes {
18987
18993
  created_at: string
18988
18994
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18989
18995
  display_name: string
18996
+ /** 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). */
18997
+ connected_account_id: string
18990
18998
  /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
18991
18999
  errors: Array<{
18992
19000
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
@@ -20667,6 +20675,8 @@ export interface Routes {
20667
20675
  created_at: string
20668
20676
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20669
20677
  display_name: string
20678
+ /** 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). */
20679
+ connected_account_id: string
20670
20680
  /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
20671
20681
  errors: Array<{
20672
20682
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
@@ -52920,6 +52930,8 @@ export interface Routes {
52920
52930
  created_at: string
52921
52931
  /** Display name for the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
52922
52932
  display_name: string
52933
+ /** 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). */
52934
+ connected_account_id: string
52923
52935
  /** Errors associated with the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
52924
52936
  errors: Array<{
52925
52937
  /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */