@seamapi/types 1.69.0 → 1.71.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (62) hide show
  1. package/dist/connect.cjs +2600 -895
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +11812 -8664
  4. package/dist/devicedb.cjs +9 -1
  5. package/dist/devicedb.cjs.map +1 -1
  6. package/dist/devicedb.d.cts +263 -2
  7. package/lib/seam/connect/openapi.d.ts +3483 -1430
  8. package/lib/seam/connect/openapi.js +2595 -890
  9. package/lib/seam/connect/openapi.js.map +1 -1
  10. package/lib/seam/connect/route-types.d.ts +1325 -230
  11. package/lib/seam/connect/unstable/models/acs/credential.js +1 -0
  12. package/lib/seam/connect/unstable/models/acs/credential.js.map +1 -1
  13. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.d.ts +22 -2
  14. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js +7 -0
  15. package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js.map +1 -1
  16. package/lib/seam/connect/unstable/models/acs/system.d.ts +7 -7
  17. package/lib/seam/connect/unstable/models/acs/system.js +1 -1
  18. package/lib/seam/connect/unstable/models/acs/system.js.map +1 -1
  19. package/lib/seam/connect/unstable/models/devices/index.d.ts +1 -0
  20. package/lib/seam/connect/unstable/models/devices/index.js +1 -0
  21. package/lib/seam/connect/unstable/models/devices/index.js.map +1 -1
  22. package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +82 -8
  23. package/lib/seam/connect/unstable/models/devices/managed-device.js +2 -0
  24. package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
  25. package/lib/seam/connect/unstable/models/devices/phone-properties.d.ts +44 -0
  26. package/lib/seam/connect/unstable/models/devices/phone-properties.js +13 -0
  27. package/lib/seam/connect/unstable/models/devices/phone-properties.js.map +1 -0
  28. package/lib/seam/connect/unstable/models/devices/phone.d.ts +3529 -0
  29. package/lib/seam/connect/unstable/models/devices/phone.js +13 -0
  30. package/lib/seam/connect/unstable/models/devices/phone.js.map +1 -0
  31. package/lib/seam/connect/unstable/models/index.d.ts +1 -0
  32. package/lib/seam/connect/unstable/models/index.js +1 -0
  33. package/lib/seam/connect/unstable/models/index.js.map +1 -1
  34. package/lib/seam/connect/unstable/models/network.d.ts +18 -0
  35. package/lib/seam/connect/unstable/models/network.js +8 -0
  36. package/lib/seam/connect/unstable/models/network.js.map +1 -0
  37. package/lib/seam/connect/unstable/schemas.d.ts +1 -1
  38. package/lib/seam/connect/unstable/schemas.js +1 -1
  39. package/lib/seam/connect/unstable/schemas.js.map +1 -1
  40. package/lib/seam/devicedb/index.d.ts +1 -1
  41. package/lib/seam/devicedb/public-models/device-model-v1.d.ts +52 -0
  42. package/lib/seam/devicedb/public-models/manufacturer.d.ts +30 -0
  43. package/lib/seam/devicedb/public-models/manufacturer.js +6 -0
  44. package/lib/seam/devicedb/public-models/manufacturer.js.map +1 -1
  45. package/lib/seam/devicedb/route-specs.d.ts +160 -0
  46. package/lib/seam/devicedb/route-types.d.ts +16 -0
  47. package/package.json +1 -1
  48. package/src/lib/seam/connect/openapi.ts +2644 -915
  49. package/src/lib/seam/connect/route-types.ts +1701 -211
  50. package/src/lib/seam/connect/unstable/models/acs/credential.ts +1 -0
  51. package/src/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.ts +12 -0
  52. package/src/lib/seam/connect/unstable/models/acs/system.ts +1 -1
  53. package/src/lib/seam/connect/unstable/models/devices/index.ts +1 -0
  54. package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +2 -0
  55. package/src/lib/seam/connect/unstable/models/devices/phone-properties.ts +15 -0
  56. package/src/lib/seam/connect/unstable/models/devices/phone.ts +15 -0
  57. package/src/lib/seam/connect/unstable/models/index.ts +1 -0
  58. package/src/lib/seam/connect/unstable/models/network.ts +10 -0
  59. package/src/lib/seam/connect/unstable/schemas.ts +3 -0
  60. package/src/lib/seam/devicedb/index.ts +1 -0
  61. package/src/lib/seam/devicedb/public-models/manufacturer.ts +12 -0
  62. package/src/lib/seam/devicedb/route-types.ts +16 -0
