@seamapi/types 1.406.0 → 1.406.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.
Files changed (54) hide show
  1. package/dist/connect.cjs +2065 -559
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +7008 -366
  4. package/lib/seam/connect/models/devices/capabilities-supported.js +3 -1
  5. package/lib/seam/connect/models/devices/capabilities-supported.js.map +1 -1
  6. package/lib/seam/connect/models/devices/capability-properties/access-code.js +53 -21
  7. package/lib/seam/connect/models/devices/capability-properties/access-code.js.map +1 -1
  8. package/lib/seam/connect/models/devices/capability-properties/lock.js +20 -4
  9. package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
  10. package/lib/seam/connect/models/devices/capability-properties/thermostat.js +175 -31
  11. package/lib/seam/connect/models/devices/capability-properties/thermostat.js.map +1 -1
  12. package/lib/seam/connect/models/devices/device-metadata.js +455 -191
  13. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  14. package/lib/seam/connect/models/devices/device-type.js +8 -6
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.js +171 -80
  17. package/lib/seam/connect/models/devices/device.js.map +1 -1
  18. package/lib/seam/connect/models/devices/phone-properties.js +5 -7
  19. package/lib/seam/connect/models/devices/phone-properties.js.map +1 -1
  20. package/lib/seam/connect/models/devices/phone.js +22 -8
  21. package/lib/seam/connect/models/devices/phone.js.map +1 -1
  22. package/lib/seam/connect/models/devices/unmanaged-device.js +35 -1
  23. package/lib/seam/connect/models/devices/unmanaged-device.js.map +1 -1
  24. package/lib/seam/connect/models/events/devices.d.ts +4 -4
  25. package/lib/seam/connect/models/events/seam-event.d.ts +2 -2
  26. package/lib/seam/connect/models/index.d.ts +1 -0
  27. package/lib/seam/connect/models/index.js +1 -0
  28. package/lib/seam/connect/models/index.js.map +1 -1
  29. package/lib/seam/connect/models/partner/index.d.ts +1 -0
  30. package/lib/seam/connect/models/partner/index.js +2 -0
  31. package/lib/seam/connect/models/partner/index.js.map +1 -0
  32. package/lib/seam/connect/models/partner/resources.d.ts +42 -0
  33. package/lib/seam/connect/models/partner/resources.js +19 -0
  34. package/lib/seam/connect/models/partner/resources.js.map +1 -0
  35. package/lib/seam/connect/openapi.d.ts +782 -50
  36. package/lib/seam/connect/openapi.js +1173 -199
  37. package/lib/seam/connect/openapi.js.map +1 -1
  38. package/lib/seam/connect/route-types.d.ts +6228 -318
  39. package/package.json +2 -2
  40. package/src/lib/seam/connect/models/devices/capabilities-supported.ts +3 -1
  41. package/src/lib/seam/connect/models/devices/capability-properties/access-code.ts +64 -34
  42. package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +20 -4
  43. package/src/lib/seam/connect/models/devices/capability-properties/thermostat.ts +175 -31
  44. package/src/lib/seam/connect/models/devices/device-metadata.ts +457 -193
  45. package/src/lib/seam/connect/models/devices/device-type.ts +10 -6
  46. package/src/lib/seam/connect/models/devices/device.ts +173 -96
  47. package/src/lib/seam/connect/models/devices/phone-properties.ts +34 -36
  48. package/src/lib/seam/connect/models/devices/phone.ts +22 -19
  49. package/src/lib/seam/connect/models/devices/unmanaged-device.ts +35 -1
  50. package/src/lib/seam/connect/models/index.ts +1 -0
  51. package/src/lib/seam/connect/models/partner/index.ts +1 -0
  52. package/src/lib/seam/connect/models/partner/resources.ts +24 -0
  53. package/src/lib/seam/connect/openapi.ts +1417 -204
  54. package/src/lib/seam/connect/route-types.ts +6231 -318
