@seamapi/types 1.207.0 → 1.209.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.
@@ -650,6 +650,19 @@ type AcsSystem = z.output<typeof acs_system>;
650
650
 
651
651
  declare const acs_user: z.ZodObject<{
652
652
  created_at: z.ZodString;
653
+ warnings: z.ZodArray<z.ZodObject<{
654
+ message: z.ZodString;
655
+ created_at: z.ZodString;
656
+ warning_code: z.ZodLiteral<"being_deleted">;
657
+ }, "strip", z.ZodTypeAny, {
658
+ message: string;
659
+ warning_code: "being_deleted";
660
+ created_at: string;
661
+ }, {
662
+ message: string;
663
+ warning_code: "being_deleted";
664
+ created_at: string;
665
+ }>, "many">;
653
666
  display_name: z.ZodString;
654
667
  workspace_id: z.ZodString;
655
668
  acs_system_id: z.ZodString;
@@ -680,6 +693,11 @@ declare const acs_user: z.ZodObject<{
680
693
  phone_number: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>;
681
694
  }, "strip", z.ZodTypeAny, {
682
695
  created_at: string;
696
+ warnings: {
697
+ message: string;
698
+ warning_code: "being_deleted";
699
+ created_at: string;
700
+ }[];
683
701
  display_name: string;
684
702
  workspace_id: string;
685
703
  acs_system_id: string;
@@ -704,6 +722,11 @@ declare const acs_user: z.ZodObject<{
704
722
  phone_number?: string | undefined;
705
723
  }, {
706
724
  created_at: string;
725
+ warnings: {
726
+ message: string;
727
+ warning_code: "being_deleted";
728
+ created_at: string;
729
+ }[];
707
730
  display_name: string;
708
731
  workspace_id: string;
709
732
  acs_system_id: string;
@@ -8555,6 +8578,26 @@ declare const _default: {
8555
8578
  nullable: boolean;
8556
8579
  type: string;
8557
8580
  };
8581
+ warnings: {
8582
+ items: {
8583
+ properties: {
8584
+ created_at: {
8585
+ format: string;
8586
+ type: string;
8587
+ };
8588
+ message: {
8589
+ type: string;
8590
+ };
8591
+ warning_code: {
8592
+ enum: string[];
8593
+ type: string;
8594
+ };
8595
+ };
8596
+ required: string[];
8597
+ type: string;
8598
+ };
8599
+ type: string;
8600
+ };
8558
8601
  workspace_id: {
8559
8602
  format: string;
8560
8603
  type: string;
@@ -19759,7 +19802,7 @@ declare const _default: {
19759
19802
  'x-fern-sdk-return-value': string;
19760
19803
  };
19761
19804
  };
19762
- '/noise_sensors/noise_thresholds/create': {
19805
+ '/noise_sensors/list': {
19763
19806
  post: {
19764
19807
  operationId: string;
19765
19808
  requestBody: {
@@ -19767,33 +19810,83 @@ declare const _default: {
19767
19810
  'application/json': {
19768
19811
  schema: {
19769
19812
  properties: {
19770
- device_id: {
19813
+ connect_webview_id: {
19771
19814
  format: string;
19772
19815
  type: string;
19773
19816
  };
19774
- ends_daily_at: {
19817
+ connected_account_id: {
19818
+ description: string;
19819
+ format: string;
19775
19820
  type: string;
19776
19821
  };
19777
- name: {
19822
+ connected_account_ids: {
19823
+ items: {
19824
+ format: string;
19825
+ type: string;
19826
+ };
19778
19827
  type: string;
19779
19828
  };
19780
- noise_threshold_decibels: {
19829
+ created_before: {
19781
19830
  format: string;
19782
19831
  type: string;
19783
19832
  };
19784
- noise_threshold_nrs: {
19833
+ custom_metadata_has: {
19834
+ additionalProperties: {
19835
+ oneOf: {
19836
+ type: string;
19837
+ }[];
19838
+ };
19839
+ type: string;
19840
+ };
19841
+ device_ids: {
19842
+ items: {
19843
+ format: string;
19844
+ type: string;
19845
+ };
19846
+ type: string;
19847
+ };
19848
+ device_type: {
19849
+ oneOf: {
19850
+ enum: string[];
19851
+ type: string;
19852
+ }[];
19853
+ };
19854
+ device_types: {
19855
+ items: {
19856
+ oneOf: {
19857
+ enum: string[];
19858
+ type: string;
19859
+ }[];
19860
+ };
19861
+ type: string;
19862
+ };
19863
+ exclude_if: {
19864
+ items: {
19865
+ enum: string[];
19866
+ type: string;
19867
+ };
19868
+ type: string;
19869
+ };
19870
+ include_if: {
19871
+ items: {
19872
+ enum: string[];
19873
+ type: string;
19874
+ };
19875
+ type: string;
19876
+ };
19877
+ limit: {
19878
+ default: number;
19785
19879
  format: string;
19786
19880
  type: string;
19787
19881
  };
19788
- starts_daily_at: {
19882
+ manufacturer: {
19883
+ enum: string[];
19789
19884
  type: string;
19790
19885
  };
19791
- sync: {
19792
- default: boolean;
19886
+ user_identifier_key: {
19793
19887
  type: string;
19794
19888
  };
19795
19889
  };
19796
- required: string[];
19797
19890
  type: string;
19798
19891
  };
19799
19892
  };
@@ -19805,11 +19898,17 @@ declare const _default: {
19805
19898
  'application/json': {
19806
19899
  schema: {
19807
19900
  properties: {
19808
- action_attempt: {
19809
- $ref: string;
19901
+ devices: {
19902
+ items: {
19903
+ $ref: string;
19904
+ };
19905
+ type: string;
19810
19906
  };
19811
- noise_threshold: {
19812
- $ref: string;
19907
+ noise_sensors: {
19908
+ items: {
19909
+ $ref: string;
19910
+ };
19911
+ type: string;
19813
19912
  };
19814
19913
  ok: {
19815
19914
  type: string;
@@ -19830,17 +19929,25 @@ declare const _default: {
19830
19929
  };
19831
19930
  };
19832
19931
  security: ({
19833
- api_key: never[];
19932
+ client_session: never[];
19834
19933
  pat_with_workspace?: never;
19835
19934
  console_session?: never;
19935
+ api_key?: never;
19836
19936
  } | {
19837
19937
  pat_with_workspace: never[];
19838
- api_key?: never;
19938
+ client_session?: never;
19839
19939
  console_session?: never;
19940
+ api_key?: never;
19840
19941
  } | {
19841
19942
  console_session: never[];
19943
+ client_session?: never;
19944
+ pat_with_workspace?: never;
19842
19945
  api_key?: never;
19946
+ } | {
19947
+ api_key: never[];
19948
+ client_session?: never;
19843
19949
  pat_with_workspace?: never;
19950
+ console_session?: never;
19844
19951
  })[];
19845
19952
  summary: string;
19846
19953
  tags: string[];
@@ -19849,7 +19956,7 @@ declare const _default: {
19849
19956
  'x-fern-sdk-return-value': string;
19850
19957
  };
19851
19958
  };
19852
- '/noise_sensors/noise_thresholds/delete': {
19959
+ '/noise_sensors/noise_thresholds/create': {
19853
19960
  post: {
19854
19961
  operationId: string;
19855
19962
  requestBody: {
@@ -19861,10 +19968,23 @@ declare const _default: {
19861
19968
  format: string;
19862
19969
  type: string;
19863
19970
  };
19864
- noise_threshold_id: {
19971
+ ends_daily_at: {
19972
+ type: string;
19973
+ };
19974
+ name: {
19975
+ type: string;
19976
+ };
19977
+ noise_threshold_decibels: {
19865
19978
  format: string;
19866
19979
  type: string;
19867
19980
  };
19981
+ noise_threshold_nrs: {
19982
+ format: string;
19983
+ type: string;
19984
+ };
19985
+ starts_daily_at: {
19986
+ type: string;
19987
+ };
19868
19988
  sync: {
19869
19989
  default: boolean;
19870
19990
  type: string;
@@ -19885,68 +20005,6 @@ declare const _default: {
19885
20005
  action_attempt: {
19886
20006
  $ref: string;
19887
20007
  };
19888
- ok: {
19889
- type: string;
19890
- };
19891
- };
19892
- required: string[];
19893
- type: string;
19894
- };
19895
- };
19896
- };
19897
- description: string;
19898
- };
19899
- 400: {
19900
- description: string;
19901
- };
19902
- 401: {
19903
- description: string;
19904
- };
19905
- };
19906
- security: ({
19907
- api_key: never[];
19908
- pat_with_workspace?: never;
19909
- console_session?: never;
19910
- } | {
19911
- pat_with_workspace: never[];
19912
- api_key?: never;
19913
- console_session?: never;
19914
- } | {
19915
- console_session: never[];
19916
- api_key?: never;
19917
- pat_with_workspace?: never;
19918
- })[];
19919
- summary: string;
19920
- tags: string[];
19921
- 'x-fern-sdk-group-name': string[];
19922
- 'x-fern-sdk-method-name': string;
19923
- };
19924
- };
19925
- '/noise_sensors/noise_thresholds/get': {
19926
- post: {
19927
- operationId: string;
19928
- requestBody: {
19929
- content: {
19930
- 'application/json': {
19931
- schema: {
19932
- properties: {
19933
- noise_threshold_id: {
19934
- format: string;
19935
- type: string;
19936
- };
19937
- };
19938
- required: string[];
19939
- type: string;
19940
- };
19941
- };
19942
- };
19943
- };
19944
- responses: {
19945
- 200: {
19946
- content: {
19947
- 'application/json': {
19948
- schema: {
19949
- properties: {
19950
20008
  noise_threshold: {
19951
20009
  $ref: string;
19952
20010
  };
@@ -19988,7 +20046,7 @@ declare const _default: {
19988
20046
  'x-fern-sdk-return-value': string;
19989
20047
  };
19990
20048
  };
19991
- '/noise_sensors/noise_thresholds/list': {
20049
+ '/noise_sensors/noise_thresholds/delete': {
19992
20050
  post: {
19993
20051
  operationId: string;
19994
20052
  requestBody: {
@@ -20000,7 +20058,12 @@ declare const _default: {
20000
20058
  format: string;
20001
20059
  type: string;
20002
20060
  };
20003
- is_programmed: {
20061
+ noise_threshold_id: {
20062
+ format: string;
20063
+ type: string;
20064
+ };
20065
+ sync: {
20066
+ default: boolean;
20004
20067
  type: string;
20005
20068
  };
20006
20069
  };
@@ -20016,11 +20079,8 @@ declare const _default: {
20016
20079
  'application/json': {
20017
20080
  schema: {
20018
20081
  properties: {
20019
- noise_thresholds: {
20020
- items: {
20021
- $ref: string;
20022
- };
20023
- type: string;
20082
+ action_attempt: {
20083
+ $ref: string;
20024
20084
  };
20025
20085
  ok: {
20026
20086
  type: string;
@@ -20041,23 +20101,15 @@ declare const _default: {
20041
20101
  };
20042
20102
  };
20043
20103
  security: ({
20044
- client_session: never[];
20045
- api_key?: never;
20046
- pat_with_workspace?: never;
20047
- console_session?: never;
20048
- } | {
20049
20104
  api_key: never[];
20050
- client_session?: never;
20051
20105
  pat_with_workspace?: never;
20052
20106
  console_session?: never;
20053
20107
  } | {
20054
20108
  pat_with_workspace: never[];
20055
- client_session?: never;
20056
20109
  api_key?: never;
20057
20110
  console_session?: never;
20058
20111
  } | {
20059
20112
  console_session: never[];
20060
- client_session?: never;
20061
20113
  api_key?: never;
20062
20114
  pat_with_workspace?: never;
20063
20115
  })[];
@@ -20065,46 +20117,20 @@ declare const _default: {
20065
20117
  tags: string[];
20066
20118
  'x-fern-sdk-group-name': string[];
20067
20119
  'x-fern-sdk-method-name': string;
20068
- 'x-fern-sdk-return-value': string;
20069
20120
  };
20070
20121
  };
20071
- '/noise_sensors/noise_thresholds/update': {
20072
- patch: {
20122
+ '/noise_sensors/noise_thresholds/get': {
20123
+ post: {
20073
20124
  operationId: string;
20074
20125
  requestBody: {
20075
20126
  content: {
20076
20127
  'application/json': {
20077
20128
  schema: {
20078
20129
  properties: {
20079
- device_id: {
20080
- format: string;
20081
- type: string;
20082
- };
20083
- ends_daily_at: {
20084
- type: string;
20085
- };
20086
- name: {
20087
- type: string;
20088
- };
20089
- noise_threshold_decibels: {
20090
- format: string;
20091
- type: string;
20092
- };
20093
20130
  noise_threshold_id: {
20094
20131
  format: string;
20095
20132
  type: string;
20096
20133
  };
20097
- noise_threshold_nrs: {
20098
- format: string;
20099
- type: string;
20100
- };
20101
- starts_daily_at: {
20102
- type: string;
20103
- };
20104
- sync: {
20105
- default: boolean;
20106
- type: string;
20107
- };
20108
20134
  };
20109
20135
  required: string[];
20110
20136
  type: string;
@@ -20118,7 +20144,178 @@ declare const _default: {
20118
20144
  'application/json': {
20119
20145
  schema: {
20120
20146
  properties: {
20121
- action_attempt: {
20147
+ noise_threshold: {
20148
+ $ref: string;
20149
+ };
20150
+ ok: {
20151
+ type: string;
20152
+ };
20153
+ };
20154
+ required: string[];
20155
+ type: string;
20156
+ };
20157
+ };
20158
+ };
20159
+ description: string;
20160
+ };
20161
+ 400: {
20162
+ description: string;
20163
+ };
20164
+ 401: {
20165
+ description: string;
20166
+ };
20167
+ };
20168
+ security: ({
20169
+ api_key: never[];
20170
+ pat_with_workspace?: never;
20171
+ console_session?: never;
20172
+ } | {
20173
+ pat_with_workspace: never[];
20174
+ api_key?: never;
20175
+ console_session?: never;
20176
+ } | {
20177
+ console_session: never[];
20178
+ api_key?: never;
20179
+ pat_with_workspace?: never;
20180
+ })[];
20181
+ summary: string;
20182
+ tags: string[];
20183
+ 'x-fern-sdk-group-name': string[];
20184
+ 'x-fern-sdk-method-name': string;
20185
+ 'x-fern-sdk-return-value': string;
20186
+ };
20187
+ };
20188
+ '/noise_sensors/noise_thresholds/list': {
20189
+ post: {
20190
+ operationId: string;
20191
+ requestBody: {
20192
+ content: {
20193
+ 'application/json': {
20194
+ schema: {
20195
+ properties: {
20196
+ device_id: {
20197
+ format: string;
20198
+ type: string;
20199
+ };
20200
+ is_programmed: {
20201
+ type: string;
20202
+ };
20203
+ };
20204
+ required: string[];
20205
+ type: string;
20206
+ };
20207
+ };
20208
+ };
20209
+ };
20210
+ responses: {
20211
+ 200: {
20212
+ content: {
20213
+ 'application/json': {
20214
+ schema: {
20215
+ properties: {
20216
+ noise_thresholds: {
20217
+ items: {
20218
+ $ref: string;
20219
+ };
20220
+ type: string;
20221
+ };
20222
+ ok: {
20223
+ type: string;
20224
+ };
20225
+ };
20226
+ required: string[];
20227
+ type: string;
20228
+ };
20229
+ };
20230
+ };
20231
+ description: string;
20232
+ };
20233
+ 400: {
20234
+ description: string;
20235
+ };
20236
+ 401: {
20237
+ description: string;
20238
+ };
20239
+ };
20240
+ security: ({
20241
+ client_session: never[];
20242
+ api_key?: never;
20243
+ pat_with_workspace?: never;
20244
+ console_session?: never;
20245
+ } | {
20246
+ api_key: never[];
20247
+ client_session?: never;
20248
+ pat_with_workspace?: never;
20249
+ console_session?: never;
20250
+ } | {
20251
+ pat_with_workspace: never[];
20252
+ client_session?: never;
20253
+ api_key?: never;
20254
+ console_session?: never;
20255
+ } | {
20256
+ console_session: never[];
20257
+ client_session?: never;
20258
+ api_key?: never;
20259
+ pat_with_workspace?: never;
20260
+ })[];
20261
+ summary: string;
20262
+ tags: string[];
20263
+ 'x-fern-sdk-group-name': string[];
20264
+ 'x-fern-sdk-method-name': string;
20265
+ 'x-fern-sdk-return-value': string;
20266
+ };
20267
+ };
20268
+ '/noise_sensors/noise_thresholds/update': {
20269
+ patch: {
20270
+ operationId: string;
20271
+ requestBody: {
20272
+ content: {
20273
+ 'application/json': {
20274
+ schema: {
20275
+ properties: {
20276
+ device_id: {
20277
+ format: string;
20278
+ type: string;
20279
+ };
20280
+ ends_daily_at: {
20281
+ type: string;
20282
+ };
20283
+ name: {
20284
+ type: string;
20285
+ };
20286
+ noise_threshold_decibels: {
20287
+ format: string;
20288
+ type: string;
20289
+ };
20290
+ noise_threshold_id: {
20291
+ format: string;
20292
+ type: string;
20293
+ };
20294
+ noise_threshold_nrs: {
20295
+ format: string;
20296
+ type: string;
20297
+ };
20298
+ starts_daily_at: {
20299
+ type: string;
20300
+ };
20301
+ sync: {
20302
+ default: boolean;
20303
+ type: string;
20304
+ };
20305
+ };
20306
+ required: string[];
20307
+ type: string;
20308
+ };
20309
+ };
20310
+ };
20311
+ };
20312
+ responses: {
20313
+ 200: {
20314
+ content: {
20315
+ 'application/json': {
20316
+ schema: {
20317
+ properties: {
20318
+ action_attempt: {
20122
20319
  $ref: string;
20123
20320
  };
20124
20321
  ok: {
@@ -26698,6 +26895,11 @@ interface Routes {
26698
26895
  user_identity_phone_number?: (string | null) | undefined;
26699
26896
  latest_desired_state_synced_with_provider_at?: string | undefined;
26700
26897
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
26898
+ warnings: Array<{
26899
+ created_at: string;
26900
+ message: string;
26901
+ warning_code: 'being_deleted';
26902
+ }>;
26701
26903
  full_name?: string | undefined;
26702
26904
  /**
26703
26905
  * @deprecated use email_address. */
@@ -27491,6 +27693,11 @@ interface Routes {
27491
27693
  user_identity_phone_number?: (string | null) | undefined;
27492
27694
  latest_desired_state_synced_with_provider_at?: string | undefined;
27493
27695
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
27696
+ warnings: Array<{
27697
+ created_at: string;
27698
+ message: string;
27699
+ warning_code: 'being_deleted';
27700
+ }>;
27494
27701
  full_name?: string | undefined;
27495
27702
  /**
27496
27703
  * @deprecated use email_address. */
@@ -27541,6 +27748,11 @@ interface Routes {
27541
27748
  user_identity_phone_number?: (string | null) | undefined;
27542
27749
  latest_desired_state_synced_with_provider_at?: string | undefined;
27543
27750
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
27751
+ warnings: Array<{
27752
+ created_at: string;
27753
+ message: string;
27754
+ warning_code: 'being_deleted';
27755
+ }>;
27544
27756
  full_name?: string | undefined;
27545
27757
  /**
27546
27758
  * @deprecated use email_address. */
@@ -27585,6 +27797,11 @@ interface Routes {
27585
27797
  user_identity_phone_number?: (string | null) | undefined;
27586
27798
  latest_desired_state_synced_with_provider_at?: string | undefined;
27587
27799
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
27800
+ warnings: Array<{
27801
+ created_at: string;
27802
+ message: string;
27803
+ warning_code: 'being_deleted';
27804
+ }>;
27588
27805
  full_name?: string | undefined;
27589
27806
  /**
27590
27807
  * @deprecated use email_address. */
@@ -33193,318 +33410,1363 @@ interface Routes {
33193
33410
  }>;
33194
33411
  };
33195
33412
  };
33196
- '/noise_sensors/noise_thresholds/create': {
33197
- route: '/noise_sensors/noise_thresholds/create';
33198
- method: 'POST';
33413
+ '/noise_sensors/list': {
33414
+ route: '/noise_sensors/list';
33415
+ method: 'GET' | 'POST';
33199
33416
  queryParams: {};
33200
- jsonBody: {
33201
- device_id: string;
33202
- sync?: boolean;
33203
- name?: string | undefined;
33204
- starts_daily_at: string;
33205
- ends_daily_at: string;
33206
- noise_threshold_decibels?: number | undefined;
33207
- noise_threshold_nrs?: number | undefined;
33417
+ jsonBody: {};
33418
+ commonParams: {
33419
+ /** List all devices owned by this connected account */
33420
+ connected_account_id?: string | undefined;
33421
+ connected_account_ids?: string[] | undefined;
33422
+ connect_webview_id?: string | undefined;
33423
+ device_type?: (('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone')) | undefined;
33424
+ device_types?: Array<('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone')> | undefined;
33425
+ manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'lockly' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'minut' | 'two_n' | 'ttlock' | 'nest' | 'igloohome' | 'ecobee' | 'hubitat' | 'controlbyweb' | 'smartthings' | 'dormakaba_oracode' | 'tedee' | 'honeywell_resideo') | undefined;
33426
+ device_ids?: string[] | undefined;
33427
+ limit?: number;
33428
+ created_before?: Date | undefined;
33429
+ user_identifier_key?: string | undefined;
33430
+ custom_metadata_has?: Record<string, string | boolean> | undefined;
33431
+ include_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
33432
+ exclude_if?: Array<'can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection'> | undefined;
33208
33433
  };
33209
- commonParams: {};
33210
33434
  formData: {};
33211
33435
  jsonResponse: {
33212
- action_attempt: {
33213
- /** The ID of the action attempt. */
33214
- action_attempt_id: string;
33215
- status: 'pending';
33216
- result: null;
33217
- error: null;
33218
- action_type: 'LOCK_DOOR';
33219
- } | {
33220
- /** The ID of the action attempt. */
33221
- action_attempt_id: string;
33222
- status: 'success';
33223
- error: null;
33224
- action_type: 'LOCK_DOOR';
33225
- result: {};
33226
- } | {
33227
- /** The ID of the action attempt. */
33228
- action_attempt_id: string;
33229
- status: 'error';
33230
- result: null;
33231
- action_type: 'LOCK_DOOR';
33232
- error: {
33233
- type: string;
33234
- message: string;
33235
- };
33236
- } | {
33237
- /** The ID of the action attempt. */
33238
- action_attempt_id: string;
33239
- status: 'pending';
33240
- result: null;
33241
- error: null;
33242
- action_type: 'UNLOCK_DOOR';
33243
- } | {
33244
- /** The ID of the action attempt. */
33245
- action_attempt_id: string;
33246
- status: 'success';
33247
- error: null;
33248
- action_type: 'UNLOCK_DOOR';
33249
- result: {};
33250
- } | {
33251
- /** The ID of the action attempt. */
33252
- action_attempt_id: string;
33253
- status: 'error';
33254
- result: null;
33255
- action_type: 'UNLOCK_DOOR';
33256
- error: {
33257
- type: string;
33258
- message: string;
33259
- };
33260
- } | {
33261
- /** The ID of the action attempt. */
33262
- action_attempt_id: string;
33263
- status: 'pending';
33264
- result: null;
33265
- error: null;
33266
- action_type: 'RESET_SANDBOX_WORKSPACE';
33267
- } | {
33268
- /** The ID of the action attempt. */
33269
- action_attempt_id: string;
33270
- status: 'success';
33271
- error: null;
33272
- action_type: 'RESET_SANDBOX_WORKSPACE';
33273
- result: {};
33274
- } | {
33275
- /** The ID of the action attempt. */
33276
- action_attempt_id: string;
33277
- status: 'error';
33278
- result: null;
33279
- action_type: 'RESET_SANDBOX_WORKSPACE';
33280
- error: {
33281
- type: string;
33282
- message: string;
33283
- };
33284
- } | {
33285
- /** The ID of the action attempt. */
33286
- action_attempt_id: string;
33287
- status: 'pending';
33288
- result: null;
33289
- error: null;
33290
- action_type: 'SET_COOL';
33291
- } | {
33292
- /** The ID of the action attempt. */
33293
- action_attempt_id: string;
33294
- status: 'success';
33295
- error: null;
33296
- action_type: 'SET_COOL';
33297
- result: {};
33298
- } | {
33299
- /** The ID of the action attempt. */
33300
- action_attempt_id: string;
33301
- status: 'error';
33302
- result: null;
33303
- action_type: 'SET_COOL';
33304
- error: {
33305
- type: string;
33306
- message: string;
33307
- };
33308
- } | {
33309
- /** The ID of the action attempt. */
33310
- action_attempt_id: string;
33311
- status: 'pending';
33312
- result: null;
33313
- error: null;
33314
- action_type: 'SET_HEAT';
33315
- } | {
33316
- /** The ID of the action attempt. */
33317
- action_attempt_id: string;
33318
- status: 'success';
33319
- error: null;
33320
- action_type: 'SET_HEAT';
33321
- result: {};
33322
- } | {
33323
- /** The ID of the action attempt. */
33324
- action_attempt_id: string;
33325
- status: 'error';
33326
- result: null;
33327
- action_type: 'SET_HEAT';
33328
- error: {
33329
- type: string;
33330
- message: string;
33331
- };
33332
- } | {
33333
- /** The ID of the action attempt. */
33334
- action_attempt_id: string;
33335
- status: 'pending';
33336
- result: null;
33337
- error: null;
33338
- action_type: 'SET_HEAT_COOL';
33339
- } | {
33340
- /** The ID of the action attempt. */
33341
- action_attempt_id: string;
33342
- status: 'success';
33343
- error: null;
33344
- action_type: 'SET_HEAT_COOL';
33345
- result: {};
33346
- } | {
33347
- /** The ID of the action attempt. */
33348
- action_attempt_id: string;
33349
- status: 'error';
33350
- result: null;
33351
- action_type: 'SET_HEAT_COOL';
33352
- error: {
33353
- type: string;
33354
- message: string;
33355
- };
33356
- } | {
33357
- /** The ID of the action attempt. */
33358
- action_attempt_id: string;
33359
- status: 'pending';
33360
- result: null;
33361
- error: null;
33362
- action_type: 'SET_FAN_MODE';
33363
- } | {
33364
- /** The ID of the action attempt. */
33365
- action_attempt_id: string;
33366
- status: 'success';
33367
- error: null;
33368
- action_type: 'SET_FAN_MODE';
33369
- result: {};
33370
- } | {
33371
- /** The ID of the action attempt. */
33372
- action_attempt_id: string;
33373
- status: 'error';
33374
- result: null;
33375
- action_type: 'SET_FAN_MODE';
33376
- error: {
33377
- type: string;
33378
- message: string;
33379
- };
33380
- } | {
33381
- /** The ID of the action attempt. */
33382
- action_attempt_id: string;
33383
- status: 'pending';
33384
- result: null;
33385
- error: null;
33386
- action_type: 'SET_THERMOSTAT_OFF';
33387
- } | {
33388
- /** The ID of the action attempt. */
33389
- action_attempt_id: string;
33390
- status: 'success';
33391
- error: null;
33392
- action_type: 'SET_THERMOSTAT_OFF';
33393
- result: {};
33394
- } | {
33395
- /** The ID of the action attempt. */
33396
- action_attempt_id: string;
33397
- status: 'error';
33398
- result: null;
33399
- action_type: 'SET_THERMOSTAT_OFF';
33400
- error: {
33401
- type: string;
33402
- message: string;
33403
- };
33404
- } | {
33405
- /** The ID of the action attempt. */
33406
- action_attempt_id: string;
33407
- status: 'pending';
33408
- result: null;
33409
- error: null;
33410
- action_type: 'SYNC_ACCESS_CODES';
33411
- } | {
33412
- /** The ID of the action attempt. */
33413
- action_attempt_id: string;
33414
- status: 'success';
33415
- error: null;
33416
- action_type: 'SYNC_ACCESS_CODES';
33417
- result?: any;
33418
- } | {
33419
- /** The ID of the action attempt. */
33420
- action_attempt_id: string;
33421
- status: 'error';
33422
- result: null;
33423
- action_type: 'SYNC_ACCESS_CODES';
33424
- error: {
33425
- type: string;
33426
- message: string;
33427
- };
33428
- } | {
33429
- /** The ID of the action attempt. */
33430
- action_attempt_id: string;
33431
- status: 'pending';
33432
- result: null;
33433
- error: null;
33434
- action_type: 'CREATE_ACCESS_CODE';
33435
- } | {
33436
- /** The ID of the action attempt. */
33437
- action_attempt_id: string;
33438
- status: 'success';
33439
- error: null;
33440
- action_type: 'CREATE_ACCESS_CODE';
33441
- result?: any;
33442
- } | {
33443
- /** The ID of the action attempt. */
33444
- action_attempt_id: string;
33445
- status: 'error';
33446
- result: null;
33447
- action_type: 'CREATE_ACCESS_CODE';
33448
- error: {
33449
- type: string;
33450
- message: string;
33451
- };
33452
- } | {
33453
- /** The ID of the action attempt. */
33454
- action_attempt_id: string;
33455
- status: 'pending';
33456
- result: null;
33457
- error: null;
33458
- action_type: 'DELETE_ACCESS_CODE';
33459
- } | {
33460
- /** The ID of the action attempt. */
33461
- action_attempt_id: string;
33462
- status: 'success';
33463
- error: null;
33464
- action_type: 'DELETE_ACCESS_CODE';
33465
- result?: any;
33466
- } | {
33467
- /** The ID of the action attempt. */
33468
- action_attempt_id: string;
33469
- status: 'error';
33470
- result: null;
33471
- action_type: 'DELETE_ACCESS_CODE';
33472
- error: {
33473
- type: string;
33474
- message: string;
33475
- };
33476
- } | {
33477
- /** The ID of the action attempt. */
33478
- action_attempt_id: string;
33479
- status: 'pending';
33480
- result: null;
33481
- error: null;
33482
- action_type: 'UPDATE_ACCESS_CODE';
33483
- } | {
33484
- /** The ID of the action attempt. */
33485
- action_attempt_id: string;
33486
- status: 'success';
33487
- error: null;
33488
- action_type: 'UPDATE_ACCESS_CODE';
33489
- result?: any;
33490
- } | {
33491
- /** The ID of the action attempt. */
33492
- action_attempt_id: string;
33493
- status: 'error';
33494
- result: null;
33495
- action_type: 'UPDATE_ACCESS_CODE';
33496
- error: {
33497
- type: string;
33498
- message: string;
33499
- };
33500
- } | {
33501
- /** The ID of the action attempt. */
33502
- action_attempt_id: string;
33503
- status: 'pending';
33504
- result: null;
33505
- error: null;
33506
- action_type: 'CREATE_NOISE_THRESHOLD';
33507
- } | {
33436
+ noise_sensors: Array<{
33437
+ /** Unique identifier for the device. */
33438
+ device_id: string;
33439
+ /** Type of the device. */
33440
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone');
33441
+ /** Optional nickname to describe the device, settable through Seam */
33442
+ nickname?: string | undefined;
33443
+ /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
33444
+ display_name: string;
33445
+ /** 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. */
33446
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
33447
+ /** Properties of the device. */
33448
+ properties: (({
33449
+ /** Indicates whether the device is online. */
33450
+ online: boolean;
33451
+ /** Name of the device.
33452
+ * @deprecated use device.display_name instead */
33453
+ name: string;
33454
+ /** Represents the accessory keypad state. */
33455
+ accessory_keypad?: {
33456
+ /** Indicates if the accessory_keypad is connected to the device. */
33457
+ is_connected: boolean;
33458
+ /** Indicates if the keypad battery properties. */
33459
+ battery?: {
33460
+ level: number;
33461
+ } | undefined;
33462
+ } | undefined;
33463
+ appearance: {
33464
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
33465
+ name: string;
33466
+ };
33467
+ model: {
33468
+ /** Indicates whether the device can connect a accessory keypad. */
33469
+ can_connect_accessory_keypad?: boolean | undefined;
33470
+ /** Display name of the device model. */
33471
+ display_name: string;
33472
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
33473
+ manufacturer_display_name: string;
33474
+ /** Indicates whether the device has a built in accessory keypad. */
33475
+ has_built_in_keypad?: boolean | undefined;
33476
+ /** Indicates whether the device supports offline access codes. */
33477
+ offline_access_codes_supported?: boolean | undefined;
33478
+ /** Indicates whether the device supports online access codes. */
33479
+ online_access_codes_supported?: boolean | undefined;
33480
+ /**
33481
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
33482
+ accessory_keypad_supported?: boolean | undefined;
33483
+ };
33484
+ /** Indicates whether the device has direct power. */
33485
+ has_direct_power?: boolean | undefined;
33486
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
33487
+ battery_level?: number | undefined;
33488
+ /** 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. */
33489
+ battery?: {
33490
+ level: number;
33491
+ status: 'critical' | 'low' | 'good' | 'full';
33492
+ } | undefined;
33493
+ /** Manufacturer of the device. */
33494
+ manufacturer?: string | undefined;
33495
+ /** Image URL for the device. */
33496
+ image_url?: string | undefined;
33497
+ /** Alt text for the device image. */
33498
+ image_alt_text?: string | undefined;
33499
+ /** Serial number of the device. */
33500
+ serial_number?: string | undefined;
33501
+ /** Indicates whether it is currently possible to use online access codes for the device. */
33502
+ online_access_codes_enabled?: boolean | undefined;
33503
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
33504
+ offline_access_codes_enabled?: boolean | undefined;
33505
+ /**
33506
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
33507
+ supports_accessory_keypad?: boolean | undefined;
33508
+ /**
33509
+ * @deprecated use offline_access_codes_enabled */
33510
+ supports_offline_access_codes?: boolean | undefined;
33511
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
33512
+ noise_level_decibels?: number | undefined;
33513
+ /** Array of noise threshold IDs that are currently triggering. */
33514
+ currently_triggering_noise_threshold_ids?: string[] | undefined;
33515
+ } & {
33516
+ assa_abloy_credential_service_metadata?: ({
33517
+ has_active_endpoint: boolean;
33518
+ endpoints: Array<{
33519
+ endpoint_id: string;
33520
+ is_active: boolean;
33521
+ }>;
33522
+ } | undefined) | undefined;
33523
+ }) & {
33524
+ august_metadata?: {
33525
+ lock_id: string;
33526
+ lock_name: string;
33527
+ house_name: string;
33528
+ has_keypad: boolean;
33529
+ keypad_battery_level?: string | undefined;
33530
+ model?: string | undefined;
33531
+ house_id?: string | undefined;
33532
+ } | undefined;
33533
+ avigilon_alta_metadata?: {
33534
+ entry_name: string;
33535
+ org_name: string;
33536
+ zone_id: number;
33537
+ zone_name: string;
33538
+ site_id: number;
33539
+ site_name: string;
33540
+ entry_relays_total_count: number;
33541
+ } | undefined;
33542
+ schlage_metadata?: {
33543
+ device_id: string;
33544
+ device_name: string;
33545
+ access_code_length: number | null;
33546
+ model?: string | undefined;
33547
+ } | undefined;
33548
+ smartthings_metadata?: {
33549
+ device_id: string;
33550
+ device_name: string;
33551
+ model?: string | undefined;
33552
+ location_id?: string | undefined;
33553
+ } | undefined;
33554
+ lockly_metadata?: {
33555
+ device_id: string;
33556
+ device_name: string;
33557
+ model?: string | undefined;
33558
+ } | undefined;
33559
+ nuki_metadata?: {
33560
+ device_id: string;
33561
+ device_name: string;
33562
+ keypad_battery_critical?: boolean | undefined;
33563
+ keypad_paired?: boolean | undefined;
33564
+ keypad_2_paired?: boolean | undefined;
33565
+ } | undefined;
33566
+ kwikset_metadata?: {
33567
+ device_id: string;
33568
+ device_name: string;
33569
+ model_number: string;
33570
+ } | undefined;
33571
+ salto_metadata?: {
33572
+ lock_id: string;
33573
+ customer_reference: string;
33574
+ lock_type: string;
33575
+ battery_level: string;
33576
+ locked_state: string;
33577
+ model?: string | undefined;
33578
+ } | undefined;
33579
+ genie_metadata?: {
33580
+ device_name: string;
33581
+ door_name: string;
33582
+ } | undefined;
33583
+ brivo_metadata?: {
33584
+ device_name: string;
33585
+ } | undefined;
33586
+ igloo_metadata?: {
33587
+ device_id: string;
33588
+ bridge_id: string;
33589
+ model?: string | undefined;
33590
+ } | undefined;
33591
+ noiseaware_metadata?: {
33592
+ device_model: 'indoor' | 'outdoor';
33593
+ noise_level_nrs: number;
33594
+ noise_level_decibel: number;
33595
+ device_name: string;
33596
+ device_id: string;
33597
+ } | undefined;
33598
+ minut_metadata?: {
33599
+ device_id: string;
33600
+ device_name: string;
33601
+ latest_sensor_values: {
33602
+ temperature: {
33603
+ time: string;
33604
+ value: number;
33605
+ };
33606
+ sound: {
33607
+ time: string;
33608
+ value: number;
33609
+ };
33610
+ humidity: {
33611
+ time: string;
33612
+ value: number;
33613
+ };
33614
+ pressure: {
33615
+ time: string;
33616
+ value: number;
33617
+ };
33618
+ accelerometer_z: {
33619
+ time: string;
33620
+ value: number;
33621
+ };
33622
+ };
33623
+ } | undefined;
33624
+ four_suites_metadata?: {
33625
+ device_id: number;
33626
+ device_name: string;
33627
+ reclose_delay_in_seconds: number;
33628
+ } | undefined;
33629
+ two_n_metadata?: {
33630
+ device_id: number;
33631
+ device_name: string;
33632
+ } | undefined;
33633
+ controlbyweb_metadata?: {
33634
+ device_id: string;
33635
+ device_name: string;
33636
+ relay_name: string | null;
33637
+ } | undefined;
33638
+ ttlock_metadata?: {
33639
+ lock_id: number;
33640
+ lock_alias: string;
33641
+ feature_value: string;
33642
+ } | undefined;
33643
+ seam_bridge_metadata?: {
33644
+ unlock_method?: ('bridge' | 'doorking') | undefined;
33645
+ device_num: number;
33646
+ name: string;
33647
+ } | undefined;
33648
+ igloohome_metadata?: {
33649
+ device_id: string;
33650
+ device_name: string;
33651
+ bridge_id?: string | undefined;
33652
+ bridge_name?: string | undefined;
33653
+ keypad_id?: string | undefined;
33654
+ } | undefined;
33655
+ nest_metadata?: {
33656
+ nest_device_id: string;
33657
+ device_name: string;
33658
+ custom_name: string;
33659
+ } | undefined;
33660
+ ecobee_metadata?: {
33661
+ ecobee_device_id: string;
33662
+ device_name: string;
33663
+ } | undefined;
33664
+ honeywell_resideo_metadata?: {
33665
+ honeywell_resideo_device_id: string;
33666
+ device_name: string;
33667
+ } | undefined;
33668
+ hubitat_metadata?: {
33669
+ device_id: string;
33670
+ device_name: string;
33671
+ device_label: string;
33672
+ } | undefined;
33673
+ dormakaba_oracode_metadata?: {
33674
+ door_id: number;
33675
+ door_name: string;
33676
+ device_id?: number | undefined;
33677
+ door_is_wireless: boolean;
33678
+ site_id: number;
33679
+ site_name: string;
33680
+ iana_timezone?: string | undefined;
33681
+ predefined_time_slots?: Array<{
33682
+ name: string;
33683
+ prefix: number;
33684
+ check_in_time: string;
33685
+ check_out_time: string;
33686
+ is_24_hour: boolean;
33687
+ is_biweekly_mode: boolean;
33688
+ is_one_shot: boolean;
33689
+ is_master: boolean;
33690
+ ext_dormakaba_oracode_user_level_prefix: number;
33691
+ dormakaba_oracode_user_level_id: string;
33692
+ }> | undefined;
33693
+ } | undefined;
33694
+ wyze_metadata?: {
33695
+ device_id: string;
33696
+ device_name: string;
33697
+ product_name: string;
33698
+ product_type: string;
33699
+ product_model: string;
33700
+ device_info_model: string;
33701
+ keypad_uuid?: string | undefined;
33702
+ locker_status_hardlock?: number | undefined;
33703
+ } | undefined;
33704
+ tedee_metadata?: {
33705
+ device_id: number;
33706
+ serial_number: string;
33707
+ device_name: string;
33708
+ device_model: string;
33709
+ bridge_id: number;
33710
+ bridge_name: string;
33711
+ keypad_id?: number | undefined;
33712
+ } | undefined;
33713
+ }) & ({
33714
+ _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
33715
+ code_constraints?: (Array<{
33716
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089';
33717
+ } | {
33718
+ constraint_type: 'name_length' | 'name_must_be_unique';
33719
+ min_length?: number | undefined;
33720
+ max_length?: number | undefined;
33721
+ }> | undefined) | undefined;
33722
+ supported_code_lengths?: (number[] | undefined) | undefined;
33723
+ max_active_codes_supported?: (number | undefined) | undefined;
33724
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
33725
+ has_native_entry_events?: (boolean | undefined) | undefined;
33726
+ locked?: (boolean | undefined) | undefined;
33727
+ keypad_battery?: ({
33728
+ level: number;
33729
+ } | undefined) | undefined;
33730
+ door_open?: (boolean | undefined) | undefined;
33731
+ } & ({
33732
+ temperature_fahrenheit?: number | undefined;
33733
+ temperature_celsius?: number | undefined;
33734
+ relative_humidity?: number | undefined;
33735
+ can_enable_automatic_heating?: boolean | undefined;
33736
+ can_enable_automatic_cooling?: boolean | undefined;
33737
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
33738
+ is_heating_available?: true | undefined;
33739
+ is_cooling_available?: true | undefined;
33740
+ is_heating?: boolean | undefined;
33741
+ is_cooling?: boolean | undefined;
33742
+ is_fan_running?: boolean | undefined;
33743
+ fan_mode_setting?: ('auto' | 'on') | undefined;
33744
+ is_temporary_manual_override_active?: boolean | undefined;
33745
+ current_climate_setting?: {
33746
+ automatic_heating_enabled: boolean;
33747
+ automatic_cooling_enabled: boolean;
33748
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
33749
+ cooling_set_point_celsius?: number | undefined;
33750
+ heating_set_point_celsius?: number | undefined;
33751
+ cooling_set_point_fahrenheit?: number | undefined;
33752
+ heating_set_point_fahrenheit?: number | undefined;
33753
+ manual_override_allowed: boolean;
33754
+ } | undefined;
33755
+ default_climate_setting?: ({
33756
+ automatic_heating_enabled: boolean;
33757
+ automatic_cooling_enabled: boolean;
33758
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
33759
+ cooling_set_point_celsius?: number | undefined;
33760
+ heating_set_point_celsius?: number | undefined;
33761
+ cooling_set_point_fahrenheit?: number | undefined;
33762
+ heating_set_point_fahrenheit?: number | undefined;
33763
+ manual_override_allowed: boolean;
33764
+ } | undefined) | undefined;
33765
+ is_climate_setting_schedule_active?: boolean | undefined;
33766
+ active_climate_setting_schedule?: ({
33767
+ climate_setting_schedule_id: string;
33768
+ schedule_type: 'time_bound';
33769
+ device_id: string;
33770
+ name?: string | undefined;
33771
+ schedule_starts_at: string;
33772
+ schedule_ends_at: string;
33773
+ created_at: string;
33774
+ /** 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. */
33775
+ errors?: any;
33776
+ automatic_heating_enabled?: boolean | undefined;
33777
+ automatic_cooling_enabled?: boolean | undefined;
33778
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
33779
+ cooling_set_point_celsius?: (number | undefined) | undefined;
33780
+ heating_set_point_celsius?: (number | undefined) | undefined;
33781
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
33782
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
33783
+ manual_override_allowed?: boolean | undefined;
33784
+ } | undefined) | undefined;
33785
+ min_cooling_set_point_celsius?: number | undefined;
33786
+ min_cooling_set_point_fahrenheit?: number | undefined;
33787
+ max_cooling_set_point_celsius?: number | undefined;
33788
+ max_cooling_set_point_fahrenheit?: number | undefined;
33789
+ min_heating_set_point_celsius?: number | undefined;
33790
+ min_heating_set_point_fahrenheit?: number | undefined;
33791
+ max_heating_set_point_celsius?: number | undefined;
33792
+ max_heating_set_point_fahrenheit?: number | undefined;
33793
+ min_heating_cooling_delta_celsius?: number | undefined;
33794
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
33795
+ } | {
33796
+ temperature_fahrenheit?: number | undefined;
33797
+ temperature_celsius?: number | undefined;
33798
+ relative_humidity?: number | undefined;
33799
+ can_enable_automatic_heating?: boolean | undefined;
33800
+ can_enable_automatic_cooling?: boolean | undefined;
33801
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
33802
+ is_heating_available?: true | undefined;
33803
+ is_cooling_available?: false | undefined;
33804
+ is_heating?: boolean | undefined;
33805
+ is_cooling?: boolean | undefined;
33806
+ is_fan_running?: boolean | undefined;
33807
+ fan_mode_setting?: ('auto' | 'on') | undefined;
33808
+ is_temporary_manual_override_active?: boolean | undefined;
33809
+ current_climate_setting?: {
33810
+ automatic_heating_enabled: boolean;
33811
+ automatic_cooling_enabled: boolean;
33812
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
33813
+ cooling_set_point_celsius?: number | undefined;
33814
+ heating_set_point_celsius?: number | undefined;
33815
+ cooling_set_point_fahrenheit?: number | undefined;
33816
+ heating_set_point_fahrenheit?: number | undefined;
33817
+ manual_override_allowed: boolean;
33818
+ } | undefined;
33819
+ default_climate_setting?: ({
33820
+ automatic_heating_enabled: boolean;
33821
+ automatic_cooling_enabled: boolean;
33822
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
33823
+ cooling_set_point_celsius?: number | undefined;
33824
+ heating_set_point_celsius?: number | undefined;
33825
+ cooling_set_point_fahrenheit?: number | undefined;
33826
+ heating_set_point_fahrenheit?: number | undefined;
33827
+ manual_override_allowed: boolean;
33828
+ } | undefined) | undefined;
33829
+ is_climate_setting_schedule_active?: boolean | undefined;
33830
+ active_climate_setting_schedule?: ({
33831
+ climate_setting_schedule_id: string;
33832
+ schedule_type: 'time_bound';
33833
+ device_id: string;
33834
+ name?: string | undefined;
33835
+ schedule_starts_at: string;
33836
+ schedule_ends_at: string;
33837
+ created_at: string;
33838
+ /** 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. */
33839
+ errors?: any;
33840
+ automatic_heating_enabled?: boolean | undefined;
33841
+ automatic_cooling_enabled?: boolean | undefined;
33842
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
33843
+ cooling_set_point_celsius?: (number | undefined) | undefined;
33844
+ heating_set_point_celsius?: (number | undefined) | undefined;
33845
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
33846
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
33847
+ manual_override_allowed?: boolean | undefined;
33848
+ } | undefined) | undefined;
33849
+ min_heating_set_point_celsius?: number | undefined;
33850
+ min_heating_set_point_fahrenheit?: number | undefined;
33851
+ max_heating_set_point_celsius?: number | undefined;
33852
+ max_heating_set_point_fahrenheit?: number | undefined;
33853
+ } | {
33854
+ temperature_fahrenheit?: number | undefined;
33855
+ temperature_celsius?: number | undefined;
33856
+ relative_humidity?: number | undefined;
33857
+ can_enable_automatic_heating?: boolean | undefined;
33858
+ can_enable_automatic_cooling?: boolean | undefined;
33859
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
33860
+ is_heating_available?: false | undefined;
33861
+ is_cooling_available?: true | undefined;
33862
+ is_heating?: boolean | undefined;
33863
+ is_cooling?: boolean | undefined;
33864
+ is_fan_running?: boolean | undefined;
33865
+ fan_mode_setting?: ('auto' | 'on') | undefined;
33866
+ is_temporary_manual_override_active?: boolean | undefined;
33867
+ current_climate_setting?: {
33868
+ automatic_heating_enabled: boolean;
33869
+ automatic_cooling_enabled: boolean;
33870
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
33871
+ cooling_set_point_celsius?: number | undefined;
33872
+ heating_set_point_celsius?: number | undefined;
33873
+ cooling_set_point_fahrenheit?: number | undefined;
33874
+ heating_set_point_fahrenheit?: number | undefined;
33875
+ manual_override_allowed: boolean;
33876
+ } | undefined;
33877
+ default_climate_setting?: ({
33878
+ automatic_heating_enabled: boolean;
33879
+ automatic_cooling_enabled: boolean;
33880
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
33881
+ cooling_set_point_celsius?: number | undefined;
33882
+ heating_set_point_celsius?: number | undefined;
33883
+ cooling_set_point_fahrenheit?: number | undefined;
33884
+ heating_set_point_fahrenheit?: number | undefined;
33885
+ manual_override_allowed: boolean;
33886
+ } | undefined) | undefined;
33887
+ is_climate_setting_schedule_active?: boolean | undefined;
33888
+ active_climate_setting_schedule?: ({
33889
+ climate_setting_schedule_id: string;
33890
+ schedule_type: 'time_bound';
33891
+ device_id: string;
33892
+ name?: string | undefined;
33893
+ schedule_starts_at: string;
33894
+ schedule_ends_at: string;
33895
+ created_at: string;
33896
+ /** 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. */
33897
+ errors?: any;
33898
+ automatic_heating_enabled?: boolean | undefined;
33899
+ automatic_cooling_enabled?: boolean | undefined;
33900
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
33901
+ cooling_set_point_celsius?: (number | undefined) | undefined;
33902
+ heating_set_point_celsius?: (number | undefined) | undefined;
33903
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
33904
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
33905
+ manual_override_allowed?: boolean | undefined;
33906
+ } | undefined) | undefined;
33907
+ min_cooling_set_point_celsius?: number | undefined;
33908
+ min_cooling_set_point_fahrenheit?: number | undefined;
33909
+ max_cooling_set_point_celsius?: number | undefined;
33910
+ max_cooling_set_point_fahrenheit?: number | undefined;
33911
+ }));
33912
+ /** Location information for the device. */
33913
+ location: {
33914
+ /** Name of the device location. */
33915
+ location_name?: string | undefined;
33916
+ /** Time zone of the device location. */
33917
+ timezone?: string | undefined;
33918
+ } | null;
33919
+ /** Unique identifier for the account associated with the device. */
33920
+ connected_account_id: string;
33921
+ /** Unique identifier for the Seam workspace associated with the device. */
33922
+ workspace_id: string;
33923
+ /** 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. */
33924
+ errors: Array<{
33925
+ error_code: string;
33926
+ message: string;
33927
+ }>;
33928
+ /** 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. */
33929
+ warnings: Array<{
33930
+ warning_code: string;
33931
+ message: string;
33932
+ }>;
33933
+ /** Date and time at which the device object was created. */
33934
+ created_at: string;
33935
+ /** Indicates whether Seam manages the device. */
33936
+ is_managed: true;
33937
+ custom_metadata: Record<string, string | boolean>;
33938
+ can_remotely_unlock?: boolean | undefined;
33939
+ can_remotely_lock?: boolean | undefined;
33940
+ can_program_offline_access_codes?: boolean | undefined;
33941
+ can_program_online_access_codes?: boolean | undefined;
33942
+ can_simulate_removal?: boolean | undefined;
33943
+ can_simulate_connection?: boolean | undefined;
33944
+ can_simulate_disconnection?: boolean | undefined;
33945
+ }>;
33946
+ devices: Array<{
33947
+ /** Unique identifier for the device. */
33948
+ device_id: string;
33949
+ /** Type of the device. */
33950
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone');
33951
+ /** Optional nickname to describe the device, settable through Seam */
33952
+ nickname?: string | undefined;
33953
+ /** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
33954
+ display_name: string;
33955
+ /** 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. */
33956
+ capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
33957
+ /** Properties of the device. */
33958
+ properties: (({
33959
+ /** Indicates whether the device is online. */
33960
+ online: boolean;
33961
+ /** Name of the device.
33962
+ * @deprecated use device.display_name instead */
33963
+ name: string;
33964
+ /** Represents the accessory keypad state. */
33965
+ accessory_keypad?: {
33966
+ /** Indicates if the accessory_keypad is connected to the device. */
33967
+ is_connected: boolean;
33968
+ /** Indicates if the keypad battery properties. */
33969
+ battery?: {
33970
+ level: number;
33971
+ } | undefined;
33972
+ } | undefined;
33973
+ appearance: {
33974
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
33975
+ name: string;
33976
+ };
33977
+ model: {
33978
+ /** Indicates whether the device can connect a accessory keypad. */
33979
+ can_connect_accessory_keypad?: boolean | undefined;
33980
+ /** Display name of the device model. */
33981
+ display_name: string;
33982
+ /** Display name that corresponds to the manufacturer-specific terminology for the device. */
33983
+ manufacturer_display_name: string;
33984
+ /** Indicates whether the device has a built in accessory keypad. */
33985
+ has_built_in_keypad?: boolean | undefined;
33986
+ /** Indicates whether the device supports offline access codes. */
33987
+ offline_access_codes_supported?: boolean | undefined;
33988
+ /** Indicates whether the device supports online access codes. */
33989
+ online_access_codes_supported?: boolean | undefined;
33990
+ /**
33991
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
33992
+ accessory_keypad_supported?: boolean | undefined;
33993
+ };
33994
+ /** Indicates whether the device has direct power. */
33995
+ has_direct_power?: boolean | undefined;
33996
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
33997
+ battery_level?: number | undefined;
33998
+ /** 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. */
33999
+ battery?: {
34000
+ level: number;
34001
+ status: 'critical' | 'low' | 'good' | 'full';
34002
+ } | undefined;
34003
+ /** Manufacturer of the device. */
34004
+ manufacturer?: string | undefined;
34005
+ /** Image URL for the device. */
34006
+ image_url?: string | undefined;
34007
+ /** Alt text for the device image. */
34008
+ image_alt_text?: string | undefined;
34009
+ /** Serial number of the device. */
34010
+ serial_number?: string | undefined;
34011
+ /** Indicates whether it is currently possible to use online access codes for the device. */
34012
+ online_access_codes_enabled?: boolean | undefined;
34013
+ /** Indicates whether it is currently possible to use offline access codes for the device. */
34014
+ offline_access_codes_enabled?: boolean | undefined;
34015
+ /**
34016
+ * @deprecated use device.properties.model.can_connect_accessory_keypad */
34017
+ supports_accessory_keypad?: boolean | undefined;
34018
+ /**
34019
+ * @deprecated use offline_access_codes_enabled */
34020
+ supports_offline_access_codes?: boolean | undefined;
34021
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
34022
+ noise_level_decibels?: number | undefined;
34023
+ /** Array of noise threshold IDs that are currently triggering. */
34024
+ currently_triggering_noise_threshold_ids?: string[] | undefined;
34025
+ } & {
34026
+ assa_abloy_credential_service_metadata?: ({
34027
+ has_active_endpoint: boolean;
34028
+ endpoints: Array<{
34029
+ endpoint_id: string;
34030
+ is_active: boolean;
34031
+ }>;
34032
+ } | undefined) | undefined;
34033
+ }) & {
34034
+ august_metadata?: {
34035
+ lock_id: string;
34036
+ lock_name: string;
34037
+ house_name: string;
34038
+ has_keypad: boolean;
34039
+ keypad_battery_level?: string | undefined;
34040
+ model?: string | undefined;
34041
+ house_id?: string | undefined;
34042
+ } | undefined;
34043
+ avigilon_alta_metadata?: {
34044
+ entry_name: string;
34045
+ org_name: string;
34046
+ zone_id: number;
34047
+ zone_name: string;
34048
+ site_id: number;
34049
+ site_name: string;
34050
+ entry_relays_total_count: number;
34051
+ } | undefined;
34052
+ schlage_metadata?: {
34053
+ device_id: string;
34054
+ device_name: string;
34055
+ access_code_length: number | null;
34056
+ model?: string | undefined;
34057
+ } | undefined;
34058
+ smartthings_metadata?: {
34059
+ device_id: string;
34060
+ device_name: string;
34061
+ model?: string | undefined;
34062
+ location_id?: string | undefined;
34063
+ } | undefined;
34064
+ lockly_metadata?: {
34065
+ device_id: string;
34066
+ device_name: string;
34067
+ model?: string | undefined;
34068
+ } | undefined;
34069
+ nuki_metadata?: {
34070
+ device_id: string;
34071
+ device_name: string;
34072
+ keypad_battery_critical?: boolean | undefined;
34073
+ keypad_paired?: boolean | undefined;
34074
+ keypad_2_paired?: boolean | undefined;
34075
+ } | undefined;
34076
+ kwikset_metadata?: {
34077
+ device_id: string;
34078
+ device_name: string;
34079
+ model_number: string;
34080
+ } | undefined;
34081
+ salto_metadata?: {
34082
+ lock_id: string;
34083
+ customer_reference: string;
34084
+ lock_type: string;
34085
+ battery_level: string;
34086
+ locked_state: string;
34087
+ model?: string | undefined;
34088
+ } | undefined;
34089
+ genie_metadata?: {
34090
+ device_name: string;
34091
+ door_name: string;
34092
+ } | undefined;
34093
+ brivo_metadata?: {
34094
+ device_name: string;
34095
+ } | undefined;
34096
+ igloo_metadata?: {
34097
+ device_id: string;
34098
+ bridge_id: string;
34099
+ model?: string | undefined;
34100
+ } | undefined;
34101
+ noiseaware_metadata?: {
34102
+ device_model: 'indoor' | 'outdoor';
34103
+ noise_level_nrs: number;
34104
+ noise_level_decibel: number;
34105
+ device_name: string;
34106
+ device_id: string;
34107
+ } | undefined;
34108
+ minut_metadata?: {
34109
+ device_id: string;
34110
+ device_name: string;
34111
+ latest_sensor_values: {
34112
+ temperature: {
34113
+ time: string;
34114
+ value: number;
34115
+ };
34116
+ sound: {
34117
+ time: string;
34118
+ value: number;
34119
+ };
34120
+ humidity: {
34121
+ time: string;
34122
+ value: number;
34123
+ };
34124
+ pressure: {
34125
+ time: string;
34126
+ value: number;
34127
+ };
34128
+ accelerometer_z: {
34129
+ time: string;
34130
+ value: number;
34131
+ };
34132
+ };
34133
+ } | undefined;
34134
+ four_suites_metadata?: {
34135
+ device_id: number;
34136
+ device_name: string;
34137
+ reclose_delay_in_seconds: number;
34138
+ } | undefined;
34139
+ two_n_metadata?: {
34140
+ device_id: number;
34141
+ device_name: string;
34142
+ } | undefined;
34143
+ controlbyweb_metadata?: {
34144
+ device_id: string;
34145
+ device_name: string;
34146
+ relay_name: string | null;
34147
+ } | undefined;
34148
+ ttlock_metadata?: {
34149
+ lock_id: number;
34150
+ lock_alias: string;
34151
+ feature_value: string;
34152
+ } | undefined;
34153
+ seam_bridge_metadata?: {
34154
+ unlock_method?: ('bridge' | 'doorking') | undefined;
34155
+ device_num: number;
34156
+ name: string;
34157
+ } | undefined;
34158
+ igloohome_metadata?: {
34159
+ device_id: string;
34160
+ device_name: string;
34161
+ bridge_id?: string | undefined;
34162
+ bridge_name?: string | undefined;
34163
+ keypad_id?: string | undefined;
34164
+ } | undefined;
34165
+ nest_metadata?: {
34166
+ nest_device_id: string;
34167
+ device_name: string;
34168
+ custom_name: string;
34169
+ } | undefined;
34170
+ ecobee_metadata?: {
34171
+ ecobee_device_id: string;
34172
+ device_name: string;
34173
+ } | undefined;
34174
+ honeywell_resideo_metadata?: {
34175
+ honeywell_resideo_device_id: string;
34176
+ device_name: string;
34177
+ } | undefined;
34178
+ hubitat_metadata?: {
34179
+ device_id: string;
34180
+ device_name: string;
34181
+ device_label: string;
34182
+ } | undefined;
34183
+ dormakaba_oracode_metadata?: {
34184
+ door_id: number;
34185
+ door_name: string;
34186
+ device_id?: number | undefined;
34187
+ door_is_wireless: boolean;
34188
+ site_id: number;
34189
+ site_name: string;
34190
+ iana_timezone?: string | undefined;
34191
+ predefined_time_slots?: Array<{
34192
+ name: string;
34193
+ prefix: number;
34194
+ check_in_time: string;
34195
+ check_out_time: string;
34196
+ is_24_hour: boolean;
34197
+ is_biweekly_mode: boolean;
34198
+ is_one_shot: boolean;
34199
+ is_master: boolean;
34200
+ ext_dormakaba_oracode_user_level_prefix: number;
34201
+ dormakaba_oracode_user_level_id: string;
34202
+ }> | undefined;
34203
+ } | undefined;
34204
+ wyze_metadata?: {
34205
+ device_id: string;
34206
+ device_name: string;
34207
+ product_name: string;
34208
+ product_type: string;
34209
+ product_model: string;
34210
+ device_info_model: string;
34211
+ keypad_uuid?: string | undefined;
34212
+ locker_status_hardlock?: number | undefined;
34213
+ } | undefined;
34214
+ tedee_metadata?: {
34215
+ device_id: number;
34216
+ serial_number: string;
34217
+ device_name: string;
34218
+ device_model: string;
34219
+ bridge_id: number;
34220
+ bridge_name: string;
34221
+ keypad_id?: number | undefined;
34222
+ } | undefined;
34223
+ }) & ({
34224
+ _experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
34225
+ code_constraints?: (Array<{
34226
+ constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089';
34227
+ } | {
34228
+ constraint_type: 'name_length' | 'name_must_be_unique';
34229
+ min_length?: number | undefined;
34230
+ max_length?: number | undefined;
34231
+ }> | undefined) | undefined;
34232
+ supported_code_lengths?: (number[] | undefined) | undefined;
34233
+ max_active_codes_supported?: (number | undefined) | undefined;
34234
+ supports_backup_access_code_pool?: (boolean | undefined) | undefined;
34235
+ has_native_entry_events?: (boolean | undefined) | undefined;
34236
+ locked?: (boolean | undefined) | undefined;
34237
+ keypad_battery?: ({
34238
+ level: number;
34239
+ } | undefined) | undefined;
34240
+ door_open?: (boolean | undefined) | undefined;
34241
+ } & ({
34242
+ temperature_fahrenheit?: number | undefined;
34243
+ temperature_celsius?: number | undefined;
34244
+ relative_humidity?: number | undefined;
34245
+ can_enable_automatic_heating?: boolean | undefined;
34246
+ can_enable_automatic_cooling?: boolean | undefined;
34247
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
34248
+ is_heating_available?: true | undefined;
34249
+ is_cooling_available?: true | undefined;
34250
+ is_heating?: boolean | undefined;
34251
+ is_cooling?: boolean | undefined;
34252
+ is_fan_running?: boolean | undefined;
34253
+ fan_mode_setting?: ('auto' | 'on') | undefined;
34254
+ is_temporary_manual_override_active?: boolean | undefined;
34255
+ current_climate_setting?: {
34256
+ automatic_heating_enabled: boolean;
34257
+ automatic_cooling_enabled: boolean;
34258
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
34259
+ cooling_set_point_celsius?: number | undefined;
34260
+ heating_set_point_celsius?: number | undefined;
34261
+ cooling_set_point_fahrenheit?: number | undefined;
34262
+ heating_set_point_fahrenheit?: number | undefined;
34263
+ manual_override_allowed: boolean;
34264
+ } | undefined;
34265
+ default_climate_setting?: ({
34266
+ automatic_heating_enabled: boolean;
34267
+ automatic_cooling_enabled: boolean;
34268
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
34269
+ cooling_set_point_celsius?: number | undefined;
34270
+ heating_set_point_celsius?: number | undefined;
34271
+ cooling_set_point_fahrenheit?: number | undefined;
34272
+ heating_set_point_fahrenheit?: number | undefined;
34273
+ manual_override_allowed: boolean;
34274
+ } | undefined) | undefined;
34275
+ is_climate_setting_schedule_active?: boolean | undefined;
34276
+ active_climate_setting_schedule?: ({
34277
+ climate_setting_schedule_id: string;
34278
+ schedule_type: 'time_bound';
34279
+ device_id: string;
34280
+ name?: string | undefined;
34281
+ schedule_starts_at: string;
34282
+ schedule_ends_at: string;
34283
+ created_at: string;
34284
+ /** 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. */
34285
+ errors?: any;
34286
+ automatic_heating_enabled?: boolean | undefined;
34287
+ automatic_cooling_enabled?: boolean | undefined;
34288
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
34289
+ cooling_set_point_celsius?: (number | undefined) | undefined;
34290
+ heating_set_point_celsius?: (number | undefined) | undefined;
34291
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
34292
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
34293
+ manual_override_allowed?: boolean | undefined;
34294
+ } | undefined) | undefined;
34295
+ min_cooling_set_point_celsius?: number | undefined;
34296
+ min_cooling_set_point_fahrenheit?: number | undefined;
34297
+ max_cooling_set_point_celsius?: number | undefined;
34298
+ max_cooling_set_point_fahrenheit?: number | undefined;
34299
+ min_heating_set_point_celsius?: number | undefined;
34300
+ min_heating_set_point_fahrenheit?: number | undefined;
34301
+ max_heating_set_point_celsius?: number | undefined;
34302
+ max_heating_set_point_fahrenheit?: number | undefined;
34303
+ min_heating_cooling_delta_celsius?: number | undefined;
34304
+ min_heating_cooling_delta_fahrenheit?: number | undefined;
34305
+ } | {
34306
+ temperature_fahrenheit?: number | undefined;
34307
+ temperature_celsius?: number | undefined;
34308
+ relative_humidity?: number | undefined;
34309
+ can_enable_automatic_heating?: boolean | undefined;
34310
+ can_enable_automatic_cooling?: boolean | undefined;
34311
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
34312
+ is_heating_available?: true | undefined;
34313
+ is_cooling_available?: false | undefined;
34314
+ is_heating?: boolean | undefined;
34315
+ is_cooling?: boolean | undefined;
34316
+ is_fan_running?: boolean | undefined;
34317
+ fan_mode_setting?: ('auto' | 'on') | undefined;
34318
+ is_temporary_manual_override_active?: boolean | undefined;
34319
+ current_climate_setting?: {
34320
+ automatic_heating_enabled: boolean;
34321
+ automatic_cooling_enabled: boolean;
34322
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
34323
+ cooling_set_point_celsius?: number | undefined;
34324
+ heating_set_point_celsius?: number | undefined;
34325
+ cooling_set_point_fahrenheit?: number | undefined;
34326
+ heating_set_point_fahrenheit?: number | undefined;
34327
+ manual_override_allowed: boolean;
34328
+ } | undefined;
34329
+ default_climate_setting?: ({
34330
+ automatic_heating_enabled: boolean;
34331
+ automatic_cooling_enabled: boolean;
34332
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
34333
+ cooling_set_point_celsius?: number | undefined;
34334
+ heating_set_point_celsius?: number | undefined;
34335
+ cooling_set_point_fahrenheit?: number | undefined;
34336
+ heating_set_point_fahrenheit?: number | undefined;
34337
+ manual_override_allowed: boolean;
34338
+ } | undefined) | undefined;
34339
+ is_climate_setting_schedule_active?: boolean | undefined;
34340
+ active_climate_setting_schedule?: ({
34341
+ climate_setting_schedule_id: string;
34342
+ schedule_type: 'time_bound';
34343
+ device_id: string;
34344
+ name?: string | undefined;
34345
+ schedule_starts_at: string;
34346
+ schedule_ends_at: string;
34347
+ created_at: string;
34348
+ /** 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. */
34349
+ errors?: any;
34350
+ automatic_heating_enabled?: boolean | undefined;
34351
+ automatic_cooling_enabled?: boolean | undefined;
34352
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
34353
+ cooling_set_point_celsius?: (number | undefined) | undefined;
34354
+ heating_set_point_celsius?: (number | undefined) | undefined;
34355
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
34356
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
34357
+ manual_override_allowed?: boolean | undefined;
34358
+ } | undefined) | undefined;
34359
+ min_heating_set_point_celsius?: number | undefined;
34360
+ min_heating_set_point_fahrenheit?: number | undefined;
34361
+ max_heating_set_point_celsius?: number | undefined;
34362
+ max_heating_set_point_fahrenheit?: number | undefined;
34363
+ } | {
34364
+ temperature_fahrenheit?: number | undefined;
34365
+ temperature_celsius?: number | undefined;
34366
+ relative_humidity?: number | undefined;
34367
+ can_enable_automatic_heating?: boolean | undefined;
34368
+ can_enable_automatic_cooling?: boolean | undefined;
34369
+ available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
34370
+ is_heating_available?: false | undefined;
34371
+ is_cooling_available?: true | undefined;
34372
+ is_heating?: boolean | undefined;
34373
+ is_cooling?: boolean | undefined;
34374
+ is_fan_running?: boolean | undefined;
34375
+ fan_mode_setting?: ('auto' | 'on') | undefined;
34376
+ is_temporary_manual_override_active?: boolean | undefined;
34377
+ current_climate_setting?: {
34378
+ automatic_heating_enabled: boolean;
34379
+ automatic_cooling_enabled: boolean;
34380
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
34381
+ cooling_set_point_celsius?: number | undefined;
34382
+ heating_set_point_celsius?: number | undefined;
34383
+ cooling_set_point_fahrenheit?: number | undefined;
34384
+ heating_set_point_fahrenheit?: number | undefined;
34385
+ manual_override_allowed: boolean;
34386
+ } | undefined;
34387
+ default_climate_setting?: ({
34388
+ automatic_heating_enabled: boolean;
34389
+ automatic_cooling_enabled: boolean;
34390
+ hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
34391
+ cooling_set_point_celsius?: number | undefined;
34392
+ heating_set_point_celsius?: number | undefined;
34393
+ cooling_set_point_fahrenheit?: number | undefined;
34394
+ heating_set_point_fahrenheit?: number | undefined;
34395
+ manual_override_allowed: boolean;
34396
+ } | undefined) | undefined;
34397
+ is_climate_setting_schedule_active?: boolean | undefined;
34398
+ active_climate_setting_schedule?: ({
34399
+ climate_setting_schedule_id: string;
34400
+ schedule_type: 'time_bound';
34401
+ device_id: string;
34402
+ name?: string | undefined;
34403
+ schedule_starts_at: string;
34404
+ schedule_ends_at: string;
34405
+ created_at: string;
34406
+ /** 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. */
34407
+ errors?: any;
34408
+ automatic_heating_enabled?: boolean | undefined;
34409
+ automatic_cooling_enabled?: boolean | undefined;
34410
+ hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
34411
+ cooling_set_point_celsius?: (number | undefined) | undefined;
34412
+ heating_set_point_celsius?: (number | undefined) | undefined;
34413
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined;
34414
+ heating_set_point_fahrenheit?: (number | undefined) | undefined;
34415
+ manual_override_allowed?: boolean | undefined;
34416
+ } | undefined) | undefined;
34417
+ min_cooling_set_point_celsius?: number | undefined;
34418
+ min_cooling_set_point_fahrenheit?: number | undefined;
34419
+ max_cooling_set_point_celsius?: number | undefined;
34420
+ max_cooling_set_point_fahrenheit?: number | undefined;
34421
+ }));
34422
+ /** Location information for the device. */
34423
+ location: {
34424
+ /** Name of the device location. */
34425
+ location_name?: string | undefined;
34426
+ /** Time zone of the device location. */
34427
+ timezone?: string | undefined;
34428
+ } | null;
34429
+ /** Unique identifier for the account associated with the device. */
34430
+ connected_account_id: string;
34431
+ /** Unique identifier for the Seam workspace associated with the device. */
34432
+ workspace_id: string;
34433
+ /** 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. */
34434
+ errors: Array<{
34435
+ error_code: string;
34436
+ message: string;
34437
+ }>;
34438
+ /** 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. */
34439
+ warnings: Array<{
34440
+ warning_code: string;
34441
+ message: string;
34442
+ }>;
34443
+ /** Date and time at which the device object was created. */
34444
+ created_at: string;
34445
+ /** Indicates whether Seam manages the device. */
34446
+ is_managed: true;
34447
+ custom_metadata: Record<string, string | boolean>;
34448
+ can_remotely_unlock?: boolean | undefined;
34449
+ can_remotely_lock?: boolean | undefined;
34450
+ can_program_offline_access_codes?: boolean | undefined;
34451
+ can_program_online_access_codes?: boolean | undefined;
34452
+ can_simulate_removal?: boolean | undefined;
34453
+ can_simulate_connection?: boolean | undefined;
34454
+ can_simulate_disconnection?: boolean | undefined;
34455
+ }>;
34456
+ };
34457
+ };
34458
+ '/noise_sensors/noise_thresholds/create': {
34459
+ route: '/noise_sensors/noise_thresholds/create';
34460
+ method: 'POST';
34461
+ queryParams: {};
34462
+ jsonBody: {
34463
+ device_id: string;
34464
+ sync?: boolean;
34465
+ name?: string | undefined;
34466
+ starts_daily_at: string;
34467
+ ends_daily_at: string;
34468
+ noise_threshold_decibels?: number | undefined;
34469
+ noise_threshold_nrs?: number | undefined;
34470
+ };
34471
+ commonParams: {};
34472
+ formData: {};
34473
+ jsonResponse: {
34474
+ action_attempt: {
34475
+ /** The ID of the action attempt. */
34476
+ action_attempt_id: string;
34477
+ status: 'pending';
34478
+ result: null;
34479
+ error: null;
34480
+ action_type: 'LOCK_DOOR';
34481
+ } | {
34482
+ /** The ID of the action attempt. */
34483
+ action_attempt_id: string;
34484
+ status: 'success';
34485
+ error: null;
34486
+ action_type: 'LOCK_DOOR';
34487
+ result: {};
34488
+ } | {
34489
+ /** The ID of the action attempt. */
34490
+ action_attempt_id: string;
34491
+ status: 'error';
34492
+ result: null;
34493
+ action_type: 'LOCK_DOOR';
34494
+ error: {
34495
+ type: string;
34496
+ message: string;
34497
+ };
34498
+ } | {
34499
+ /** The ID of the action attempt. */
34500
+ action_attempt_id: string;
34501
+ status: 'pending';
34502
+ result: null;
34503
+ error: null;
34504
+ action_type: 'UNLOCK_DOOR';
34505
+ } | {
34506
+ /** The ID of the action attempt. */
34507
+ action_attempt_id: string;
34508
+ status: 'success';
34509
+ error: null;
34510
+ action_type: 'UNLOCK_DOOR';
34511
+ result: {};
34512
+ } | {
34513
+ /** The ID of the action attempt. */
34514
+ action_attempt_id: string;
34515
+ status: 'error';
34516
+ result: null;
34517
+ action_type: 'UNLOCK_DOOR';
34518
+ error: {
34519
+ type: string;
34520
+ message: string;
34521
+ };
34522
+ } | {
34523
+ /** The ID of the action attempt. */
34524
+ action_attempt_id: string;
34525
+ status: 'pending';
34526
+ result: null;
34527
+ error: null;
34528
+ action_type: 'RESET_SANDBOX_WORKSPACE';
34529
+ } | {
34530
+ /** The ID of the action attempt. */
34531
+ action_attempt_id: string;
34532
+ status: 'success';
34533
+ error: null;
34534
+ action_type: 'RESET_SANDBOX_WORKSPACE';
34535
+ result: {};
34536
+ } | {
34537
+ /** The ID of the action attempt. */
34538
+ action_attempt_id: string;
34539
+ status: 'error';
34540
+ result: null;
34541
+ action_type: 'RESET_SANDBOX_WORKSPACE';
34542
+ error: {
34543
+ type: string;
34544
+ message: string;
34545
+ };
34546
+ } | {
34547
+ /** The ID of the action attempt. */
34548
+ action_attempt_id: string;
34549
+ status: 'pending';
34550
+ result: null;
34551
+ error: null;
34552
+ action_type: 'SET_COOL';
34553
+ } | {
34554
+ /** The ID of the action attempt. */
34555
+ action_attempt_id: string;
34556
+ status: 'success';
34557
+ error: null;
34558
+ action_type: 'SET_COOL';
34559
+ result: {};
34560
+ } | {
34561
+ /** The ID of the action attempt. */
34562
+ action_attempt_id: string;
34563
+ status: 'error';
34564
+ result: null;
34565
+ action_type: 'SET_COOL';
34566
+ error: {
34567
+ type: string;
34568
+ message: string;
34569
+ };
34570
+ } | {
34571
+ /** The ID of the action attempt. */
34572
+ action_attempt_id: string;
34573
+ status: 'pending';
34574
+ result: null;
34575
+ error: null;
34576
+ action_type: 'SET_HEAT';
34577
+ } | {
34578
+ /** The ID of the action attempt. */
34579
+ action_attempt_id: string;
34580
+ status: 'success';
34581
+ error: null;
34582
+ action_type: 'SET_HEAT';
34583
+ result: {};
34584
+ } | {
34585
+ /** The ID of the action attempt. */
34586
+ action_attempt_id: string;
34587
+ status: 'error';
34588
+ result: null;
34589
+ action_type: 'SET_HEAT';
34590
+ error: {
34591
+ type: string;
34592
+ message: string;
34593
+ };
34594
+ } | {
34595
+ /** The ID of the action attempt. */
34596
+ action_attempt_id: string;
34597
+ status: 'pending';
34598
+ result: null;
34599
+ error: null;
34600
+ action_type: 'SET_HEAT_COOL';
34601
+ } | {
34602
+ /** The ID of the action attempt. */
34603
+ action_attempt_id: string;
34604
+ status: 'success';
34605
+ error: null;
34606
+ action_type: 'SET_HEAT_COOL';
34607
+ result: {};
34608
+ } | {
34609
+ /** The ID of the action attempt. */
34610
+ action_attempt_id: string;
34611
+ status: 'error';
34612
+ result: null;
34613
+ action_type: 'SET_HEAT_COOL';
34614
+ error: {
34615
+ type: string;
34616
+ message: string;
34617
+ };
34618
+ } | {
34619
+ /** The ID of the action attempt. */
34620
+ action_attempt_id: string;
34621
+ status: 'pending';
34622
+ result: null;
34623
+ error: null;
34624
+ action_type: 'SET_FAN_MODE';
34625
+ } | {
34626
+ /** The ID of the action attempt. */
34627
+ action_attempt_id: string;
34628
+ status: 'success';
34629
+ error: null;
34630
+ action_type: 'SET_FAN_MODE';
34631
+ result: {};
34632
+ } | {
34633
+ /** The ID of the action attempt. */
34634
+ action_attempt_id: string;
34635
+ status: 'error';
34636
+ result: null;
34637
+ action_type: 'SET_FAN_MODE';
34638
+ error: {
34639
+ type: string;
34640
+ message: string;
34641
+ };
34642
+ } | {
34643
+ /** The ID of the action attempt. */
34644
+ action_attempt_id: string;
34645
+ status: 'pending';
34646
+ result: null;
34647
+ error: null;
34648
+ action_type: 'SET_THERMOSTAT_OFF';
34649
+ } | {
34650
+ /** The ID of the action attempt. */
34651
+ action_attempt_id: string;
34652
+ status: 'success';
34653
+ error: null;
34654
+ action_type: 'SET_THERMOSTAT_OFF';
34655
+ result: {};
34656
+ } | {
34657
+ /** The ID of the action attempt. */
34658
+ action_attempt_id: string;
34659
+ status: 'error';
34660
+ result: null;
34661
+ action_type: 'SET_THERMOSTAT_OFF';
34662
+ error: {
34663
+ type: string;
34664
+ message: string;
34665
+ };
34666
+ } | {
34667
+ /** The ID of the action attempt. */
34668
+ action_attempt_id: string;
34669
+ status: 'pending';
34670
+ result: null;
34671
+ error: null;
34672
+ action_type: 'SYNC_ACCESS_CODES';
34673
+ } | {
34674
+ /** The ID of the action attempt. */
34675
+ action_attempt_id: string;
34676
+ status: 'success';
34677
+ error: null;
34678
+ action_type: 'SYNC_ACCESS_CODES';
34679
+ result?: any;
34680
+ } | {
34681
+ /** The ID of the action attempt. */
34682
+ action_attempt_id: string;
34683
+ status: 'error';
34684
+ result: null;
34685
+ action_type: 'SYNC_ACCESS_CODES';
34686
+ error: {
34687
+ type: string;
34688
+ message: string;
34689
+ };
34690
+ } | {
34691
+ /** The ID of the action attempt. */
34692
+ action_attempt_id: string;
34693
+ status: 'pending';
34694
+ result: null;
34695
+ error: null;
34696
+ action_type: 'CREATE_ACCESS_CODE';
34697
+ } | {
34698
+ /** The ID of the action attempt. */
34699
+ action_attempt_id: string;
34700
+ status: 'success';
34701
+ error: null;
34702
+ action_type: 'CREATE_ACCESS_CODE';
34703
+ result?: any;
34704
+ } | {
34705
+ /** The ID of the action attempt. */
34706
+ action_attempt_id: string;
34707
+ status: 'error';
34708
+ result: null;
34709
+ action_type: 'CREATE_ACCESS_CODE';
34710
+ error: {
34711
+ type: string;
34712
+ message: string;
34713
+ };
34714
+ } | {
34715
+ /** The ID of the action attempt. */
34716
+ action_attempt_id: string;
34717
+ status: 'pending';
34718
+ result: null;
34719
+ error: null;
34720
+ action_type: 'DELETE_ACCESS_CODE';
34721
+ } | {
34722
+ /** The ID of the action attempt. */
34723
+ action_attempt_id: string;
34724
+ status: 'success';
34725
+ error: null;
34726
+ action_type: 'DELETE_ACCESS_CODE';
34727
+ result?: any;
34728
+ } | {
34729
+ /** The ID of the action attempt. */
34730
+ action_attempt_id: string;
34731
+ status: 'error';
34732
+ result: null;
34733
+ action_type: 'DELETE_ACCESS_CODE';
34734
+ error: {
34735
+ type: string;
34736
+ message: string;
34737
+ };
34738
+ } | {
34739
+ /** The ID of the action attempt. */
34740
+ action_attempt_id: string;
34741
+ status: 'pending';
34742
+ result: null;
34743
+ error: null;
34744
+ action_type: 'UPDATE_ACCESS_CODE';
34745
+ } | {
34746
+ /** The ID of the action attempt. */
34747
+ action_attempt_id: string;
34748
+ status: 'success';
34749
+ error: null;
34750
+ action_type: 'UPDATE_ACCESS_CODE';
34751
+ result?: any;
34752
+ } | {
34753
+ /** The ID of the action attempt. */
34754
+ action_attempt_id: string;
34755
+ status: 'error';
34756
+ result: null;
34757
+ action_type: 'UPDATE_ACCESS_CODE';
34758
+ error: {
34759
+ type: string;
34760
+ message: string;
34761
+ };
34762
+ } | {
34763
+ /** The ID of the action attempt. */
34764
+ action_attempt_id: string;
34765
+ status: 'pending';
34766
+ result: null;
34767
+ error: null;
34768
+ action_type: 'CREATE_NOISE_THRESHOLD';
34769
+ } | {
33508
34770
  /** The ID of the action attempt. */
33509
34771
  action_attempt_id: string;
33510
34772
  status: 'success';
@@ -38999,6 +40261,11 @@ interface Routes {
38999
40261
  user_identity_phone_number?: (string | null) | undefined;
39000
40262
  latest_desired_state_synced_with_provider_at?: string | undefined;
39001
40263
  is_latest_desired_state_synced_with_provider?: boolean | undefined;
40264
+ warnings: Array<{
40265
+ created_at: string;
40266
+ message: string;
40267
+ warning_code: 'being_deleted';
40268
+ }>;
39002
40269
  full_name?: string | undefined;
39003
40270
  /**
39004
40271
  * @deprecated use email_address. */