@@ -1103,7 +1103,7 @@ export interface Routes {
1103
1103
  | 'brivo_account'
1104
1104
  | 'hid_credential_manager_organization'
1105
1105
  | 'visionline_system'
1106
- | 'assa_abloy_credential_service_user'
1106
+ | 'assa_abloy_credential_service'
1107
1107
  external_type_display_name: string
1108
1108
  /** deprecated: use external_type */
1109
1109
  system_type:
@@ -1113,7 +1113,7 @@ export interface Routes {
1113
1113
  | 'brivo_account'
1114
1114
  | 'hid_credential_manager_organization'
1115
1115
  | 'visionline_system'
1116
- | 'assa_abloy_credential_service_user'
1116
+ | 'assa_abloy_credential_service'
1117
1117
  /** deprecated: use external_type_display_name */
1118
1118
  system_type_display_name: string
1119
1119
  name: string
@@ -1142,7 +1142,7 @@ export interface Routes {
1142
1142
  | 'brivo_account'
1143
1143
  | 'hid_credential_manager_organization'
1144
1144
  | 'visionline_system'
1145
- | 'assa_abloy_credential_service_user'
1145
+ | 'assa_abloy_credential_service'
1146
1146
  external_type_display_name: string
1147
1147
  /** deprecated: use external_type */
1148
1148
  system_type:
@@ -1152,7 +1152,7 @@ export interface Routes {
1152
1152
  | 'brivo_account'
1153
1153
  | 'hid_credential_manager_organization'
1154
1154
  | 'visionline_system'
1155
- | 'assa_abloy_credential_service_user'
1155
+ | 'assa_abloy_credential_service'
1156
1156
  /** deprecated: use external_type_display_name */
1157
1157
  system_type_display_name: string
1158
1158
  name: string
@@ -1345,6 +1345,12 @@ export interface Routes {
1345
1345
  method: 'PATCH' | 'POST'
1346
1346
  queryParams: {}
1347
1347
  jsonBody: {
1348
+ access_schedule?:
1349
+ | {
1350
+ starts_at: string
1351
+ ends_at: string
1352
+ }
1353
+ | undefined
1348
1354
  acs_user_id: string
1349
1355
  full_name?: string | undefined
1350
1356
  /** Deprecated: use email_address. */
@@ -1929,7 +1935,7 @@ export interface Routes {
1929
1935
  | 'phone'
1930
1936
  >
1931
1937
  /** Properties of the device. */
1932
- properties: ({
1938
+ properties: (({
1933
1939
  /** Indicates whether the device is online. */
1934
1940
  online: boolean
1935
1941
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -2497,7 +2503,20 @@ export interface Routes {
2497
2503
  max_cooling_set_point_celsius?: number | undefined
2498
2504
  max_cooling_set_point_fahrenheit?: number | undefined
2499
2505
  }
2500
- ))
2506
+ ))) & {
2507
+ assa_abloy_credential_service_metadata?:
2508
+ | (
2509
+ | {
2510
+ has_active_endpoint: boolean
2511
+ endpoints: Array<{
2512
+ endpoint_id: string
2513
+ is_active: boolean
2514
+ }>
2515
+ }
2516
+ | undefined
2517
+ )
2518
+ | undefined
2519
+ }
2501
2520
  /** Location information for the device. */
2502
2521
  location: {
2503
2522
  /** Name of the device location. */
@@ -2692,7 +2711,7 @@ export interface Routes {
2692
2711
  | 'phone'
2693
2712
  >
2694
2713
  /** Properties of the device. */
2695
- properties: ({
2714
+ properties: (({
2696
2715
  /** Indicates whether the device is online. */
2697
2716
  online: boolean
2698
2717
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -3260,7 +3279,20 @@ export interface Routes {
3260
3279
  max_cooling_set_point_celsius?: number | undefined
3261
3280
  max_cooling_set_point_fahrenheit?: number | undefined
3262
3281
  }
3263
- ))
3282
+ ))) & {
3283
+ assa_abloy_credential_service_metadata?:
3284
+ | (
3285
+ | {
3286
+ has_active_endpoint: boolean
3287
+ endpoints: Array<{
3288
+ endpoint_id: string
3289
+ is_active: boolean
3290
+ }>
3291
+ }
3292
+ | undefined
3293
+ )
3294
+ | undefined
3295
+ }
3264
3296
  /** Location information for the device. */
3265
3297
  location: {
3266
3298
  /** Name of the device location. */
@@ -3952,7 +3984,7 @@ export interface Routes {
3952
3984
  | 'phone'
3953
3985
  >
3954
3986
  /** Properties of the device. */
3955
- properties: ({
3987
+ properties: (({
3956
3988
  /** Indicates whether the device is online. */
3957
3989
  online: boolean
3958
3990
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -4520,7 +4552,20 @@ export interface Routes {
4520
4552
  max_cooling_set_point_celsius?: number | undefined
4521
4553
  max_cooling_set_point_fahrenheit?: number | undefined
4522
4554
  }
4523
- ))
4555
+ ))) & {
4556
+ assa_abloy_credential_service_metadata?:
4557
+ | (
4558
+ | {
4559
+ has_active_endpoint: boolean
4560
+ endpoints: Array<{
4561
+ endpoint_id: string
4562
+ is_active: boolean
4563
+ }>
4564
+ }
4565
+ | undefined
4566
+ )
4567
+ | undefined
4568
+ }
4524
4569
  /** Location information for the device. */
4525
4570
  location: {
4526
4571
  /** Name of the device location. */
@@ -4592,7 +4637,7 @@ export interface Routes {
4592
4637
  | 'phone'
4593
4638
  >
4594
4639
  /** Properties of the device. */
4595
- properties: ({
4640
+ properties: (({
4596
4641
  /** Indicates whether the device is online. */
4597
4642
  online: boolean
4598
4643
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -5160,7 +5205,20 @@ export interface Routes {
5160
5205
  max_cooling_set_point_celsius?: number | undefined
5161
5206
  max_cooling_set_point_fahrenheit?: number | undefined
5162
5207
  }
5163
- ))
5208
+ ))) & {
5209
+ assa_abloy_credential_service_metadata?:
5210
+ | (
5211
+ | {
5212
+ has_active_endpoint: boolean
5213
+ endpoints: Array<{
5214
+ endpoint_id: string
5215
+ is_active: boolean
5216
+ }>
5217
+ }
5218
+ | undefined
5219
+ )
5220
+ | undefined
5221
+ }
5164
5222
  /** Location information for the device. */
5165
5223
  location: {
5166
5224
  /** Name of the device location. */
@@ -5355,7 +5413,7 @@ export interface Routes {
5355
5413
  | 'phone'
5356
5414
  >
5357
5415
  /** Properties of the device. */
5358
- properties: ({
5416
+ properties: (({
5359
5417
  /** Indicates whether the device is online. */
5360
5418
  online: boolean
5361
5419
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -5923,7 +5981,20 @@ export interface Routes {
5923
5981
  max_cooling_set_point_celsius?: number | undefined
5924
5982
  max_cooling_set_point_fahrenheit?: number | undefined
5925
5983
  }
5926
- ))
5984
+ ))) & {
5985
+ assa_abloy_credential_service_metadata?:
5986
+ | (
5987
+ | {
5988
+ has_active_endpoint: boolean
5989
+ endpoints: Array<{
5990
+ endpoint_id: string
5991
+ is_active: boolean
5992
+ }>
5993
+ }
5994
+ | undefined
5995
+ )
5996
+ | undefined
5997
+ }
5927
5998
  /** Location information for the device. */
5928
5999
  location: {
5929
6000
  /** Name of the device location. */
@@ -5995,7 +6066,7 @@ export interface Routes {
5995
6066
  | 'phone'
5996
6067
  >
5997
6068
  /** Properties of the device. */
5998
- properties: ({
6069
+ properties: (({
5999
6070
  /** Indicates whether the device is online. */
6000
6071
  online: boolean
6001
6072
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -6563,7 +6634,20 @@ export interface Routes {
6563
6634
  max_cooling_set_point_celsius?: number | undefined
6564
6635
  max_cooling_set_point_fahrenheit?: number | undefined
6565
6636
  }
6566
- ))
6637
+ ))) & {
6638
+ assa_abloy_credential_service_metadata?:
6639
+ | (
6640
+ | {
6641
+ has_active_endpoint: boolean
6642
+ endpoints: Array<{
6643
+ endpoint_id: string
6644
+ is_active: boolean
6645
+ }>
6646
+ }
6647
+ | undefined
6648
+ )
6649
+ | undefined
6650
+ }
6567
6651
  /** Location information for the device. */
6568
6652
  location: {
6569
6653
  /** Name of the device location. */
@@ -6668,6 +6752,40 @@ export interface Routes {
6668
6752
  }
6669
6753
  }
6670
6754
  }
6755
+ '/networks/get': {
6756
+ route: '/networks/get'
6757
+ method: 'GET' | 'POST'
6758
+ queryParams: {}
6759
+ jsonBody: {}
6760
+ commonParams: {
6761
+ network_id: string
6762
+ }
6763
+ formData: {}
6764
+ jsonResponse: {
6765
+ network: {
6766
+ network_id: string
6767
+ workspace_id: string
6768
+ display_name: string
6769
+ created_at: string
6770
+ }
6771
+ }
6772
+ }
6773
+ '/networks/list': {
6774
+ route: '/networks/list'
6775
+ method: 'GET' | 'POST'
6776
+ queryParams: {}
6777
+ jsonBody: {}
6778
+ commonParams: {}
6779
+ formData: {}
6780
+ jsonResponse: {
6781
+ networks: Array<{
6782
+ network_id: string
6783
+ workspace_id: string
6784
+ display_name: string
6785
+ created_at: string
6786
+ }>
6787
+ }
6788
+ }
6671
6789
  '/noise_sensors/noise_thresholds/create': {
6672
6790
  route: '/noise_sensors/noise_thresholds/create'
6673
6791
  method: 'POST'
@@ -6857,204 +6975,1499 @@ export interface Routes {
6857
6975
  formData: {}
6858
6976
  jsonResponse: {}
6859
6977
  }
6860
- '/thermostats/climate_setting_schedules/create': {
6861
- route: '/thermostats/climate_setting_schedules/create'
6862
- method: 'POST'
6863
- queryParams: {}
6864
- jsonBody: {
6865
- schedule_type?: 'time_bound'
6866
- device_id: string
6867
- name?: string | undefined
6868
- schedule_starts_at: string
6869
- schedule_ends_at: string
6870
- automatic_heating_enabled?: boolean | undefined
6871
- automatic_cooling_enabled?: boolean | undefined
6872
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
6873
- cooling_set_point_celsius?: (number | undefined) | undefined
6874
- heating_set_point_celsius?: (number | undefined) | undefined
6875
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
6876
- heating_set_point_fahrenheit?: (number | undefined) | undefined
6877
- manual_override_allowed?: boolean | undefined
6878
- }
6879
- commonParams: {}
6880
- formData: {}
6881
- jsonResponse: {
6882
- climate_setting_schedule: {
6883
- climate_setting_schedule_id: string
6884
- schedule_type: 'time_bound'
6885
- device_id: string
6886
- name?: string | undefined
6887
- schedule_starts_at: string
6888
- schedule_ends_at: string
6889
- created_at: string
6890
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6891
- errors?: any
6892
- automatic_heating_enabled?: boolean | undefined
6893
- automatic_cooling_enabled?: boolean | undefined
6894
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
6895
- cooling_set_point_celsius?: (number | undefined) | undefined
6896
- heating_set_point_celsius?: (number | undefined) | undefined
6897
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
6898
- heating_set_point_fahrenheit?: (number | undefined) | undefined
6899
- manual_override_allowed?: boolean | undefined
6900
- }
6901
- }
6902
- }
6903
- '/thermostats/climate_setting_schedules/delete': {
6904
- route: '/thermostats/climate_setting_schedules/delete'
6905
- method: 'DELETE' | 'POST' | 'PUT'
6906
- queryParams: {}
6907
- jsonBody: {}
6908
- commonParams: {
6909
- climate_setting_schedule_id: string
6910
- }
6911
- formData: {}
6912
- jsonResponse: {}
6913
- }
6914
- '/thermostats/climate_setting_schedules/get': {
6915
- route: '/thermostats/climate_setting_schedules/get'
6916
- method: 'GET' | 'POST'
6917
- queryParams: {}
6918
- jsonBody: {}
6919
- commonParams: {
6920
- climate_setting_schedule_id?: string | undefined
6921
- device_id?: string | undefined
6922
- }
6923
- formData: {}
6924
- jsonResponse: {
6925
- climate_setting_schedule: {
6926
- climate_setting_schedule_id: string
6927
- schedule_type: 'time_bound'
6928
- device_id: string
6929
- name?: string | undefined
6930
- schedule_starts_at: string
6931
- schedule_ends_at: string
6932
- created_at: string
6933
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6934
- errors?: any
6935
- automatic_heating_enabled?: boolean | undefined
6936
- automatic_cooling_enabled?: boolean | undefined
6937
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
6938
- cooling_set_point_celsius?: (number | undefined) | undefined
6939
- heating_set_point_celsius?: (number | undefined) | undefined
6940
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
6941
- heating_set_point_fahrenheit?: (number | undefined) | undefined
6942
- manual_override_allowed?: boolean | undefined
6943
- }
6944
- }
6945
- }
6946
- '/thermostats/climate_setting_schedules/list': {
6947
- route: '/thermostats/climate_setting_schedules/list'
6948
- method: 'GET' | 'POST'
6949
- queryParams: {}
6950
- jsonBody: {}
6951
- commonParams: {
6952
- device_id: string
6953
- user_identifier_key?: string | undefined
6954
- }
6955
- formData: {}
6956
- jsonResponse: {
6957
- climate_setting_schedules: Array<{
6958
- climate_setting_schedule_id: string
6959
- schedule_type: 'time_bound'
6960
- device_id: string
6961
- name?: string | undefined
6962
- schedule_starts_at: string
6963
- schedule_ends_at: string
6964
- created_at: string
6965
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
6966
- errors?: any
6967
- automatic_heating_enabled?: boolean | undefined
6968
- automatic_cooling_enabled?: boolean | undefined
6969
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
6970
- cooling_set_point_celsius?: (number | undefined) | undefined
6971
- heating_set_point_celsius?: (number | undefined) | undefined
6972
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
6973
- heating_set_point_fahrenheit?: (number | undefined) | undefined
6974
- manual_override_allowed?: boolean | undefined
6975
- }>
6976
- }
6977
- }
6978
- '/thermostats/climate_setting_schedules/update': {
6979
- route: '/thermostats/climate_setting_schedules/update'
6980
- method: 'PATCH' | 'POST' | 'PUT'
6981
- queryParams: {}
6982
- jsonBody: {
6983
- climate_setting_schedule_id: string
6984
- schedule_type?: 'time_bound'
6985
- name?: string | undefined
6986
- schedule_starts_at?: string | undefined
6987
- schedule_ends_at?: string | undefined
6988
- automatic_heating_enabled?: boolean | undefined
6989
- automatic_cooling_enabled?: boolean | undefined
6990
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
6991
- cooling_set_point_celsius?: (number | undefined) | undefined
6992
- heating_set_point_celsius?: (number | undefined) | undefined
6993
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
6994
- heating_set_point_fahrenheit?: (number | undefined) | undefined
6995
- manual_override_allowed?: boolean | undefined
6996
- }
6997
- commonParams: {}
6998
- formData: {}
6999
- jsonResponse: {
7000
- climate_setting_schedule: {
7001
- climate_setting_schedule_id: string
7002
- schedule_type: 'time_bound'
7003
- device_id: string
7004
- name?: string | undefined
7005
- schedule_starts_at: string
7006
- schedule_ends_at: string
7007
- created_at: string
7008
- /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7009
- errors?: any
7010
- automatic_heating_enabled?: boolean | undefined
7011
- automatic_cooling_enabled?: boolean | undefined
7012
- hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
7013
- cooling_set_point_celsius?: (number | undefined) | undefined
7014
- heating_set_point_celsius?: (number | undefined) | undefined
7015
- cooling_set_point_fahrenheit?: (number | undefined) | undefined
7016
- heating_set_point_fahrenheit?: (number | undefined) | undefined
7017
- manual_override_allowed?: boolean | undefined
7018
- }
7019
- }
7020
- }
7021
- '/thermostats/cool': {
7022
- route: '/thermostats/cool'
7023
- method: 'POST'
7024
- queryParams: {}
7025
- jsonBody: {
7026
- device_id: string
7027
- cooling_set_point_celsius?: number | undefined
7028
- cooling_set_point_fahrenheit?: number | undefined
7029
- sync?: boolean
7030
- }
7031
- commonParams: {}
7032
- formData: {}
7033
- jsonResponse: {}
7034
- }
7035
- '/thermostats/get': {
7036
- route: '/thermostats/get'
6978
+ '/phones/list': {
6979
+ route: '/phones/list'
7037
6980
  method: 'GET' | 'POST'
7038
6981
  queryParams: {}
7039
6982
  jsonBody: {}
7040
6983
  commonParams: {
7041
- device_id?: string | undefined
7042
- name?: string | undefined
6984
+ owner_user_identity_id?: string | undefined
7043
6985
  }
7044
6986
  formData: {}
7045
6987
  jsonResponse: {
7046
- thermostat: {
6988
+ phones: Array<{
7047
6989
  /** Unique identifier for the device. */
7048
6990
  device_id: string
7049
- /** Type of the device. */
7050
- device_type:
7051
- | (
7052
- | 'akuvox_lock'
7053
- | 'august_lock'
7054
- | 'brivo_access_point'
7055
- | 'butterflymx_panel'
7056
- | 'avigilon_alta_entry'
7057
- | 'doorking_lock'
6991
+ device_type: 'android_phone' | 'ios_phone'
6992
+ /** 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. */
6993
+ capabilities_supported: Array<
6994
+ | 'access_code'
6995
+ | 'lock'
6996
+ | 'noise_detection'
6997
+ | 'thermostat'
6998
+ | 'battery'
6999
+ | 'phone'
7000
+ >
7001
+ /** Properties of the device. */
7002
+ properties: (({
7003
+ /** Indicates whether the device is online. */
7004
+ online: boolean
7005
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
7006
+ name: string
7007
+ model: {
7008
+ /** Display name of the device model. */
7009
+ display_name: string
7010
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
7011
+ manufacturer_display_name: string
7012
+ /** Indicates whether the device supports offline access codes. */
7013
+ offline_access_codes_supported?: boolean | undefined
7014
+ /** Indicates whether the device supports online access codes. */
7015
+ online_access_codes_supported?: boolean | undefined
7016
+ /** Indicates whether the device supports an accessory keypad. */
7017
+ accessory_keypad_supported?: boolean | undefined
7018
+ }
7019
+ /** Indicates whether the device has direct power. */
7020
+ has_direct_power?: boolean | undefined
7021
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
7022
+ battery_level?: number | undefined
7023
+ /** 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. */
7024
+ battery?:
7025
+ | {
7026
+ level: number
7027
+ status: 'critical' | 'low' | 'good' | 'full'
7028
+ }
7029
+ | undefined
7030
+ /** Manufacturer of the device. */
7031
+ manufacturer?: string | undefined
7032
+ /** Image URL for the device. */
7033
+ image_url?: string | undefined
7034
+ /** Alt text for the device image. */
7035
+ image_alt_text?: string | undefined
7036
+ /** Serial number of the device. */
7037
+ serial_number?: string | undefined
7038
+ /** Indicates whether it is currently possible to use online access codes for the device. */
7039
+ online_access_codes_enabled?: boolean | undefined
7040
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
7041
+ offline_access_codes_enabled?: boolean | undefined
7042
+ /** Deprecated. Use model.accessory_keypad_supported. */
7043
+ supports_accessory_keypad?: boolean | undefined
7044
+ /** Deprecated. Use offline_access_codes_enabled. */
7045
+ supports_offline_access_codes?: boolean | undefined
7046
+ } & {
7047
+ august_metadata?:
7048
+ | {
7049
+ lock_id: string
7050
+ lock_name: string
7051
+ house_name: string
7052
+ has_keypad: boolean
7053
+ keypad_battery_level?: string | undefined
7054
+ model?: string | undefined
7055
+ house_id?: string | undefined
7056
+ }
7057
+ | undefined
7058
+ avigilon_alta_metadata?:
7059
+ | {
7060
+ entry_name: string
7061
+ org_name: string
7062
+ zone_id: number
7063
+ zone_name: string
7064
+ site_id: number
7065
+ site_name: string
7066
+ }
7067
+ | undefined
7068
+ schlage_metadata?:
7069
+ | {
7070
+ device_id: string
7071
+ device_name: string
7072
+ access_code_length: number
7073
+ model?: string | undefined
7074
+ }
7075
+ | undefined
7076
+ smartthings_metadata?:
7077
+ | {
7078
+ device_id: string
7079
+ device_name: string
7080
+ model?: string | undefined
7081
+ location_id?: string | undefined
7082
+ }
7083
+ | undefined
7084
+ lockly_metadata?:
7085
+ | {
7086
+ device_id: string
7087
+ device_name: string
7088
+ model?: string | undefined
7089
+ }
7090
+ | undefined
7091
+ nuki_metadata?:
7092
+ | {
7093
+ device_id: string
7094
+ device_name: string
7095
+ keypad_battery_critical?: boolean | undefined
7096
+ }
7097
+ | undefined
7098
+ kwikset_metadata?:
7099
+ | {
7100
+ device_id: string
7101
+ device_name: string
7102
+ model_number: string
7103
+ }
7104
+ | undefined
7105
+ salto_metadata?:
7106
+ | {
7107
+ lock_id: string
7108
+ customer_reference: string
7109
+ lock_type: string
7110
+ battery_level: string
7111
+ locked_state: string
7112
+ model?: string | undefined
7113
+ }
7114
+ | undefined
7115
+ genie_metadata?:
7116
+ | {
7117
+ device_name: string
7118
+ door_name: string
7119
+ }
7120
+ | undefined
7121
+ brivo_metadata?:
7122
+ | {
7123
+ device_name: string
7124
+ }
7125
+ | undefined
7126
+ igloo_metadata?:
7127
+ | {
7128
+ device_id: string
7129
+ bridge_id: string
7130
+ model?: string | undefined
7131
+ }
7132
+ | undefined
7133
+ noiseaware_metadata?:
7134
+ | {
7135
+ device_model: 'indoor' | 'outdoor'
7136
+ noise_level_nrs: number
7137
+ noise_level_decibel: number
7138
+ device_name: string
7139
+ device_id: string
7140
+ }
7141
+ | undefined
7142
+ minut_metadata?:
7143
+ | {
7144
+ device_id: string
7145
+ device_name: string
7146
+ latest_sensor_values: {
7147
+ temperature: {
7148
+ time: string
7149
+ value: number
7150
+ }
7151
+ sound: {
7152
+ time: string
7153
+ value: number
7154
+ }
7155
+ humidity: {
7156
+ time: string
7157
+ value: number
7158
+ }
7159
+ pressure: {
7160
+ time: string
7161
+ value: number
7162
+ }
7163
+ accelerometer_z: {
7164
+ time: string
7165
+ value: number
7166
+ }
7167
+ }
7168
+ }
7169
+ | undefined
7170
+ four_suites_metadata?:
7171
+ | {
7172
+ device_id: number
7173
+ device_name: string
7174
+ reclose_delay_in_seconds: number
7175
+ }
7176
+ | undefined
7177
+ two_n_metadata?:
7178
+ | {
7179
+ device_id: number
7180
+ device_name: string
7181
+ }
7182
+ | undefined
7183
+ controlbyweb_metadata?:
7184
+ | {
7185
+ device_id: string
7186
+ device_name: string
7187
+ relay_name: string | null
7188
+ }
7189
+ | undefined
7190
+ ttlock_metadata?:
7191
+ | {
7192
+ lock_id: number
7193
+ lock_alias: string
7194
+ }
7195
+ | undefined
7196
+ seam_bridge_metadata?:
7197
+ | {
7198
+ unlock_method?: ('bridge' | 'doorking') | undefined
7199
+ device_num: number
7200
+ name: string
7201
+ }
7202
+ | undefined
7203
+ igloohome_metadata?:
7204
+ | {
7205
+ device_id: string
7206
+ device_name: string
7207
+ bridge_id?: string | undefined
7208
+ bridge_name?: string | undefined
7209
+ }
7210
+ | undefined
7211
+ nest_metadata?:
7212
+ | {
7213
+ nest_device_id: string
7214
+ device_name: string
7215
+ custom_name: string
7216
+ }
7217
+ | undefined
7218
+ ecobee_metadata?:
7219
+ | {
7220
+ ecobee_device_id: string
7221
+ device_name: string
7222
+ }
7223
+ | undefined
7224
+ hubitat_metadata?:
7225
+ | {
7226
+ device_id: string
7227
+ device_name: string
7228
+ device_label: string
7229
+ }
7230
+ | undefined
7231
+ dormakaba_oracode_metadata?:
7232
+ | {
7233
+ door_id: number
7234
+ door_name: string
7235
+ device_id?: number | undefined
7236
+ site_id: number
7237
+ site_name: string
7238
+ iana_timezone?: string | undefined
7239
+ predefined_time_slots?:
7240
+ | Array<{
7241
+ name: string
7242
+ prefix: number
7243
+ check_in_time: string
7244
+ check_out_time: string
7245
+ is_24_hour: boolean
7246
+ is_biweekly_mode: boolean
7247
+ is_one_shot: boolean
7248
+ is_master: boolean
7249
+ ext_dormakaba_oracode_user_level_prefix: number
7250
+ dormakaba_oracode_user_level_id: string
7251
+ }>
7252
+ | undefined
7253
+ }
7254
+ | undefined
7255
+ wyze_metadata?:
7256
+ | {
7257
+ device_id: string
7258
+ device_name: string
7259
+ product_name: string
7260
+ product_type: string
7261
+ product_model: string
7262
+ device_info_model: string
7263
+ }
7264
+ | undefined
7265
+ }) &
7266
+ ({
7267
+ code_constraints?:
7268
+ | (
7269
+ | Array<
7270
+ | {
7271
+ constraint_type:
7272
+ | 'no_zeros'
7273
+ | 'cannot_start_with_12'
7274
+ | 'no_triple_consecutive_ints'
7275
+ | 'cannot_specify_pin_code'
7276
+ | 'pin_code_matches_existing_set'
7277
+ | 'start_date_in_future'
7278
+ }
7279
+ | {
7280
+ constraint_type: 'name_length'
7281
+ min_length?: number | undefined
7282
+ max_length?: number | undefined
7283
+ }
7284
+ >
7285
+ | undefined
7286
+ )
7287
+ | undefined
7288
+ supported_code_lengths?: (number[] | undefined) | undefined
7289
+ max_active_codes_supported?: (number | undefined) | undefined
7290
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
7291
+ has_native_entry_events?: (boolean | undefined) | undefined
7292
+ locked?: (boolean | undefined) | undefined
7293
+ keypad_battery?:
7294
+ | (
7295
+ | {
7296
+ level: number
7297
+ }
7298
+ | undefined
7299
+ )
7300
+ | undefined
7301
+ door_open?: (boolean | undefined) | undefined
7302
+ } & (
7303
+ | {
7304
+ temperature_fahrenheit?: number | undefined
7305
+ temperature_celsius?: number | undefined
7306
+ relative_humidity?: number | undefined
7307
+ can_enable_automatic_heating?: boolean | undefined
7308
+ can_enable_automatic_cooling?: boolean | undefined
7309
+ available_hvac_mode_settings?:
7310
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
7311
+ | undefined
7312
+ is_heating_available?: true | undefined
7313
+ is_cooling_available?: true | undefined
7314
+ is_heating?: boolean | undefined
7315
+ is_cooling?: boolean | undefined
7316
+ is_fan_running?: boolean | undefined
7317
+ fan_mode_setting?: ('auto' | 'on') | undefined
7318
+ is_temporary_manual_override_active?: boolean | undefined
7319
+ current_climate_setting?:
7320
+ | {
7321
+ automatic_heating_enabled: boolean
7322
+ automatic_cooling_enabled: boolean
7323
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
7324
+ cooling_set_point_celsius?: number | undefined
7325
+ heating_set_point_celsius?: number | undefined
7326
+ cooling_set_point_fahrenheit?: number | undefined
7327
+ heating_set_point_fahrenheit?: number | undefined
7328
+ manual_override_allowed: boolean
7329
+ }
7330
+ | undefined
7331
+ default_climate_setting?:
7332
+ | (
7333
+ | {
7334
+ automatic_heating_enabled: boolean
7335
+ automatic_cooling_enabled: boolean
7336
+ hvac_mode_setting:
7337
+ | 'off'
7338
+ | 'heat'
7339
+ | 'cool'
7340
+ | 'heat_cool'
7341
+ cooling_set_point_celsius?: number | undefined
7342
+ heating_set_point_celsius?: number | undefined
7343
+ cooling_set_point_fahrenheit?: number | undefined
7344
+ heating_set_point_fahrenheit?: number | undefined
7345
+ manual_override_allowed: boolean
7346
+ }
7347
+ | undefined
7348
+ )
7349
+ | undefined
7350
+ is_climate_setting_schedule_active?: boolean | undefined
7351
+ active_climate_setting_schedule?:
7352
+ | (
7353
+ | {
7354
+ climate_setting_schedule_id: string
7355
+ schedule_type: 'time_bound'
7356
+ device_id: string
7357
+ name?: string | undefined
7358
+ schedule_starts_at: string
7359
+ schedule_ends_at: string
7360
+ created_at: string
7361
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7362
+ errors?: any
7363
+ automatic_heating_enabled?: boolean | undefined
7364
+ automatic_cooling_enabled?: boolean | undefined
7365
+ hvac_mode_setting?:
7366
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
7367
+ | undefined
7368
+ cooling_set_point_celsius?:
7369
+ | (number | undefined)
7370
+ | undefined
7371
+ heating_set_point_celsius?:
7372
+ | (number | undefined)
7373
+ | undefined
7374
+ cooling_set_point_fahrenheit?:
7375
+ | (number | undefined)
7376
+ | undefined
7377
+ heating_set_point_fahrenheit?:
7378
+ | (number | undefined)
7379
+ | undefined
7380
+ manual_override_allowed?: boolean | undefined
7381
+ }
7382
+ | undefined
7383
+ )
7384
+ | undefined
7385
+ min_cooling_set_point_celsius?: number | undefined
7386
+ min_cooling_set_point_fahrenheit?: number | undefined
7387
+ max_cooling_set_point_celsius?: number | undefined
7388
+ max_cooling_set_point_fahrenheit?: number | undefined
7389
+ min_heating_set_point_celsius?: number | undefined
7390
+ min_heating_set_point_fahrenheit?: number | undefined
7391
+ max_heating_set_point_celsius?: number | undefined
7392
+ max_heating_set_point_fahrenheit?: number | undefined
7393
+ min_heating_cooling_delta_celsius?: number | undefined
7394
+ min_heating_cooling_delta_fahrenheit?: number | undefined
7395
+ }
7396
+ | {
7397
+ temperature_fahrenheit?: number | undefined
7398
+ temperature_celsius?: number | undefined
7399
+ relative_humidity?: number | undefined
7400
+ can_enable_automatic_heating?: boolean | undefined
7401
+ can_enable_automatic_cooling?: boolean | undefined
7402
+ available_hvac_mode_settings?:
7403
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
7404
+ | undefined
7405
+ is_heating_available?: true | undefined
7406
+ is_cooling_available?: false | undefined
7407
+ is_heating?: boolean | undefined
7408
+ is_cooling?: boolean | undefined
7409
+ is_fan_running?: boolean | undefined
7410
+ fan_mode_setting?: ('auto' | 'on') | undefined
7411
+ is_temporary_manual_override_active?: boolean | undefined
7412
+ current_climate_setting?:
7413
+ | {
7414
+ automatic_heating_enabled: boolean
7415
+ automatic_cooling_enabled: boolean
7416
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
7417
+ cooling_set_point_celsius?: number | undefined
7418
+ heating_set_point_celsius?: number | undefined
7419
+ cooling_set_point_fahrenheit?: number | undefined
7420
+ heating_set_point_fahrenheit?: number | undefined
7421
+ manual_override_allowed: boolean
7422
+ }
7423
+ | undefined
7424
+ default_climate_setting?:
7425
+ | (
7426
+ | {
7427
+ automatic_heating_enabled: boolean
7428
+ automatic_cooling_enabled: boolean
7429
+ hvac_mode_setting:
7430
+ | 'off'
7431
+ | 'heat'
7432
+ | 'cool'
7433
+ | 'heat_cool'
7434
+ cooling_set_point_celsius?: number | undefined
7435
+ heating_set_point_celsius?: number | undefined
7436
+ cooling_set_point_fahrenheit?: number | undefined
7437
+ heating_set_point_fahrenheit?: number | undefined
7438
+ manual_override_allowed: boolean
7439
+ }
7440
+ | undefined
7441
+ )
7442
+ | undefined
7443
+ is_climate_setting_schedule_active?: boolean | undefined
7444
+ active_climate_setting_schedule?:
7445
+ | (
7446
+ | {
7447
+ climate_setting_schedule_id: string
7448
+ schedule_type: 'time_bound'
7449
+ device_id: string
7450
+ name?: string | undefined
7451
+ schedule_starts_at: string
7452
+ schedule_ends_at: string
7453
+ created_at: string
7454
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7455
+ errors?: any
7456
+ automatic_heating_enabled?: boolean | undefined
7457
+ automatic_cooling_enabled?: boolean | undefined
7458
+ hvac_mode_setting?:
7459
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
7460
+ | undefined
7461
+ cooling_set_point_celsius?:
7462
+ | (number | undefined)
7463
+ | undefined
7464
+ heating_set_point_celsius?:
7465
+ | (number | undefined)
7466
+ | undefined
7467
+ cooling_set_point_fahrenheit?:
7468
+ | (number | undefined)
7469
+ | undefined
7470
+ heating_set_point_fahrenheit?:
7471
+ | (number | undefined)
7472
+ | undefined
7473
+ manual_override_allowed?: boolean | undefined
7474
+ }
7475
+ | undefined
7476
+ )
7477
+ | undefined
7478
+ min_heating_set_point_celsius?: number | undefined
7479
+ min_heating_set_point_fahrenheit?: number | undefined
7480
+ max_heating_set_point_celsius?: number | undefined
7481
+ max_heating_set_point_fahrenheit?: number | undefined
7482
+ }
7483
+ | {
7484
+ temperature_fahrenheit?: number | undefined
7485
+ temperature_celsius?: number | undefined
7486
+ relative_humidity?: number | undefined
7487
+ can_enable_automatic_heating?: boolean | undefined
7488
+ can_enable_automatic_cooling?: boolean | undefined
7489
+ available_hvac_mode_settings?:
7490
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
7491
+ | undefined
7492
+ is_heating_available?: false | undefined
7493
+ is_cooling_available?: true | undefined
7494
+ is_heating?: boolean | undefined
7495
+ is_cooling?: boolean | undefined
7496
+ is_fan_running?: boolean | undefined
7497
+ fan_mode_setting?: ('auto' | 'on') | undefined
7498
+ is_temporary_manual_override_active?: boolean | undefined
7499
+ current_climate_setting?:
7500
+ | {
7501
+ automatic_heating_enabled: boolean
7502
+ automatic_cooling_enabled: boolean
7503
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
7504
+ cooling_set_point_celsius?: number | undefined
7505
+ heating_set_point_celsius?: number | undefined
7506
+ cooling_set_point_fahrenheit?: number | undefined
7507
+ heating_set_point_fahrenheit?: number | undefined
7508
+ manual_override_allowed: boolean
7509
+ }
7510
+ | undefined
7511
+ default_climate_setting?:
7512
+ | (
7513
+ | {
7514
+ automatic_heating_enabled: boolean
7515
+ automatic_cooling_enabled: boolean
7516
+ hvac_mode_setting:
7517
+ | 'off'
7518
+ | 'heat'
7519
+ | 'cool'
7520
+ | 'heat_cool'
7521
+ cooling_set_point_celsius?: number | undefined
7522
+ heating_set_point_celsius?: number | undefined
7523
+ cooling_set_point_fahrenheit?: number | undefined
7524
+ heating_set_point_fahrenheit?: number | undefined
7525
+ manual_override_allowed: boolean
7526
+ }
7527
+ | undefined
7528
+ )
7529
+ | undefined
7530
+ is_climate_setting_schedule_active?: boolean | undefined
7531
+ active_climate_setting_schedule?:
7532
+ | (
7533
+ | {
7534
+ climate_setting_schedule_id: string
7535
+ schedule_type: 'time_bound'
7536
+ device_id: string
7537
+ name?: string | undefined
7538
+ schedule_starts_at: string
7539
+ schedule_ends_at: string
7540
+ created_at: string
7541
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
7542
+ errors?: any
7543
+ automatic_heating_enabled?: boolean | undefined
7544
+ automatic_cooling_enabled?: boolean | undefined
7545
+ hvac_mode_setting?:
7546
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
7547
+ | undefined
7548
+ cooling_set_point_celsius?:
7549
+ | (number | undefined)
7550
+ | undefined
7551
+ heating_set_point_celsius?:
7552
+ | (number | undefined)
7553
+ | undefined
7554
+ cooling_set_point_fahrenheit?:
7555
+ | (number | undefined)
7556
+ | undefined
7557
+ heating_set_point_fahrenheit?:
7558
+ | (number | undefined)
7559
+ | undefined
7560
+ manual_override_allowed?: boolean | undefined
7561
+ }
7562
+ | undefined
7563
+ )
7564
+ | undefined
7565
+ min_cooling_set_point_celsius?: number | undefined
7566
+ min_cooling_set_point_fahrenheit?: number | undefined
7567
+ max_cooling_set_point_celsius?: number | undefined
7568
+ max_cooling_set_point_fahrenheit?: number | undefined
7569
+ }
7570
+ ))) & {
7571
+ assa_abloy_credential_service_metadata?:
7572
+ | (
7573
+ | {
7574
+ has_active_endpoint: boolean
7575
+ endpoints: Array<{
7576
+ endpoint_id: string
7577
+ is_active: boolean
7578
+ }>
7579
+ }
7580
+ | undefined
7581
+ )
7582
+ | undefined
7583
+ }
7584
+ /** Location information for the device. */
7585
+ location: {
7586
+ /** Name of the device location. */
7587
+ location_name?: string | undefined
7588
+ /** Time zone of the device location. */
7589
+ timezone?: string | undefined
7590
+ } | null
7591
+ /** Unique identifier for the Seam workspace associated with the device. */
7592
+ workspace_id: string
7593
+ /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
7594
+ errors: Array<{
7595
+ error_code: string
7596
+ message: string
7597
+ }>
7598
+ /** 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. */
7599
+ warnings: Array<{
7600
+ warning_code: string
7601
+ message: string
7602
+ }>
7603
+ /** Date and time at which the device object was created. */
7604
+ created_at: string
7605
+ /** Indicates whether Seam manages the device. */
7606
+ is_managed: true
7607
+ assa_abloy_credential_service_metadata?:
7608
+ | {
7609
+ has_active_endpoint: boolean
7610
+ endpoints: Array<{
7611
+ endpoint_id: string
7612
+ is_active: boolean
7613
+ }>
7614
+ }
7615
+ | undefined
7616
+ }>
7617
+ }
7618
+ }
7619
+ '/phones/simulate/create_sandbox_phone': {
7620
+ route: '/phones/simulate/create_sandbox_phone'
7621
+ method: 'GET' | 'POST'
7622
+ queryParams: {}
7623
+ jsonBody: {
7624
+ assa_abloy_credential_service_acs_system_id: string
7625
+ custom_sdk_installation_id?: string | undefined
7626
+ user_identity_id: string
7627
+ phone_metadata?: {
7628
+ ble_capability?: boolean
7629
+ hce_capability?: boolean
7630
+ nfc_capability?: boolean
7631
+ application_version?: string
7632
+ seos_applet_version?: string
7633
+ device_manufacturer?: string
7634
+ device_model?: string
7635
+ os_version?: string
7636
+ operating_system?: 'android' | 'ios'
7637
+ }
7638
+ }
7639
+ commonParams: {}
7640
+ formData: {}
7641
+ jsonResponse: {
7642
+ phone: {
7643
+ /** Unique identifier for the device. */
7644
+ device_id: string
7645
+ device_type: 'android_phone' | 'ios_phone'
7646
+ /** 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. */
7647
+ capabilities_supported: Array<
7648
+ | 'access_code'
7649
+ | 'lock'
7650
+ | 'noise_detection'
7651
+ | 'thermostat'
7652
+ | 'battery'
7653
+ | 'phone'
7654
+ >
7655
+ /** Properties of the device. */
7656
+ properties: (({
7657
+ /** Indicates whether the device is online. */
7658
+ online: boolean
7659
+ /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
7660
+ name: string
7661
+ model: {
7662
+ /** Display name of the device model. */
7663
+ display_name: string
7664
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
7665
+ manufacturer_display_name: string
7666
+ /** Indicates whether the device supports offline access codes. */
7667
+ offline_access_codes_supported?: boolean | undefined
7668
+ /** Indicates whether the device supports online access codes. */
7669
+ online_access_codes_supported?: boolean | undefined
7670
+ /** Indicates whether the device supports an accessory keypad. */
7671
+ accessory_keypad_supported?: boolean | undefined
7672
+ }
7673
+ /** Indicates whether the device has direct power. */
7674
+ has_direct_power?: boolean | undefined
7675
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
7676
+ battery_level?: number | undefined
7677
+ /** 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. */
7678
+ battery?:
7679
+ | {
7680
+ level: number
7681
+ status: 'critical' | 'low' | 'good' | 'full'
7682
+ }
7683
+ | undefined
7684
+ /** Manufacturer of the device. */
7685
+ manufacturer?: string | undefined
7686
+ /** Image URL for the device. */
7687
+ image_url?: string | undefined
7688
+ /** Alt text for the device image. */
7689
+ image_alt_text?: string | undefined
7690
+ /** Serial number of the device. */
7691
+ serial_number?: string | undefined
7692
+ /** Indicates whether it is currently possible to use online access codes for the device. */
7693
+ online_access_codes_enabled?: boolean | undefined
7694
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
7695
+ offline_access_codes_enabled?: boolean | undefined
7696
+ /** Deprecated. Use model.accessory_keypad_supported. */
7697
+ supports_accessory_keypad?: boolean | undefined
7698
+ /** Deprecated. Use offline_access_codes_enabled. */
7699
+ supports_offline_access_codes?: boolean | undefined
7700
+ } & {
7701
+ august_metadata?:
7702
+ | {
7703
+ lock_id: string
7704
+ lock_name: string
7705
+ house_name: string
7706
+ has_keypad: boolean
7707
+ keypad_battery_level?: string | undefined
7708
+ model?: string | undefined
7709
+ house_id?: string | undefined
7710
+ }
7711
+ | undefined
7712
+ avigilon_alta_metadata?:
7713
+ | {
7714
+ entry_name: string
7715
+ org_name: string
7716
+ zone_id: number
7717
+ zone_name: string
7718
+ site_id: number
7719
+ site_name: string
7720
+ }
7721
+ | undefined
7722
+ schlage_metadata?:
7723
+ | {
7724
+ device_id: string
7725
+ device_name: string
7726
+ access_code_length: number
7727
+ model?: string | undefined
7728
+ }
7729
+ | undefined
7730
+ smartthings_metadata?:
7731
+ | {
7732
+ device_id: string
7733
+ device_name: string
7734
+ model?: string | undefined
7735
+ location_id?: string | undefined
7736
+ }
7737
+ | undefined
7738
+ lockly_metadata?:
7739
+ | {
7740
+ device_id: string
7741
+ device_name: string
7742
+ model?: string | undefined
7743
+ }
7744
+ | undefined
7745
+ nuki_metadata?:
7746
+ | {
7747
+ device_id: string
7748
+ device_name: string
7749
+ keypad_battery_critical?: boolean | undefined
7750
+ }
7751
+ | undefined
7752
+ kwikset_metadata?:
7753
+ | {
7754
+ device_id: string
7755
+ device_name: string
7756
+ model_number: string
7757
+ }
7758
+ | undefined
7759
+ salto_metadata?:
7760
+ | {
7761
+ lock_id: string
7762
+ customer_reference: string
7763
+ lock_type: string
7764
+ battery_level: string
7765
+ locked_state: string
7766
+ model?: string | undefined
7767
+ }
7768
+ | undefined
7769
+ genie_metadata?:
7770
+ | {
7771
+ device_name: string
7772
+ door_name: string
7773
+ }
7774
+ | undefined
7775
+ brivo_metadata?:
7776
+ | {
7777
+ device_name: string
7778
+ }
7779
+ | undefined
7780
+ igloo_metadata?:
7781
+ | {
7782
+ device_id: string
7783
+ bridge_id: string
7784
+ model?: string | undefined
7785
+ }
7786
+ | undefined
7787
+ noiseaware_metadata?:
7788
+ | {
7789
+ device_model: 'indoor' | 'outdoor'
7790
+ noise_level_nrs: number
7791
+ noise_level_decibel: number
7792
+ device_name: string
7793
+ device_id: string
7794
+ }
7795
+ | undefined
7796
+ minut_metadata?:
7797
+ | {
7798
+ device_id: string
7799
+ device_name: string
7800
+ latest_sensor_values: {
7801
+ temperature: {
7802
+ time: string
7803
+ value: number
7804
+ }
7805
+ sound: {
7806
+ time: string
7807
+ value: number
7808
+ }
7809
+ humidity: {
7810
+ time: string
7811
+ value: number
7812
+ }
7813
+ pressure: {
7814
+ time: string
7815
+ value: number
7816
+ }
7817
+ accelerometer_z: {
7818
+ time: string
7819
+ value: number
7820
+ }
7821
+ }
7822
+ }
7823
+ | undefined
7824
+ four_suites_metadata?:
7825
+ | {
7826
+ device_id: number
7827
+ device_name: string
7828
+ reclose_delay_in_seconds: number
7829
+ }
7830
+ | undefined
7831
+ two_n_metadata?:
7832
+ | {
7833
+ device_id: number
7834
+ device_name: string
7835
+ }
7836
+ | undefined
7837
+ controlbyweb_metadata?:
7838
+ | {
7839
+ device_id: string
7840
+ device_name: string
7841
+ relay_name: string | null
7842
+ }
7843
+ | undefined
7844
+ ttlock_metadata?:
7845
+ | {
7846
+ lock_id: number
7847
+ lock_alias: string
7848
+ }
7849
+ | undefined
7850
+ seam_bridge_metadata?:
7851
+ | {
7852
+ unlock_method?: ('bridge' | 'doorking') | undefined
7853
+ device_num: number
7854
+ name: string
7855
+ }
7856
+ | undefined
7857
+ igloohome_metadata?:
7858
+ | {
7859
+ device_id: string
7860
+ device_name: string
7861
+ bridge_id?: string | undefined
7862
+ bridge_name?: string | undefined
7863
+ }
7864
+ | undefined
7865
+ nest_metadata?:
7866
+ | {
7867
+ nest_device_id: string
7868
+ device_name: string
7869
+ custom_name: string
7870
+ }
7871
+ | undefined
7872
+ ecobee_metadata?:
7873
+ | {
7874
+ ecobee_device_id: string
7875
+ device_name: string
7876
+ }
7877
+ | undefined
7878
+ hubitat_metadata?:
7879
+ | {
7880
+ device_id: string
7881
+ device_name: string
7882
+ device_label: string
7883
+ }
7884
+ | undefined
7885
+ dormakaba_oracode_metadata?:
7886
+ | {
7887
+ door_id: number
7888
+ door_name: string
7889
+ device_id?: number | undefined
7890
+ site_id: number
7891
+ site_name: string
7892
+ iana_timezone?: string | undefined
7893
+ predefined_time_slots?:
7894
+ | Array<{
7895
+ name: string
7896
+ prefix: number
7897
+ check_in_time: string
7898
+ check_out_time: string
7899
+ is_24_hour: boolean
7900
+ is_biweekly_mode: boolean
7901
+ is_one_shot: boolean
7902
+ is_master: boolean
7903
+ ext_dormakaba_oracode_user_level_prefix: number
7904
+ dormakaba_oracode_user_level_id: string
7905
+ }>
7906
+ | undefined
7907
+ }
7908
+ | undefined
7909
+ wyze_metadata?:
7910
+ | {
7911
+ device_id: string
7912
+ device_name: string
7913
+ product_name: string
7914
+ product_type: string
7915
+ product_model: string
7916
+ device_info_model: string
7917
+ }
7918
+ | undefined
7919
+ }) &
7920
+ ({
7921
+ code_constraints?:
7922
+ | (
7923
+ | Array<
7924
+ | {
7925
+ constraint_type:
7926
+ | 'no_zeros'
7927
+ | 'cannot_start_with_12'
7928
+ | 'no_triple_consecutive_ints'
7929
+ | 'cannot_specify_pin_code'
7930
+ | 'pin_code_matches_existing_set'
7931
+ | 'start_date_in_future'
7932
+ }
7933
+ | {
7934
+ constraint_type: 'name_length'
7935
+ min_length?: number | undefined
7936
+ max_length?: number | undefined
7937
+ }
7938
+ >
7939
+ | undefined
7940
+ )
7941
+ | undefined
7942
+ supported_code_lengths?: (number[] | undefined) | undefined
7943
+ max_active_codes_supported?: (number | undefined) | undefined
7944
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined
7945
+ has_native_entry_events?: (boolean | undefined) | undefined
7946
+ locked?: (boolean | undefined) | undefined
7947
+ keypad_battery?:
7948
+ | (
7949
+ | {
7950
+ level: number
7951
+ }
7952
+ | undefined
7953
+ )
7954
+ | undefined
7955
+ door_open?: (boolean | undefined) | undefined
7956
+ } & (
7957
+ | {
7958
+ temperature_fahrenheit?: number | undefined
7959
+ temperature_celsius?: number | undefined
7960
+ relative_humidity?: number | undefined
7961
+ can_enable_automatic_heating?: boolean | undefined
7962
+ can_enable_automatic_cooling?: boolean | undefined
7963
+ available_hvac_mode_settings?:
7964
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
7965
+ | undefined
7966
+ is_heating_available?: true | undefined
7967
+ is_cooling_available?: true | undefined
7968
+ is_heating?: boolean | undefined
7969
+ is_cooling?: boolean | undefined
7970
+ is_fan_running?: boolean | undefined
7971
+ fan_mode_setting?: ('auto' | 'on') | undefined
7972
+ is_temporary_manual_override_active?: boolean | undefined
7973
+ current_climate_setting?:
7974
+ | {
7975
+ automatic_heating_enabled: boolean
7976
+ automatic_cooling_enabled: boolean
7977
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
7978
+ cooling_set_point_celsius?: number | undefined
7979
+ heating_set_point_celsius?: number | undefined
7980
+ cooling_set_point_fahrenheit?: number | undefined
7981
+ heating_set_point_fahrenheit?: number | undefined
7982
+ manual_override_allowed: boolean
7983
+ }
7984
+ | undefined
7985
+ default_climate_setting?:
7986
+ | (
7987
+ | {
7988
+ automatic_heating_enabled: boolean
7989
+ automatic_cooling_enabled: boolean
7990
+ hvac_mode_setting:
7991
+ | 'off'
7992
+ | 'heat'
7993
+ | 'cool'
7994
+ | 'heat_cool'
7995
+ cooling_set_point_celsius?: number | undefined
7996
+ heating_set_point_celsius?: number | undefined
7997
+ cooling_set_point_fahrenheit?: number | undefined
7998
+ heating_set_point_fahrenheit?: number | undefined
7999
+ manual_override_allowed: boolean
8000
+ }
8001
+ | undefined
8002
+ )
8003
+ | undefined
8004
+ is_climate_setting_schedule_active?: boolean | undefined
8005
+ active_climate_setting_schedule?:
8006
+ | (
8007
+ | {
8008
+ climate_setting_schedule_id: string
8009
+ schedule_type: 'time_bound'
8010
+ device_id: string
8011
+ name?: string | undefined
8012
+ schedule_starts_at: string
8013
+ schedule_ends_at: string
8014
+ created_at: string
8015
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8016
+ errors?: any
8017
+ automatic_heating_enabled?: boolean | undefined
8018
+ automatic_cooling_enabled?: boolean | undefined
8019
+ hvac_mode_setting?:
8020
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
8021
+ | undefined
8022
+ cooling_set_point_celsius?:
8023
+ | (number | undefined)
8024
+ | undefined
8025
+ heating_set_point_celsius?:
8026
+ | (number | undefined)
8027
+ | undefined
8028
+ cooling_set_point_fahrenheit?:
8029
+ | (number | undefined)
8030
+ | undefined
8031
+ heating_set_point_fahrenheit?:
8032
+ | (number | undefined)
8033
+ | undefined
8034
+ manual_override_allowed?: boolean | undefined
8035
+ }
8036
+ | undefined
8037
+ )
8038
+ | undefined
8039
+ min_cooling_set_point_celsius?: number | undefined
8040
+ min_cooling_set_point_fahrenheit?: number | undefined
8041
+ max_cooling_set_point_celsius?: number | undefined
8042
+ max_cooling_set_point_fahrenheit?: number | undefined
8043
+ min_heating_set_point_celsius?: number | undefined
8044
+ min_heating_set_point_fahrenheit?: number | undefined
8045
+ max_heating_set_point_celsius?: number | undefined
8046
+ max_heating_set_point_fahrenheit?: number | undefined
8047
+ min_heating_cooling_delta_celsius?: number | undefined
8048
+ min_heating_cooling_delta_fahrenheit?: number | undefined
8049
+ }
8050
+ | {
8051
+ temperature_fahrenheit?: number | undefined
8052
+ temperature_celsius?: number | undefined
8053
+ relative_humidity?: number | undefined
8054
+ can_enable_automatic_heating?: boolean | undefined
8055
+ can_enable_automatic_cooling?: boolean | undefined
8056
+ available_hvac_mode_settings?:
8057
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
8058
+ | undefined
8059
+ is_heating_available?: true | undefined
8060
+ is_cooling_available?: false | undefined
8061
+ is_heating?: boolean | undefined
8062
+ is_cooling?: boolean | undefined
8063
+ is_fan_running?: boolean | undefined
8064
+ fan_mode_setting?: ('auto' | 'on') | undefined
8065
+ is_temporary_manual_override_active?: boolean | undefined
8066
+ current_climate_setting?:
8067
+ | {
8068
+ automatic_heating_enabled: boolean
8069
+ automatic_cooling_enabled: boolean
8070
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
8071
+ cooling_set_point_celsius?: number | undefined
8072
+ heating_set_point_celsius?: number | undefined
8073
+ cooling_set_point_fahrenheit?: number | undefined
8074
+ heating_set_point_fahrenheit?: number | undefined
8075
+ manual_override_allowed: boolean
8076
+ }
8077
+ | undefined
8078
+ default_climate_setting?:
8079
+ | (
8080
+ | {
8081
+ automatic_heating_enabled: boolean
8082
+ automatic_cooling_enabled: boolean
8083
+ hvac_mode_setting:
8084
+ | 'off'
8085
+ | 'heat'
8086
+ | 'cool'
8087
+ | 'heat_cool'
8088
+ cooling_set_point_celsius?: number | undefined
8089
+ heating_set_point_celsius?: number | undefined
8090
+ cooling_set_point_fahrenheit?: number | undefined
8091
+ heating_set_point_fahrenheit?: number | undefined
8092
+ manual_override_allowed: boolean
8093
+ }
8094
+ | undefined
8095
+ )
8096
+ | undefined
8097
+ is_climate_setting_schedule_active?: boolean | undefined
8098
+ active_climate_setting_schedule?:
8099
+ | (
8100
+ | {
8101
+ climate_setting_schedule_id: string
8102
+ schedule_type: 'time_bound'
8103
+ device_id: string
8104
+ name?: string | undefined
8105
+ schedule_starts_at: string
8106
+ schedule_ends_at: string
8107
+ created_at: string
8108
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8109
+ errors?: any
8110
+ automatic_heating_enabled?: boolean | undefined
8111
+ automatic_cooling_enabled?: boolean | undefined
8112
+ hvac_mode_setting?:
8113
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
8114
+ | undefined
8115
+ cooling_set_point_celsius?:
8116
+ | (number | undefined)
8117
+ | undefined
8118
+ heating_set_point_celsius?:
8119
+ | (number | undefined)
8120
+ | undefined
8121
+ cooling_set_point_fahrenheit?:
8122
+ | (number | undefined)
8123
+ | undefined
8124
+ heating_set_point_fahrenheit?:
8125
+ | (number | undefined)
8126
+ | undefined
8127
+ manual_override_allowed?: boolean | undefined
8128
+ }
8129
+ | undefined
8130
+ )
8131
+ | undefined
8132
+ min_heating_set_point_celsius?: number | undefined
8133
+ min_heating_set_point_fahrenheit?: number | undefined
8134
+ max_heating_set_point_celsius?: number | undefined
8135
+ max_heating_set_point_fahrenheit?: number | undefined
8136
+ }
8137
+ | {
8138
+ temperature_fahrenheit?: number | undefined
8139
+ temperature_celsius?: number | undefined
8140
+ relative_humidity?: number | undefined
8141
+ can_enable_automatic_heating?: boolean | undefined
8142
+ can_enable_automatic_cooling?: boolean | undefined
8143
+ available_hvac_mode_settings?:
8144
+ | Array<'off' | 'heat' | 'cool' | 'heat_cool'>
8145
+ | undefined
8146
+ is_heating_available?: false | undefined
8147
+ is_cooling_available?: true | undefined
8148
+ is_heating?: boolean | undefined
8149
+ is_cooling?: boolean | undefined
8150
+ is_fan_running?: boolean | undefined
8151
+ fan_mode_setting?: ('auto' | 'on') | undefined
8152
+ is_temporary_manual_override_active?: boolean | undefined
8153
+ current_climate_setting?:
8154
+ | {
8155
+ automatic_heating_enabled: boolean
8156
+ automatic_cooling_enabled: boolean
8157
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool'
8158
+ cooling_set_point_celsius?: number | undefined
8159
+ heating_set_point_celsius?: number | undefined
8160
+ cooling_set_point_fahrenheit?: number | undefined
8161
+ heating_set_point_fahrenheit?: number | undefined
8162
+ manual_override_allowed: boolean
8163
+ }
8164
+ | undefined
8165
+ default_climate_setting?:
8166
+ | (
8167
+ | {
8168
+ automatic_heating_enabled: boolean
8169
+ automatic_cooling_enabled: boolean
8170
+ hvac_mode_setting:
8171
+ | 'off'
8172
+ | 'heat'
8173
+ | 'cool'
8174
+ | 'heat_cool'
8175
+ cooling_set_point_celsius?: number | undefined
8176
+ heating_set_point_celsius?: number | undefined
8177
+ cooling_set_point_fahrenheit?: number | undefined
8178
+ heating_set_point_fahrenheit?: number | undefined
8179
+ manual_override_allowed: boolean
8180
+ }
8181
+ | undefined
8182
+ )
8183
+ | undefined
8184
+ is_climate_setting_schedule_active?: boolean | undefined
8185
+ active_climate_setting_schedule?:
8186
+ | (
8187
+ | {
8188
+ climate_setting_schedule_id: string
8189
+ schedule_type: 'time_bound'
8190
+ device_id: string
8191
+ name?: string | undefined
8192
+ schedule_starts_at: string
8193
+ schedule_ends_at: string
8194
+ created_at: string
8195
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8196
+ errors?: any
8197
+ automatic_heating_enabled?: boolean | undefined
8198
+ automatic_cooling_enabled?: boolean | undefined
8199
+ hvac_mode_setting?:
8200
+ | ('off' | 'heat' | 'cool' | 'heat_cool')
8201
+ | undefined
8202
+ cooling_set_point_celsius?:
8203
+ | (number | undefined)
8204
+ | undefined
8205
+ heating_set_point_celsius?:
8206
+ | (number | undefined)
8207
+ | undefined
8208
+ cooling_set_point_fahrenheit?:
8209
+ | (number | undefined)
8210
+ | undefined
8211
+ heating_set_point_fahrenheit?:
8212
+ | (number | undefined)
8213
+ | undefined
8214
+ manual_override_allowed?: boolean | undefined
8215
+ }
8216
+ | undefined
8217
+ )
8218
+ | undefined
8219
+ min_cooling_set_point_celsius?: number | undefined
8220
+ min_cooling_set_point_fahrenheit?: number | undefined
8221
+ max_cooling_set_point_celsius?: number | undefined
8222
+ max_cooling_set_point_fahrenheit?: number | undefined
8223
+ }
8224
+ ))) & {
8225
+ assa_abloy_credential_service_metadata?:
8226
+ | (
8227
+ | {
8228
+ has_active_endpoint: boolean
8229
+ endpoints: Array<{
8230
+ endpoint_id: string
8231
+ is_active: boolean
8232
+ }>
8233
+ }
8234
+ | undefined
8235
+ )
8236
+ | undefined
8237
+ }
8238
+ /** Location information for the device. */
8239
+ location: {
8240
+ /** Name of the device location. */
8241
+ location_name?: string | undefined
8242
+ /** Time zone of the device location. */
8243
+ timezone?: string | undefined
8244
+ } | null
8245
+ /** Unique identifier for the Seam workspace associated with the device. */
8246
+ workspace_id: string
8247
+ /** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
8248
+ errors: Array<{
8249
+ error_code: string
8250
+ message: string
8251
+ }>
8252
+ /** 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. */
8253
+ warnings: Array<{
8254
+ warning_code: string
8255
+ message: string
8256
+ }>
8257
+ /** Date and time at which the device object was created. */
8258
+ created_at: string
8259
+ /** Indicates whether Seam manages the device. */
8260
+ is_managed: true
8261
+ assa_abloy_credential_service_metadata?:
8262
+ | {
8263
+ has_active_endpoint: boolean
8264
+ endpoints: Array<{
8265
+ endpoint_id: string
8266
+ is_active: boolean
8267
+ }>
8268
+ }
8269
+ | undefined
8270
+ }
8271
+ }
8272
+ }
8273
+ '/thermostats/climate_setting_schedules/create': {
8274
+ route: '/thermostats/climate_setting_schedules/create'
8275
+ method: 'POST'
8276
+ queryParams: {}
8277
+ jsonBody: {
8278
+ schedule_type?: 'time_bound'
8279
+ device_id: string
8280
+ name?: string | undefined
8281
+ schedule_starts_at: string
8282
+ schedule_ends_at: string
8283
+ automatic_heating_enabled?: boolean | undefined
8284
+ automatic_cooling_enabled?: boolean | undefined
8285
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8286
+ cooling_set_point_celsius?: (number | undefined) | undefined
8287
+ heating_set_point_celsius?: (number | undefined) | undefined
8288
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
8289
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
8290
+ manual_override_allowed?: boolean | undefined
8291
+ }
8292
+ commonParams: {}
8293
+ formData: {}
8294
+ jsonResponse: {
8295
+ climate_setting_schedule: {
8296
+ climate_setting_schedule_id: string
8297
+ schedule_type: 'time_bound'
8298
+ device_id: string
8299
+ name?: string | undefined
8300
+ schedule_starts_at: string
8301
+ schedule_ends_at: string
8302
+ created_at: string
8303
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8304
+ errors?: any
8305
+ automatic_heating_enabled?: boolean | undefined
8306
+ automatic_cooling_enabled?: boolean | undefined
8307
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8308
+ cooling_set_point_celsius?: (number | undefined) | undefined
8309
+ heating_set_point_celsius?: (number | undefined) | undefined
8310
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
8311
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
8312
+ manual_override_allowed?: boolean | undefined
8313
+ }
8314
+ }
8315
+ }
8316
+ '/thermostats/climate_setting_schedules/delete': {
8317
+ route: '/thermostats/climate_setting_schedules/delete'
8318
+ method: 'DELETE' | 'POST' | 'PUT'
8319
+ queryParams: {}
8320
+ jsonBody: {}
8321
+ commonParams: {
8322
+ climate_setting_schedule_id: string
8323
+ }
8324
+ formData: {}
8325
+ jsonResponse: {}
8326
+ }
8327
+ '/thermostats/climate_setting_schedules/get': {
8328
+ route: '/thermostats/climate_setting_schedules/get'
8329
+ method: 'GET' | 'POST'
8330
+ queryParams: {}
8331
+ jsonBody: {}
8332
+ commonParams: {
8333
+ climate_setting_schedule_id?: string | undefined
8334
+ device_id?: string | undefined
8335
+ }
8336
+ formData: {}
8337
+ jsonResponse: {
8338
+ climate_setting_schedule: {
8339
+ climate_setting_schedule_id: string
8340
+ schedule_type: 'time_bound'
8341
+ device_id: string
8342
+ name?: string | undefined
8343
+ schedule_starts_at: string
8344
+ schedule_ends_at: string
8345
+ created_at: string
8346
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8347
+ errors?: any
8348
+ automatic_heating_enabled?: boolean | undefined
8349
+ automatic_cooling_enabled?: boolean | undefined
8350
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8351
+ cooling_set_point_celsius?: (number | undefined) | undefined
8352
+ heating_set_point_celsius?: (number | undefined) | undefined
8353
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
8354
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
8355
+ manual_override_allowed?: boolean | undefined
8356
+ }
8357
+ }
8358
+ }
8359
+ '/thermostats/climate_setting_schedules/list': {
8360
+ route: '/thermostats/climate_setting_schedules/list'
8361
+ method: 'GET' | 'POST'
8362
+ queryParams: {}
8363
+ jsonBody: {}
8364
+ commonParams: {
8365
+ device_id: string
8366
+ user_identifier_key?: string | undefined
8367
+ }
8368
+ formData: {}
8369
+ jsonResponse: {
8370
+ climate_setting_schedules: Array<{
8371
+ climate_setting_schedule_id: string
8372
+ schedule_type: 'time_bound'
8373
+ device_id: string
8374
+ name?: string | undefined
8375
+ schedule_starts_at: string
8376
+ schedule_ends_at: string
8377
+ created_at: string
8378
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8379
+ errors?: any
8380
+ automatic_heating_enabled?: boolean | undefined
8381
+ automatic_cooling_enabled?: boolean | undefined
8382
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8383
+ cooling_set_point_celsius?: (number | undefined) | undefined
8384
+ heating_set_point_celsius?: (number | undefined) | undefined
8385
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
8386
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
8387
+ manual_override_allowed?: boolean | undefined
8388
+ }>
8389
+ }
8390
+ }
8391
+ '/thermostats/climate_setting_schedules/update': {
8392
+ route: '/thermostats/climate_setting_schedules/update'
8393
+ method: 'PATCH' | 'POST' | 'PUT'
8394
+ queryParams: {}
8395
+ jsonBody: {
8396
+ climate_setting_schedule_id: string
8397
+ schedule_type?: 'time_bound'
8398
+ name?: string | undefined
8399
+ schedule_starts_at?: string | undefined
8400
+ schedule_ends_at?: string | undefined
8401
+ automatic_heating_enabled?: boolean | undefined
8402
+ automatic_cooling_enabled?: boolean | undefined
8403
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8404
+ cooling_set_point_celsius?: (number | undefined) | undefined
8405
+ heating_set_point_celsius?: (number | undefined) | undefined
8406
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
8407
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
8408
+ manual_override_allowed?: boolean | undefined
8409
+ }
8410
+ commonParams: {}
8411
+ formData: {}
8412
+ jsonResponse: {
8413
+ climate_setting_schedule: {
8414
+ climate_setting_schedule_id: string
8415
+ schedule_type: 'time_bound'
8416
+ device_id: string
8417
+ name?: string | undefined
8418
+ schedule_starts_at: string
8419
+ schedule_ends_at: string
8420
+ created_at: string
8421
+ /** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
8422
+ errors?: any
8423
+ automatic_heating_enabled?: boolean | undefined
8424
+ automatic_cooling_enabled?: boolean | undefined
8425
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined
8426
+ cooling_set_point_celsius?: (number | undefined) | undefined
8427
+ heating_set_point_celsius?: (number | undefined) | undefined
8428
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
8429
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
8430
+ manual_override_allowed?: boolean | undefined
8431
+ }
8432
+ }
8433
+ }
8434
+ '/thermostats/cool': {
8435
+ route: '/thermostats/cool'
8436
+ method: 'POST'
8437
+ queryParams: {}
8438
+ jsonBody: {
8439
+ device_id: string
8440
+ cooling_set_point_celsius?: number | undefined
8441
+ cooling_set_point_fahrenheit?: number | undefined
8442
+ sync?: boolean
8443
+ }
8444
+ commonParams: {}
8445
+ formData: {}
8446
+ jsonResponse: {}
8447
+ }
8448
+ '/thermostats/get': {
8449
+ route: '/thermostats/get'
8450
+ method: 'GET' | 'POST'
8451
+ queryParams: {}
8452
+ jsonBody: {}
8453
+ commonParams: {
8454
+ device_id?: string | undefined
8455
+ name?: string | undefined
8456
+ }
8457
+ formData: {}
8458
+ jsonResponse: {
8459
+ thermostat: {
8460
+ /** Unique identifier for the device. */
8461
+ device_id: string
8462
+ /** Type of the device. */
8463
+ device_type:
8464
+ | (
8465
+ | 'akuvox_lock'
8466
+ | 'august_lock'
8467
+ | 'brivo_access_point'
8468
+ | 'butterflymx_panel'
8469
+ | 'avigilon_alta_entry'
8470
+ | 'doorking_lock'
7058
8471
  | 'genie_door'
7059
8472
  | 'igloo_lock'
7060
8473
  | 'linear_lock'
@@ -7088,7 +8501,7 @@ export interface Routes {
7088
8501
  | 'phone'
7089
8502
  >
7090
8503
  /** Properties of the device. */
7091
- properties: ({
8504
+ properties: (({
7092
8505
  /** Indicates whether the device is online. */
7093
8506
  online: boolean
7094
8507
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -7656,7 +9069,20 @@ export interface Routes {
7656
9069
  max_cooling_set_point_celsius?: number | undefined
7657
9070
  max_cooling_set_point_fahrenheit?: number | undefined
7658
9071
  }
7659
- ))
9072
+ ))) & {
9073
+ assa_abloy_credential_service_metadata?:
9074
+ | (
9075
+ | {
9076
+ has_active_endpoint: boolean
9077
+ endpoints: Array<{
9078
+ endpoint_id: string
9079
+ is_active: boolean
9080
+ }>
9081
+ }
9082
+ | undefined
9083
+ )
9084
+ | undefined
9085
+ }
7660
9086
  /** Location information for the device. */
7661
9087
  location: {
7662
9088
  /** Name of the device location. */
@@ -7881,7 +9307,7 @@ export interface Routes {
7881
9307
  | 'phone'
7882
9308
  >
7883
9309
  /** Properties of the device. */
7884
- properties: ({
9310
+ properties: (({
7885
9311
  /** Indicates whether the device is online. */
7886
9312
  online: boolean
7887
9313
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -8449,7 +9875,20 @@ export interface Routes {
8449
9875
  max_cooling_set_point_celsius?: number | undefined
8450
9876
  max_cooling_set_point_fahrenheit?: number | undefined
8451
9877
  }
8452
- ))
9878
+ ))) & {
9879
+ assa_abloy_credential_service_metadata?:
9880
+ | (
9881
+ | {
9882
+ has_active_endpoint: boolean
9883
+ endpoints: Array<{
9884
+ endpoint_id: string
9885
+ is_active: boolean
9886
+ }>
9887
+ }
9888
+ | undefined
9889
+ )
9890
+ | undefined
9891
+ }
8453
9892
  /** Location information for the device. */
8454
9893
  location: {
8455
9894
  /** Name of the device location. */
@@ -8561,6 +10000,25 @@ export interface Routes {
8561
10000
  }
8562
10001
  }
8563
10002
  }
10003
+ '/user_identities/enrollment_automations/get': {
10004
+ route: '/user_identities/enrollment_automations/get'
10005
+ method: 'GET' | 'POST'
10006
+ queryParams: {}
10007
+ jsonBody: {}
10008
+ commonParams: {
10009
+ enrollment_automation_id: string
10010
+ }
10011
+ formData: {}
10012
+ jsonResponse: {
10013
+ enrollment_automation: {
10014
+ credential_manager_acs_system_id: string
10015
+ user_identity_id: string
10016
+ created_at: string
10017
+ workspace_id: string
10018
+ enrollment_automation_id: string
10019
+ }
10020
+ }
10021
+ }
8564
10022
  '/user_identities/enrollment_automations/launch': {
8565
10023
  route: '/user_identities/enrollment_automations/launch'
8566
10024
  method: 'POST'
@@ -8585,6 +10043,25 @@ export interface Routes {
8585
10043
  }
8586
10044
  }
8587
10045
  }
10046
+ '/user_identities/enrollment_automations/list': {
10047
+ route: '/user_identities/enrollment_automations/list'
10048
+ method: 'GET' | 'POST'
10049
+ queryParams: {}
10050
+ jsonBody: {}
10051
+ commonParams: {
10052
+ user_identity_id: string
10053
+ }
10054
+ formData: {}
10055
+ jsonResponse: {
10056
+ enrollment_automations: Array<{
10057
+ credential_manager_acs_system_id: string
10058
+ user_identity_id: string
10059
+ created_at: string
10060
+ workspace_id: string
10061
+ enrollment_automation_id: string
10062
+ }>
10063
+ }
10064
+ }
8588
10065
  '/user_identities/get': {
8589
10066
  route: '/user_identities/get'
8590
10067
  method: 'GET' | 'POST'
@@ -8696,7 +10173,7 @@ export interface Routes {
8696
10173
  | 'phone'
8697
10174
  >
8698
10175
  /** Properties of the device. */
8699
- properties: ({
10176
+ properties: (({
8700
10177
  /** Indicates whether the device is online. */
8701
10178
  online: boolean
8702
10179
  /** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
@@ -9264,7 +10741,20 @@ export interface Routes {
9264
10741
  max_cooling_set_point_celsius?: number | undefined
9265
10742
  max_cooling_set_point_fahrenheit?: number | undefined
9266
10743
  }
9267
- ))
10744
+ ))) & {
10745
+ assa_abloy_credential_service_metadata?:
10746
+ | (
10747
+ | {
10748
+ has_active_endpoint: boolean
10749
+ endpoints: Array<{
10750
+ endpoint_id: string
10751
+ is_active: boolean
10752
+ }>
10753
+ }
10754
+ | undefined
10755
+ )
10756
+ | undefined
10757
+ }
9268
10758
  /** Location information for the device. */
9269
10759
  location: {
9270
10760
  /** Name of the device location. */