@@ -6943,8 +6943,9 @@ export default {
6943
6943
  can_simulate_removal: { type: 'boolean' },
6944
6944
  can_turn_off_hvac: { type: 'boolean' },
6945
6945
  capabilities_supported: {
6946
- description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
6946
+ description: '\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
6947
6947
  items: {
6948
+ description: '\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
6948
6949
  enum: [
6949
6950
  'access_code',
6950
6951
  'lock',
@@ -6983,6 +6984,7 @@ export default {
6983
6984
  description: 'Type of the device.',
6984
6985
  oneOf: [
6985
6986
  {
6987
+ description: 'Device type for smartlocks.\n ',
6986
6988
  enum: [
6987
6989
  'akuvox_lock',
6988
6990
  'august_lock',
@@ -7015,10 +7017,12 @@ export default {
7015
7017
  type: 'string',
7016
7018
  },
7017
7019
  {
7020
+ description: 'Device type for noise sensors.\n ',
7018
7021
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
7019
7022
  type: 'string',
7020
7023
  },
7021
7024
  {
7025
+ description: 'Device type for thermostats.\n ',
7022
7026
  enum: [
7023
7027
  'ecobee_thermostat',
7024
7028
  'nest_thermostat',
@@ -7030,7 +7034,7 @@ export default {
7030
7034
  type: 'string',
7031
7035
  },
7032
7036
  {
7033
- description: 'Type of phone.',
7037
+ description: 'Device type for phones.\n ',
7034
7038
  enum: ['ios_phone', 'android_phone'],
7035
7039
  type: 'string',
7036
7040
  },
@@ -7387,15 +7391,16 @@ export default {
7387
7391
  nullable: true,
7388
7392
  properties: {
7389
7393
  location_name: {
7390
- description: 'Name of the device location.',
7394
+ description: 'Name of the device location.\n ',
7391
7395
  type: 'string',
7392
7396
  },
7393
7397
  timezone: {
7394
- description: 'Time zone of the device location.',
7398
+ description: 'Time zone of the device location.\n ',
7395
7399
  type: 'string',
7396
7400
  },
7397
7401
  },
7398
7402
  type: 'object',
7403
+ 'x-property-group-key': 'hardware',
7399
7404
  },
7400
7405
  nickname: {
7401
7406
  description: 'Optional nickname to describe the device, settable through Seam',
@@ -7410,10 +7415,10 @@ export default {
7410
7415
  {
7411
7416
  properties: {
7412
7417
  accessory_keypad: {
7413
- description: 'Represents the accessory keypad state.',
7418
+ description: 'Accessory keypad properties and state.',
7414
7419
  properties: {
7415
7420
  battery: {
7416
- description: 'Indicates if the keypad battery properties.',
7421
+ description: 'Keypad battery properties.\n ',
7417
7422
  properties: {
7418
7423
  level: {
7419
7424
  format: 'float',
@@ -7426,14 +7431,16 @@ export default {
7426
7431
  type: 'object',
7427
7432
  },
7428
7433
  is_connected: {
7429
- description: 'Indicates if the accessory_keypad is connected to the device.',
7434
+ description: 'Indicates if an accessory keypad is connected to the device.\n ',
7430
7435
  type: 'boolean',
7431
7436
  },
7432
7437
  },
7433
7438
  required: ['is_connected'],
7434
7439
  type: 'object',
7440
+ 'x-property-group-key': 'hardware',
7435
7441
  },
7436
7442
  appearance: {
7443
+ description: 'Appearance-related properties, as reported by the device.',
7437
7444
  properties: {
7438
7445
  name: {
7439
7446
  description: 'Name of the device as seen from the provider API and application, not settable through Seam.',
@@ -7442,23 +7449,27 @@ export default {
7442
7449
  },
7443
7450
  required: ['name'],
7444
7451
  type: 'object',
7452
+ 'x-property-group-key': 'hardware',
7445
7453
  },
7446
7454
  battery: {
7447
- description: 'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
7455
+ description: 'Represents the current status of the battery charge level.',
7448
7456
  properties: {
7449
7457
  level: {
7458
+ description: 'Battery charge level as a value between 0 and 1, inclusive.\n ',
7450
7459
  format: 'float',
7451
7460
  maximum: 1,
7452
7461
  minimum: 0,
7453
7462
  type: 'number',
7454
7463
  },
7455
7464
  status: {
7465
+ description: 'Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ',
7456
7466
  enum: ['critical', 'low', 'good', 'full'],
7457
7467
  type: 'string',
7458
7468
  },
7459
7469
  },
7460
7470
  required: ['level', 'status'],
7461
7471
  type: 'object',
7472
+ 'x-property-group-key': 'hardware',
7462
7473
  },
7463
7474
  battery_level: {
7464
7475
  description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
@@ -7466,30 +7477,37 @@ export default {
7466
7477
  maximum: 1,
7467
7478
  minimum: 0,
7468
7479
  type: 'number',
7480
+ 'x-property-group-key': 'hardware',
7469
7481
  },
7470
7482
  currently_triggering_noise_threshold_ids: {
7471
7483
  description: 'Array of noise threshold IDs that are currently triggering.',
7472
7484
  items: { type: 'string' },
7473
7485
  type: 'array',
7486
+ 'x-property-group-key': 'noise_sensors',
7474
7487
  },
7475
7488
  has_direct_power: {
7476
7489
  description: 'Indicates whether the device has direct power.',
7477
7490
  type: 'boolean',
7491
+ 'x-property-group-key': 'hardware',
7478
7492
  },
7479
7493
  image_alt_text: {
7480
7494
  description: 'Alt text for the device image.',
7481
7495
  type: 'string',
7496
+ 'x-property-group-key': 'hardware',
7482
7497
  },
7483
7498
  image_url: {
7484
7499
  description: 'Image URL for the device.',
7485
7500
  format: 'uri',
7486
7501
  type: 'string',
7502
+ 'x-property-group-key': 'hardware',
7487
7503
  },
7488
7504
  manufacturer: {
7489
7505
  description: 'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.',
7490
7506
  type: 'string',
7507
+ 'x-property-group-key': 'hardware',
7491
7508
  },
7492
7509
  model: {
7510
+ description: 'Device model-related properties.',
7493
7511
  properties: {
7494
7512
  accessory_keypad_supported: {
7495
7513
  deprecated: true,
@@ -7497,28 +7515,30 @@ export default {
7497
7515
  'x-deprecated': 'use device.properties.model.can_connect_accessory_keypad',
7498
7516
  },
7499
7517
  can_connect_accessory_keypad: {
7500
- description: 'Indicates whether the device can connect a accessory keypad.',
7518
+ description: '\n Indicates whether the device can connect a accessory keypad.\n ',
7501
7519
  type: 'boolean',
7502
7520
  },
7503
7521
  display_name: {
7504
- description: 'Display name of the device model.',
7522
+ description: '\n Display name of the device model.\n ',
7505
7523
  type: 'string',
7506
7524
  },
7507
7525
  has_built_in_keypad: {
7508
- description: 'Indicates whether the device has a built in accessory keypad.',
7526
+ description: '\n Indicates whether the device has a built in accessory keypad.\n ',
7509
7527
  type: 'boolean',
7510
7528
  },
7511
7529
  manufacturer_display_name: {
7512
- description: 'Display name that corresponds to the manufacturer-specific terminology for the device.',
7530
+ description: '\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ',
7513
7531
  type: 'string',
7514
7532
  },
7515
7533
  offline_access_codes_supported: {
7516
- description: 'Indicates whether the device supports offline access codes.',
7534
+ deprecated: true,
7517
7535
  type: 'boolean',
7536
+ 'x-deprecated': 'use device.can_program_offline_access_codes.',
7518
7537
  },
7519
7538
  online_access_codes_supported: {
7520
- description: 'Indicates whether the device supports online access codes.',
7539
+ deprecated: true,
7521
7540
  type: 'boolean',
7541
+ 'x-deprecated': 'use device.can_program_online_access_codes.',
7522
7542
  },
7523
7543
  },
7524
7544
  required: [
@@ -7537,10 +7557,12 @@ export default {
7537
7557
  description: 'Indicates current noise level in decibels, if the device supports noise detection.',
7538
7558
  format: 'float',
7539
7559
  type: 'number',
7560
+ 'x-property-group-key': 'noise_sensors',
7540
7561
  },
7541
7562
  offline_access_codes_enabled: {
7542
7563
  description: 'Indicates whether it is currently possible to use offline access codes for the device.',
7543
7564
  type: 'boolean',
7565
+ 'x-property-group-key': 'access_codes',
7544
7566
  },
7545
7567
  online: {
7546
7568
  description: 'Indicates whether the device is online.',
@@ -7549,27 +7571,31 @@ export default {
7549
7571
  online_access_codes_enabled: {
7550
7572
  description: 'Indicates whether it is currently possible to use online access codes for the device.',
7551
7573
  type: 'boolean',
7574
+ 'x-property-group-key': 'access_codes',
7552
7575
  },
7553
7576
  serial_number: {
7554
7577
  description: 'Serial number of the device.',
7555
7578
  type: 'string',
7579
+ 'x-property-group-key': 'hardware',
7556
7580
  },
7557
7581
  supports_accessory_keypad: {
7558
7582
  deprecated: true,
7559
7583
  type: 'boolean',
7560
7584
  'x-deprecated': 'use device.properties.model.can_connect_accessory_keypad',
7585
+ 'x-property-group-key': 'access_codes',
7561
7586
  },
7562
7587
  supports_offline_access_codes: {
7563
7588
  deprecated: true,
7564
7589
  type: 'boolean',
7565
7590
  'x-deprecated': 'use offline_access_codes_enabled',
7591
+ 'x-property-group-key': 'access_codes',
7566
7592
  },
7567
7593
  },
7568
7594
  required: ['online', 'name', 'appearance', 'model'],
7569
7595
  type: 'object',
7570
7596
  },
7571
7597
  {
7572
- description: 'Properties of the phone.',
7598
+ description: '\n Properties of the phone.\n ',
7573
7599
  properties: {
7574
7600
  assa_abloy_credential_service_metadata: {
7575
7601
  description: 'ASSA ABLOY Credential Service metadata for the phone.',
@@ -7617,31 +7643,73 @@ export default {
7617
7643
  ],
7618
7644
  },
7619
7645
  {
7646
+ description: 'Provider-specific metadata.',
7620
7647
  properties: {
7621
7648
  akiles_metadata: {
7649
+ description: 'Metadata for an Akiles device.\n ',
7622
7650
  properties: {
7623
- _member_group_id: { type: 'string' },
7624
- gadget_id: { type: 'string' },
7625
- gadget_name: { type: 'string' },
7626
- product_name: { type: 'string' },
7651
+ _member_group_id: {
7652
+ description: 'Group ID to which to add users for an Akiles device.\n ',
7653
+ type: 'string',
7654
+ },
7655
+ gadget_id: {
7656
+ description: 'Gadget ID for an Akiles device.\n ',
7657
+ type: 'string',
7658
+ },
7659
+ gadget_name: {
7660
+ description: 'Gadget name for an Akiles device.\n ',
7661
+ type: 'string',
7662
+ },
7663
+ product_name: {
7664
+ description: 'Product name for an Akiles device.\n ',
7665
+ type: 'string',
7666
+ },
7627
7667
  },
7628
7668
  required: ['gadget_name', 'gadget_id', 'product_name'],
7629
7669
  type: 'object',
7630
7670
  },
7631
7671
  assa_abloy_vostio_metadata: {
7632
- properties: { encoder_name: { type: 'string' } },
7672
+ description: 'Metadata for an ASSA ABLOY Vostio system.\n ',
7673
+ properties: {
7674
+ encoder_name: {
7675
+ description: 'Encoder name for an ASSA ABLOY Vostio system.\n ',
7676
+ type: 'string',
7677
+ },
7678
+ },
7633
7679
  required: ['encoder_name'],
7634
7680
  type: 'object',
7635
7681
  },
7636
7682
  august_metadata: {
7683
+ description: 'Metadata for an August device.\n ',
7637
7684
  properties: {
7638
- has_keypad: { type: 'boolean' },
7639
- house_id: { type: 'string' },
7640
- house_name: { type: 'string' },
7641
- keypad_battery_level: { type: 'string' },
7642
- lock_id: { type: 'string' },
7643
- lock_name: { type: 'string' },
7644
- model: { type: 'string' },
7685
+ has_keypad: {
7686
+ description: 'Indicates whether an August device has a keypad.\n ',
7687
+ type: 'boolean',
7688
+ },
7689
+ house_id: {
7690
+ description: 'House ID for an August device.\n ',
7691
+ type: 'string',
7692
+ },
7693
+ house_name: {
7694
+ description: 'House name for an August device.\n ',
7695
+ type: 'string',
7696
+ },
7697
+ keypad_battery_level: {
7698
+ description: 'Keypad battery level for an August device.\n ',
7699
+ type: 'string',
7700
+ },
7701
+ lock_id: {
7702
+ description: 'Lock ID for an August device.\n ',
7703
+ type: 'string',
7704
+ },
7705
+ lock_name: {
7706
+ description: 'Lock name for an August device.\n ',
7707
+ type: 'string',
7708
+ },
7709
+ model: {
7710
+ description: 'Model for an August device.\n ',
7711
+ type: 'string',
7712
+ },
7645
7713
  },
7646
7714
  required: [
7647
7715
  'lock_id',
@@ -7652,17 +7720,39 @@ export default {
7652
7720
  type: 'object',
7653
7721
  },
7654
7722
  avigilon_alta_metadata: {
7723
+ description: 'Metadata for an Avigilon Alta system.\n ',
7655
7724
  properties: {
7656
- entry_name: { type: 'string' },
7725
+ entry_name: {
7726
+ description: 'Entry name for an Avigilon Alta system.\n ',
7727
+ type: 'string',
7728
+ },
7657
7729
  entry_relays_total_count: {
7730
+ description: 'Total count of entry relays for an Avigilon Alta system.\n ',
7658
7731
  format: 'float',
7659
7732
  type: 'number',
7660
7733
  },
7661
- org_name: { type: 'string' },
7662
- site_id: { format: 'float', type: 'number' },
7663
- site_name: { type: 'string' },
7664
- zone_id: { format: 'float', type: 'number' },
7665
- zone_name: { type: 'string' },
7734
+ org_name: {
7735
+ description: 'Organization name for an Avigilon Alta system.\n ',
7736
+ type: 'string',
7737
+ },
7738
+ site_id: {
7739
+ description: 'Site ID for an Avigilon Alta system.\n ',
7740
+ format: 'float',
7741
+ type: 'number',
7742
+ },
7743
+ site_name: {
7744
+ description: 'Site name for an Avigilon Alta system.\n ',
7745
+ type: 'string',
7746
+ },
7747
+ zone_id: {
7748
+ description: 'Zone ID for an Avigilon Alta system.\n ',
7749
+ format: 'float',
7750
+ type: 'number',
7751
+ },
7752
+ zone_name: {
7753
+ description: 'Zone name for an Avigilon Alta system.\n ',
7754
+ type: 'string',
7755
+ },
7666
7756
  },
7667
7757
  required: [
7668
7758
  'entry_name',
@@ -7676,50 +7766,111 @@ export default {
7676
7766
  type: 'object',
7677
7767
  },
7678
7768
  brivo_metadata: {
7679
- properties: { device_name: { type: 'string' } },
7769
+ description: 'Metadata for a Brivo device.\n ',
7770
+ properties: {
7771
+ device_name: {
7772
+ description: 'Device name for a Brivo device.\n ',
7773
+ type: 'string',
7774
+ },
7775
+ },
7680
7776
  required: ['device_name'],
7681
7777
  type: 'object',
7682
7778
  },
7683
7779
  controlbyweb_metadata: {
7780
+ description: 'Metadata for a ControlByWeb device.\n ',
7684
7781
  properties: {
7685
- device_id: { type: 'string' },
7686
- device_name: { type: 'string' },
7687
- relay_name: { nullable: true, type: 'string' },
7782
+ device_id: {
7783
+ description: 'Device ID for a ControlByWeb device.\n ',
7784
+ type: 'string',
7785
+ },
7786
+ device_name: {
7787
+ description: 'Device name for a ControlByWeb device.\n ',
7788
+ type: 'string',
7789
+ },
7790
+ relay_name: {
7791
+ description: 'Relay name for a ControlByWeb device.\n ',
7792
+ nullable: true,
7793
+ type: 'string',
7794
+ },
7688
7795
  },
7689
7796
  required: ['device_id', 'device_name', 'relay_name'],
7690
7797
  type: 'object',
7691
7798
  },
7692
7799
  dormakaba_oracode_metadata: {
7800
+ description: 'Metadata for a dormakaba Oracode device.\n ',
7693
7801
  properties: {
7694
7802
  device_id: {
7803
+ description: 'Device ID for a dormakaba Oracode device.\n ',
7695
7804
  oneOf: [
7696
7805
  { format: 'float', type: 'number' },
7697
7806
  { type: 'string' },
7698
7807
  ],
7699
7808
  },
7700
- door_id: { format: 'float', type: 'number' },
7701
- door_is_wireless: { type: 'boolean' },
7702
- door_name: { type: 'string' },
7703
- iana_timezone: { type: 'string' },
7809
+ door_id: {
7810
+ description: 'Door ID for a dormakaba Oracode device.\n ',
7811
+ format: 'float',
7812
+ type: 'number',
7813
+ },
7814
+ door_is_wireless: {
7815
+ description: 'Indicates whether a door is wireless for a dormakaba Oracode device.\n ',
7816
+ type: 'boolean',
7817
+ },
7818
+ door_name: {
7819
+ description: 'Door name for a dormakaba Oracode device.\n ',
7820
+ type: 'string',
7821
+ },
7822
+ iana_timezone: {
7823
+ description: 'IANA time zone for a dormakaba Oracode device.\n ',
7824
+ type: 'string',
7825
+ },
7704
7826
  predefined_time_slots: {
7827
+ description: 'Predefined time slots for a dormakaba Oracode device.\n ',
7705
7828
  items: {
7829
+ description: 'Time slot for a dormakaba Oracode device.\n ',
7706
7830
  properties: {
7707
- check_in_time: { type: 'string' },
7708
- check_out_time: { type: 'string' },
7831
+ check_in_time: {
7832
+ description: 'Check in time for a time slot for a dormakaba Oracode device.\n ',
7833
+ type: 'string',
7834
+ },
7835
+ check_out_time: {
7836
+ description: 'Checkout time for a time slot for a dormakaba Oracode device.\n ',
7837
+ type: 'string',
7838
+ },
7709
7839
  dormakaba_oracode_user_level_id: {
7840
+ description: 'ID of a user level for a dormakaba Oracode device.\n ',
7710
7841
  format: 'uuid',
7711
7842
  type: 'string',
7712
7843
  },
7713
7844
  ext_dormakaba_oracode_user_level_prefix: {
7845
+ description: 'Prefix for a user level for a dormakaba Oracode device.\n ',
7846
+ format: 'float',
7847
+ type: 'number',
7848
+ },
7849
+ is_24_hour: {
7850
+ description: 'Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.\n ',
7851
+ type: 'boolean',
7852
+ },
7853
+ is_biweekly_mode: {
7854
+ description: 'Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.\n ',
7855
+ type: 'boolean',
7856
+ },
7857
+ is_master: {
7858
+ description: 'Indicates whether a time slot for a dormakaba Oracode device is a master time slot.\n ',
7859
+ type: 'boolean',
7860
+ },
7861
+ is_one_shot: {
7862
+ description: 'Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.\n ',
7863
+ type: 'boolean',
7864
+ },
7865
+ name: {
7866
+ description: 'Name of a time slot for a dormakaba Oracode device.\n ',
7867
+ type: 'string',
7868
+ },
7869
+ prefix: {
7870
+ description: 'Prefix for a time slot for a dormakaba Oracode device.\n ',
7714
7871
  format: 'float',
7715
7872
  type: 'number',
7716
7873
  },
7717
- is_24_hour: { type: 'boolean' },
7718
- is_biweekly_mode: { type: 'boolean' },
7719
- is_master: { type: 'boolean' },
7720
- is_one_shot: { type: 'boolean' },
7721
- name: { type: 'string' },
7722
- prefix: { format: 'float', type: 'number' },
7723
7874
  },
7724
7875
  required: [
7725
7876
  'name',
@@ -7738,12 +7889,17 @@ export default {
7738
7889
  type: 'array',
7739
7890
  },
7740
7891
  site_id: {
7741
- description: '@DEPRECATED',
7892
+ deprecated: true,
7893
+ description: 'Site ID for a dormakaba Oracode device.',
7742
7894
  format: 'float',
7743
7895
  nullable: true,
7744
7896
  type: 'number',
7897
+ 'x-deprecated': 'Previously marked as "@DEPRECATED."',
7898
+ },
7899
+ site_name: {
7900
+ description: 'Site name for a dormakaba Oracode device.\n ',
7901
+ type: 'string',
7745
7902
  },
7746
- site_name: { type: 'string' },
7747
7903
  },
7748
7904
  required: [
7749
7905
  'door_name',
@@ -7754,18 +7910,34 @@ export default {
7754
7910
  type: 'object',
7755
7911
  },
7756
7912
  ecobee_metadata: {
7913
+ description: 'Metadata for an ecobee device.\n ',
7757
7914
  properties: {
7758
- device_name: { type: 'string' },
7759
- ecobee_device_id: { type: 'string' },
7915
+ device_name: {
7916
+ description: 'Device name for an ecobee device.\n ',
7917
+ type: 'string',
7918
+ },
7919
+ ecobee_device_id: {
7920
+ description: 'Device ID for an ecobee device.\n ',
7921
+ type: 'string',
7922
+ },
7760
7923
  },
7761
7924
  required: ['ecobee_device_id', 'device_name'],
7762
7925
  type: 'object',
7763
7926
  },
7764
7927
  four_suites_metadata: {
7928
+ description: 'Metadata for a 4SUITES device.\n ',
7765
7929
  properties: {
7766
- device_id: { format: 'float', type: 'number' },
7767
- device_name: { type: 'string' },
7930
+ device_id: {
7931
+ description: 'Device ID for a 4SUITES device.\n ',
7932
+ format: 'float',
7933
+ type: 'number',
7934
+ },
7935
+ device_name: {
7936
+ description: 'Device name for a 4SUITES device.\n ',
7937
+ type: 'string',
7938
+ },
7768
7939
  reclose_delay_in_seconds: {
7940
+ description: 'Reclose delay, in seconds, for a 4SUITES device.\n ',
7769
7941
  format: 'float',
7770
7942
  type: 'number',
7771
7943
  },
@@ -7778,17 +7950,31 @@ export default {
7778
7950
  type: 'object',
7779
7951
  },
7780
7952
  genie_metadata: {
7953
+ description: 'Metadata for a Genie device.\n ',
7781
7954
  properties: {
7782
- device_name: { type: 'string' },
7783
- door_name: { type: 'string' },
7955
+ device_name: {
7956
+ description: 'Lock name for a Genie device.\n ',
7957
+ type: 'string',
7958
+ },
7959
+ door_name: {
7960
+ description: 'Door name for a Genie device.\n ',
7961
+ type: 'string',
7962
+ },
7784
7963
  },
7785
7964
  required: ['device_name', 'door_name'],
7786
7965
  type: 'object',
7787
7966
  },
7788
7967
  honeywell_resideo_metadata: {
7968
+ description: 'Metadata for a Honeywell Resideo device.\n ',
7789
7969
  properties: {
7790
- device_name: { type: 'string' },
7791
- honeywell_resideo_device_id: { type: 'string' },
7970
+ device_name: {
7971
+ description: 'Device name for a Honeywell Resideo device.\n ',
7972
+ type: 'string',
7973
+ },
7974
+ honeywell_resideo_device_id: {
7975
+ description: 'Device ID for a Honeywell Resideo device.\n ',
7976
+ type: 'string',
7977
+ },
7792
7978
  },
7793
7979
  required: [
7794
7980
  'honeywell_resideo_device_id',
@@ -7797,94 +7983,198 @@ export default {
7797
7983
  type: 'object',
7798
7984
  },
7799
7985
  hubitat_metadata: {
7986
+ description: 'Metadata for a Hubitat device.\n ',
7800
7987
  properties: {
7801
- device_id: { type: 'string' },
7802
- device_label: { type: 'string' },
7803
- device_name: { type: 'string' },
7988
+ device_id: {
7989
+ description: 'Device ID for a Hubitat device.\n ',
7990
+ type: 'string',
7991
+ },
7992
+ device_label: {
7993
+ description: 'Device label for a Hubitat device.\n ',
7994
+ type: 'string',
7995
+ },
7996
+ device_name: {
7997
+ description: 'Device name for a Hubitat device.\n ',
7998
+ type: 'string',
7999
+ },
7804
8000
  },
7805
8001
  required: ['device_id', 'device_name', 'device_label'],
7806
8002
  type: 'object',
7807
8003
  },
7808
8004
  igloo_metadata: {
8005
+ description: 'Metadata for an igloo device.\n ',
7809
8006
  properties: {
7810
- bridge_id: { type: 'string' },
7811
- device_id: { type: 'string' },
7812
- model: { type: 'string' },
8007
+ bridge_id: {
8008
+ description: 'Bridge ID for an igloo device.\n ',
8009
+ type: 'string',
8010
+ },
8011
+ device_id: {
8012
+ description: 'Device ID for an igloo device.\n ',
8013
+ type: 'string',
8014
+ },
8015
+ model: {
8016
+ description: 'Model for an igloo device.\n ',
8017
+ type: 'string',
8018
+ },
7813
8019
  },
7814
8020
  required: ['device_id', 'bridge_id'],
7815
8021
  type: 'object',
7816
8022
  },
7817
8023
  igloohome_metadata: {
8024
+ description: 'Metadata for an igloohome device.\n ',
7818
8025
  properties: {
7819
- bridge_id: { type: 'string' },
7820
- bridge_name: { type: 'string' },
7821
- device_id: { type: 'string' },
7822
- device_name: { type: 'string' },
7823
- keypad_id: { type: 'string' },
8026
+ bridge_id: {
8027
+ description: 'Bridge ID for an igloohome device.\n ',
8028
+ type: 'string',
8029
+ },
8030
+ bridge_name: {
8031
+ description: 'Bridge name for an igloohome device.\n ',
8032
+ type: 'string',
8033
+ },
8034
+ device_id: {
8035
+ description: 'Device ID for an igloohome device.\n ',
8036
+ type: 'string',
8037
+ },
8038
+ device_name: {
8039
+ description: 'Device name for an igloohome device.\n ',
8040
+ type: 'string',
8041
+ },
8042
+ keypad_id: {
8043
+ description: 'Keypad ID for an igloohome device.\n ',
8044
+ type: 'string',
8045
+ },
7824
8046
  },
7825
8047
  required: ['device_id', 'device_name'],
7826
8048
  type: 'object',
7827
8049
  },
7828
8050
  kwikset_metadata: {
8051
+ description: 'Metadata for a Kwikset device.\n ',
7829
8052
  properties: {
7830
- device_id: { type: 'string' },
7831
- device_name: { type: 'string' },
7832
- model_number: { type: 'string' },
8053
+ device_id: {
8054
+ description: 'Device ID for a Kwikset device.\n ',
8055
+ type: 'string',
8056
+ },
8057
+ device_name: {
8058
+ description: 'Device name for a Kwikset device.\n ',
8059
+ type: 'string',
8060
+ },
8061
+ model_number: {
8062
+ description: 'Model number for a Kwikset device.\n ',
8063
+ type: 'string',
8064
+ },
7833
8065
  },
7834
8066
  required: ['device_id', 'device_name', 'model_number'],
7835
8067
  type: 'object',
7836
8068
  },
7837
8069
  lockly_metadata: {
8070
+ description: 'Metadata for a Lockly device.\n ',
7838
8071
  properties: {
7839
- device_id: { type: 'string' },
7840
- device_name: { type: 'string' },
7841
- model: { type: 'string' },
8072
+ device_id: {
8073
+ description: 'Device ID for a Lockly device.\n ',
8074
+ type: 'string',
8075
+ },
8076
+ device_name: {
8077
+ description: 'Device name for a Lockly device.\n ',
8078
+ type: 'string',
8079
+ },
8080
+ model: {
8081
+ description: 'Model for a Lockly device.\n ',
8082
+ type: 'string',
8083
+ },
7842
8084
  },
7843
8085
  required: ['device_id', 'device_name'],
7844
8086
  type: 'object',
7845
8087
  },
7846
8088
  minut_metadata: {
8089
+ description: 'Metadata for a Minut device.\n ',
7847
8090
  properties: {
7848
- device_id: { type: 'string' },
7849
- device_name: { type: 'string' },
8091
+ device_id: {
8092
+ description: 'Device ID for a Minut device.\n ',
8093
+ type: 'string',
8094
+ },
8095
+ device_name: {
8096
+ description: 'Device name for a Minut device.\n ',
8097
+ type: 'string',
8098
+ },
7850
8099
  latest_sensor_values: {
8100
+ description: 'Latest sensor values for a Minut device.\n ',
7851
8101
  properties: {
7852
8102
  accelerometer_z: {
8103
+ description: 'Latest accelerometer Z-axis reading for a Minut device.\n ',
7853
8104
  properties: {
7854
- time: { type: 'string' },
7855
- value: { format: 'float', type: 'number' },
8105
+ time: {
8106
+ description: 'Time of latest accelerometer Z-axis reading for a Minut device.\n ',
8107
+ type: 'string',
8108
+ },
8109
+ value: {
8110
+ description: 'Value of latest accelerometer Z-axis reading for a Minut device.\n ',
8111
+ format: 'float',
8112
+ type: 'number',
8113
+ },
7856
8114
  },
7857
8115
  required: ['time', 'value'],
7858
8116
  type: 'object',
7859
8117
  },
7860
8118
  humidity: {
8119
+ description: 'Latest humidity reading for a Minut device.\n ',
7861
8120
  properties: {
7862
- time: { type: 'string' },
7863
- value: { format: 'float', type: 'number' },
8121
+ time: {
8122
+ description: 'Time of latest humidity reading for a Minut device.\n ',
8123
+ type: 'string',
8124
+ },
8125
+ value: {
8126
+ description: 'Value of latest humidity reading for a Minut device.\n ',
8127
+ format: 'float',
8128
+ type: 'number',
8129
+ },
7864
8130
  },
7865
8131
  required: ['time', 'value'],
7866
8132
  type: 'object',
7867
8133
  },
7868
8134
  pressure: {
8135
+ description: 'Latest pressure reading for a Minut device.\n ',
7869
8136
  properties: {
7870
- time: { type: 'string' },
7871
- value: { format: 'float', type: 'number' },
8137
+ time: {
8138
+ description: 'Time of latest pressure reading for a Minut device.\n ',
8139
+ type: 'string',
8140
+ },
8141
+ value: {
8142
+ description: 'Value of latest pressure reading for a Minut device.\n ',
8143
+ format: 'float',
8144
+ type: 'number',
8145
+ },
7872
8146
  },
7873
8147
  required: ['time', 'value'],
7874
8148
  type: 'object',
7875
8149
  },
7876
8150
  sound: {
8151
+ description: 'Latest sound reading for a Minut device.\n ',
7877
8152
  properties: {
7878
- time: { type: 'string' },
7879
- value: { format: 'float', type: 'number' },
8153
+ time: {
8154
+ description: 'Time of latest sound reading for a Minut device.\n ',
8155
+ type: 'string',
8156
+ },
8157
+ value: {
8158
+ description: 'Value of latest sound reading for a Minut device.\n ',
8159
+ format: 'float',
8160
+ type: 'number',
8161
+ },
7880
8162
  },
7881
8163
  required: ['time', 'value'],
7882
8164
  type: 'object',
7883
8165
  },
7884
8166
  temperature: {
8167
+ description: 'Latest temperature reading for a Minut device.\n ',
7885
8168
  properties: {
7886
- time: { type: 'string' },
7887
- value: { format: 'float', type: 'number' },
8169
+ time: {
8170
+ description: 'Time of latest temperature reading for a Minut device.\n ',
8171
+ type: 'string',
8172
+ },
8173
+ value: {
8174
+ description: 'Value of latest temperature reading for a Minut device.\n ',
8175
+ format: 'float',
8176
+ type: 'number',
8177
+ },
7888
8178
  },
7889
8179
  required: ['time', 'value'],
7890
8180
  type: 'object',
@@ -7908,11 +8198,24 @@ export default {
7908
8198
  type: 'object',
7909
8199
  },
7910
8200
  nest_metadata: {
8201
+ description: 'Metadata for a Google Nest device.\n ',
7911
8202
  properties: {
7912
- device_custom_name: { type: 'string' },
7913
- device_name: { type: 'string' },
7914
- display_name: { type: 'string' },
7915
- nest_device_id: { type: 'string' },
8203
+ device_custom_name: {
8204
+ description: 'Custom device name for a Google Nest device. The device owner sets this value.\n ',
8205
+ type: 'string',
8206
+ },
8207
+ device_name: {
8208
+ description: 'Device name for a Google Nest device. Google sets this value.\n ',
8209
+ type: 'string',
8210
+ },
8211
+ display_name: {
8212
+ description: 'Display name for a Google Nest device.\n ',
8213
+ type: 'string',
8214
+ },
8215
+ nest_device_id: {
8216
+ description: 'Device ID for a Google Nest device.\n ',
8217
+ type: 'string',
8218
+ },
7916
8219
  },
7917
8220
  required: [
7918
8221
  'nest_device_id',
@@ -7922,18 +8225,31 @@ export default {
7922
8225
  type: 'object',
7923
8226
  },
7924
8227
  noiseaware_metadata: {
8228
+ description: 'Metadata for a NoiseAware device.\n ',
7925
8229
  properties: {
7926
- device_id: { type: 'string' },
8230
+ device_id: {
8231
+ description: 'Device ID for a NoiseAware device.\n ',
8232
+ type: 'string',
8233
+ },
7927
8234
  device_model: {
8235
+ description: 'Device model for a NoiseAware device.\n ',
7928
8236
  enum: ['indoor', 'outdoor'],
7929
8237
  type: 'string',
7930
8238
  },
7931
- device_name: { type: 'string' },
8239
+ device_name: {
8240
+ description: 'Device name for a NoiseAware device.\n ',
8241
+ type: 'string',
8242
+ },
7932
8243
  noise_level_decibel: {
8244
+ description: 'Noise level, in decibels, for a NoiseAware device.\n ',
8245
+ format: 'float',
8246
+ type: 'number',
8247
+ },
8248
+ noise_level_nrs: {
8249
+ description: 'Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.\n ',
7933
8250
  format: 'float',
7934
8251
  type: 'number',
7935
8252
  },
7936
- noise_level_nrs: { format: 'float', type: 'number' },
7937
8253
  },
7938
8254
  required: [
7939
8255
  'device_model',
@@ -7945,24 +8261,59 @@ export default {
7945
8261
  type: 'object',
7946
8262
  },
7947
8263
  nuki_metadata: {
8264
+ description: 'Metadata for a Nuki device.\n ',
7948
8265
  properties: {
7949
- device_id: { type: 'string' },
7950
- device_name: { type: 'string' },
7951
- keypad_2_paired: { type: 'boolean' },
7952
- keypad_battery_critical: { type: 'boolean' },
7953
- keypad_paired: { type: 'boolean' },
8266
+ device_id: {
8267
+ description: 'Device ID for a Nuki device.\n ',
8268
+ type: 'string',
8269
+ },
8270
+ device_name: {
8271
+ description: 'Device name for a Nuki device.\n ',
8272
+ type: 'string',
8273
+ },
8274
+ keypad_2_paired: {
8275
+ description: 'Indicates whether keypad 2 is paired for a Nuki device.\n ',
8276
+ type: 'boolean',
8277
+ },
8278
+ keypad_battery_critical: {
8279
+ description: 'Indicates whether the keypad battery is in a critical state for a Nuki device.\n ',
8280
+ type: 'boolean',
8281
+ },
8282
+ keypad_paired: {
8283
+ description: 'Indicates whether the keypad is paired for a Nuki device.\n ',
8284
+ type: 'boolean',
8285
+ },
7954
8286
  },
7955
8287
  required: ['device_id', 'device_name'],
7956
8288
  type: 'object',
7957
8289
  },
7958
8290
  salto_ks_metadata: {
8291
+ description: 'Metadata for a Salto KS device.\n ',
7959
8292
  properties: {
7960
- battery_level: { type: 'string' },
7961
- customer_reference: { type: 'string' },
7962
- lock_id: { type: 'string' },
7963
- lock_type: { type: 'string' },
7964
- locked_state: { type: 'string' },
7965
- model: { type: 'string' },
8293
+ battery_level: {
8294
+ description: 'Battery level for a Salto KS device.\n ',
8295
+ type: 'string',
8296
+ },
8297
+ customer_reference: {
8298
+ description: 'Customer reference for a Salto KS device.\n ',
8299
+ type: 'string',
8300
+ },
8301
+ lock_id: {
8302
+ description: 'Lock ID for a Salto KS device.\n ',
8303
+ type: 'string',
8304
+ },
8305
+ lock_type: {
8306
+ description: 'Lock type for a Salto KS device.\n ',
8307
+ type: 'string',
8308
+ },
8309
+ locked_state: {
8310
+ description: 'Locked state for a Salto KS device.\n ',
8311
+ type: 'string',
8312
+ },
8313
+ model: {
8314
+ description: 'Model for a Salto KS device.\n ',
8315
+ type: 'string',
8316
+ },
7966
8317
  },
7967
8318
  required: [
7968
8319
  'lock_id',
@@ -7974,14 +8325,33 @@ export default {
7974
8325
  type: 'object',
7975
8326
  },
7976
8327
  salto_metadata: {
7977
- description: '\n ---\n deprecated: Use `salto_ks_metadata ` instead.\n ',
8328
+ deprecated: true,
8329
+ description: 'Metada for a Salto device.',
7978
8330
  properties: {
7979
- battery_level: { type: 'string' },
7980
- customer_reference: { type: 'string' },
7981
- lock_id: { type: 'string' },
7982
- lock_type: { type: 'string' },
7983
- locked_state: { type: 'string' },
7984
- model: { type: 'string' },
8331
+ battery_level: {
8332
+ description: 'Battery level for a Salto device.\n ',
8333
+ type: 'string',
8334
+ },
8335
+ customer_reference: {
8336
+ description: 'Customer reference for a Salto device.\n ',
8337
+ type: 'string',
8338
+ },
8339
+ lock_id: {
8340
+ description: 'Lock ID for a Salto device.\n ',
8341
+ type: 'string',
8342
+ },
8343
+ lock_type: {
8344
+ description: 'Lock type for a Salto device.\n ',
8345
+ type: 'string',
8346
+ },
8347
+ locked_state: {
8348
+ description: 'Locked state for a Salto device.\n ',
8349
+ type: 'string',
8350
+ },
8351
+ model: {
8352
+ description: 'Model for a Salto device.\n ',
8353
+ type: 'string',
8354
+ },
7985
8355
  },
7986
8356
  required: [
7987
8357
  'lock_id',
@@ -7991,21 +8361,41 @@ export default {
7991
8361
  'locked_state',
7992
8362
  ],
7993
8363
  type: 'object',
8364
+ 'x-deprecated': 'Use `salto_ks_metadata ` instead.',
7994
8365
  },
7995
8366
  schlage_metadata: {
8367
+ description: 'Metadata for a Schlage device.\n ',
7996
8368
  properties: {
7997
- device_id: { type: 'string' },
7998
- device_name: { type: 'string' },
7999
- model: { type: 'string' },
8369
+ device_id: {
8370
+ description: 'Device ID for a Schlage device.\n ',
8371
+ type: 'string',
8372
+ },
8373
+ device_name: {
8374
+ description: 'Device name for a Schlage device.\n ',
8375
+ type: 'string',
8376
+ },
8377
+ model: {
8378
+ description: 'Model for a Schlage device.\n ',
8379
+ type: 'string',
8380
+ },
8000
8381
  },
8001
8382
  required: ['device_id', 'device_name'],
8002
8383
  type: 'object',
8003
8384
  },
8004
8385
  seam_bridge_metadata: {
8386
+ description: 'Metadata for Seam Bridge.\n ',
8005
8387
  properties: {
8006
- device_num: { format: 'float', type: 'number' },
8007
- name: { type: 'string' },
8388
+ device_num: {
8389
+ description: 'Device number for Seam Bridge.\n ',
8390
+ format: 'float',
8391
+ type: 'number',
8392
+ },
8393
+ name: {
8394
+ description: 'Name for Seam Bridge.\n ',
8395
+ type: 'string',
8396
+ },
8008
8397
  unlock_method: {
8398
+ description: 'Unlock method for Seam Bridge.\n ',
8009
8399
  enum: ['bridge', 'doorking'],
8010
8400
  type: 'string',
8011
8401
  },
@@ -8014,41 +8404,96 @@ export default {
8014
8404
  type: 'object',
8015
8405
  },
8016
8406
  sensi_metadata: {
8407
+ description: 'Metadata for a Sensi device.\n ',
8017
8408
  properties: {
8018
- device_id: { type: 'string' },
8019
- device_name: { type: 'string' },
8020
- product_type: { type: 'string' },
8409
+ device_id: {
8410
+ description: 'Device ID for a Sensi device.\n ',
8411
+ type: 'string',
8412
+ },
8413
+ device_name: {
8414
+ description: 'Device name for a Sensi device.\n ',
8415
+ type: 'string',
8416
+ },
8417
+ product_type: {
8418
+ description: 'Product type for a Sensi device.\n ',
8419
+ type: 'string',
8420
+ },
8021
8421
  },
8022
8422
  required: ['device_id', 'device_name', 'product_type'],
8023
8423
  type: 'object',
8024
8424
  },
8025
8425
  smartthings_metadata: {
8426
+ description: 'Metadata for a SmartThings device.\n ',
8026
8427
  properties: {
8027
- device_id: { type: 'string' },
8028
- device_name: { type: 'string' },
8029
- location_id: { type: 'string' },
8030
- model: { type: 'string' },
8428
+ device_id: {
8429
+ description: 'Device ID for a SmartThings device.\n ',
8430
+ type: 'string',
8431
+ },
8432
+ device_name: {
8433
+ description: 'Device name for a SmartThings device.\n ',
8434
+ type: 'string',
8435
+ },
8436
+ location_id: {
8437
+ description: 'Location ID for a SmartThings device.\n ',
8438
+ type: 'string',
8439
+ },
8440
+ model: {
8441
+ description: 'Model for a SmartThings device.\n ',
8442
+ type: 'string',
8443
+ },
8031
8444
  },
8032
8445
  required: ['device_id', 'device_name'],
8033
8446
  type: 'object',
8034
8447
  },
8035
8448
  tado_metadata: {
8449
+ description: 'Metadata for a tado° device.\n ',
8036
8450
  properties: {
8037
- device_type: { type: 'string' },
8038
- serial_no: { type: 'string' },
8451
+ device_type: {
8452
+ description: 'Device type for a tado° device.\n ',
8453
+ type: 'string',
8454
+ },
8455
+ serial_no: {
8456
+ description: 'Serial number for a tado° device.\n ',
8457
+ type: 'string',
8458
+ },
8039
8459
  },
8040
8460
  required: ['serial_no', 'device_type'],
8041
8461
  type: 'object',
8042
8462
  },
8043
8463
  tedee_metadata: {
8464
+ description: 'Metadata for a Tedee device.\n ',
8044
8465
  properties: {
8045
- bridge_id: { format: 'float', type: 'number' },
8046
- bridge_name: { type: 'string' },
8047
- device_id: { format: 'float', type: 'number' },
8048
- device_model: { type: 'string' },
8049
- device_name: { type: 'string' },
8050
- keypad_id: { format: 'float', type: 'number' },
8051
- serial_number: { type: 'string' },
8466
+ bridge_id: {
8467
+ description: 'Bridge ID for a Tedee device.\n ',
8468
+ format: 'float',
8469
+ type: 'number',
8470
+ },
8471
+ bridge_name: {
8472
+ description: 'Bridge name for a Tedee device.\n ',
8473
+ type: 'string',
8474
+ },
8475
+ device_id: {
8476
+ description: 'Device ID for a Tedee device.\n ',
8477
+ format: 'float',
8478
+ type: 'number',
8479
+ },
8480
+ device_model: {
8481
+ description: 'Device model for a Tedee device.\n ',
8482
+ type: 'string',
8483
+ },
8484
+ device_name: {
8485
+ description: 'Device name for a Tedee device.\n ',
8486
+ type: 'string',
8487
+ },
8488
+ keypad_id: {
8489
+ description: 'Keypad ID for a Tedee device.\n ',
8490
+ format: 'float',
8491
+ type: 'number',
8492
+ },
8493
+ serial_number: {
8494
+ description: 'Serial number for a Tedee device.\n ',
8495
+ type: 'string',
8496
+ },
8052
8497
  },
8053
8498
  required: [
8054
8499
  'device_id',
@@ -8061,16 +8506,39 @@ export default {
8061
8506
  type: 'object',
8062
8507
  },
8063
8508
  ttlock_metadata: {
8509
+ description: 'Metadata for a TTLock device.\n ',
8064
8510
  properties: {
8065
- feature_value: { type: 'string' },
8511
+ feature_value: {
8512
+ description: 'Feature value for a TTLock device.\n ',
8513
+ type: 'string',
8514
+ },
8066
8515
  features: {
8516
+ description: 'Features for a TTLock device.\n ',
8067
8517
  properties: {
8068
- incomplete_keyboard_passcode: { type: 'boolean' },
8069
- lock_command: { type: 'boolean' },
8070
- passcode: { type: 'boolean' },
8071
- passcode_management: { type: 'boolean' },
8072
- unlock_via_gateway: { type: 'boolean' },
8073
- wifi: { type: 'boolean' },
8518
+ incomplete_keyboard_passcode: {
8519
+ description: 'Indicates whether a TTLock device supports an incomplete keyboard passcode.\n ',
8520
+ type: 'boolean',
8521
+ },
8522
+ lock_command: {
8523
+ description: 'Indicates whether a TTLock device supports the lock command.\n ',
8524
+ type: 'boolean',
8525
+ },
8526
+ passcode: {
8527
+ description: 'Indicates whether a TTLock device supports a passcode.\n ',
8528
+ type: 'boolean',
8529
+ },
8530
+ passcode_management: {
8531
+ description: 'Indicates whether a TTLock device supports passcode management.\n ',
8532
+ type: 'boolean',
8533
+ },
8534
+ unlock_via_gateway: {
8535
+ description: 'Indicates whether a TTLock device supports unlock via gateway.\n ',
8536
+ type: 'boolean',
8537
+ },
8538
+ wifi: {
8539
+ description: 'Indicates whether a TTLock device supports Wi-Fi.\n ',
8540
+ type: 'boolean',
8541
+ },
8074
8542
  },
8075
8543
  required: [
8076
8544
  'passcode',
@@ -8082,17 +8550,32 @@ export default {
8082
8550
  ],
8083
8551
  type: 'object',
8084
8552
  },
8085
- has_gateway: { type: 'boolean' },
8086
- lock_alias: { type: 'string' },
8087
- lock_id: { format: 'float', type: 'number' },
8553
+ has_gateway: {
8554
+ description: 'Indicates whether a TTLock device has a gateway.\n ',
8555
+ type: 'boolean',
8556
+ },
8557
+ lock_alias: {
8558
+ description: 'Lock alias for a TTLock device.\n ',
8559
+ type: 'string',
8560
+ },
8561
+ lock_id: {
8562
+ description: 'Lock ID for a TTLock device.\n ',
8563
+ format: 'float',
8564
+ type: 'number',
8565
+ },
8088
8566
  wireless_keypads: {
8567
+ description: 'Wireless keypads for a TTLock device.\n ',
8089
8568
  items: {
8090
8569
  properties: {
8091
8570
  wireless_keypad_id: {
8571
+ description: 'ID for a wireless keypad for a TTLock device.\n ',
8092
8572
  format: 'float',
8093
8573
  type: 'number',
8094
8574
  },
8095
- wireless_keypad_name: { type: 'string' },
8575
+ wireless_keypad_name: {
8576
+ description: 'Name for a wireless keypad for a TTLock device.\n ',
8577
+ type: 'string',
8578
+ },
8096
8579
  },
8097
8580
  required: [
8098
8581
  'wireless_keypad_id',
@@ -8112,31 +8595,68 @@ export default {
8112
8595
  type: 'object',
8113
8596
  },
8114
8597
  two_n_metadata: {
8598
+ description: 'Metadata for a 2N device.\n ',
8115
8599
  properties: {
8116
- device_id: { format: 'float', type: 'number' },
8117
- device_name: { type: 'string' },
8600
+ device_id: {
8601
+ description: 'Device ID for a 2N device.\n ',
8602
+ format: 'float',
8603
+ type: 'number',
8604
+ },
8605
+ device_name: {
8606
+ description: 'Device name for a 2N device.\n ',
8607
+ type: 'string',
8608
+ },
8118
8609
  },
8119
8610
  required: ['device_id', 'device_name'],
8120
8611
  type: 'object',
8121
8612
  },
8122
8613
  visionline_metadata: {
8123
- properties: { encoder_id: { type: 'string' } },
8614
+ description: 'Metadata for an ASSA ABLOY Visionline system.\n ',
8615
+ properties: {
8616
+ encoder_id: {
8617
+ description: 'Encoder ID for an ASSA ABLOY Visionline system.\n ',
8618
+ type: 'string',
8619
+ },
8620
+ },
8124
8621
  required: ['encoder_id'],
8125
8622
  type: 'object',
8126
8623
  },
8127
8624
  wyze_metadata: {
8625
+ description: 'Metadata for a Wyze device.\n ',
8128
8626
  properties: {
8129
- device_id: { type: 'string' },
8130
- device_info_model: { type: 'string' },
8131
- device_name: { type: 'string' },
8132
- keypad_uuid: { type: 'string' },
8627
+ device_id: {
8628
+ description: 'Device ID for a Wyze device.\n ',
8629
+ type: 'string',
8630
+ },
8631
+ device_info_model: {
8632
+ description: 'Device information model for a Wyze device.\n ',
8633
+ type: 'string',
8634
+ },
8635
+ device_name: {
8636
+ description: 'Device name for a Wyze device.\n ',
8637
+ type: 'string',
8638
+ },
8639
+ keypad_uuid: {
8640
+ description: 'Keypad UUID for a Wyze device.\n ',
8641
+ type: 'string',
8642
+ },
8133
8643
  locker_status_hardlock: {
8644
+ description: 'Locker status (hardlock) for a Wyze device.\n ',
8134
8645
  format: 'float',
8135
8646
  type: 'number',
8136
8647
  },
8137
- product_model: { type: 'string' },
8138
- product_name: { type: 'string' },
8139
- product_type: { type: 'string' },
8648
+ product_model: {
8649
+ description: 'Product model for a Wyze device.\n ',
8650
+ type: 'string',
8651
+ },
8652
+ product_name: {
8653
+ description: 'Product name for a Wyze device.\n ',
8654
+ type: 'string',
8655
+ },
8656
+ product_type: {
8657
+ description: 'Product type for a Wyze device.\n ',
8658
+ type: 'string',
8659
+ },
8140
8660
  },
8141
8661
  required: [
8142
8662
  'device_id',
@@ -8150,6 +8670,7 @@ export default {
8150
8670
  },
8151
8671
  },
8152
8672
  type: 'object',
8673
+ 'x-property-group-key': 'provider_metadata',
8153
8674
  },
8154
8675
  ],
8155
8676
  },
@@ -8160,14 +8681,18 @@ export default {
8160
8681
  _experimental_supported_code_from_access_codes_lengths: {
8161
8682
  items: { format: 'float', type: 'number' },
8162
8683
  type: 'array',
8684
+ 'x-undocumented': 'Marked as experimental.',
8163
8685
  },
8164
8686
  code_constraints: {
8165
8687
  description: 'Constraints on access codes for the device. Seam represents each constraint as an object with a `constraint_type` property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.',
8166
8688
  items: {
8689
+ description: 'Access code constraint.',
8167
8690
  oneOf: [
8168
8691
  {
8692
+ description: 'Code constraint for access codes.',
8169
8693
  properties: {
8170
8694
  constraint_type: {
8695
+ description: 'Code constraint type for access codes.',
8171
8696
  enum: [
8172
8697
  'no_zeros',
8173
8698
  'cannot_start_with_12',
@@ -8187,13 +8712,22 @@ export default {
8187
8712
  type: 'object',
8188
8713
  },
8189
8714
  {
8715
+ description: 'Name constraint for access codes.',
8190
8716
  properties: {
8191
8717
  constraint_type: {
8192
8718
  enum: ['name_length', 'name_must_be_unique'],
8193
8719
  type: 'string',
8194
8720
  },
8195
- max_length: { format: 'float', type: 'number' },
8196
- min_length: { format: 'float', type: 'number' },
8721
+ max_length: {
8722
+ description: 'Maximum name length constraint for access codes.',
8723
+ format: 'float',
8724
+ type: 'number',
8725
+ },
8726
+ min_length: {
8727
+ description: 'Minimum name length constraint for access codes.',
8728
+ format: 'float',
8729
+ type: 'number',
8730
+ },
8197
8731
  },
8198
8732
  required: ['constraint_type'],
8199
8733
  type: 'object',
@@ -8201,26 +8735,53 @@ export default {
8201
8735
  ],
8202
8736
  },
8203
8737
  type: 'array',
8738
+ 'x-property-group-key': 'access_codes',
8739
+ },
8740
+ door_open: {
8741
+ description: 'Indicates whether the door is open.',
8742
+ type: 'boolean',
8743
+ 'x-property-group-key': 'locks',
8744
+ },
8745
+ has_native_entry_events: {
8746
+ description: 'Indicates whether the device supports native entry events.',
8747
+ type: 'boolean',
8748
+ 'x-property-group-key': 'access_codes',
8204
8749
  },
8205
- door_open: { type: 'boolean' },
8206
- has_native_entry_events: { type: 'boolean' },
8207
8750
  keypad_battery: {
8751
+ description: 'Keypad battery status.',
8208
8752
  properties: {
8209
- level: { format: 'float', type: 'number' },
8753
+ level: {
8754
+ description: 'Keypad battery charge level.\n ',
8755
+ format: 'float',
8756
+ type: 'number',
8757
+ },
8210
8758
  },
8211
8759
  required: ['level'],
8212
8760
  type: 'object',
8761
+ 'x-property-group-key': 'access_codes',
8762
+ },
8763
+ locked: {
8764
+ description: 'Indicates whether the lock is locked.',
8765
+ type: 'boolean',
8766
+ 'x-property-group-key': 'locks',
8213
8767
  },
8214
- locked: { type: 'boolean' },
8215
8768
  max_active_codes_supported: {
8769
+ description: 'Maximum number of active access codes that the device supports.',
8216
8770
  format: 'float',
8217
8771
  type: 'number',
8772
+ 'x-property-group-key': 'access_codes',
8218
8773
  },
8219
8774
  supported_code_lengths: {
8775
+ description: 'Supported code lengths for access codes.',
8220
8776
  items: { format: 'float', type: 'number' },
8221
8777
  type: 'array',
8778
+ 'x-property-group-key': 'access_codes',
8779
+ },
8780
+ supports_backup_access_code_pool: {
8781
+ description: 'Indicates whether the device supports a [backup access code pool](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes/backup-access-codes).',
8782
+ type: 'boolean',
8783
+ 'x-property-group-key': 'access_codes',
8222
8784
  },
8223
- supports_backup_access_code_pool: { type: 'boolean' },
8224
8785
  },
8225
8786
  type: 'object',
8226
8787
  },
@@ -8228,7 +8789,7 @@ export default {
8228
8789
  properties: {
8229
8790
  active_thermostat_schedule: {
8230
8791
  default: null,
8231
- 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.',
8792
+ description: 'Active [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules).',
8232
8793
  nullable: true,
8233
8794
  properties: {
8234
8795
  climate_preset_key: {
@@ -8312,9 +8873,11 @@ export default {
8312
8873
  'errors',
8313
8874
  ],
8314
8875
  type: 'object',
8876
+ 'x-property-group-key': 'thermostats',
8315
8877
  'x-route-path': '/thermostats/schedules',
8316
8878
  },
8317
8879
  available_climate_presets: {
8880
+ description: 'Available [climate presets](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for the thermostat.',
8318
8881
  items: {
8319
8882
  properties: {
8320
8883
  can_delete: {
@@ -8391,22 +8954,28 @@ export default {
8391
8954
  type: 'object',
8392
8955
  },
8393
8956
  type: 'array',
8957
+ 'x-property-group-key': 'thermostats',
8394
8958
  },
8395
8959
  available_fan_mode_settings: {
8960
+ description: 'Fan mode settings that the thermostat supports.',
8396
8961
  items: {
8397
8962
  enum: ['auto', 'on', 'circulate'],
8398
8963
  type: 'string',
8399
8964
  },
8400
8965
  type: 'array',
8966
+ 'x-property-group-key': 'thermostats',
8401
8967
  },
8402
8968
  available_hvac_mode_settings: {
8969
+ description: 'HVAC mode settings that the thermostat supports.',
8403
8970
  items: {
8404
8971
  enum: ['off', 'heat', 'cool', 'heat_cool'],
8405
8972
  type: 'string',
8406
8973
  },
8407
8974
  type: 'array',
8975
+ 'x-property-group-key': 'thermostats',
8408
8976
  },
8409
8977
  current_climate_setting: {
8978
+ description: 'Current climate setting.',
8410
8979
  properties: {
8411
8980
  can_delete: {
8412
8981
  description: 'Indicates whether the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) key can be deleted.',
@@ -8472,6 +9041,7 @@ export default {
8472
9041
  },
8473
9042
  },
8474
9043
  type: 'object',
9044
+ 'x-property-group-key': 'thermostats',
8475
9045
  },
8476
9046
  default_climate_setting: {
8477
9047
  deprecated: true,
@@ -8541,92 +9111,146 @@ export default {
8541
9111
  },
8542
9112
  type: 'object',
8543
9113
  'x-deprecated': 'use fallback_climate_preset_key to specify a fallback climate preset instead.',
9114
+ 'x-property-group-key': 'thermostats',
8544
9115
  },
8545
9116
  fallback_climate_preset_key: {
8546
9117
  default: null,
9118
+ description: 'Key of the [fallback climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets/setting-the-fallback-climate-preset) for the thermostat.',
8547
9119
  minLength: 1,
8548
9120
  nullable: true,
8549
9121
  type: 'string',
9122
+ 'x-property-group-key': 'thermostats',
8550
9123
  },
8551
9124
  fan_mode_setting: {
8552
9125
  deprecated: true,
8553
9126
  enum: ['auto', 'on', 'circulate'],
8554
9127
  type: 'string',
8555
- 'x-deprecated': 'use current_climate_setting.fan_mode_setting instead.',
9128
+ 'x-deprecated': 'Use `current_climate_setting.fan_mode_setting` instead.',
9129
+ 'x-property-group-key': 'thermostats',
9130
+ },
9131
+ is_cooling: {
9132
+ description: 'Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.',
9133
+ type: 'boolean',
9134
+ 'x-property-group-key': 'thermostats',
9135
+ },
9136
+ is_fan_running: {
9137
+ description: 'Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.',
9138
+ type: 'boolean',
9139
+ 'x-property-group-key': 'thermostats',
9140
+ },
9141
+ is_heating: {
9142
+ description: 'Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.',
9143
+ type: 'boolean',
9144
+ 'x-property-group-key': 'thermostats',
9145
+ },
9146
+ is_temporary_manual_override_active: {
9147
+ description: 'Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, `current_climate_setting.manual_override_allowed` must also be `true`.',
9148
+ type: 'boolean',
9149
+ 'x-property-group-key': 'thermostats',
8556
9150
  },
8557
- is_cooling: { type: 'boolean' },
8558
- is_fan_running: { type: 'boolean' },
8559
- is_heating: { type: 'boolean' },
8560
- is_temporary_manual_override_active: { type: 'boolean' },
8561
9151
  max_cooling_set_point_celsius: {
9152
+ description: 'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.',
8562
9153
  format: 'float',
8563
9154
  type: 'number',
9155
+ 'x-property-group-key': 'thermostats',
8564
9156
  },
8565
9157
  max_cooling_set_point_fahrenheit: {
9158
+ description: 'Maximum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.',
8566
9159
  format: 'float',
8567
9160
  type: 'number',
9161
+ 'x-property-group-key': 'thermostats',
8568
9162
  },
8569
9163
  max_heating_set_point_celsius: {
9164
+ description: 'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.',
8570
9165
  format: 'float',
8571
9166
  type: 'number',
9167
+ 'x-property-group-key': 'thermostats',
8572
9168
  },
8573
9169
  max_heating_set_point_fahrenheit: {
9170
+ description: 'Maximum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.',
8574
9171
  format: 'float',
8575
9172
  type: 'number',
9173
+ 'x-property-group-key': 'thermostats',
8576
9174
  },
8577
9175
  min_cooling_set_point_celsius: {
9176
+ description: 'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °C.',
8578
9177
  format: 'float',
8579
9178
  type: 'number',
9179
+ 'x-property-group-key': 'thermostats',
8580
9180
  },
8581
9181
  min_cooling_set_point_fahrenheit: {
9182
+ description: 'Minimum [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#cooling-set-point) in °F.',
8582
9183
  format: 'float',
8583
9184
  type: 'number',
9185
+ 'x-property-group-key': 'thermostats',
8584
9186
  },
8585
9187
  min_heating_cooling_delta_celsius: {
9188
+ description: 'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °C between the cooling and heating set points when in heat-cool (auto) mode.',
8586
9189
  format: 'float',
8587
9190
  type: 'number',
9191
+ 'x-property-group-key': 'thermostats',
8588
9192
  },
8589
9193
  min_heating_cooling_delta_fahrenheit: {
9194
+ description: 'Minimum [temperature difference](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#minimum-heating-cooling-temperature-delta) in °F between the cooling and heating set points when in heat-cool (auto) mode.',
8590
9195
  format: 'float',
8591
9196
  type: 'number',
9197
+ 'x-property-group-key': 'thermostats',
8592
9198
  },
8593
9199
  min_heating_set_point_celsius: {
9200
+ description: 'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °C.',
8594
9201
  format: 'float',
8595
9202
  type: 'number',
9203
+ 'x-property-group-key': 'thermostats',
8596
9204
  },
8597
9205
  min_heating_set_point_fahrenheit: {
9206
+ description: 'Minimum [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points#heating-set-point) in °F.',
8598
9207
  format: 'float',
8599
9208
  type: 'number',
9209
+ 'x-property-group-key': 'thermostats',
8600
9210
  },
8601
9211
  relative_humidity: {
9212
+ description: 'Reported relative humidity, as a value between 0 and 1, inclusive.',
8602
9213
  format: 'float',
8603
9214
  maximum: 1,
8604
9215
  minimum: 0,
8605
9216
  type: 'number',
9217
+ 'x-property-group-key': 'thermostats',
9218
+ },
9219
+ temperature_celsius: {
9220
+ description: 'Reported temperature in °C.',
9221
+ format: 'float',
9222
+ type: 'number',
9223
+ 'x-property-group-key': 'thermostats',
8606
9224
  },
8607
- temperature_celsius: { format: 'float', type: 'number' },
8608
9225
  temperature_fahrenheit: {
9226
+ description: 'Reported temperature in °F.',
8609
9227
  format: 'float',
8610
9228
  type: 'number',
9229
+ 'x-property-group-key': 'thermostats',
8611
9230
  },
8612
9231
  temperature_threshold: {
9232
+ description: 'Current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.',
8613
9233
  properties: {
8614
9234
  lower_limit_celsius: {
9235
+ description: 'Lower limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
8615
9236
  format: 'float',
8616
9237
  nullable: true,
8617
9238
  type: 'number',
8618
9239
  },
8619
9240
  lower_limit_fahrenheit: {
9241
+ description: 'Lower limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
8620
9242
  format: 'float',
8621
9243
  nullable: true,
8622
9244
  type: 'number',
8623
9245
  },
8624
9246
  upper_limit_celsius: {
9247
+ description: 'Upper limit in °C within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
8625
9248
  format: 'float',
8626
9249
  nullable: true,
8627
9250
  type: 'number',
8628
9251
  },
8629
9252
  upper_limit_fahrenheit: {
9253
+ description: 'Upper limit in °F within the current [temperature threshold](https://docs.seam.co/latest/capability-guides/thermostats/setting-and-monitoring-temperature-thresholds) set for the thermostat.\n ',
8630
9254
  format: 'float',
8631
9255
  nullable: true,
8632
9256
  type: 'number',
@@ -8639,8 +9263,10 @@ export default {
8639
9263
  'upper_limit_fahrenheit',
8640
9264
  ],
8641
9265
  type: 'object',
9266
+ 'x-property-group-key': 'thermostats',
8642
9267
  },
8643
9268
  thermostat_daily_programs: {
9269
+ description: 'Configured [daily programs](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.',
8644
9270
  items: {
8645
9271
  description: 'Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time.',
8646
9272
  properties: {
@@ -8705,8 +9331,10 @@ export default {
8705
9331
  'x-route-path': '/thermostats/thermostat_daily_programs',
8706
9332
  },
8707
9333
  type: 'array',
9334
+ 'x-property-group-key': 'thermostats',
8708
9335
  },
8709
9336
  thermostat_weekly_program: {
9337
+ description: 'Current [weekly program](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-programs) for the thermostat.',
8710
9338
  nullable: true,
8711
9339
  properties: {
8712
9340
  created_at: {
@@ -8768,6 +9396,7 @@ export default {
8768
9396
  'created_at',
8769
9397
  ],
8770
9398
  type: 'object',
9399
+ 'x-property-group-key': 'thermostats',
8771
9400
  },
8772
9401
  },
8773
9402
  type: 'object',
@@ -8776,6 +9405,15 @@ export default {
8776
9405
  },
8777
9406
  ],
8778
9407
  description: 'Properties of the device.',
9408
+ 'x-property-groups': {
9409
+ access_codes: { name: 'Access Codes' },
9410
+ hardware: { name: 'Hardware' },
9411
+ locks: { name: 'Locks' },
9412
+ noise_sensors: { name: 'Noise Sensors' },
9413
+ phones: { name: 'Phones' },
9414
+ provider_metadata: { name: 'Provider Metadata' },
9415
+ thermostats: { name: 'Thermostats' },
9416
+ },
8779
9417
  },
8780
9418
  warnings: {
8781
9419
  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.',
@@ -9046,6 +9684,15 @@ export default {
9046
9684
  'custom_metadata',
9047
9685
  ],
9048
9686
  type: 'object',
9687
+ 'x-property-groups': {
9688
+ access_codes: { name: 'Access Codes' },
9689
+ hardware: { name: 'Hardware' },
9690
+ locks: { name: 'Locks' },
9691
+ noise_sensors: { name: 'Noise Sensors' },
9692
+ phones: { name: 'Phones' },
9693
+ provider_metadata: { name: 'Provider Metadata' },
9694
+ thermostats: { name: 'Thermostats' },
9695
+ },
9049
9696
  'x-route-path': '/devices',
9050
9697
  },
9051
9698
  device_provider: {
@@ -13897,7 +14544,7 @@ export default {
13897
14544
  description: "Represents an app user's mobile phone.",
13898
14545
  properties: {
13899
14546
  created_at: {
13900
- description: 'Date and time at which the `phone` was created.',
14547
+ description: 'Date and time at which the phone was created.\n ',
13901
14548
  format: 'date-time',
13902
14549
  type: 'string',
13903
14550
  },
@@ -13905,25 +14552,25 @@ export default {
13905
14552
  additionalProperties: {
13906
14553
  oneOf: [{ type: 'string' }, { type: 'boolean' }],
13907
14554
  },
13908
- description: 'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.',
14555
+ description: 'Optional [custom metadata](https://docs.seam.co/latest/core-concepts/devices/adding-custom-metadata-to-a-device) for the phone.\n ',
13909
14556
  type: 'object',
13910
14557
  },
13911
14558
  device_id: {
13912
- description: 'ID of the `phone`.',
14559
+ description: 'ID of the phone.\n ',
13913
14560
  format: 'uuid',
13914
14561
  type: 'string',
13915
14562
  },
13916
14563
  device_type: {
13917
- description: 'Type of phone.',
14564
+ description: 'Device type for phones.\n ',
13918
14565
  enum: ['ios_phone', 'android_phone'],
13919
14566
  type: 'string',
13920
14567
  },
13921
14568
  display_name: {
13922
- description: 'Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.',
14569
+ description: 'Display name of the phone. Defaults to `nickname` (if it is set) or `properties.appearance.name` otherwise. Enables administrators and users to identify the phone easily, especially when there are numerous phones.\n ',
13923
14570
  type: 'string',
13924
14571
  },
13925
14572
  errors: {
13926
- description: 'Errors associated with the `phone`.',
14573
+ description: 'Errors associated with the phone.',
13927
14574
  items: {
13928
14575
  properties: {
13929
14576
  error_code: { type: 'string' },
@@ -13935,11 +14582,11 @@ export default {
13935
14582
  type: 'array',
13936
14583
  },
13937
14584
  nickname: {
13938
- description: 'Optional nickname to describe the phone, settable through Seam.',
14585
+ description: 'Optional nickname to describe the phone, settable through Seam.\n ',
13939
14586
  type: 'string',
13940
14587
  },
13941
14588
  properties: {
13942
- description: 'Properties of the phone.',
14589
+ description: '\n Properties of the phone.\n ',
13943
14590
  properties: {
13944
14591
  assa_abloy_credential_service_metadata: {
13945
14592
  description: 'ASSA ABLOY Credential Service metadata for the phone.',
@@ -13985,7 +14632,7 @@ export default {
13985
14632
  type: 'object',
13986
14633
  },
13987
14634
  warnings: {
13988
- description: 'Warnings associated with the `phone`.',
14635
+ description: 'Warnings associated with the phone.',
13989
14636
  items: {
13990
14637
  properties: {
13991
14638
  message: { type: 'string' },
@@ -13997,7 +14644,7 @@ export default {
13997
14644
  type: 'array',
13998
14645
  },
13999
14646
  workspace_id: {
14000
- description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `phone`.',
14647
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the phone.\n ',
14001
14648
  format: 'uuid',
14002
14649
  type: 'string',
14003
14650
  },
@@ -14014,6 +14661,7 @@ export default {
14014
14661
  'properties',
14015
14662
  ],
14016
14663
  type: 'object',
14664
+ 'x-property-groups': { phones: { name: 'Phones' } },
14017
14665
  'x-route-path': '/phones',
14018
14666
  },
14019
14667
  phone_registration: {
@@ -17011,8 +17659,9 @@ export default {
17011
17659
  can_simulate_removal: { type: 'boolean' },
17012
17660
  can_turn_off_hvac: { type: 'boolean' },
17013
17661
  capabilities_supported: {
17014
- description: 'Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health.',
17662
+ description: '\n Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
17015
17663
  items: {
17664
+ description: '\n Collection of capabilities that the device supports when connected to Seam. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).\n ',
17016
17665
  enum: [
17017
17666
  'access_code',
17018
17667
  'lock',
@@ -17044,6 +17693,7 @@ export default {
17044
17693
  description: 'Type of the device.',
17045
17694
  oneOf: [
17046
17695
  {
17696
+ description: 'Device type for smartlocks.\n ',
17047
17697
  enum: [
17048
17698
  'akuvox_lock',
17049
17699
  'august_lock',
@@ -17076,10 +17726,12 @@ export default {
17076
17726
  type: 'string',
17077
17727
  },
17078
17728
  {
17729
+ description: 'Device type for noise sensors.\n ',
17079
17730
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
17080
17731
  type: 'string',
17081
17732
  },
17082
17733
  {
17734
+ description: 'Device type for thermostats.\n ',
17083
17735
  enum: [
17084
17736
  'ecobee_thermostat',
17085
17737
  'nest_thermostat',
@@ -17091,7 +17743,7 @@ export default {
17091
17743
  type: 'string',
17092
17744
  },
17093
17745
  {
17094
- description: 'Type of phone.',
17746
+ description: 'Device type for phones.\n ',
17095
17747
  enum: ['ios_phone', 'android_phone'],
17096
17748
  type: 'string',
17097
17749
  },
@@ -17440,23 +18092,25 @@ export default {
17440
18092
  nullable: true,
17441
18093
  properties: {
17442
18094
  location_name: {
17443
- description: 'Name of the device location.',
18095
+ description: 'Name of the device location.\n ',
17444
18096
  type: 'string',
17445
18097
  },
17446
18098
  timezone: {
17447
- description: 'Time zone of the device location.',
18099
+ description: 'Time zone of the device location.\n ',
17448
18100
  type: 'string',
17449
18101
  },
17450
18102
  },
17451
18103
  type: 'object',
18104
+ 'x-property-group-key': 'hardware',
17452
18105
  },
17453
18106
  properties: {
18107
+ description: 'properties of the device.',
17454
18108
  properties: {
17455
18109
  accessory_keypad: {
17456
- description: 'Represents the accessory keypad state.',
18110
+ description: 'Accessory keypad properties and state.',
17457
18111
  properties: {
17458
18112
  battery: {
17459
- description: 'Indicates if the keypad battery properties.',
18113
+ description: 'Keypad battery properties.\n ',
17460
18114
  properties: {
17461
18115
  level: {
17462
18116
  format: 'float',
@@ -17469,29 +18123,33 @@ export default {
17469
18123
  type: 'object',
17470
18124
  },
17471
18125
  is_connected: {
17472
- description: 'Indicates if the accessory_keypad is connected to the device.',
18126
+ description: 'Indicates if an accessory keypad is connected to the device.\n ',
17473
18127
  type: 'boolean',
17474
18128
  },
17475
18129
  },
17476
18130
  required: ['is_connected'],
17477
18131
  type: 'object',
18132
+ 'x-property-group-key': 'hardware',
17478
18133
  },
17479
18134
  battery: {
17480
- description: 'Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage.',
18135
+ description: 'Represents the current status of the battery charge level.',
17481
18136
  properties: {
17482
18137
  level: {
18138
+ description: 'Battery charge level as a value between 0 and 1, inclusive.\n ',
17483
18139
  format: 'float',
17484
18140
  maximum: 1,
17485
18141
  minimum: 0,
17486
18142
  type: 'number',
17487
18143
  },
17488
18144
  status: {
18145
+ description: 'Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.\n ',
17489
18146
  enum: ['critical', 'low', 'good', 'full'],
17490
18147
  type: 'string',
17491
18148
  },
17492
18149
  },
17493
18150
  required: ['level', 'status'],
17494
18151
  type: 'object',
18152
+ 'x-property-group-key': 'hardware',
17495
18153
  },
17496
18154
  battery_level: {
17497
18155
  description: 'Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.',
@@ -17499,21 +18157,26 @@ export default {
17499
18157
  maximum: 1,
17500
18158
  minimum: 0,
17501
18159
  type: 'number',
18160
+ 'x-property-group-key': 'hardware',
17502
18161
  },
17503
18162
  image_alt_text: {
17504
18163
  description: 'Alt text for the device image.',
17505
18164
  type: 'string',
18165
+ 'x-property-group-key': 'hardware',
17506
18166
  },
17507
18167
  image_url: {
17508
18168
  description: 'Image URL for the device.',
17509
18169
  format: 'uri',
17510
18170
  type: 'string',
18171
+ 'x-property-group-key': 'hardware',
17511
18172
  },
17512
18173
  manufacturer: {
17513
18174
  description: 'Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.',
17514
18175
  type: 'string',
18176
+ 'x-property-group-key': 'hardware',
17515
18177
  },
17516
18178
  model: {
18179
+ description: 'Device model-related properties.',
17517
18180
  properties: {
17518
18181
  accessory_keypad_supported: {
17519
18182
  deprecated: true,
@@ -17521,28 +18184,30 @@ export default {
17521
18184
  'x-deprecated': 'use device.properties.model.can_connect_accessory_keypad',
17522
18185
  },
17523
18186
  can_connect_accessory_keypad: {
17524
- description: 'Indicates whether the device can connect a accessory keypad.',
18187
+ description: '\n Indicates whether the device can connect a accessory keypad.\n ',
17525
18188
  type: 'boolean',
17526
18189
  },
17527
18190
  display_name: {
17528
- description: 'Display name of the device model.',
18191
+ description: '\n Display name of the device model.\n ',
17529
18192
  type: 'string',
17530
18193
  },
17531
18194
  has_built_in_keypad: {
17532
- description: 'Indicates whether the device has a built in accessory keypad.',
18195
+ description: '\n Indicates whether the device has a built in accessory keypad.\n ',
17533
18196
  type: 'boolean',
17534
18197
  },
17535
18198
  manufacturer_display_name: {
17536
- description: 'Display name that corresponds to the manufacturer-specific terminology for the device.',
18199
+ description: '\n Display name that corresponds to the manufacturer-specific terminology for the device.\n ',
17537
18200
  type: 'string',
17538
18201
  },
17539
18202
  offline_access_codes_supported: {
17540
- description: 'Indicates whether the device supports offline access codes.',
18203
+ deprecated: true,
17541
18204
  type: 'boolean',
18205
+ 'x-deprecated': 'use device.can_program_offline_access_codes.',
17542
18206
  },
17543
18207
  online_access_codes_supported: {
17544
- description: 'Indicates whether the device supports online access codes.',
18208
+ deprecated: true,
17545
18209
  type: 'boolean',
18210
+ 'x-deprecated': 'use device.can_program_online_access_codes.',
17546
18211
  },
17547
18212
  },
17548
18213
  required: ['display_name', 'manufacturer_display_name'],
@@ -17557,6 +18222,7 @@ export default {
17557
18222
  offline_access_codes_enabled: {
17558
18223
  description: 'Indicates whether it is currently possible to use offline access codes for the device.',
17559
18224
  type: 'boolean',
18225
+ 'x-property-group-key': 'access_codes',
17560
18226
  },
17561
18227
  online: {
17562
18228
  description: 'Indicates whether the device is online.',
@@ -17565,10 +18231,20 @@ export default {
17565
18231
  online_access_codes_enabled: {
17566
18232
  description: 'Indicates whether it is currently possible to use online access codes for the device.',
17567
18233
  type: 'boolean',
18234
+ 'x-property-group-key': 'access_codes',
17568
18235
  },
17569
18236
  },
17570
18237
  required: ['name', 'online', 'model'],
17571
18238
  type: 'object',
18239
+ 'x-property-groups': {
18240
+ access_codes: { name: 'access codes' },
18241
+ hardware: { name: 'hardware' },
18242
+ locks: { name: 'locks' },
18243
+ noise_sensors: { name: 'noise sensors' },
18244
+ phones: { name: 'phones' },
18245
+ provider_metadata: { name: 'provider metadata' },
18246
+ thermostats: { name: 'thermostats' },
18247
+ },
17572
18248
  },
17573
18249
  warnings: {
17574
18250
  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.',
@@ -17837,6 +18513,15 @@ export default {
17837
18513
  'properties',
17838
18514
  ],
17839
18515
  type: 'object',
18516
+ 'x-property-groups': {
18517
+ access_codes: { name: 'Access Codes' },
18518
+ hardware: { name: 'Hardware' },
18519
+ locks: { name: 'Locks' },
18520
+ noise_sensors: { name: 'Noise Sensors' },
18521
+ phones: { name: 'Phones' },
18522
+ provider_metadata: { name: 'Provider Metadata' },
18523
+ thermostats: { name: 'Thermostats' },
18524
+ },
17840
18525
  'x-route-path': '/devices/unmanaged',
17841
18526
  },
17842
18527
  user_identity: {
@@ -17979,6 +18664,11 @@ export default {
17979
18664
  scheme: 'bearer',
17980
18665
  type: 'http',
17981
18666
  },
18667
+ customer_client_session: {
18668
+ bearerFormat: 'Customer Client Session Token',
18669
+ scheme: 'bearer',
18670
+ type: 'http',
18671
+ },
17982
18672
  pat_with_workspace: {
17983
18673
  bearerFormat: 'API Token',
17984
18674
  scheme: 'bearer',
@@ -23936,6 +24626,8 @@ export default {
23936
24626
  items: { type: 'string' },
23937
24627
  type: 'array',
23938
24628
  },
24629
+ customer_id: { type: 'string' },
24630
+ customer_key: { type: 'string' },
23939
24631
  expires_at: {
23940
24632
  description: 'Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
23941
24633
  format: 'date-time',
@@ -24010,6 +24702,8 @@ export default {
24010
24702
  items: { type: 'string' },
24011
24703
  type: 'array',
24012
24704
  },
24705
+ customer_id: { type: 'string' },
24706
+ customer_key: { type: 'string' },
24013
24707
  expires_at: {
24014
24708
  description: 'Date and time at which the client session should expire, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format.',
24015
24709
  format: 'date-time',
@@ -24604,6 +25298,7 @@ export default {
24604
25298
  description: 'URL that you want to redirect the user to after the provider login is complete.',
24605
25299
  type: 'string',
24606
25300
  },
25301
+ customer_id: { format: 'uuid', type: 'string' },
24607
25302
  device_selection_mode: {
24608
25303
  enum: ['none', 'single', 'multiple'],
24609
25304
  type: 'string',
@@ -24655,6 +25350,7 @@ export default {
24655
25350
  },
24656
25351
  security: [
24657
25352
  { client_session: [] },
25353
+ { customer_client_session: [] },
24658
25354
  { pat_with_workspace: [] },
24659
25355
  { console_session_with_workspace: [] },
24660
25356
  { api_key: [] },
@@ -24791,6 +25487,7 @@ export default {
24791
25487
  description: 'Custom metadata pairs by which you want to [filter Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Returns Connect Webviews with `custom_metadata` that contains all of the provided key:value pairs.',
24792
25488
  type: 'object',
24793
25489
  },
25490
+ customer_id: { type: 'string' },
24794
25491
  limit: {
24795
25492
  default: 500,
24796
25493
  description: 'Maximum number of records to return per page.',
@@ -24831,6 +25528,7 @@ export default {
24831
25528
  },
24832
25529
  security: [
24833
25530
  { client_session: [] },
25531
+ { customer_client_session: [] },
24834
25532
  { pat_with_workspace: [] },
24835
25533
  { console_session_with_workspace: [] },
24836
25534
  { api_key: [] },
@@ -25329,6 +26027,7 @@ export default {
25329
26027
  description: 'Device type for which you want to list devices.',
25330
26028
  oneOf: [
25331
26029
  {
26030
+ description: 'Device type for smartlocks.\n ',
25332
26031
  enum: [
25333
26032
  'akuvox_lock',
25334
26033
  'august_lock',
@@ -25361,10 +26060,12 @@ export default {
25361
26060
  type: 'string',
25362
26061
  },
25363
26062
  {
26063
+ description: 'Device type for noise sensors.\n ',
25364
26064
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
25365
26065
  type: 'string',
25366
26066
  },
25367
26067
  {
26068
+ description: 'Device type for thermostats.\n ',
25368
26069
  enum: [
25369
26070
  'ecobee_thermostat',
25370
26071
  'nest_thermostat',
@@ -25376,7 +26077,7 @@ export default {
25376
26077
  type: 'string',
25377
26078
  },
25378
26079
  {
25379
- description: 'Type of phone.',
26080
+ description: 'Device type for phones.\n ',
25380
26081
  enum: ['ios_phone', 'android_phone'],
25381
26082
  type: 'string',
25382
26083
  },
@@ -25387,6 +26088,7 @@ export default {
25387
26088
  items: {
25388
26089
  oneOf: [
25389
26090
  {
26091
+ description: 'Device type for smartlocks.\n ',
25390
26092
  enum: [
25391
26093
  'akuvox_lock',
25392
26094
  'august_lock',
@@ -25419,10 +26121,12 @@ export default {
25419
26121
  type: 'string',
25420
26122
  },
25421
26123
  {
26124
+ description: 'Device type for noise sensors.\n ',
25422
26125
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
25423
26126
  type: 'string',
25424
26127
  },
25425
26128
  {
26129
+ description: 'Device type for thermostats.\n ',
25426
26130
  enum: [
25427
26131
  'ecobee_thermostat',
25428
26132
  'nest_thermostat',
@@ -25434,7 +26138,7 @@ export default {
25434
26138
  type: 'string',
25435
26139
  },
25436
26140
  {
25437
- description: 'Type of phone.',
26141
+ description: 'Device type for phones.\n ',
25438
26142
  enum: ['ios_phone', 'android_phone'],
25439
26143
  type: 'string',
25440
26144
  },
@@ -25913,6 +26617,7 @@ export default {
25913
26617
  description: 'Device type for which you want to list devices.',
25914
26618
  oneOf: [
25915
26619
  {
26620
+ description: 'Device type for smartlocks.\n ',
25916
26621
  enum: [
25917
26622
  'akuvox_lock',
25918
26623
  'august_lock',
@@ -25945,10 +26650,12 @@ export default {
25945
26650
  type: 'string',
25946
26651
  },
25947
26652
  {
26653
+ description: 'Device type for noise sensors.\n ',
25948
26654
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
25949
26655
  type: 'string',
25950
26656
  },
25951
26657
  {
26658
+ description: 'Device type for thermostats.\n ',
25952
26659
  enum: [
25953
26660
  'ecobee_thermostat',
25954
26661
  'nest_thermostat',
@@ -25960,7 +26667,7 @@ export default {
25960
26667
  type: 'string',
25961
26668
  },
25962
26669
  {
25963
- description: 'Type of phone.',
26670
+ description: 'Device type for phones.\n ',
25964
26671
  enum: ['ios_phone', 'android_phone'],
25965
26672
  type: 'string',
25966
26673
  },
@@ -25971,6 +26678,7 @@ export default {
25971
26678
  items: {
25972
26679
  oneOf: [
25973
26680
  {
26681
+ description: 'Device type for smartlocks.\n ',
25974
26682
  enum: [
25975
26683
  'akuvox_lock',
25976
26684
  'august_lock',
@@ -26003,10 +26711,12 @@ export default {
26003
26711
  type: 'string',
26004
26712
  },
26005
26713
  {
26714
+ description: 'Device type for noise sensors.\n ',
26006
26715
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
26007
26716
  type: 'string',
26008
26717
  },
26009
26718
  {
26719
+ description: 'Device type for thermostats.\n ',
26010
26720
  enum: [
26011
26721
  'ecobee_thermostat',
26012
26722
  'nest_thermostat',
@@ -26018,7 +26728,7 @@ export default {
26018
26728
  type: 'string',
26019
26729
  },
26020
26730
  {
26021
- description: 'Type of phone.',
26731
+ description: 'Device type for phones.\n ',
26022
26732
  enum: ['ios_phone', 'android_phone'],
26023
26733
  type: 'string',
26024
26734
  },
@@ -26907,6 +27617,7 @@ export default {
26907
27617
  device_types: {
26908
27618
  description: 'Array of device types by which to filter devices.',
26909
27619
  items: {
27620
+ description: 'Device type for smartlocks.\n ',
26910
27621
  enum: [
26911
27622
  'akuvox_lock',
26912
27623
  'august_lock',
@@ -27432,6 +28143,7 @@ export default {
27432
28143
  device_types: {
27433
28144
  description: 'Array of device types by which to filter devices.',
27434
28145
  items: {
28146
+ description: 'Device type for noise sensors.\n ',
27435
28147
  enum: ['noiseaware_activity_zone', 'minut_sensor'],
27436
28148
  type: 'string',
27437
28149
  },
@@ -29479,6 +30191,85 @@ export default {
29479
30191
  'x-undocumented': 'Mobile SDK only.',
29480
30192
  },
29481
30193
  },
30194
+ '/seam/partner/v1/resources/list': {
30195
+ post: {
30196
+ description: 'List partner resources that have been pushed to Seam.',
30197
+ operationId: 'seamPartnerV1ResourcesListPost',
30198
+ requestBody: {
30199
+ content: {
30200
+ 'application/json': {
30201
+ schema: {
30202
+ properties: {
30203
+ resource_type_alias: {
30204
+ description: 'Filter by resource type alias.',
30205
+ type: 'string',
30206
+ },
30207
+ },
30208
+ type: 'object',
30209
+ },
30210
+ },
30211
+ },
30212
+ },
30213
+ responses: {
30214
+ 200: {
30215
+ content: {
30216
+ 'application/json': {
30217
+ schema: {
30218
+ properties: {
30219
+ ok: { type: 'boolean' },
30220
+ partner_resources: {
30221
+ items: {
30222
+ properties: {
30223
+ custom_metadata: {
30224
+ additionalProperties: { type: 'string' },
30225
+ type: 'object',
30226
+ },
30227
+ customer_key: { type: 'string' },
30228
+ description: { type: 'string' },
30229
+ email_address: { type: 'string' },
30230
+ ends_at: { type: 'string' },
30231
+ location_keys: {
30232
+ items: { type: 'string' },
30233
+ type: 'array',
30234
+ },
30235
+ name: { type: 'string' },
30236
+ partner_resource_key: { type: 'string' },
30237
+ partner_resource_type: { type: 'string' },
30238
+ phone_number: { type: 'string' },
30239
+ starts_at: { type: 'string' },
30240
+ user_identity_key: { type: 'string' },
30241
+ },
30242
+ required: [
30243
+ 'partner_resource_type',
30244
+ 'partner_resource_key',
30245
+ 'customer_key',
30246
+ ],
30247
+ type: 'object',
30248
+ },
30249
+ type: 'array',
30250
+ },
30251
+ },
30252
+ required: ['partner_resources', 'ok'],
30253
+ type: 'object',
30254
+ },
30255
+ },
30256
+ },
30257
+ description: 'OK',
30258
+ },
30259
+ 400: { description: 'Bad Request' },
30260
+ 401: { description: 'Unauthorized' },
30261
+ },
30262
+ security: [{ customer_client_session: [] }],
30263
+ summary: '/seam/partner/v1/resources/list',
30264
+ tags: [],
30265
+ 'x-fern-sdk-group-name': ['seam', 'partner', 'v1', 'resources'],
30266
+ 'x-fern-sdk-method-name': 'list',
30267
+ 'x-fern-sdk-return-value': 'partner_resources',
30268
+ 'x-response-key': 'partner_resources',
30269
+ 'x-title': 'List partner resources at Seam',
30270
+ 'x-undocumented': 'Partner building blocks/UI only.',
30271
+ },
30272
+ },
29482
30273
  '/thermostats/activate_climate_preset': {
29483
30274
  post: {
29484
30275
  description: 'Activates a specified [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) for a specified [thermostat](https://docs.seam.co/latest/capability-guides/thermostats).',
@@ -30391,6 +31182,7 @@ export default {
30391
31182
  device_types: {
30392
31183
  description: 'Array of device types by which to filter thermostat devices.',
30393
31184
  items: {
31185
+ description: 'Device type for thermostats.\n ',
30394
31186
  enum: [
30395
31187
  'ecobee_thermostat',
30396
31188
  'nest_thermostat',
@@ -33715,6 +34507,190 @@ export default {
33715
34507
  'x-undocumented': 'Experimental locations.',
33716
34508
  },
33717
34509
  },
34510
+ '/unstable_partner/building_blocks/generate_link': {
34511
+ post: {
34512
+ description: 'Creates a new bridge client session.',
34513
+ operationId: 'unstablePartnerBuildingBlocksGenerateLinkPost',
34514
+ requestBody: {
34515
+ content: {
34516
+ 'application/json': {
34517
+ schema: {
34518
+ properties: {
34519
+ bridge_client_machine_identifier_key: { type: 'string' },
34520
+ bridge_client_name: { type: 'string' },
34521
+ bridge_client_time_zone: { type: 'string' },
34522
+ },
34523
+ required: [
34524
+ 'bridge_client_name',
34525
+ 'bridge_client_time_zone',
34526
+ 'bridge_client_machine_identifier_key',
34527
+ ],
34528
+ type: 'object',
34529
+ },
34530
+ },
34531
+ },
34532
+ },
34533
+ responses: {
34534
+ 200: {
34535
+ content: {
34536
+ 'application/json': {
34537
+ schema: {
34538
+ properties: {
34539
+ bridge_client_session: {
34540
+ properties: {
34541
+ bridge_client_machine_identifier_key: {
34542
+ type: 'string',
34543
+ },
34544
+ bridge_client_name: { type: 'string' },
34545
+ bridge_client_session_id: {
34546
+ format: 'uuid',
34547
+ type: 'string',
34548
+ },
34549
+ bridge_client_session_token: { type: 'string' },
34550
+ bridge_client_time_zone: { type: 'string' },
34551
+ created_at: { format: 'date-time', type: 'string' },
34552
+ errors: {
34553
+ items: {
34554
+ description: 'Error associated with the `bridge_client_session`.',
34555
+ discriminator: { propertyName: 'error_code' },
34556
+ oneOf: [
34557
+ {
34558
+ description: "Seam cannot reach the bridge's LAN",
34559
+ properties: {
34560
+ can_tailscale_proxy_reach_bridge: {
34561
+ description: 'Tailscale proxy cannot reach the bridge',
34562
+ nullable: true,
34563
+ type: 'boolean',
34564
+ },
34565
+ can_tailscale_proxy_reach_tailscale_network: {
34566
+ description: 'Tailscale proxy cannot reach the Tailscale network',
34567
+ nullable: true,
34568
+ type: 'boolean',
34569
+ },
34570
+ created_at: {
34571
+ format: 'date-time',
34572
+ type: 'string',
34573
+ },
34574
+ error_code: {
34575
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
34576
+ enum: ['bridge_lan_unreachable'],
34577
+ type: 'string',
34578
+ },
34579
+ is_bridge_socks_server_healthy: {
34580
+ description: "Bridge's SOCKS server is unhealthy",
34581
+ nullable: true,
34582
+ type: 'boolean',
34583
+ },
34584
+ is_tailscale_proxy_reachable: {
34585
+ description: 'Seam cannot reach the tailscale proxy',
34586
+ nullable: true,
34587
+ type: 'boolean',
34588
+ },
34589
+ is_tailscale_proxy_socks_server_healthy: {
34590
+ description: "Tailscale proxy's SOCKS server is unhealthy",
34591
+ nullable: true,
34592
+ type: 'boolean',
34593
+ },
34594
+ message: { type: 'string' },
34595
+ },
34596
+ required: [
34597
+ 'message',
34598
+ 'created_at',
34599
+ 'error_code',
34600
+ 'is_tailscale_proxy_reachable',
34601
+ 'is_tailscale_proxy_socks_server_healthy',
34602
+ 'can_tailscale_proxy_reach_tailscale_network',
34603
+ 'can_tailscale_proxy_reach_bridge',
34604
+ 'is_bridge_socks_server_healthy',
34605
+ ],
34606
+ type: 'object',
34607
+ },
34608
+ {
34609
+ description: 'Bridge has stopped communicating with Seam',
34610
+ properties: {
34611
+ created_at: {
34612
+ format: 'date-time',
34613
+ type: 'string',
34614
+ },
34615
+ error_code: {
34616
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
34617
+ enum: ['no_communication_from_bridge'],
34618
+ type: 'string',
34619
+ },
34620
+ message: { type: 'string' },
34621
+ },
34622
+ required: [
34623
+ 'message',
34624
+ 'created_at',
34625
+ 'error_code',
34626
+ ],
34627
+ type: 'object',
34628
+ },
34629
+ ],
34630
+ },
34631
+ type: 'array',
34632
+ },
34633
+ pairing_code: {
34634
+ maxLength: 6,
34635
+ minLength: 6,
34636
+ type: 'string',
34637
+ },
34638
+ pairing_code_expires_at: {
34639
+ format: 'date-time',
34640
+ type: 'string',
34641
+ },
34642
+ tailscale_auth_key: { nullable: true, type: 'string' },
34643
+ tailscale_hostname: { type: 'string' },
34644
+ telemetry_token: { nullable: true, type: 'string' },
34645
+ telemetry_token_expires_at: {
34646
+ format: 'date-time',
34647
+ nullable: true,
34648
+ type: 'string',
34649
+ },
34650
+ telemetry_url: { nullable: true, type: 'string' },
34651
+ },
34652
+ required: [
34653
+ 'created_at',
34654
+ 'bridge_client_session_id',
34655
+ 'bridge_client_session_token',
34656
+ 'pairing_code',
34657
+ 'pairing_code_expires_at',
34658
+ 'tailscale_hostname',
34659
+ 'tailscale_auth_key',
34660
+ 'bridge_client_name',
34661
+ 'bridge_client_time_zone',
34662
+ 'bridge_client_machine_identifier_key',
34663
+ 'errors',
34664
+ 'telemetry_token',
34665
+ 'telemetry_token_expires_at',
34666
+ 'telemetry_url',
34667
+ ],
34668
+ type: 'object',
34669
+ 'x-route-path': '/seam/bridge/v1/bridge_client_sessions',
34670
+ 'x-undocumented': 'Seam Bridge Client only.',
34671
+ },
34672
+ ok: { type: 'boolean' },
34673
+ },
34674
+ required: ['bridge_client_session', 'ok'],
34675
+ type: 'object',
34676
+ },
34677
+ },
34678
+ },
34679
+ description: 'OK',
34680
+ },
34681
+ 400: { description: 'Bad Request' },
34682
+ 401: { description: 'Unauthorized' },
34683
+ },
34684
+ security: [{ certified_client: [] }],
34685
+ summary: '/unstable_partner/building_blocks/generate_link',
34686
+ tags: [],
34687
+ 'x-fern-sdk-group-name': ['unstable_partner', 'building_blocks'],
34688
+ 'x-fern-sdk-method-name': 'generate_link',
34689
+ 'x-fern-sdk-return-value': 'bridge_client_session',
34690
+ 'x-response-key': 'bridge_client_session',
34691
+ 'x-title': 'Generate a building block magic link',
34692
+ },
34693
+ },
33718
34694
  '/unstable_partner/resources/push': {
33719
34695
  post: {
33720
34696
  description: 'Send Seam some of your resources.',
@@ -33735,7 +34711,6 @@ export default {
33735
34711
  description: { type: 'string' },
33736
34712
  email_address: { type: 'string' },
33737
34713
  ends_at: { type: 'string' },
33738
- icon_url: { type: 'string' },
33739
34714
  location_keys: {
33740
34715
  items: { type: 'string' },
33741
34716
  type: 'array',
@@ -33761,7 +34736,6 @@ export default {
33761
34736
  description: { type: 'string' },
33762
34737
  email_address: { type: 'string' },
33763
34738
  ends_at: { type: 'string' },
33764
- icon_url: { type: 'string' },
33765
34739
  location_keys: {
33766
34740
  items: { type: 'string' },
33767
34741
  type: 'array',