@seamapi/types 1.1073.0 → 1.1074.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.
@@ -106798,6 +106798,4137 @@ export type Routes = {
106798
106798
  jsonResponse: {}
106799
106799
  maxDuration: undefined
106800
106800
  }
106801
+ '/seam/webhooks/v1/simulate_event': {
106802
+ route: '/seam/webhooks/v1/simulate_event'
106803
+ method: 'POST'
106804
+ queryParams: {}
106805
+ jsonBody: {
106806
+ /** Type of the event that you want to send to your webhooks. */
106807
+ event_type:
106808
+ | 'access_code.created'
106809
+ | 'access_code.changed'
106810
+ | 'access_code.name_changed'
106811
+ | 'access_code.code_changed'
106812
+ | 'access_code.time_frame_changed'
106813
+ | 'access_code.mutations_requested'
106814
+ | 'access_code.scheduled_on_device'
106815
+ | 'access_code.set_on_device'
106816
+ | 'access_code.removed_from_device'
106817
+ | 'access_code.delay_in_setting_on_device'
106818
+ | 'access_code.failed_to_set_on_device'
106819
+ | 'access_code.issued'
106820
+ | 'access_code.delay_in_issuing'
106821
+ | 'access_code.failed_to_issue'
106822
+ | 'access_code.failed_to_update'
106823
+ | 'access_code.failed_to_expire'
106824
+ | 'access_code.deleted'
106825
+ | 'access_code.delay_in_removing_from_device'
106826
+ | 'access_code.failed_to_remove_from_device'
106827
+ | 'access_code.modified_external_to_seam'
106828
+ | 'access_code.deleted_external_to_seam'
106829
+ | 'access_code.backup_access_code_pulled'
106830
+ | 'access_code.unmanaged.converted_to_managed'
106831
+ | 'access_code.unmanaged.failed_to_convert_to_managed'
106832
+ | 'access_code.unmanaged.created'
106833
+ | 'access_code.unmanaged.removed'
106834
+ | 'access_grant.created'
106835
+ | 'access_grant.deleted'
106836
+ | 'access_grant.access_granted_to_all_doors'
106837
+ | 'access_grant.access_granted_to_door'
106838
+ | 'access_grant.access_to_door_lost'
106839
+ | 'access_grant.access_times_changed'
106840
+ | 'access_grant.could_not_create_requested_access_methods'
106841
+ | 'access_method.issued'
106842
+ | 'access_method.revoked'
106843
+ | 'access_method.card_encoding_required'
106844
+ | 'access_method.deleted'
106845
+ | 'access_method.reissued'
106846
+ | 'access_method.created'
106847
+ | 'access_method.delay_in_issuing'
106848
+ | 'access_method.failed_to_issue'
106849
+ | 'acs_system.connected'
106850
+ | 'acs_system.added'
106851
+ | 'acs_system.disconnected'
106852
+ | 'acs_credential.deleted'
106853
+ | 'acs_credential.issued'
106854
+ | 'acs_credential.reissued'
106855
+ | 'acs_credential.invalidated'
106856
+ | 'acs_user.created'
106857
+ | 'acs_user.deleted'
106858
+ | 'acs_encoder.added'
106859
+ | 'acs_encoder.removed'
106860
+ | 'acs_access_group.deleted'
106861
+ | 'acs_entrance.added'
106862
+ | 'acs_entrance.removed'
106863
+ | 'client_session.deleted'
106864
+ | 'connected_account.connected'
106865
+ | 'connected_account.created'
106866
+ | 'connected_account.successful_login'
106867
+ | 'connected_account.disconnected'
106868
+ | 'connected_account.completed_first_sync'
106869
+ | 'connected_account.deleted'
106870
+ | 'connected_account.completed_first_sync_after_reconnection'
106871
+ | 'connected_account.reauthorization_requested'
106872
+ | 'action_attempt.lock_door.succeeded'
106873
+ | 'action_attempt.lock_door.failed'
106874
+ | 'action_attempt.unlock_door.succeeded'
106875
+ | 'action_attempt.unlock_door.failed'
106876
+ | 'action_attempt.simulate_keypad_code_entry.succeeded'
106877
+ | 'action_attempt.simulate_keypad_code_entry.failed'
106878
+ | 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
106879
+ | 'action_attempt.simulate_manual_lock_via_keypad.failed'
106880
+ | 'connect_webview.login_succeeded'
106881
+ | 'connect_webview.login_failed'
106882
+ | 'device.connected'
106883
+ | 'device.added'
106884
+ | 'device.converted_to_unmanaged'
106885
+ | 'device.unmanaged.converted_to_managed'
106886
+ | 'device.unmanaged.connected'
106887
+ | 'device.disconnected'
106888
+ | 'device.unmanaged.disconnected'
106889
+ | 'device.tampered'
106890
+ | 'device.low_battery'
106891
+ | 'device.battery_status_changed'
106892
+ | 'device.removed'
106893
+ | 'device.deleted'
106894
+ | 'device.third_party_integration_detected'
106895
+ | 'device.third_party_integration_no_longer_detected'
106896
+ | 'device.salto.privacy_mode_activated'
106897
+ | 'device.salto.privacy_mode_deactivated'
106898
+ | 'device.connection_became_flaky'
106899
+ | 'device.connection_stabilized'
106900
+ | 'device.error.subscription_required'
106901
+ | 'device.error.subscription_required.resolved'
106902
+ | 'device.accessory_keypad_connected'
106903
+ | 'device.accessory_keypad_disconnected'
106904
+ | 'noise_sensor.noise_threshold_triggered'
106905
+ | 'lock.locked'
106906
+ | 'lock.unlocked'
106907
+ | 'lock.access_denied'
106908
+ | 'thermostat.climate_preset_activated'
106909
+ | 'thermostat.manually_adjusted'
106910
+ | 'thermostat.temperature_threshold_exceeded'
106911
+ | 'thermostat.temperature_threshold_no_longer_exceeded'
106912
+ | 'thermostat.temperature_reached_set_point'
106913
+ | 'thermostat.temperature_changed'
106914
+ | 'device.name_changed'
106915
+ | 'camera.activated'
106916
+ | 'device.doorbell_rang'
106917
+ | 'enrollment_automation.deleted'
106918
+ | 'phone.deactivated'
106919
+ | 'space.device_membership_changed'
106920
+ | 'space.created'
106921
+ | 'space.deleted'
106922
+ /** Event payload fields that you want to set explicitly. Each field that you provide overrides the value that Seam would otherwise fill in. */
106923
+ payload?: {
106924
+ [x: string]: unknown
106925
+ }
106926
+ }
106927
+ commonParams: {}
106928
+ formData: {}
106929
+ jsonResponse: {
106930
+ /** Represents an event. Events let you know when something interesting happens in your workspace. For example, when a lock is unlocked, Seam creates a `lock.unlocked` event. When a device's battery level is low, Seam creates a `device.battery_low` event.
106931
+
106932
+ As with other API resources, you can retrieve an individual event or a list of events. Seam also provides a separate webhook system for sending the event objects directly to an endpoint on your sever. Manage webhooks through [Seam Console](https://console.seam.co). You can also use the webhooks sandbox in Seam Console to see the different payloads for each event and test them against your own endpoints. */
106933
+ event:
106934
+ | {
106935
+ /** ID of the event. */
106936
+ event_id: string
106937
+ /** ID of the workspace associated with the event. */
106938
+ workspace_id: string
106939
+ /** Date and time at which the event was created. */
106940
+ created_at: string
106941
+ /** Date and time at which the event occurred. */
106942
+ occurred_at: string
106943
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
106944
+ event_description?: string | undefined
106945
+ /** ID of the affected access code. */
106946
+ access_code_id: string
106947
+ /** ID of the device associated with the affected access code. */
106948
+ device_id: string
106949
+ /** ID of the connected account associated with the affected access code. */
106950
+ connected_account_id: string
106951
+ /** Custom metadata of the device, present when device_id is provided. */
106952
+ device_custom_metadata?:
106953
+ | {
106954
+ [x: string]: string | boolean
106955
+ }
106956
+ | undefined
106957
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
106958
+ connected_account_custom_metadata?:
106959
+ | {
106960
+ [x: string]: string | boolean
106961
+ }
106962
+ | undefined
106963
+ event_type: 'access_code.created'
106964
+ }
106965
+ | {
106966
+ /** ID of the event. */
106967
+ event_id: string
106968
+ /** ID of the workspace associated with the event. */
106969
+ workspace_id: string
106970
+ /** Date and time at which the event was created. */
106971
+ created_at: string
106972
+ /** Date and time at which the event occurred. */
106973
+ occurred_at: string
106974
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
106975
+ event_description?: string | undefined
106976
+ /** ID of the affected access code. */
106977
+ access_code_id: string
106978
+ /** ID of the device associated with the affected access code. */
106979
+ device_id: string
106980
+ /** ID of the connected account associated with the affected access code. */
106981
+ connected_account_id: string
106982
+ /** Custom metadata of the device, present when device_id is provided. */
106983
+ device_custom_metadata?:
106984
+ | {
106985
+ [x: string]: string | boolean
106986
+ }
106987
+ | undefined
106988
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
106989
+ connected_account_custom_metadata?:
106990
+ | {
106991
+ [x: string]: string | boolean
106992
+ }
106993
+ | undefined
106994
+ event_type: 'access_code.changed'
106995
+ /** List of properties that changed on the access code. */
106996
+ changed_properties?:
106997
+ | {
106998
+ /** Name of the property that changed (e.g. `code`). */
106999
+ property: string
107000
+ /** Previous value of the property, or null if not set. */
107001
+ from: string | null
107002
+ /** New value of the property, or null if cleared. */
107003
+ to: string | null
107004
+ }[]
107005
+ | undefined
107006
+ /** Human-readable reason for the change (e.g. `ongoing code auto-renewed`). */
107007
+ change_reason?: string | undefined
107008
+ }
107009
+ | {
107010
+ /** ID of the event. */
107011
+ event_id: string
107012
+ /** ID of the workspace associated with the event. */
107013
+ workspace_id: string
107014
+ /** Date and time at which the event was created. */
107015
+ created_at: string
107016
+ /** Date and time at which the event occurred. */
107017
+ occurred_at: string
107018
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107019
+ event_description?: string | undefined
107020
+ /** ID of the affected access code. */
107021
+ access_code_id: string
107022
+ /** ID of the device associated with the affected access code. */
107023
+ device_id: string
107024
+ /** ID of the connected account associated with the affected access code. */
107025
+ connected_account_id: string
107026
+ /** Custom metadata of the device, present when device_id is provided. */
107027
+ device_custom_metadata?:
107028
+ | {
107029
+ [x: string]: string | boolean
107030
+ }
107031
+ | undefined
107032
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107033
+ connected_account_custom_metadata?:
107034
+ | {
107035
+ [x: string]: string | boolean
107036
+ }
107037
+ | undefined
107038
+ event_type: 'access_code.name_changed'
107039
+ /** Previous access code name configuration. */
107040
+ from: {
107041
+ /** Previous name of the access code. */
107042
+ name: string | null
107043
+ }
107044
+ /** New access code name configuration. */
107045
+ to: {
107046
+ /** New name of the access code. */
107047
+ name: string | null
107048
+ }
107049
+ /** Human-readable description of the change and its source. */
107050
+ description: string
107051
+ }
107052
+ | {
107053
+ /** ID of the event. */
107054
+ event_id: string
107055
+ /** ID of the workspace associated with the event. */
107056
+ workspace_id: string
107057
+ /** Date and time at which the event was created. */
107058
+ created_at: string
107059
+ /** Date and time at which the event occurred. */
107060
+ occurred_at: string
107061
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107062
+ event_description?: string | undefined
107063
+ /** ID of the affected access code. */
107064
+ access_code_id: string
107065
+ /** ID of the device associated with the affected access code. */
107066
+ device_id: string
107067
+ /** ID of the connected account associated with the affected access code. */
107068
+ connected_account_id: string
107069
+ /** Custom metadata of the device, present when device_id is provided. */
107070
+ device_custom_metadata?:
107071
+ | {
107072
+ [x: string]: string | boolean
107073
+ }
107074
+ | undefined
107075
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107076
+ connected_account_custom_metadata?:
107077
+ | {
107078
+ [x: string]: string | boolean
107079
+ }
107080
+ | undefined
107081
+ event_type: 'access_code.code_changed'
107082
+ /** Previous pin code configuration. */
107083
+ from: {
107084
+ /** Previous pin code. */
107085
+ code: string | null
107086
+ }
107087
+ /** New pin code configuration. */
107088
+ to: {
107089
+ /** New pin code. */
107090
+ code: string | null
107091
+ }
107092
+ /** Human-readable description of the change and its source. */
107093
+ description: string
107094
+ }
107095
+ | {
107096
+ /** ID of the event. */
107097
+ event_id: string
107098
+ /** ID of the workspace associated with the event. */
107099
+ workspace_id: string
107100
+ /** Date and time at which the event was created. */
107101
+ created_at: string
107102
+ /** Date and time at which the event occurred. */
107103
+ occurred_at: string
107104
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107105
+ event_description?: string | undefined
107106
+ /** ID of the affected access code. */
107107
+ access_code_id: string
107108
+ /** ID of the device associated with the affected access code. */
107109
+ device_id: string
107110
+ /** ID of the connected account associated with the affected access code. */
107111
+ connected_account_id: string
107112
+ /** Custom metadata of the device, present when device_id is provided. */
107113
+ device_custom_metadata?:
107114
+ | {
107115
+ [x: string]: string | boolean
107116
+ }
107117
+ | undefined
107118
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107119
+ connected_account_custom_metadata?:
107120
+ | {
107121
+ [x: string]: string | boolean
107122
+ }
107123
+ | undefined
107124
+ event_type: 'access_code.time_frame_changed'
107125
+ /** Previous time frame configuration. */
107126
+ from: {
107127
+ /** Previous start time. */
107128
+ starts_at: string | null
107129
+ /** Previous end time. */
107130
+ ends_at: string | null
107131
+ }
107132
+ /** New time frame configuration. */
107133
+ to: {
107134
+ /** New start time. */
107135
+ starts_at: string | null
107136
+ /** New end time. */
107137
+ ends_at: string | null
107138
+ }
107139
+ /** Human-readable description of the change and its source. */
107140
+ description: string
107141
+ }
107142
+ | {
107143
+ /** ID of the event. */
107144
+ event_id: string
107145
+ /** ID of the workspace associated with the event. */
107146
+ workspace_id: string
107147
+ /** Date and time at which the event was created. */
107148
+ created_at: string
107149
+ /** Date and time at which the event occurred. */
107150
+ occurred_at: string
107151
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107152
+ event_description?: string | undefined
107153
+ /** ID of the affected access code. */
107154
+ access_code_id: string
107155
+ /** ID of the device associated with the affected access code. */
107156
+ device_id: string
107157
+ /** ID of the connected account associated with the affected access code. */
107158
+ connected_account_id: string
107159
+ /** Custom metadata of the device, present when device_id is provided. */
107160
+ device_custom_metadata?:
107161
+ | {
107162
+ [x: string]: string | boolean
107163
+ }
107164
+ | undefined
107165
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107166
+ connected_account_custom_metadata?:
107167
+ | {
107168
+ [x: string]: string | boolean
107169
+ }
107170
+ | undefined
107171
+ event_type: 'access_code.mutations_requested'
107172
+ /** Array of mutations requested on the access code, each containing the mutation type and from/to values. */
107173
+ requested_mutations: {
107174
+ /** Code identifying the type of mutation requested, such as `updating_name`, `updating_code`, `updating_time_frame`, or `deleting`. */
107175
+ mutation_code:
107176
+ | 'updating_name'
107177
+ | 'updating_code'
107178
+ | 'updating_time_frame'
107179
+ | 'deleting'
107180
+ | 'creating'
107181
+ | 'deferring_creation'
107182
+ /** Previous property values before the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
107183
+ from?:
107184
+ | {
107185
+ [x: string]: unknown
107186
+ }
107187
+ | undefined
107188
+ /** New property values after the requested change. Keys depend on the mutation type. Absent for non-property mutations like `deleting`. */
107189
+ to?:
107190
+ | {
107191
+ [x: string]: unknown
107192
+ }
107193
+ | undefined
107194
+ }[]
107195
+ }
107196
+ | {
107197
+ /** ID of the event. */
107198
+ event_id: string
107199
+ /** ID of the workspace associated with the event. */
107200
+ workspace_id: string
107201
+ /** Date and time at which the event was created. */
107202
+ created_at: string
107203
+ /** Date and time at which the event occurred. */
107204
+ occurred_at: string
107205
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107206
+ event_description?: string | undefined
107207
+ /** ID of the affected access code. */
107208
+ access_code_id: string
107209
+ /** ID of the device associated with the affected access code. */
107210
+ device_id: string
107211
+ /** ID of the connected account associated with the affected access code. */
107212
+ connected_account_id: string
107213
+ /** Custom metadata of the device, present when device_id is provided. */
107214
+ device_custom_metadata?:
107215
+ | {
107216
+ [x: string]: string | boolean
107217
+ }
107218
+ | undefined
107219
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107220
+ connected_account_custom_metadata?:
107221
+ | {
107222
+ [x: string]: string | boolean
107223
+ }
107224
+ | undefined
107225
+ event_type: 'access_code.scheduled_on_device'
107226
+ /** Code for the affected access code. */
107227
+ code: string
107228
+ }
107229
+ | {
107230
+ /** ID of the event. */
107231
+ event_id: string
107232
+ /** ID of the workspace associated with the event. */
107233
+ workspace_id: string
107234
+ /** Date and time at which the event was created. */
107235
+ created_at: string
107236
+ /** Date and time at which the event occurred. */
107237
+ occurred_at: string
107238
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107239
+ event_description?: string | undefined
107240
+ /** ID of the affected access code. */
107241
+ access_code_id: string
107242
+ /** ID of the device associated with the affected access code. */
107243
+ device_id: string
107244
+ /** ID of the connected account associated with the affected access code. */
107245
+ connected_account_id: string
107246
+ /** Custom metadata of the device, present when device_id is provided. */
107247
+ device_custom_metadata?:
107248
+ | {
107249
+ [x: string]: string | boolean
107250
+ }
107251
+ | undefined
107252
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107253
+ connected_account_custom_metadata?:
107254
+ | {
107255
+ [x: string]: string | boolean
107256
+ }
107257
+ | undefined
107258
+ event_type: 'access_code.set_on_device'
107259
+ /** Code for the affected access code. */
107260
+ code: string
107261
+ }
107262
+ | {
107263
+ /** ID of the event. */
107264
+ event_id: string
107265
+ /** ID of the workspace associated with the event. */
107266
+ workspace_id: string
107267
+ /** Date and time at which the event was created. */
107268
+ created_at: string
107269
+ /** Date and time at which the event occurred. */
107270
+ occurred_at: string
107271
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107272
+ event_description?: string | undefined
107273
+ /** ID of the affected access code. */
107274
+ access_code_id: string
107275
+ /** ID of the device associated with the affected access code. */
107276
+ device_id: string
107277
+ /** ID of the connected account associated with the affected access code. */
107278
+ connected_account_id: string
107279
+ /** Custom metadata of the device, present when device_id is provided. */
107280
+ device_custom_metadata?:
107281
+ | {
107282
+ [x: string]: string | boolean
107283
+ }
107284
+ | undefined
107285
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107286
+ connected_account_custom_metadata?:
107287
+ | {
107288
+ [x: string]: string | boolean
107289
+ }
107290
+ | undefined
107291
+ event_type: 'access_code.removed_from_device'
107292
+ }
107293
+ | {
107294
+ /** ID of the event. */
107295
+ event_id: string
107296
+ /** ID of the workspace associated with the event. */
107297
+ workspace_id: string
107298
+ /** Date and time at which the event was created. */
107299
+ created_at: string
107300
+ /** Date and time at which the event occurred. */
107301
+ occurred_at: string
107302
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107303
+ event_description?: string | undefined
107304
+ /** ID of the affected access code. */
107305
+ access_code_id: string
107306
+ /** ID of the device associated with the affected access code. */
107307
+ device_id: string
107308
+ /** ID of the connected account associated with the affected access code. */
107309
+ connected_account_id: string
107310
+ /** Custom metadata of the device, present when device_id is provided. */
107311
+ device_custom_metadata?:
107312
+ | {
107313
+ [x: string]: string | boolean
107314
+ }
107315
+ | undefined
107316
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107317
+ connected_account_custom_metadata?:
107318
+ | {
107319
+ [x: string]: string | boolean
107320
+ }
107321
+ | undefined
107322
+ event_type: 'access_code.delay_in_setting_on_device'
107323
+ /** Errors associated with the connected account. */
107324
+ connected_account_errors: {
107325
+ /** Date and time at which Seam created the error. */
107326
+ created_at: string
107327
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107328
+ message: string
107329
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107330
+ error_code: string
107331
+ }[]
107332
+ /** Warnings associated with the connected account. */
107333
+ connected_account_warnings: {
107334
+ /** Date and time at which Seam created the warning. */
107335
+ created_at: string
107336
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107337
+ message: string
107338
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107339
+ warning_code: string
107340
+ }[]
107341
+ /** Errors associated with the device. */
107342
+ device_errors: {
107343
+ /** Date and time at which Seam created the error. */
107344
+ created_at: string
107345
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107346
+ message: string
107347
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107348
+ error_code: string
107349
+ }[]
107350
+ /** Warnings associated with the device. */
107351
+ device_warnings: {
107352
+ /** Date and time at which Seam created the warning. */
107353
+ created_at: string
107354
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107355
+ message: string
107356
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107357
+ warning_code: string
107358
+ }[]
107359
+ /** Errors associated with the access code. */
107360
+ access_code_errors: {
107361
+ /** Date and time at which Seam created the error. */
107362
+ created_at: string
107363
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107364
+ message: string
107365
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107366
+ error_code: string
107367
+ }[]
107368
+ /** Warnings associated with the access code. */
107369
+ access_code_warnings: {
107370
+ /** Date and time at which Seam created the warning. */
107371
+ created_at: string
107372
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107373
+ message: string
107374
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107375
+ warning_code: string
107376
+ }[]
107377
+ }
107378
+ | {
107379
+ /** ID of the event. */
107380
+ event_id: string
107381
+ /** ID of the workspace associated with the event. */
107382
+ workspace_id: string
107383
+ /** Date and time at which the event was created. */
107384
+ created_at: string
107385
+ /** Date and time at which the event occurred. */
107386
+ occurred_at: string
107387
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107388
+ event_description?: string | undefined
107389
+ /** ID of the affected access code. */
107390
+ access_code_id: string
107391
+ /** ID of the device associated with the affected access code. */
107392
+ device_id: string
107393
+ /** ID of the connected account associated with the affected access code. */
107394
+ connected_account_id: string
107395
+ /** Custom metadata of the device, present when device_id is provided. */
107396
+ device_custom_metadata?:
107397
+ | {
107398
+ [x: string]: string | boolean
107399
+ }
107400
+ | undefined
107401
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107402
+ connected_account_custom_metadata?:
107403
+ | {
107404
+ [x: string]: string | boolean
107405
+ }
107406
+ | undefined
107407
+ event_type: 'access_code.failed_to_set_on_device'
107408
+ /** Errors associated with the connected account. */
107409
+ connected_account_errors: {
107410
+ /** Date and time at which Seam created the error. */
107411
+ created_at: string
107412
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107413
+ message: string
107414
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107415
+ error_code: string
107416
+ }[]
107417
+ /** Warnings associated with the connected account. */
107418
+ connected_account_warnings: {
107419
+ /** Date and time at which Seam created the warning. */
107420
+ created_at: string
107421
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107422
+ message: string
107423
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107424
+ warning_code: string
107425
+ }[]
107426
+ /** Errors associated with the device. */
107427
+ device_errors: {
107428
+ /** Date and time at which Seam created the error. */
107429
+ created_at: string
107430
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107431
+ message: string
107432
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107433
+ error_code: string
107434
+ }[]
107435
+ /** Warnings associated with the device. */
107436
+ device_warnings: {
107437
+ /** Date and time at which Seam created the warning. */
107438
+ created_at: string
107439
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107440
+ message: string
107441
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107442
+ warning_code: string
107443
+ }[]
107444
+ /** Errors associated with the access code. */
107445
+ access_code_errors: {
107446
+ /** Date and time at which Seam created the error. */
107447
+ created_at: string
107448
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107449
+ message: string
107450
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107451
+ error_code: string
107452
+ }[]
107453
+ /** Warnings associated with the access code. */
107454
+ access_code_warnings: {
107455
+ /** Date and time at which Seam created the warning. */
107456
+ created_at: string
107457
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107458
+ message: string
107459
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107460
+ warning_code: string
107461
+ }[]
107462
+ }
107463
+ | {
107464
+ /** ID of the event. */
107465
+ event_id: string
107466
+ /** ID of the workspace associated with the event. */
107467
+ workspace_id: string
107468
+ /** Date and time at which the event was created. */
107469
+ created_at: string
107470
+ /** Date and time at which the event occurred. */
107471
+ occurred_at: string
107472
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107473
+ event_description?: string | undefined
107474
+ /** ID of the affected access code. */
107475
+ access_code_id: string
107476
+ /** ID of the device associated with the affected access code. */
107477
+ device_id: string
107478
+ /** ID of the connected account associated with the affected access code. */
107479
+ connected_account_id: string
107480
+ /** Custom metadata of the device, present when device_id is provided. */
107481
+ device_custom_metadata?:
107482
+ | {
107483
+ [x: string]: string | boolean
107484
+ }
107485
+ | undefined
107486
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107487
+ connected_account_custom_metadata?:
107488
+ | {
107489
+ [x: string]: string | boolean
107490
+ }
107491
+ | undefined
107492
+ event_type: 'access_code.issued'
107493
+ /** Code for the affected access code. */
107494
+ code: string
107495
+ }
107496
+ | {
107497
+ /** ID of the event. */
107498
+ event_id: string
107499
+ /** ID of the workspace associated with the event. */
107500
+ workspace_id: string
107501
+ /** Date and time at which the event was created. */
107502
+ created_at: string
107503
+ /** Date and time at which the event occurred. */
107504
+ occurred_at: string
107505
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107506
+ event_description?: string | undefined
107507
+ /** ID of the affected access code. */
107508
+ access_code_id: string
107509
+ /** ID of the device associated with the affected access code. */
107510
+ device_id: string
107511
+ /** ID of the connected account associated with the affected access code. */
107512
+ connected_account_id: string
107513
+ /** Custom metadata of the device, present when device_id is provided. */
107514
+ device_custom_metadata?:
107515
+ | {
107516
+ [x: string]: string | boolean
107517
+ }
107518
+ | undefined
107519
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107520
+ connected_account_custom_metadata?:
107521
+ | {
107522
+ [x: string]: string | boolean
107523
+ }
107524
+ | undefined
107525
+ event_type: 'access_code.delay_in_issuing'
107526
+ /** Errors associated with the connected account. */
107527
+ connected_account_errors: {
107528
+ /** Date and time at which Seam created the error. */
107529
+ created_at: string
107530
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107531
+ message: string
107532
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107533
+ error_code: string
107534
+ }[]
107535
+ /** Warnings associated with the connected account. */
107536
+ connected_account_warnings: {
107537
+ /** Date and time at which Seam created the warning. */
107538
+ created_at: string
107539
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107540
+ message: string
107541
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107542
+ warning_code: string
107543
+ }[]
107544
+ /** Errors associated with the device. */
107545
+ device_errors: {
107546
+ /** Date and time at which Seam created the error. */
107547
+ created_at: string
107548
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107549
+ message: string
107550
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107551
+ error_code: string
107552
+ }[]
107553
+ /** Warnings associated with the device. */
107554
+ device_warnings: {
107555
+ /** Date and time at which Seam created the warning. */
107556
+ created_at: string
107557
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107558
+ message: string
107559
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107560
+ warning_code: string
107561
+ }[]
107562
+ /** Errors associated with the access code. */
107563
+ access_code_errors: {
107564
+ /** Date and time at which Seam created the error. */
107565
+ created_at: string
107566
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107567
+ message: string
107568
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107569
+ error_code: string
107570
+ }[]
107571
+ /** Warnings associated with the access code. */
107572
+ access_code_warnings: {
107573
+ /** Date and time at which Seam created the warning. */
107574
+ created_at: string
107575
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107576
+ message: string
107577
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107578
+ warning_code: string
107579
+ }[]
107580
+ }
107581
+ | {
107582
+ /** ID of the event. */
107583
+ event_id: string
107584
+ /** ID of the workspace associated with the event. */
107585
+ workspace_id: string
107586
+ /** Date and time at which the event was created. */
107587
+ created_at: string
107588
+ /** Date and time at which the event occurred. */
107589
+ occurred_at: string
107590
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107591
+ event_description?: string | undefined
107592
+ /** ID of the affected access code. */
107593
+ access_code_id: string
107594
+ /** ID of the device associated with the affected access code. */
107595
+ device_id: string
107596
+ /** ID of the connected account associated with the affected access code. */
107597
+ connected_account_id: string
107598
+ /** Custom metadata of the device, present when device_id is provided. */
107599
+ device_custom_metadata?:
107600
+ | {
107601
+ [x: string]: string | boolean
107602
+ }
107603
+ | undefined
107604
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107605
+ connected_account_custom_metadata?:
107606
+ | {
107607
+ [x: string]: string | boolean
107608
+ }
107609
+ | undefined
107610
+ event_type: 'access_code.failed_to_issue'
107611
+ /** Errors associated with the connected account. */
107612
+ connected_account_errors: {
107613
+ /** Date and time at which Seam created the error. */
107614
+ created_at: string
107615
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107616
+ message: string
107617
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107618
+ error_code: string
107619
+ }[]
107620
+ /** Warnings associated with the connected account. */
107621
+ connected_account_warnings: {
107622
+ /** Date and time at which Seam created the warning. */
107623
+ created_at: string
107624
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107625
+ message: string
107626
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107627
+ warning_code: string
107628
+ }[]
107629
+ /** Errors associated with the device. */
107630
+ device_errors: {
107631
+ /** Date and time at which Seam created the error. */
107632
+ created_at: string
107633
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107634
+ message: string
107635
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107636
+ error_code: string
107637
+ }[]
107638
+ /** Warnings associated with the device. */
107639
+ device_warnings: {
107640
+ /** Date and time at which Seam created the warning. */
107641
+ created_at: string
107642
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107643
+ message: string
107644
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107645
+ warning_code: string
107646
+ }[]
107647
+ /** Errors associated with the access code. */
107648
+ access_code_errors: {
107649
+ /** Date and time at which Seam created the error. */
107650
+ created_at: string
107651
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107652
+ message: string
107653
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107654
+ error_code: string
107655
+ }[]
107656
+ /** Warnings associated with the access code. */
107657
+ access_code_warnings: {
107658
+ /** Date and time at which Seam created the warning. */
107659
+ created_at: string
107660
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107661
+ message: string
107662
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107663
+ warning_code: string
107664
+ }[]
107665
+ }
107666
+ | {
107667
+ /** ID of the event. */
107668
+ event_id: string
107669
+ /** ID of the workspace associated with the event. */
107670
+ workspace_id: string
107671
+ /** Date and time at which the event was created. */
107672
+ created_at: string
107673
+ /** Date and time at which the event occurred. */
107674
+ occurred_at: string
107675
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107676
+ event_description?: string | undefined
107677
+ /** ID of the affected access code. */
107678
+ access_code_id: string
107679
+ /** ID of the device associated with the affected access code. */
107680
+ device_id: string
107681
+ /** ID of the connected account associated with the affected access code. */
107682
+ connected_account_id: string
107683
+ /** Custom metadata of the device, present when device_id is provided. */
107684
+ device_custom_metadata?:
107685
+ | {
107686
+ [x: string]: string | boolean
107687
+ }
107688
+ | undefined
107689
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107690
+ connected_account_custom_metadata?:
107691
+ | {
107692
+ [x: string]: string | boolean
107693
+ }
107694
+ | undefined
107695
+ event_type: 'access_code.failed_to_update'
107696
+ /** Errors associated with the connected account. */
107697
+ connected_account_errors: {
107698
+ /** Date and time at which Seam created the error. */
107699
+ created_at: string
107700
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107701
+ message: string
107702
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107703
+ error_code: string
107704
+ }[]
107705
+ /** Warnings associated with the connected account. */
107706
+ connected_account_warnings: {
107707
+ /** Date and time at which Seam created the warning. */
107708
+ created_at: string
107709
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107710
+ message: string
107711
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107712
+ warning_code: string
107713
+ }[]
107714
+ /** Errors associated with the device. */
107715
+ device_errors: {
107716
+ /** Date and time at which Seam created the error. */
107717
+ created_at: string
107718
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107719
+ message: string
107720
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107721
+ error_code: string
107722
+ }[]
107723
+ /** Warnings associated with the device. */
107724
+ device_warnings: {
107725
+ /** Date and time at which Seam created the warning. */
107726
+ created_at: string
107727
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107728
+ message: string
107729
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107730
+ warning_code: string
107731
+ }[]
107732
+ /** Errors associated with the access code. */
107733
+ access_code_errors: {
107734
+ /** Date and time at which Seam created the error. */
107735
+ created_at: string
107736
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107737
+ message: string
107738
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107739
+ error_code: string
107740
+ }[]
107741
+ /** Warnings associated with the access code. */
107742
+ access_code_warnings: {
107743
+ /** Date and time at which Seam created the warning. */
107744
+ created_at: string
107745
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107746
+ message: string
107747
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107748
+ warning_code: string
107749
+ }[]
107750
+ }
107751
+ | {
107752
+ /** ID of the event. */
107753
+ event_id: string
107754
+ /** ID of the workspace associated with the event. */
107755
+ workspace_id: string
107756
+ /** Date and time at which the event was created. */
107757
+ created_at: string
107758
+ /** Date and time at which the event occurred. */
107759
+ occurred_at: string
107760
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107761
+ event_description?: string | undefined
107762
+ /** ID of the affected access code. */
107763
+ access_code_id: string
107764
+ /** ID of the device associated with the affected access code. */
107765
+ device_id: string
107766
+ /** ID of the connected account associated with the affected access code. */
107767
+ connected_account_id: string
107768
+ /** Custom metadata of the device, present when device_id is provided. */
107769
+ device_custom_metadata?:
107770
+ | {
107771
+ [x: string]: string | boolean
107772
+ }
107773
+ | undefined
107774
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107775
+ connected_account_custom_metadata?:
107776
+ | {
107777
+ [x: string]: string | boolean
107778
+ }
107779
+ | undefined
107780
+ event_type: 'access_code.failed_to_expire'
107781
+ /** Errors associated with the connected account. */
107782
+ connected_account_errors: {
107783
+ /** Date and time at which Seam created the error. */
107784
+ created_at: string
107785
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107786
+ message: string
107787
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107788
+ error_code: string
107789
+ }[]
107790
+ /** Warnings associated with the connected account. */
107791
+ connected_account_warnings: {
107792
+ /** Date and time at which Seam created the warning. */
107793
+ created_at: string
107794
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107795
+ message: string
107796
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107797
+ warning_code: string
107798
+ }[]
107799
+ /** Errors associated with the device. */
107800
+ device_errors: {
107801
+ /** Date and time at which Seam created the error. */
107802
+ created_at: string
107803
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107804
+ message: string
107805
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107806
+ error_code: string
107807
+ }[]
107808
+ /** Warnings associated with the device. */
107809
+ device_warnings: {
107810
+ /** Date and time at which Seam created the warning. */
107811
+ created_at: string
107812
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107813
+ message: string
107814
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107815
+ warning_code: string
107816
+ }[]
107817
+ /** Errors associated with the access code. */
107818
+ access_code_errors: {
107819
+ /** Date and time at which Seam created the error. */
107820
+ created_at: string
107821
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107822
+ message: string
107823
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107824
+ error_code: string
107825
+ }[]
107826
+ /** Warnings associated with the access code. */
107827
+ access_code_warnings: {
107828
+ /** Date and time at which Seam created the warning. */
107829
+ created_at: string
107830
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107831
+ message: string
107832
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107833
+ warning_code: string
107834
+ }[]
107835
+ }
107836
+ | {
107837
+ /** ID of the event. */
107838
+ event_id: string
107839
+ /** ID of the workspace associated with the event. */
107840
+ workspace_id: string
107841
+ /** Date and time at which the event was created. */
107842
+ created_at: string
107843
+ /** Date and time at which the event occurred. */
107844
+ occurred_at: string
107845
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107846
+ event_description?: string | undefined
107847
+ /** ID of the affected access code. */
107848
+ access_code_id: string
107849
+ /** ID of the device associated with the affected access code. */
107850
+ device_id: string
107851
+ /** ID of the connected account associated with the affected access code. */
107852
+ connected_account_id: string
107853
+ /** Custom metadata of the device, present when device_id is provided. */
107854
+ device_custom_metadata?:
107855
+ | {
107856
+ [x: string]: string | boolean
107857
+ }
107858
+ | undefined
107859
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107860
+ connected_account_custom_metadata?:
107861
+ | {
107862
+ [x: string]: string | boolean
107863
+ }
107864
+ | undefined
107865
+ event_type: 'access_code.deleted'
107866
+ /** Code for the affected access code. */
107867
+ code: string | null
107868
+ }
107869
+ | {
107870
+ /** ID of the event. */
107871
+ event_id: string
107872
+ /** ID of the workspace associated with the event. */
107873
+ workspace_id: string
107874
+ /** Date and time at which the event was created. */
107875
+ created_at: string
107876
+ /** Date and time at which the event occurred. */
107877
+ occurred_at: string
107878
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107879
+ event_description?: string | undefined
107880
+ /** ID of the affected access code. */
107881
+ access_code_id: string
107882
+ /** ID of the device associated with the affected access code. */
107883
+ device_id: string
107884
+ /** ID of the connected account associated with the affected access code. */
107885
+ connected_account_id: string
107886
+ /** Custom metadata of the device, present when device_id is provided. */
107887
+ device_custom_metadata?:
107888
+ | {
107889
+ [x: string]: string | boolean
107890
+ }
107891
+ | undefined
107892
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107893
+ connected_account_custom_metadata?:
107894
+ | {
107895
+ [x: string]: string | boolean
107896
+ }
107897
+ | undefined
107898
+ event_type: 'access_code.delay_in_removing_from_device'
107899
+ /** Errors associated with the connected account. */
107900
+ connected_account_errors: {
107901
+ /** Date and time at which Seam created the error. */
107902
+ created_at: string
107903
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107904
+ message: string
107905
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107906
+ error_code: string
107907
+ }[]
107908
+ /** Warnings associated with the connected account. */
107909
+ connected_account_warnings: {
107910
+ /** Date and time at which Seam created the warning. */
107911
+ created_at: string
107912
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107913
+ message: string
107914
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107915
+ warning_code: string
107916
+ }[]
107917
+ /** Errors associated with the device. */
107918
+ device_errors: {
107919
+ /** Date and time at which Seam created the error. */
107920
+ created_at: string
107921
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107922
+ message: string
107923
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107924
+ error_code: string
107925
+ }[]
107926
+ /** Warnings associated with the device. */
107927
+ device_warnings: {
107928
+ /** Date and time at which Seam created the warning. */
107929
+ created_at: string
107930
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107931
+ message: string
107932
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107933
+ warning_code: string
107934
+ }[]
107935
+ /** Errors associated with the access code. */
107936
+ access_code_errors: {
107937
+ /** Date and time at which Seam created the error. */
107938
+ created_at: string
107939
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107940
+ message: string
107941
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107942
+ error_code: string
107943
+ }[]
107944
+ /** Warnings associated with the access code. */
107945
+ access_code_warnings: {
107946
+ /** Date and time at which Seam created the warning. */
107947
+ created_at: string
107948
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107949
+ message: string
107950
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
107951
+ warning_code: string
107952
+ }[]
107953
+ }
107954
+ | {
107955
+ /** ID of the event. */
107956
+ event_id: string
107957
+ /** ID of the workspace associated with the event. */
107958
+ workspace_id: string
107959
+ /** Date and time at which the event was created. */
107960
+ created_at: string
107961
+ /** Date and time at which the event occurred. */
107962
+ occurred_at: string
107963
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
107964
+ event_description?: string | undefined
107965
+ /** ID of the affected access code. */
107966
+ access_code_id: string
107967
+ /** ID of the device associated with the affected access code. */
107968
+ device_id: string
107969
+ /** ID of the connected account associated with the affected access code. */
107970
+ connected_account_id: string
107971
+ /** Custom metadata of the device, present when device_id is provided. */
107972
+ device_custom_metadata?:
107973
+ | {
107974
+ [x: string]: string | boolean
107975
+ }
107976
+ | undefined
107977
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
107978
+ connected_account_custom_metadata?:
107979
+ | {
107980
+ [x: string]: string | boolean
107981
+ }
107982
+ | undefined
107983
+ event_type: 'access_code.failed_to_remove_from_device'
107984
+ /** Errors associated with the connected account. */
107985
+ connected_account_errors: {
107986
+ /** Date and time at which Seam created the error. */
107987
+ created_at: string
107988
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
107989
+ message: string
107990
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
107991
+ error_code: string
107992
+ }[]
107993
+ /** Warnings associated with the connected account. */
107994
+ connected_account_warnings: {
107995
+ /** Date and time at which Seam created the warning. */
107996
+ created_at: string
107997
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
107998
+ message: string
107999
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108000
+ warning_code: string
108001
+ }[]
108002
+ /** Errors associated with the device. */
108003
+ device_errors: {
108004
+ /** Date and time at which Seam created the error. */
108005
+ created_at: string
108006
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108007
+ message: string
108008
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
108009
+ error_code: string
108010
+ }[]
108011
+ /** Warnings associated with the device. */
108012
+ device_warnings: {
108013
+ /** Date and time at which Seam created the warning. */
108014
+ created_at: string
108015
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108016
+ message: string
108017
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108018
+ warning_code: string
108019
+ }[]
108020
+ /** Errors associated with the access code. */
108021
+ access_code_errors: {
108022
+ /** Date and time at which Seam created the error. */
108023
+ created_at: string
108024
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108025
+ message: string
108026
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
108027
+ error_code: string
108028
+ }[]
108029
+ /** Warnings associated with the access code. */
108030
+ access_code_warnings: {
108031
+ /** Date and time at which Seam created the warning. */
108032
+ created_at: string
108033
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108034
+ message: string
108035
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108036
+ warning_code: string
108037
+ }[]
108038
+ }
108039
+ | {
108040
+ /** ID of the event. */
108041
+ event_id: string
108042
+ /** ID of the workspace associated with the event. */
108043
+ workspace_id: string
108044
+ /** Date and time at which the event was created. */
108045
+ created_at: string
108046
+ /** Date and time at which the event occurred. */
108047
+ occurred_at: string
108048
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108049
+ event_description?: string | undefined
108050
+ /** ID of the affected access code. */
108051
+ access_code_id: string
108052
+ /** ID of the device associated with the affected access code. */
108053
+ device_id: string
108054
+ /** ID of the connected account associated with the affected access code. */
108055
+ connected_account_id: string
108056
+ /** Custom metadata of the device, present when device_id is provided. */
108057
+ device_custom_metadata?:
108058
+ | {
108059
+ [x: string]: string | boolean
108060
+ }
108061
+ | undefined
108062
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108063
+ connected_account_custom_metadata?:
108064
+ | {
108065
+ [x: string]: string | boolean
108066
+ }
108067
+ | undefined
108068
+ event_type: 'access_code.modified_external_to_seam'
108069
+ }
108070
+ | {
108071
+ /** ID of the event. */
108072
+ event_id: string
108073
+ /** ID of the workspace associated with the event. */
108074
+ workspace_id: string
108075
+ /** Date and time at which the event was created. */
108076
+ created_at: string
108077
+ /** Date and time at which the event occurred. */
108078
+ occurred_at: string
108079
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108080
+ event_description?: string | undefined
108081
+ /** ID of the affected access code. */
108082
+ access_code_id: string
108083
+ /** ID of the device associated with the affected access code. */
108084
+ device_id: string
108085
+ /** ID of the connected account associated with the affected access code. */
108086
+ connected_account_id: string
108087
+ /** Custom metadata of the device, present when device_id is provided. */
108088
+ device_custom_metadata?:
108089
+ | {
108090
+ [x: string]: string | boolean
108091
+ }
108092
+ | undefined
108093
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108094
+ connected_account_custom_metadata?:
108095
+ | {
108096
+ [x: string]: string | boolean
108097
+ }
108098
+ | undefined
108099
+ event_type: 'access_code.deleted_external_to_seam'
108100
+ }
108101
+ | {
108102
+ /** ID of the event. */
108103
+ event_id: string
108104
+ /** ID of the workspace associated with the event. */
108105
+ workspace_id: string
108106
+ /** Date and time at which the event was created. */
108107
+ created_at: string
108108
+ /** Date and time at which the event occurred. */
108109
+ occurred_at: string
108110
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108111
+ event_description?: string | undefined
108112
+ /** ID of the affected access code. */
108113
+ access_code_id: string
108114
+ /** ID of the device associated with the affected access code. */
108115
+ device_id: string
108116
+ /** ID of the connected account associated with the affected access code. */
108117
+ connected_account_id: string
108118
+ /** Custom metadata of the device, present when device_id is provided. */
108119
+ device_custom_metadata?:
108120
+ | {
108121
+ [x: string]: string | boolean
108122
+ }
108123
+ | undefined
108124
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108125
+ connected_account_custom_metadata?:
108126
+ | {
108127
+ [x: string]: string | boolean
108128
+ }
108129
+ | undefined
108130
+ event_type: 'access_code.backup_access_code_pulled'
108131
+ /** ID of the backup access code that was pulled from the pool. */
108132
+ backup_access_code_id: string
108133
+ }
108134
+ | {
108135
+ /** ID of the event. */
108136
+ event_id: string
108137
+ /** ID of the workspace associated with the event. */
108138
+ workspace_id: string
108139
+ /** Date and time at which the event was created. */
108140
+ created_at: string
108141
+ /** Date and time at which the event occurred. */
108142
+ occurred_at: string
108143
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108144
+ event_description?: string | undefined
108145
+ /** ID of the affected access code. */
108146
+ access_code_id: string
108147
+ /** ID of the device associated with the affected access code. */
108148
+ device_id: string
108149
+ /** ID of the connected account associated with the affected access code. */
108150
+ connected_account_id: string
108151
+ /** Custom metadata of the device, present when device_id is provided. */
108152
+ device_custom_metadata?:
108153
+ | {
108154
+ [x: string]: string | boolean
108155
+ }
108156
+ | undefined
108157
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108158
+ connected_account_custom_metadata?:
108159
+ | {
108160
+ [x: string]: string | boolean
108161
+ }
108162
+ | undefined
108163
+ event_type: 'access_code.unmanaged.converted_to_managed'
108164
+ }
108165
+ | {
108166
+ /** ID of the event. */
108167
+ event_id: string
108168
+ /** ID of the workspace associated with the event. */
108169
+ workspace_id: string
108170
+ /** Date and time at which the event was created. */
108171
+ created_at: string
108172
+ /** Date and time at which the event occurred. */
108173
+ occurred_at: string
108174
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108175
+ event_description?: string | undefined
108176
+ /** ID of the affected access code. */
108177
+ access_code_id: string
108178
+ /** ID of the device associated with the affected access code. */
108179
+ device_id: string
108180
+ /** ID of the connected account associated with the affected access code. */
108181
+ connected_account_id: string
108182
+ /** Custom metadata of the device, present when device_id is provided. */
108183
+ device_custom_metadata?:
108184
+ | {
108185
+ [x: string]: string | boolean
108186
+ }
108187
+ | undefined
108188
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108189
+ connected_account_custom_metadata?:
108190
+ | {
108191
+ [x: string]: string | boolean
108192
+ }
108193
+ | undefined
108194
+ event_type: 'access_code.unmanaged.failed_to_convert_to_managed'
108195
+ /** Errors associated with the connected account. */
108196
+ connected_account_errors: {
108197
+ /** Date and time at which Seam created the error. */
108198
+ created_at: string
108199
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108200
+ message: string
108201
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
108202
+ error_code: string
108203
+ }[]
108204
+ /** Warnings associated with the connected account. */
108205
+ connected_account_warnings: {
108206
+ /** Date and time at which Seam created the warning. */
108207
+ created_at: string
108208
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108209
+ message: string
108210
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108211
+ warning_code: string
108212
+ }[]
108213
+ /** Errors associated with the device. */
108214
+ device_errors: {
108215
+ /** Date and time at which Seam created the error. */
108216
+ created_at: string
108217
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108218
+ message: string
108219
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
108220
+ error_code: string
108221
+ }[]
108222
+ /** Warnings associated with the device. */
108223
+ device_warnings: {
108224
+ /** Date and time at which Seam created the warning. */
108225
+ created_at: string
108226
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108227
+ message: string
108228
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108229
+ warning_code: string
108230
+ }[]
108231
+ /** Errors associated with the access code. */
108232
+ access_code_errors: {
108233
+ /** Date and time at which Seam created the error. */
108234
+ created_at: string
108235
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108236
+ message: string
108237
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
108238
+ error_code: string
108239
+ }[]
108240
+ /** Warnings associated with the access code. */
108241
+ access_code_warnings: {
108242
+ /** Date and time at which Seam created the warning. */
108243
+ created_at: string
108244
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108245
+ message: string
108246
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108247
+ warning_code: string
108248
+ }[]
108249
+ }
108250
+ | {
108251
+ /** ID of the event. */
108252
+ event_id: string
108253
+ /** ID of the workspace associated with the event. */
108254
+ workspace_id: string
108255
+ /** Date and time at which the event was created. */
108256
+ created_at: string
108257
+ /** Date and time at which the event occurred. */
108258
+ occurred_at: string
108259
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108260
+ event_description?: string | undefined
108261
+ /** ID of the affected access code. */
108262
+ access_code_id: string
108263
+ /** ID of the device associated with the affected access code. */
108264
+ device_id: string
108265
+ /** ID of the connected account associated with the affected access code. */
108266
+ connected_account_id: string
108267
+ /** Custom metadata of the device, present when device_id is provided. */
108268
+ device_custom_metadata?:
108269
+ | {
108270
+ [x: string]: string | boolean
108271
+ }
108272
+ | undefined
108273
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108274
+ connected_account_custom_metadata?:
108275
+ | {
108276
+ [x: string]: string | boolean
108277
+ }
108278
+ | undefined
108279
+ event_type: 'access_code.unmanaged.created'
108280
+ }
108281
+ | {
108282
+ /** ID of the event. */
108283
+ event_id: string
108284
+ /** ID of the workspace associated with the event. */
108285
+ workspace_id: string
108286
+ /** Date and time at which the event was created. */
108287
+ created_at: string
108288
+ /** Date and time at which the event occurred. */
108289
+ occurred_at: string
108290
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108291
+ event_description?: string | undefined
108292
+ /** ID of the affected access code. */
108293
+ access_code_id: string
108294
+ /** ID of the device associated with the affected access code. */
108295
+ device_id: string
108296
+ /** ID of the connected account associated with the affected access code. */
108297
+ connected_account_id: string
108298
+ /** Custom metadata of the device, present when device_id is provided. */
108299
+ device_custom_metadata?:
108300
+ | {
108301
+ [x: string]: string | boolean
108302
+ }
108303
+ | undefined
108304
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108305
+ connected_account_custom_metadata?:
108306
+ | {
108307
+ [x: string]: string | boolean
108308
+ }
108309
+ | undefined
108310
+ event_type: 'access_code.unmanaged.removed'
108311
+ }
108312
+ | {
108313
+ /** ID of the event. */
108314
+ event_id: string
108315
+ /** ID of the workspace associated with the event. */
108316
+ workspace_id: string
108317
+ /** Date and time at which the event was created. */
108318
+ created_at: string
108319
+ /** Date and time at which the event occurred. */
108320
+ occurred_at: string
108321
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108322
+ event_description?: string | undefined
108323
+ /** ID of the affected Access Grant. */
108324
+ access_grant_id: string
108325
+ event_type: 'access_grant.created'
108326
+ }
108327
+ | {
108328
+ /** ID of the event. */
108329
+ event_id: string
108330
+ /** ID of the workspace associated with the event. */
108331
+ workspace_id: string
108332
+ /** Date and time at which the event was created. */
108333
+ created_at: string
108334
+ /** Date and time at which the event occurred. */
108335
+ occurred_at: string
108336
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108337
+ event_description?: string | undefined
108338
+ /** ID of the affected Access Grant. */
108339
+ access_grant_id: string
108340
+ event_type: 'access_grant.deleted'
108341
+ }
108342
+ | {
108343
+ /** ID of the event. */
108344
+ event_id: string
108345
+ /** ID of the workspace associated with the event. */
108346
+ workspace_id: string
108347
+ /** Date and time at which the event was created. */
108348
+ created_at: string
108349
+ /** Date and time at which the event occurred. */
108350
+ occurred_at: string
108351
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108352
+ event_description?: string | undefined
108353
+ /** ID of the affected Access Grant. */
108354
+ access_grant_id: string
108355
+ event_type: 'access_grant.access_granted_to_all_doors'
108356
+ }
108357
+ | {
108358
+ /** ID of the event. */
108359
+ event_id: string
108360
+ /** ID of the workspace associated with the event. */
108361
+ workspace_id: string
108362
+ /** Date and time at which the event was created. */
108363
+ created_at: string
108364
+ /** Date and time at which the event occurred. */
108365
+ occurred_at: string
108366
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108367
+ event_description?: string | undefined
108368
+ /** ID of the affected Access Grant. */
108369
+ access_grant_id: string
108370
+ event_type: 'access_grant.access_granted_to_door'
108371
+ /** ID of the affected [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
108372
+ acs_entrance_id: string
108373
+ }
108374
+ | {
108375
+ /** ID of the event. */
108376
+ event_id: string
108377
+ /** ID of the workspace associated with the event. */
108378
+ workspace_id: string
108379
+ /** Date and time at which the event was created. */
108380
+ created_at: string
108381
+ /** Date and time at which the event occurred. */
108382
+ occurred_at: string
108383
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108384
+ event_description?: string | undefined
108385
+ /** ID of the affected Access Grant. */
108386
+ access_grant_id: string
108387
+ event_type: 'access_grant.access_to_door_lost'
108388
+ /** ID of the affected [entrance](https://docs.seam.co/low-level-apis/access-systems/retrieving-entrance-details). */
108389
+ acs_entrance_id: string
108390
+ }
108391
+ | {
108392
+ /** ID of the event. */
108393
+ event_id: string
108394
+ /** ID of the workspace associated with the event. */
108395
+ workspace_id: string
108396
+ /** Date and time at which the event was created. */
108397
+ created_at: string
108398
+ /** Date and time at which the event occurred. */
108399
+ occurred_at: string
108400
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108401
+ event_description?: string | undefined
108402
+ /** ID of the affected Access Grant. */
108403
+ access_grant_id: string
108404
+ event_type: 'access_grant.access_times_changed'
108405
+ /** Key of the affected Access Grant (if present). */
108406
+ access_grant_key?: string | undefined
108407
+ /** The new start time for the access grant. */
108408
+ starts_at?: string | undefined
108409
+ /** The new end time for the access grant. */
108410
+ ends_at?: string | undefined
108411
+ }
108412
+ | {
108413
+ /** ID of the event. */
108414
+ event_id: string
108415
+ /** ID of the workspace associated with the event. */
108416
+ workspace_id: string
108417
+ /** Date and time at which the event was created. */
108418
+ created_at: string
108419
+ /** Date and time at which the event occurred. */
108420
+ occurred_at: string
108421
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108422
+ event_description?: string | undefined
108423
+ /** ID of the affected Access Grant. */
108424
+ access_grant_id: string
108425
+ event_type: 'access_grant.could_not_create_requested_access_methods'
108426
+ /** Description of why the access methods could not be created. */
108427
+ error_message: string
108428
+ /** IDs of the devices that did not receive a requested access method. Use these to identify which specific devices failed without having to fetch the Access Grant. */
108429
+ missing_device_ids?: string[] | undefined
108430
+ }
108431
+ | {
108432
+ /** ID of the event. */
108433
+ event_id: string
108434
+ /** ID of the workspace associated with the event. */
108435
+ workspace_id: string
108436
+ /** Date and time at which the event was created. */
108437
+ created_at: string
108438
+ /** Date and time at which the event occurred. */
108439
+ occurred_at: string
108440
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108441
+ event_description?: string | undefined
108442
+ /** ID of the affected access method. */
108443
+ access_method_id: string
108444
+ /** IDs of the access grants associated with this access method. */
108445
+ access_grant_ids: string[]
108446
+ /** Keys of the access grants associated with this access method (if present). */
108447
+ access_grant_keys?: string[] | undefined
108448
+ event_type: 'access_method.issued'
108449
+ /** The actual PIN code for code access methods (only present when mode is 'code'). */
108450
+ code?: string | undefined
108451
+ /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
108452
+ is_backup_code?: boolean | undefined
108453
+ }
108454
+ | {
108455
+ /** ID of the event. */
108456
+ event_id: string
108457
+ /** ID of the workspace associated with the event. */
108458
+ workspace_id: string
108459
+ /** Date and time at which the event was created. */
108460
+ created_at: string
108461
+ /** Date and time at which the event occurred. */
108462
+ occurred_at: string
108463
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108464
+ event_description?: string | undefined
108465
+ /** ID of the affected access method. */
108466
+ access_method_id: string
108467
+ /** IDs of the access grants associated with this access method. */
108468
+ access_grant_ids: string[]
108469
+ /** Keys of the access grants associated with this access method (if present). */
108470
+ access_grant_keys?: string[] | undefined
108471
+ event_type: 'access_method.revoked'
108472
+ }
108473
+ | {
108474
+ /** ID of the event. */
108475
+ event_id: string
108476
+ /** ID of the workspace associated with the event. */
108477
+ workspace_id: string
108478
+ /** Date and time at which the event was created. */
108479
+ created_at: string
108480
+ /** Date and time at which the event occurred. */
108481
+ occurred_at: string
108482
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108483
+ event_description?: string | undefined
108484
+ /** ID of the affected access method. */
108485
+ access_method_id: string
108486
+ /** IDs of the access grants associated with this access method. */
108487
+ access_grant_ids: string[]
108488
+ /** Keys of the access grants associated with this access method (if present). */
108489
+ access_grant_keys?: string[] | undefined
108490
+ event_type: 'access_method.card_encoding_required'
108491
+ }
108492
+ | {
108493
+ /** ID of the event. */
108494
+ event_id: string
108495
+ /** ID of the workspace associated with the event. */
108496
+ workspace_id: string
108497
+ /** Date and time at which the event was created. */
108498
+ created_at: string
108499
+ /** Date and time at which the event occurred. */
108500
+ occurred_at: string
108501
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108502
+ event_description?: string | undefined
108503
+ /** ID of the affected access method. */
108504
+ access_method_id: string
108505
+ /** IDs of the access grants associated with this access method. */
108506
+ access_grant_ids: string[]
108507
+ /** Keys of the access grants associated with this access method (if present). */
108508
+ access_grant_keys?: string[] | undefined
108509
+ event_type: 'access_method.deleted'
108510
+ }
108511
+ | {
108512
+ /** ID of the event. */
108513
+ event_id: string
108514
+ /** ID of the workspace associated with the event. */
108515
+ workspace_id: string
108516
+ /** Date and time at which the event was created. */
108517
+ created_at: string
108518
+ /** Date and time at which the event occurred. */
108519
+ occurred_at: string
108520
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108521
+ event_description?: string | undefined
108522
+ /** ID of the affected access method. */
108523
+ access_method_id: string
108524
+ /** IDs of the access grants associated with this access method. */
108525
+ access_grant_ids: string[]
108526
+ /** Keys of the access grants associated with this access method (if present). */
108527
+ access_grant_keys?: string[] | undefined
108528
+ event_type: 'access_method.reissued'
108529
+ /** The actual PIN code for code access methods (only present when mode is 'code'). */
108530
+ code?: string | undefined
108531
+ /** Indicates whether the code is a backup code (only present when mode is 'code' and a backup code was used). */
108532
+ is_backup_code?: boolean | undefined
108533
+ }
108534
+ | {
108535
+ /** ID of the event. */
108536
+ event_id: string
108537
+ /** ID of the workspace associated with the event. */
108538
+ workspace_id: string
108539
+ /** Date and time at which the event was created. */
108540
+ created_at: string
108541
+ /** Date and time at which the event occurred. */
108542
+ occurred_at: string
108543
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108544
+ event_description?: string | undefined
108545
+ /** ID of the affected access method. */
108546
+ access_method_id: string
108547
+ /** IDs of the access grants associated with this access method. */
108548
+ access_grant_ids: string[]
108549
+ /** Keys of the access grants associated with this access method (if present). */
108550
+ access_grant_keys?: string[] | undefined
108551
+ event_type: 'access_method.created'
108552
+ }
108553
+ | {
108554
+ /** ID of the event. */
108555
+ event_id: string
108556
+ /** ID of the workspace associated with the event. */
108557
+ workspace_id: string
108558
+ /** Date and time at which the event was created. */
108559
+ created_at: string
108560
+ /** Date and time at which the event occurred. */
108561
+ occurred_at: string
108562
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108563
+ event_description?: string | undefined
108564
+ /** ID of the affected access method. */
108565
+ access_method_id: string
108566
+ /** IDs of the access grants associated with this access method. */
108567
+ access_grant_ids: string[]
108568
+ /** Keys of the access grants associated with this access method (if present). */
108569
+ access_grant_keys?: string[] | undefined
108570
+ event_type: 'access_method.delay_in_issuing'
108571
+ }
108572
+ | {
108573
+ /** ID of the event. */
108574
+ event_id: string
108575
+ /** ID of the workspace associated with the event. */
108576
+ workspace_id: string
108577
+ /** Date and time at which the event was created. */
108578
+ created_at: string
108579
+ /** Date and time at which the event occurred. */
108580
+ occurred_at: string
108581
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108582
+ event_description?: string | undefined
108583
+ /** ID of the affected access method. */
108584
+ access_method_id: string
108585
+ /** IDs of the access grants associated with this access method. */
108586
+ access_grant_ids: string[]
108587
+ /** Keys of the access grants associated with this access method (if present). */
108588
+ access_grant_keys?: string[] | undefined
108589
+ event_type: 'access_method.failed_to_issue'
108590
+ }
108591
+ | {
108592
+ /** ID of the event. */
108593
+ event_id: string
108594
+ /** ID of the workspace associated with the event. */
108595
+ workspace_id: string
108596
+ /** Date and time at which the event was created. */
108597
+ created_at: string
108598
+ /** Date and time at which the event occurred. */
108599
+ occurred_at: string
108600
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108601
+ event_description?: string | undefined
108602
+ /** ID of the connected account. */
108603
+ connected_account_id?: string | undefined
108604
+ /** ID of the access system. */
108605
+ acs_system_id: string
108606
+ event_type: 'acs_system.connected'
108607
+ }
108608
+ | {
108609
+ /** ID of the event. */
108610
+ event_id: string
108611
+ /** ID of the workspace associated with the event. */
108612
+ workspace_id: string
108613
+ /** Date and time at which the event was created. */
108614
+ created_at: string
108615
+ /** Date and time at which the event occurred. */
108616
+ occurred_at: string
108617
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108618
+ event_description?: string | undefined
108619
+ /** ID of the connected account. */
108620
+ connected_account_id?: string | undefined
108621
+ /** ID of the access system. */
108622
+ acs_system_id: string
108623
+ event_type: 'acs_system.added'
108624
+ }
108625
+ | {
108626
+ /** ID of the event. */
108627
+ event_id: string
108628
+ /** ID of the workspace associated with the event. */
108629
+ workspace_id: string
108630
+ /** Date and time at which the event was created. */
108631
+ created_at: string
108632
+ /** Date and time at which the event occurred. */
108633
+ occurred_at: string
108634
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108635
+ event_description?: string | undefined
108636
+ /** ID of the connected account. */
108637
+ connected_account_id?: string | undefined
108638
+ /** ID of the access system. */
108639
+ acs_system_id: string
108640
+ event_type: 'acs_system.disconnected'
108641
+ /** Errors associated with the access control system. */
108642
+ acs_system_errors: {
108643
+ /** Date and time at which Seam created the error. */
108644
+ created_at: string
108645
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108646
+ message: string
108647
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
108648
+ error_code: string
108649
+ }[]
108650
+ /** Warnings associated with the access control system. */
108651
+ acs_system_warnings: {
108652
+ /** Date and time at which Seam created the warning. */
108653
+ created_at: string
108654
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108655
+ message: string
108656
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108657
+ warning_code: string
108658
+ }[]
108659
+ /** Errors associated with the connected account. */
108660
+ connected_account_errors: {
108661
+ /** Date and time at which Seam created the error. */
108662
+ created_at: string
108663
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108664
+ message: string
108665
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
108666
+ error_code: string
108667
+ }[]
108668
+ /** Warnings associated with the connected account. */
108669
+ connected_account_warnings: {
108670
+ /** Date and time at which Seam created the warning. */
108671
+ created_at: string
108672
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
108673
+ message: string
108674
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
108675
+ warning_code: string
108676
+ }[]
108677
+ }
108678
+ | {
108679
+ /** ID of the event. */
108680
+ event_id: string
108681
+ /** ID of the workspace associated with the event. */
108682
+ workspace_id: string
108683
+ /** Date and time at which the event was created. */
108684
+ created_at: string
108685
+ /** Date and time at which the event occurred. */
108686
+ occurred_at: string
108687
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108688
+ event_description?: string | undefined
108689
+ /** ID of the connected account. */
108690
+ connected_account_id?: string | undefined
108691
+ /** ID of the access system. */
108692
+ acs_system_id: string
108693
+ /** ID of the affected credential. */
108694
+ acs_credential_id: string
108695
+ event_type: 'acs_credential.deleted'
108696
+ }
108697
+ | {
108698
+ /** ID of the event. */
108699
+ event_id: string
108700
+ /** ID of the workspace associated with the event. */
108701
+ workspace_id: string
108702
+ /** Date and time at which the event was created. */
108703
+ created_at: string
108704
+ /** Date and time at which the event occurred. */
108705
+ occurred_at: string
108706
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108707
+ event_description?: string | undefined
108708
+ /** ID of the connected account. */
108709
+ connected_account_id?: string | undefined
108710
+ /** ID of the access system. */
108711
+ acs_system_id: string
108712
+ /** ID of the affected credential. */
108713
+ acs_credential_id: string
108714
+ event_type: 'acs_credential.issued'
108715
+ }
108716
+ | {
108717
+ /** ID of the event. */
108718
+ event_id: string
108719
+ /** ID of the workspace associated with the event. */
108720
+ workspace_id: string
108721
+ /** Date and time at which the event was created. */
108722
+ created_at: string
108723
+ /** Date and time at which the event occurred. */
108724
+ occurred_at: string
108725
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108726
+ event_description?: string | undefined
108727
+ /** ID of the connected account. */
108728
+ connected_account_id?: string | undefined
108729
+ /** ID of the access system. */
108730
+ acs_system_id: string
108731
+ /** ID of the affected credential. */
108732
+ acs_credential_id: string
108733
+ event_type: 'acs_credential.reissued'
108734
+ }
108735
+ | {
108736
+ /** ID of the event. */
108737
+ event_id: string
108738
+ /** ID of the workspace associated with the event. */
108739
+ workspace_id: string
108740
+ /** Date and time at which the event was created. */
108741
+ created_at: string
108742
+ /** Date and time at which the event occurred. */
108743
+ occurred_at: string
108744
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108745
+ event_description?: string | undefined
108746
+ /** ID of the connected account. */
108747
+ connected_account_id?: string | undefined
108748
+ /** ID of the access system. */
108749
+ acs_system_id: string
108750
+ /** ID of the affected credential. */
108751
+ acs_credential_id: string
108752
+ event_type: 'acs_credential.invalidated'
108753
+ }
108754
+ | {
108755
+ /** ID of the event. */
108756
+ event_id: string
108757
+ /** ID of the workspace associated with the event. */
108758
+ workspace_id: string
108759
+ /** Date and time at which the event was created. */
108760
+ created_at: string
108761
+ /** Date and time at which the event occurred. */
108762
+ occurred_at: string
108763
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108764
+ event_description?: string | undefined
108765
+ /** ID of the connected account. */
108766
+ connected_account_id?: string | undefined
108767
+ /** ID of the access system. */
108768
+ acs_system_id: string
108769
+ /** ID of the affected access system user. */
108770
+ acs_user_id: string
108771
+ event_type: 'acs_user.created'
108772
+ }
108773
+ | {
108774
+ /** ID of the event. */
108775
+ event_id: string
108776
+ /** ID of the workspace associated with the event. */
108777
+ workspace_id: string
108778
+ /** Date and time at which the event was created. */
108779
+ created_at: string
108780
+ /** Date and time at which the event occurred. */
108781
+ occurred_at: string
108782
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108783
+ event_description?: string | undefined
108784
+ /** ID of the connected account. */
108785
+ connected_account_id?: string | undefined
108786
+ /** ID of the access system. */
108787
+ acs_system_id: string
108788
+ /** ID of the affected access system user. */
108789
+ acs_user_id: string
108790
+ event_type: 'acs_user.deleted'
108791
+ }
108792
+ | {
108793
+ /** ID of the event. */
108794
+ event_id: string
108795
+ /** ID of the workspace associated with the event. */
108796
+ workspace_id: string
108797
+ /** Date and time at which the event was created. */
108798
+ created_at: string
108799
+ /** Date and time at which the event occurred. */
108800
+ occurred_at: string
108801
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108802
+ event_description?: string | undefined
108803
+ /** ID of the connected account. */
108804
+ connected_account_id?: string | undefined
108805
+ /** ID of the access system. */
108806
+ acs_system_id: string
108807
+ /** ID of the affected encoder. */
108808
+ acs_encoder_id: string
108809
+ event_type: 'acs_encoder.added'
108810
+ }
108811
+ | {
108812
+ /** ID of the event. */
108813
+ event_id: string
108814
+ /** ID of the workspace associated with the event. */
108815
+ workspace_id: string
108816
+ /** Date and time at which the event was created. */
108817
+ created_at: string
108818
+ /** Date and time at which the event occurred. */
108819
+ occurred_at: string
108820
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108821
+ event_description?: string | undefined
108822
+ /** ID of the connected account. */
108823
+ connected_account_id?: string | undefined
108824
+ /** ID of the access system. */
108825
+ acs_system_id: string
108826
+ /** ID of the affected encoder. */
108827
+ acs_encoder_id: string
108828
+ event_type: 'acs_encoder.removed'
108829
+ }
108830
+ | {
108831
+ /** ID of the event. */
108832
+ event_id: string
108833
+ /** ID of the workspace associated with the event. */
108834
+ workspace_id: string
108835
+ /** Date and time at which the event was created. */
108836
+ created_at: string
108837
+ /** Date and time at which the event occurred. */
108838
+ occurred_at: string
108839
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108840
+ event_description?: string | undefined
108841
+ /** ID of the connected account. */
108842
+ connected_account_id?: string | undefined
108843
+ /** ID of the access system. */
108844
+ acs_system_id: string
108845
+ /** ID of the affected access group. */
108846
+ acs_access_group_id: string
108847
+ event_type: 'acs_access_group.deleted'
108848
+ }
108849
+ | {
108850
+ /** ID of the event. */
108851
+ event_id: string
108852
+ /** ID of the workspace associated with the event. */
108853
+ workspace_id: string
108854
+ /** Date and time at which the event was created. */
108855
+ created_at: string
108856
+ /** Date and time at which the event occurred. */
108857
+ occurred_at: string
108858
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108859
+ event_description?: string | undefined
108860
+ /** ID of the connected account. */
108861
+ connected_account_id?: string | undefined
108862
+ /** ID of the access system. */
108863
+ acs_system_id: string
108864
+ /** ID of the affected entrance. */
108865
+ acs_entrance_id: string
108866
+ event_type: 'acs_entrance.added'
108867
+ }
108868
+ | {
108869
+ /** ID of the event. */
108870
+ event_id: string
108871
+ /** ID of the workspace associated with the event. */
108872
+ workspace_id: string
108873
+ /** Date and time at which the event was created. */
108874
+ created_at: string
108875
+ /** Date and time at which the event occurred. */
108876
+ occurred_at: string
108877
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108878
+ event_description?: string | undefined
108879
+ /** ID of the connected account. */
108880
+ connected_account_id?: string | undefined
108881
+ /** ID of the access system. */
108882
+ acs_system_id: string
108883
+ /** ID of the affected entrance. */
108884
+ acs_entrance_id: string
108885
+ event_type: 'acs_entrance.removed'
108886
+ }
108887
+ | {
108888
+ /** ID of the event. */
108889
+ event_id: string
108890
+ /** ID of the workspace associated with the event. */
108891
+ workspace_id: string
108892
+ /** Date and time at which the event was created. */
108893
+ created_at: string
108894
+ /** Date and time at which the event occurred. */
108895
+ occurred_at: string
108896
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108897
+ event_description?: string | undefined
108898
+ /** ID of the affected client session. */
108899
+ client_session_id: string
108900
+ event_type: 'client_session.deleted'
108901
+ }
108902
+ | {
108903
+ /** ID of the event. */
108904
+ event_id: string
108905
+ /** ID of the workspace associated with the event. */
108906
+ workspace_id: string
108907
+ /** Date and time at which the event was created. */
108908
+ created_at: string
108909
+ /** Date and time at which the event occurred. */
108910
+ occurred_at: string
108911
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108912
+ event_description?: string | undefined
108913
+ /** ID of the affected connected account. */
108914
+ connected_account_id: string
108915
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108916
+ connected_account_custom_metadata?:
108917
+ | {
108918
+ [x: string]: string | boolean
108919
+ }
108920
+ | undefined
108921
+ event_type: 'connected_account.connected'
108922
+ /** ID of the Connect Webview associated with the event. */
108923
+ connect_webview_id?: string | undefined
108924
+ /** The customer key associated with this connected account, if any. */
108925
+ customer_key?: string | undefined
108926
+ }
108927
+ | {
108928
+ /** ID of the event. */
108929
+ event_id: string
108930
+ /** ID of the workspace associated with the event. */
108931
+ workspace_id: string
108932
+ /** Date and time at which the event was created. */
108933
+ created_at: string
108934
+ /** Date and time at which the event occurred. */
108935
+ occurred_at: string
108936
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108937
+ event_description?: string | undefined
108938
+ /** ID of the affected connected account. */
108939
+ connected_account_id: string
108940
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108941
+ connected_account_custom_metadata?:
108942
+ | {
108943
+ [x: string]: string | boolean
108944
+ }
108945
+ | undefined
108946
+ event_type: 'connected_account.created'
108947
+ /** ID of the Connect Webview associated with the event. */
108948
+ connect_webview_id: string
108949
+ }
108950
+ | {
108951
+ /** ID of the event. */
108952
+ event_id: string
108953
+ /** ID of the workspace associated with the event. */
108954
+ workspace_id: string
108955
+ /** Date and time at which the event was created. */
108956
+ created_at: string
108957
+ /** Date and time at which the event occurred. */
108958
+ occurred_at: string
108959
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108960
+ event_description?: string | undefined
108961
+ /** ID of the affected connected account. */
108962
+ connected_account_id: string
108963
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108964
+ connected_account_custom_metadata?:
108965
+ | {
108966
+ [x: string]: string | boolean
108967
+ }
108968
+ | undefined
108969
+ event_type: 'connected_account.successful_login'
108970
+ /** ID of the Connect Webview associated with the event. */
108971
+ connect_webview_id: string
108972
+ }
108973
+ | {
108974
+ /** ID of the event. */
108975
+ event_id: string
108976
+ /** ID of the workspace associated with the event. */
108977
+ workspace_id: string
108978
+ /** Date and time at which the event was created. */
108979
+ created_at: string
108980
+ /** Date and time at which the event occurred. */
108981
+ occurred_at: string
108982
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
108983
+ event_description?: string | undefined
108984
+ /** ID of the affected connected account. */
108985
+ connected_account_id: string
108986
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
108987
+ connected_account_custom_metadata?:
108988
+ | {
108989
+ [x: string]: string | boolean
108990
+ }
108991
+ | undefined
108992
+ event_type: 'connected_account.disconnected'
108993
+ /** Errors associated with the connected account. */
108994
+ connected_account_errors: {
108995
+ /** Date and time at which Seam created the error. */
108996
+ created_at: string
108997
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
108998
+ message: string
108999
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109000
+ error_code: string
109001
+ }[]
109002
+ /** Warnings associated with the connected account. */
109003
+ connected_account_warnings: {
109004
+ /** Date and time at which Seam created the warning. */
109005
+ created_at: string
109006
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109007
+ message: string
109008
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109009
+ warning_code: string
109010
+ }[]
109011
+ }
109012
+ | {
109013
+ /** ID of the event. */
109014
+ event_id: string
109015
+ /** ID of the workspace associated with the event. */
109016
+ workspace_id: string
109017
+ /** Date and time at which the event was created. */
109018
+ created_at: string
109019
+ /** Date and time at which the event occurred. */
109020
+ occurred_at: string
109021
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109022
+ event_description?: string | undefined
109023
+ /** ID of the affected connected account. */
109024
+ connected_account_id: string
109025
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109026
+ connected_account_custom_metadata?:
109027
+ | {
109028
+ [x: string]: string | boolean
109029
+ }
109030
+ | undefined
109031
+ event_type: 'connected_account.completed_first_sync'
109032
+ }
109033
+ | {
109034
+ /** ID of the event. */
109035
+ event_id: string
109036
+ /** ID of the workspace associated with the event. */
109037
+ workspace_id: string
109038
+ /** Date and time at which the event was created. */
109039
+ created_at: string
109040
+ /** Date and time at which the event occurred. */
109041
+ occurred_at: string
109042
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109043
+ event_description?: string | undefined
109044
+ /** ID of the affected connected account. */
109045
+ connected_account_id: string
109046
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109047
+ connected_account_custom_metadata?:
109048
+ | {
109049
+ [x: string]: string | boolean
109050
+ }
109051
+ | undefined
109052
+ event_type: 'connected_account.deleted'
109053
+ /** */
109054
+ connected_account_type?: string | undefined
109055
+ /** The customer key associated with this connected account, if any. */
109056
+ customer_key?: string | undefined
109057
+ }
109058
+ | {
109059
+ /** ID of the event. */
109060
+ event_id: string
109061
+ /** ID of the workspace associated with the event. */
109062
+ workspace_id: string
109063
+ /** Date and time at which the event was created. */
109064
+ created_at: string
109065
+ /** Date and time at which the event occurred. */
109066
+ occurred_at: string
109067
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109068
+ event_description?: string | undefined
109069
+ /** ID of the affected connected account. */
109070
+ connected_account_id: string
109071
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109072
+ connected_account_custom_metadata?:
109073
+ | {
109074
+ [x: string]: string | boolean
109075
+ }
109076
+ | undefined
109077
+ event_type: 'connected_account.completed_first_sync_after_reconnection'
109078
+ }
109079
+ | {
109080
+ /** ID of the event. */
109081
+ event_id: string
109082
+ /** ID of the workspace associated with the event. */
109083
+ workspace_id: string
109084
+ /** Date and time at which the event was created. */
109085
+ created_at: string
109086
+ /** Date and time at which the event occurred. */
109087
+ occurred_at: string
109088
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109089
+ event_description?: string | undefined
109090
+ /** ID of the affected connected account. */
109091
+ connected_account_id: string
109092
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109093
+ connected_account_custom_metadata?:
109094
+ | {
109095
+ [x: string]: string | boolean
109096
+ }
109097
+ | undefined
109098
+ event_type: 'connected_account.reauthorization_requested'
109099
+ /** Errors associated with the connected account. */
109100
+ connected_account_errors: {
109101
+ /** Date and time at which Seam created the error. */
109102
+ created_at: string
109103
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109104
+ message: string
109105
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109106
+ error_code: string
109107
+ }[]
109108
+ /** Warnings associated with the connected account. */
109109
+ connected_account_warnings: {
109110
+ /** Date and time at which Seam created the warning. */
109111
+ created_at: string
109112
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109113
+ message: string
109114
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109115
+ warning_code: string
109116
+ }[]
109117
+ }
109118
+ | {
109119
+ /** ID of the event. */
109120
+ event_id: string
109121
+ /** ID of the workspace associated with the event. */
109122
+ workspace_id: string
109123
+ /** Date and time at which the event was created. */
109124
+ created_at: string
109125
+ /** Date and time at which the event occurred. */
109126
+ occurred_at: string
109127
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109128
+ event_description?: string | undefined
109129
+ /** ID of the affected action attempt. */
109130
+ action_attempt_id: string
109131
+ /** Type of the action. */
109132
+ action_type: string
109133
+ /** Status of the action. */
109134
+ status: string
109135
+ /** ID of the device associated with the action attempt, if applicable. */
109136
+ device_id?: string | undefined
109137
+ /** ID of the connected account associated with the action attempt, if applicable. */
109138
+ connected_account_id?: string | undefined
109139
+ event_type: 'action_attempt.lock_door.succeeded'
109140
+ }
109141
+ | {
109142
+ /** ID of the event. */
109143
+ event_id: string
109144
+ /** ID of the workspace associated with the event. */
109145
+ workspace_id: string
109146
+ /** Date and time at which the event was created. */
109147
+ created_at: string
109148
+ /** Date and time at which the event occurred. */
109149
+ occurred_at: string
109150
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109151
+ event_description?: string | undefined
109152
+ /** ID of the affected action attempt. */
109153
+ action_attempt_id: string
109154
+ /** Type of the action. */
109155
+ action_type: string
109156
+ /** Status of the action. */
109157
+ status: string
109158
+ /** ID of the device associated with the action attempt, if applicable. */
109159
+ device_id?: string | undefined
109160
+ /** ID of the connected account associated with the action attempt, if applicable. */
109161
+ connected_account_id?: string | undefined
109162
+ event_type: 'action_attempt.lock_door.failed'
109163
+ }
109164
+ | {
109165
+ /** ID of the event. */
109166
+ event_id: string
109167
+ /** ID of the workspace associated with the event. */
109168
+ workspace_id: string
109169
+ /** Date and time at which the event was created. */
109170
+ created_at: string
109171
+ /** Date and time at which the event occurred. */
109172
+ occurred_at: string
109173
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109174
+ event_description?: string | undefined
109175
+ /** ID of the affected action attempt. */
109176
+ action_attempt_id: string
109177
+ /** Type of the action. */
109178
+ action_type: string
109179
+ /** Status of the action. */
109180
+ status: string
109181
+ /** ID of the device associated with the action attempt, if applicable. */
109182
+ device_id?: string | undefined
109183
+ /** ID of the connected account associated with the action attempt, if applicable. */
109184
+ connected_account_id?: string | undefined
109185
+ event_type: 'action_attempt.unlock_door.succeeded'
109186
+ }
109187
+ | {
109188
+ /** ID of the event. */
109189
+ event_id: string
109190
+ /** ID of the workspace associated with the event. */
109191
+ workspace_id: string
109192
+ /** Date and time at which the event was created. */
109193
+ created_at: string
109194
+ /** Date and time at which the event occurred. */
109195
+ occurred_at: string
109196
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109197
+ event_description?: string | undefined
109198
+ /** ID of the affected action attempt. */
109199
+ action_attempt_id: string
109200
+ /** Type of the action. */
109201
+ action_type: string
109202
+ /** Status of the action. */
109203
+ status: string
109204
+ /** ID of the device associated with the action attempt, if applicable. */
109205
+ device_id?: string | undefined
109206
+ /** ID of the connected account associated with the action attempt, if applicable. */
109207
+ connected_account_id?: string | undefined
109208
+ event_type: 'action_attempt.unlock_door.failed'
109209
+ }
109210
+ | {
109211
+ /** ID of the event. */
109212
+ event_id: string
109213
+ /** ID of the workspace associated with the event. */
109214
+ workspace_id: string
109215
+ /** Date and time at which the event was created. */
109216
+ created_at: string
109217
+ /** Date and time at which the event occurred. */
109218
+ occurred_at: string
109219
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109220
+ event_description?: string | undefined
109221
+ /** ID of the affected action attempt. */
109222
+ action_attempt_id: string
109223
+ /** Type of the action. */
109224
+ action_type: string
109225
+ /** Status of the action. */
109226
+ status: string
109227
+ /** ID of the device associated with the action attempt, if applicable. */
109228
+ device_id?: string | undefined
109229
+ /** ID of the connected account associated with the action attempt, if applicable. */
109230
+ connected_account_id?: string | undefined
109231
+ event_type: 'action_attempt.simulate_keypad_code_entry.succeeded'
109232
+ }
109233
+ | {
109234
+ /** ID of the event. */
109235
+ event_id: string
109236
+ /** ID of the workspace associated with the event. */
109237
+ workspace_id: string
109238
+ /** Date and time at which the event was created. */
109239
+ created_at: string
109240
+ /** Date and time at which the event occurred. */
109241
+ occurred_at: string
109242
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109243
+ event_description?: string | undefined
109244
+ /** ID of the affected action attempt. */
109245
+ action_attempt_id: string
109246
+ /** Type of the action. */
109247
+ action_type: string
109248
+ /** Status of the action. */
109249
+ status: string
109250
+ /** ID of the device associated with the action attempt, if applicable. */
109251
+ device_id?: string | undefined
109252
+ /** ID of the connected account associated with the action attempt, if applicable. */
109253
+ connected_account_id?: string | undefined
109254
+ event_type: 'action_attempt.simulate_keypad_code_entry.failed'
109255
+ }
109256
+ | {
109257
+ /** ID of the event. */
109258
+ event_id: string
109259
+ /** ID of the workspace associated with the event. */
109260
+ workspace_id: string
109261
+ /** Date and time at which the event was created. */
109262
+ created_at: string
109263
+ /** Date and time at which the event occurred. */
109264
+ occurred_at: string
109265
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109266
+ event_description?: string | undefined
109267
+ /** ID of the affected action attempt. */
109268
+ action_attempt_id: string
109269
+ /** Type of the action. */
109270
+ action_type: string
109271
+ /** Status of the action. */
109272
+ status: string
109273
+ /** ID of the device associated with the action attempt, if applicable. */
109274
+ device_id?: string | undefined
109275
+ /** ID of the connected account associated with the action attempt, if applicable. */
109276
+ connected_account_id?: string | undefined
109277
+ event_type: 'action_attempt.simulate_manual_lock_via_keypad.succeeded'
109278
+ }
109279
+ | {
109280
+ /** ID of the event. */
109281
+ event_id: string
109282
+ /** ID of the workspace associated with the event. */
109283
+ workspace_id: string
109284
+ /** Date and time at which the event was created. */
109285
+ created_at: string
109286
+ /** Date and time at which the event occurred. */
109287
+ occurred_at: string
109288
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109289
+ event_description?: string | undefined
109290
+ /** ID of the affected action attempt. */
109291
+ action_attempt_id: string
109292
+ /** Type of the action. */
109293
+ action_type: string
109294
+ /** Status of the action. */
109295
+ status: string
109296
+ /** ID of the device associated with the action attempt, if applicable. */
109297
+ device_id?: string | undefined
109298
+ /** ID of the connected account associated with the action attempt, if applicable. */
109299
+ connected_account_id?: string | undefined
109300
+ event_type: 'action_attempt.simulate_manual_lock_via_keypad.failed'
109301
+ }
109302
+ | {
109303
+ /** ID of the event. */
109304
+ event_id: string
109305
+ /** ID of the workspace associated with the event. */
109306
+ workspace_id: string
109307
+ /** Date and time at which the event was created. */
109308
+ created_at: string
109309
+ /** Date and time at which the event occurred. */
109310
+ occurred_at: string
109311
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109312
+ event_description?: string | undefined
109313
+ /** ID of the affected Connect Webview. */
109314
+ connect_webview_id: string
109315
+ event_type: 'connect_webview.login_succeeded'
109316
+ /** ID of the connected account associated with the event. */
109317
+ connected_account_id: string
109318
+ /** Custom metadata of the connected account; present when connected_account_id is provided. */
109319
+ connected_account_custom_metadata?:
109320
+ | {
109321
+ [x: string]: string | boolean
109322
+ }
109323
+ | undefined
109324
+ /** The customer key associated with this connect webview, if any. */
109325
+ customer_key?: string | undefined
109326
+ }
109327
+ | {
109328
+ /** ID of the event. */
109329
+ event_id: string
109330
+ /** ID of the workspace associated with the event. */
109331
+ workspace_id: string
109332
+ /** Date and time at which the event was created. */
109333
+ created_at: string
109334
+ /** Date and time at which the event occurred. */
109335
+ occurred_at: string
109336
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109337
+ event_description?: string | undefined
109338
+ /** ID of the affected Connect Webview. */
109339
+ connect_webview_id: string
109340
+ event_type: 'connect_webview.login_failed'
109341
+ }
109342
+ | {
109343
+ /** ID of the event. */
109344
+ event_id: string
109345
+ /** ID of the workspace associated with the event. */
109346
+ workspace_id: string
109347
+ /** Date and time at which the event was created. */
109348
+ created_at: string
109349
+ /** Date and time at which the event occurred. */
109350
+ occurred_at: string
109351
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109352
+ event_description?: string | undefined
109353
+ /** ID of the affected device. */
109354
+ device_id: string
109355
+ /** ID of the connected account associated with the event. */
109356
+ connected_account_id: string
109357
+ /** The customer key associated with the device, if any. */
109358
+ customer_key?: string | undefined
109359
+ /** Custom metadata of the device, present when device_id is provided. */
109360
+ device_custom_metadata?:
109361
+ | {
109362
+ [x: string]: string | boolean
109363
+ }
109364
+ | undefined
109365
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109366
+ connected_account_custom_metadata?:
109367
+ | {
109368
+ [x: string]: string | boolean
109369
+ }
109370
+ | undefined
109371
+ event_type: 'device.connected'
109372
+ }
109373
+ | {
109374
+ /** ID of the event. */
109375
+ event_id: string
109376
+ /** ID of the workspace associated with the event. */
109377
+ workspace_id: string
109378
+ /** Date and time at which the event was created. */
109379
+ created_at: string
109380
+ /** Date and time at which the event occurred. */
109381
+ occurred_at: string
109382
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109383
+ event_description?: string | undefined
109384
+ /** ID of the affected device. */
109385
+ device_id: string
109386
+ /** ID of the connected account associated with the event. */
109387
+ connected_account_id: string
109388
+ /** The customer key associated with the device, if any. */
109389
+ customer_key?: string | undefined
109390
+ /** Custom metadata of the device, present when device_id is provided. */
109391
+ device_custom_metadata?:
109392
+ | {
109393
+ [x: string]: string | boolean
109394
+ }
109395
+ | undefined
109396
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109397
+ connected_account_custom_metadata?:
109398
+ | {
109399
+ [x: string]: string | boolean
109400
+ }
109401
+ | undefined
109402
+ event_type: 'device.added'
109403
+ }
109404
+ | {
109405
+ /** ID of the event. */
109406
+ event_id: string
109407
+ /** ID of the workspace associated with the event. */
109408
+ workspace_id: string
109409
+ /** Date and time at which the event was created. */
109410
+ created_at: string
109411
+ /** Date and time at which the event occurred. */
109412
+ occurred_at: string
109413
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109414
+ event_description?: string | undefined
109415
+ /** ID of the affected device. */
109416
+ device_id: string
109417
+ /** ID of the connected account associated with the event. */
109418
+ connected_account_id: string
109419
+ /** The customer key associated with the device, if any. */
109420
+ customer_key?: string | undefined
109421
+ /** Custom metadata of the device, present when device_id is provided. */
109422
+ device_custom_metadata?:
109423
+ | {
109424
+ [x: string]: string | boolean
109425
+ }
109426
+ | undefined
109427
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109428
+ connected_account_custom_metadata?:
109429
+ | {
109430
+ [x: string]: string | boolean
109431
+ }
109432
+ | undefined
109433
+ event_type: 'device.converted_to_unmanaged'
109434
+ }
109435
+ | {
109436
+ /** ID of the event. */
109437
+ event_id: string
109438
+ /** ID of the workspace associated with the event. */
109439
+ workspace_id: string
109440
+ /** Date and time at which the event was created. */
109441
+ created_at: string
109442
+ /** Date and time at which the event occurred. */
109443
+ occurred_at: string
109444
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109445
+ event_description?: string | undefined
109446
+ /** ID of the affected device. */
109447
+ device_id: string
109448
+ /** ID of the connected account associated with the event. */
109449
+ connected_account_id: string
109450
+ /** The customer key associated with the device, if any. */
109451
+ customer_key?: string | undefined
109452
+ /** Custom metadata of the device, present when device_id is provided. */
109453
+ device_custom_metadata?:
109454
+ | {
109455
+ [x: string]: string | boolean
109456
+ }
109457
+ | undefined
109458
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109459
+ connected_account_custom_metadata?:
109460
+ | {
109461
+ [x: string]: string | boolean
109462
+ }
109463
+ | undefined
109464
+ event_type: 'device.unmanaged.converted_to_managed'
109465
+ }
109466
+ | {
109467
+ /** ID of the event. */
109468
+ event_id: string
109469
+ /** ID of the workspace associated with the event. */
109470
+ workspace_id: string
109471
+ /** Date and time at which the event was created. */
109472
+ created_at: string
109473
+ /** Date and time at which the event occurred. */
109474
+ occurred_at: string
109475
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109476
+ event_description?: string | undefined
109477
+ /** ID of the affected device. */
109478
+ device_id: string
109479
+ /** ID of the connected account associated with the event. */
109480
+ connected_account_id: string
109481
+ /** The customer key associated with the device, if any. */
109482
+ customer_key?: string | undefined
109483
+ /** Custom metadata of the device, present when device_id is provided. */
109484
+ device_custom_metadata?:
109485
+ | {
109486
+ [x: string]: string | boolean
109487
+ }
109488
+ | undefined
109489
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109490
+ connected_account_custom_metadata?:
109491
+ | {
109492
+ [x: string]: string | boolean
109493
+ }
109494
+ | undefined
109495
+ event_type: 'device.unmanaged.connected'
109496
+ }
109497
+ | {
109498
+ /** ID of the event. */
109499
+ event_id: string
109500
+ /** ID of the workspace associated with the event. */
109501
+ workspace_id: string
109502
+ /** Date and time at which the event was created. */
109503
+ created_at: string
109504
+ /** Date and time at which the event occurred. */
109505
+ occurred_at: string
109506
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109507
+ event_description?: string | undefined
109508
+ /** ID of the affected device. */
109509
+ device_id: string
109510
+ /** ID of the connected account associated with the event. */
109511
+ connected_account_id: string
109512
+ /** The customer key associated with the device, if any. */
109513
+ customer_key?: string | undefined
109514
+ /** Custom metadata of the device, present when device_id is provided. */
109515
+ device_custom_metadata?:
109516
+ | {
109517
+ [x: string]: string | boolean
109518
+ }
109519
+ | undefined
109520
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109521
+ connected_account_custom_metadata?:
109522
+ | {
109523
+ [x: string]: string | boolean
109524
+ }
109525
+ | undefined
109526
+ event_type: 'device.disconnected'
109527
+ /** Error code associated with the disconnection event, if any. */
109528
+ error_code:
109529
+ | 'account_disconnected'
109530
+ | 'hub_disconnected'
109531
+ | 'device_disconnected'
109532
+ /** Errors associated with the connected account. */
109533
+ connected_account_errors: {
109534
+ /** Date and time at which Seam created the error. */
109535
+ created_at: string
109536
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109537
+ message: string
109538
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109539
+ error_code: string
109540
+ }[]
109541
+ /** Warnings associated with the connected account. */
109542
+ connected_account_warnings: {
109543
+ /** Date and time at which Seam created the warning. */
109544
+ created_at: string
109545
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109546
+ message: string
109547
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109548
+ warning_code: string
109549
+ }[]
109550
+ /** Errors associated with the device. */
109551
+ device_errors: {
109552
+ /** Date and time at which Seam created the error. */
109553
+ created_at: string
109554
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109555
+ message: string
109556
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109557
+ error_code: string
109558
+ }[]
109559
+ /** Warnings associated with the device. */
109560
+ device_warnings: {
109561
+ /** Date and time at which Seam created the warning. */
109562
+ created_at: string
109563
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109564
+ message: string
109565
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109566
+ warning_code: string
109567
+ }[]
109568
+ }
109569
+ | {
109570
+ /** ID of the event. */
109571
+ event_id: string
109572
+ /** ID of the workspace associated with the event. */
109573
+ workspace_id: string
109574
+ /** Date and time at which the event was created. */
109575
+ created_at: string
109576
+ /** Date and time at which the event occurred. */
109577
+ occurred_at: string
109578
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109579
+ event_description?: string | undefined
109580
+ /** ID of the affected device. */
109581
+ device_id: string
109582
+ /** ID of the connected account associated with the event. */
109583
+ connected_account_id: string
109584
+ /** The customer key associated with the device, if any. */
109585
+ customer_key?: string | undefined
109586
+ /** Custom metadata of the device, present when device_id is provided. */
109587
+ device_custom_metadata?:
109588
+ | {
109589
+ [x: string]: string | boolean
109590
+ }
109591
+ | undefined
109592
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109593
+ connected_account_custom_metadata?:
109594
+ | {
109595
+ [x: string]: string | boolean
109596
+ }
109597
+ | undefined
109598
+ event_type: 'device.unmanaged.disconnected'
109599
+ /** Error code associated with the disconnection event, if any. */
109600
+ error_code:
109601
+ | 'account_disconnected'
109602
+ | 'hub_disconnected'
109603
+ | 'device_disconnected'
109604
+ /** Errors associated with the connected account. */
109605
+ connected_account_errors: {
109606
+ /** Date and time at which Seam created the error. */
109607
+ created_at: string
109608
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109609
+ message: string
109610
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109611
+ error_code: string
109612
+ }[]
109613
+ /** Warnings associated with the connected account. */
109614
+ connected_account_warnings: {
109615
+ /** Date and time at which Seam created the warning. */
109616
+ created_at: string
109617
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109618
+ message: string
109619
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109620
+ warning_code: string
109621
+ }[]
109622
+ /** Errors associated with the device. */
109623
+ device_errors: {
109624
+ /** Date and time at which Seam created the error. */
109625
+ created_at: string
109626
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109627
+ message: string
109628
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109629
+ error_code: string
109630
+ }[]
109631
+ /** Warnings associated with the device. */
109632
+ device_warnings: {
109633
+ /** Date and time at which Seam created the warning. */
109634
+ created_at: string
109635
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109636
+ message: string
109637
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109638
+ warning_code: string
109639
+ }[]
109640
+ }
109641
+ | {
109642
+ /** ID of the event. */
109643
+ event_id: string
109644
+ /** ID of the workspace associated with the event. */
109645
+ workspace_id: string
109646
+ /** Date and time at which the event was created. */
109647
+ created_at: string
109648
+ /** Date and time at which the event occurred. */
109649
+ occurred_at: string
109650
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109651
+ event_description?: string | undefined
109652
+ /** ID of the affected device. */
109653
+ device_id: string
109654
+ /** ID of the connected account associated with the event. */
109655
+ connected_account_id: string
109656
+ /** The customer key associated with the device, if any. */
109657
+ customer_key?: string | undefined
109658
+ /** Custom metadata of the device, present when device_id is provided. */
109659
+ device_custom_metadata?:
109660
+ | {
109661
+ [x: string]: string | boolean
109662
+ }
109663
+ | undefined
109664
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109665
+ connected_account_custom_metadata?:
109666
+ | {
109667
+ [x: string]: string | boolean
109668
+ }
109669
+ | undefined
109670
+ event_type: 'device.tampered'
109671
+ }
109672
+ | {
109673
+ /** ID of the event. */
109674
+ event_id: string
109675
+ /** ID of the workspace associated with the event. */
109676
+ workspace_id: string
109677
+ /** Date and time at which the event was created. */
109678
+ created_at: string
109679
+ /** Date and time at which the event occurred. */
109680
+ occurred_at: string
109681
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109682
+ event_description?: string | undefined
109683
+ /** ID of the affected device. */
109684
+ device_id: string
109685
+ /** ID of the connected account associated with the event. */
109686
+ connected_account_id: string
109687
+ /** The customer key associated with the device, if any. */
109688
+ customer_key?: string | undefined
109689
+ /** Custom metadata of the device, present when device_id is provided. */
109690
+ device_custom_metadata?:
109691
+ | {
109692
+ [x: string]: string | boolean
109693
+ }
109694
+ | undefined
109695
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109696
+ connected_account_custom_metadata?:
109697
+ | {
109698
+ [x: string]: string | boolean
109699
+ }
109700
+ | undefined
109701
+ event_type: 'device.low_battery'
109702
+ /** Number in the range 0 to 1.0 indicating the level of the battery whose drop triggered this event.
109703
+ * @deprecated Use device_battery_level and accessory_keypad_battery_level, which distinguish the device's own battery from a paired accessory keypad's battery.*/
109704
+ battery_level: number
109705
+ /** Number in the range 0 to 1.0 indicating the affected device's own battery level, when known. */
109706
+ device_battery_level?: number | undefined
109707
+ /** Number in the range 0 to 1.0 indicating the battery level of the affected device's paired accessory keypad, when the device has one and its level is known. */
109708
+ accessory_keypad_battery_level?: number | undefined
109709
+ }
109710
+ | {
109711
+ /** ID of the event. */
109712
+ event_id: string
109713
+ /** ID of the workspace associated with the event. */
109714
+ workspace_id: string
109715
+ /** Date and time at which the event was created. */
109716
+ created_at: string
109717
+ /** Date and time at which the event occurred. */
109718
+ occurred_at: string
109719
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109720
+ event_description?: string | undefined
109721
+ /** ID of the affected device. */
109722
+ device_id: string
109723
+ /** ID of the connected account associated with the event. */
109724
+ connected_account_id: string
109725
+ /** The customer key associated with the device, if any. */
109726
+ customer_key?: string | undefined
109727
+ /** Custom metadata of the device, present when device_id is provided. */
109728
+ device_custom_metadata?:
109729
+ | {
109730
+ [x: string]: string | boolean
109731
+ }
109732
+ | undefined
109733
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109734
+ connected_account_custom_metadata?:
109735
+ | {
109736
+ [x: string]: string | boolean
109737
+ }
109738
+ | undefined
109739
+ event_type: 'device.battery_status_changed'
109740
+ /** Battery status of the affected device, calculated from the numeric `battery_level` value. */
109741
+ battery_status: 'critical' | 'low' | 'good' | 'full'
109742
+ /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
109743
+ battery_level: number
109744
+ }
109745
+ | {
109746
+ /** ID of the event. */
109747
+ event_id: string
109748
+ /** ID of the workspace associated with the event. */
109749
+ workspace_id: string
109750
+ /** Date and time at which the event was created. */
109751
+ created_at: string
109752
+ /** Date and time at which the event occurred. */
109753
+ occurred_at: string
109754
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109755
+ event_description?: string | undefined
109756
+ /** ID of the affected device. */
109757
+ device_id: string
109758
+ /** ID of the connected account associated with the event. */
109759
+ connected_account_id: string
109760
+ /** The customer key associated with the device, if any. */
109761
+ customer_key?: string | undefined
109762
+ /** Custom metadata of the device, present when device_id is provided. */
109763
+ device_custom_metadata?:
109764
+ | {
109765
+ [x: string]: string | boolean
109766
+ }
109767
+ | undefined
109768
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109769
+ connected_account_custom_metadata?:
109770
+ | {
109771
+ [x: string]: string | boolean
109772
+ }
109773
+ | undefined
109774
+ event_type: 'device.removed'
109775
+ }
109776
+ | {
109777
+ /** ID of the event. */
109778
+ event_id: string
109779
+ /** ID of the workspace associated with the event. */
109780
+ workspace_id: string
109781
+ /** Date and time at which the event was created. */
109782
+ created_at: string
109783
+ /** Date and time at which the event occurred. */
109784
+ occurred_at: string
109785
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109786
+ event_description?: string | undefined
109787
+ /** ID of the affected device. */
109788
+ device_id: string
109789
+ /** ID of the connected account associated with the event. */
109790
+ connected_account_id: string
109791
+ /** The customer key associated with the device, if any. */
109792
+ customer_key?: string | undefined
109793
+ /** Custom metadata of the device, present when device_id is provided. */
109794
+ device_custom_metadata?:
109795
+ | {
109796
+ [x: string]: string | boolean
109797
+ }
109798
+ | undefined
109799
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109800
+ connected_account_custom_metadata?:
109801
+ | {
109802
+ [x: string]: string | boolean
109803
+ }
109804
+ | undefined
109805
+ event_type: 'device.deleted'
109806
+ /** Name of the deleted device, captured at deletion time. The device record no longer exists when this event fires, so the name is preserved here. Null when the device had no resolvable name. */
109807
+ device_name?: (string | null) | undefined
109808
+ }
109809
+ | {
109810
+ /** ID of the event. */
109811
+ event_id: string
109812
+ /** ID of the workspace associated with the event. */
109813
+ workspace_id: string
109814
+ /** Date and time at which the event was created. */
109815
+ created_at: string
109816
+ /** Date and time at which the event occurred. */
109817
+ occurred_at: string
109818
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109819
+ event_description?: string | undefined
109820
+ /** ID of the affected device. */
109821
+ device_id: string
109822
+ /** ID of the connected account associated with the event. */
109823
+ connected_account_id: string
109824
+ /** The customer key associated with the device, if any. */
109825
+ customer_key?: string | undefined
109826
+ /** Custom metadata of the device, present when device_id is provided. */
109827
+ device_custom_metadata?:
109828
+ | {
109829
+ [x: string]: string | boolean
109830
+ }
109831
+ | undefined
109832
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109833
+ connected_account_custom_metadata?:
109834
+ | {
109835
+ [x: string]: string | boolean
109836
+ }
109837
+ | undefined
109838
+ event_type: 'device.third_party_integration_detected'
109839
+ }
109840
+ | {
109841
+ /** ID of the event. */
109842
+ event_id: string
109843
+ /** ID of the workspace associated with the event. */
109844
+ workspace_id: string
109845
+ /** Date and time at which the event was created. */
109846
+ created_at: string
109847
+ /** Date and time at which the event occurred. */
109848
+ occurred_at: string
109849
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109850
+ event_description?: string | undefined
109851
+ /** ID of the affected device. */
109852
+ device_id: string
109853
+ /** ID of the connected account associated with the event. */
109854
+ connected_account_id: string
109855
+ /** The customer key associated with the device, if any. */
109856
+ customer_key?: string | undefined
109857
+ /** Custom metadata of the device, present when device_id is provided. */
109858
+ device_custom_metadata?:
109859
+ | {
109860
+ [x: string]: string | boolean
109861
+ }
109862
+ | undefined
109863
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109864
+ connected_account_custom_metadata?:
109865
+ | {
109866
+ [x: string]: string | boolean
109867
+ }
109868
+ | undefined
109869
+ event_type: 'device.third_party_integration_no_longer_detected'
109870
+ }
109871
+ | {
109872
+ /** ID of the event. */
109873
+ event_id: string
109874
+ /** ID of the workspace associated with the event. */
109875
+ workspace_id: string
109876
+ /** Date and time at which the event was created. */
109877
+ created_at: string
109878
+ /** Date and time at which the event occurred. */
109879
+ occurred_at: string
109880
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109881
+ event_description?: string | undefined
109882
+ /** ID of the affected device. */
109883
+ device_id: string
109884
+ /** ID of the connected account associated with the event. */
109885
+ connected_account_id: string
109886
+ /** The customer key associated with the device, if any. */
109887
+ customer_key?: string | undefined
109888
+ /** Custom metadata of the device, present when device_id is provided. */
109889
+ device_custom_metadata?:
109890
+ | {
109891
+ [x: string]: string | boolean
109892
+ }
109893
+ | undefined
109894
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109895
+ connected_account_custom_metadata?:
109896
+ | {
109897
+ [x: string]: string | boolean
109898
+ }
109899
+ | undefined
109900
+ event_type: 'device.salto.privacy_mode_activated'
109901
+ }
109902
+ | {
109903
+ /** ID of the event. */
109904
+ event_id: string
109905
+ /** ID of the workspace associated with the event. */
109906
+ workspace_id: string
109907
+ /** Date and time at which the event was created. */
109908
+ created_at: string
109909
+ /** Date and time at which the event occurred. */
109910
+ occurred_at: string
109911
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109912
+ event_description?: string | undefined
109913
+ /** ID of the affected device. */
109914
+ device_id: string
109915
+ /** ID of the connected account associated with the event. */
109916
+ connected_account_id: string
109917
+ /** The customer key associated with the device, if any. */
109918
+ customer_key?: string | undefined
109919
+ /** Custom metadata of the device, present when device_id is provided. */
109920
+ device_custom_metadata?:
109921
+ | {
109922
+ [x: string]: string | boolean
109923
+ }
109924
+ | undefined
109925
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109926
+ connected_account_custom_metadata?:
109927
+ | {
109928
+ [x: string]: string | boolean
109929
+ }
109930
+ | undefined
109931
+ event_type: 'device.salto.privacy_mode_deactivated'
109932
+ }
109933
+ | {
109934
+ /** ID of the event. */
109935
+ event_id: string
109936
+ /** ID of the workspace associated with the event. */
109937
+ workspace_id: string
109938
+ /** Date and time at which the event was created. */
109939
+ created_at: string
109940
+ /** Date and time at which the event occurred. */
109941
+ occurred_at: string
109942
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
109943
+ event_description?: string | undefined
109944
+ /** ID of the affected device. */
109945
+ device_id: string
109946
+ /** ID of the connected account associated with the event. */
109947
+ connected_account_id: string
109948
+ /** The customer key associated with the device, if any. */
109949
+ customer_key?: string | undefined
109950
+ /** Custom metadata of the device, present when device_id is provided. */
109951
+ device_custom_metadata?:
109952
+ | {
109953
+ [x: string]: string | boolean
109954
+ }
109955
+ | undefined
109956
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
109957
+ connected_account_custom_metadata?:
109958
+ | {
109959
+ [x: string]: string | boolean
109960
+ }
109961
+ | undefined
109962
+ event_type: 'device.connection_became_flaky'
109963
+ /** Errors associated with the connected account. */
109964
+ connected_account_errors: {
109965
+ /** Date and time at which Seam created the error. */
109966
+ created_at: string
109967
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109968
+ message: string
109969
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109970
+ error_code: string
109971
+ }[]
109972
+ /** Warnings associated with the connected account. */
109973
+ connected_account_warnings: {
109974
+ /** Date and time at which Seam created the warning. */
109975
+ created_at: string
109976
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109977
+ message: string
109978
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109979
+ warning_code: string
109980
+ }[]
109981
+ /** Errors associated with the device. */
109982
+ device_errors: {
109983
+ /** Date and time at which Seam created the error. */
109984
+ created_at: string
109985
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
109986
+ message: string
109987
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
109988
+ error_code: string
109989
+ }[]
109990
+ /** Warnings associated with the device. */
109991
+ device_warnings: {
109992
+ /** Date and time at which Seam created the warning. */
109993
+ created_at: string
109994
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
109995
+ message: string
109996
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
109997
+ warning_code: string
109998
+ }[]
109999
+ }
110000
+ | {
110001
+ /** ID of the event. */
110002
+ event_id: string
110003
+ /** ID of the workspace associated with the event. */
110004
+ workspace_id: string
110005
+ /** Date and time at which the event was created. */
110006
+ created_at: string
110007
+ /** Date and time at which the event occurred. */
110008
+ occurred_at: string
110009
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110010
+ event_description?: string | undefined
110011
+ /** ID of the affected device. */
110012
+ device_id: string
110013
+ /** ID of the connected account associated with the event. */
110014
+ connected_account_id: string
110015
+ /** The customer key associated with the device, if any. */
110016
+ customer_key?: string | undefined
110017
+ /** Custom metadata of the device, present when device_id is provided. */
110018
+ device_custom_metadata?:
110019
+ | {
110020
+ [x: string]: string | boolean
110021
+ }
110022
+ | undefined
110023
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110024
+ connected_account_custom_metadata?:
110025
+ | {
110026
+ [x: string]: string | boolean
110027
+ }
110028
+ | undefined
110029
+ event_type: 'device.connection_stabilized'
110030
+ }
110031
+ | {
110032
+ /** ID of the event. */
110033
+ event_id: string
110034
+ /** ID of the workspace associated with the event. */
110035
+ workspace_id: string
110036
+ /** Date and time at which the event was created. */
110037
+ created_at: string
110038
+ /** Date and time at which the event occurred. */
110039
+ occurred_at: string
110040
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110041
+ event_description?: string | undefined
110042
+ /** ID of the affected device. */
110043
+ device_id: string
110044
+ /** ID of the connected account associated with the event. */
110045
+ connected_account_id: string
110046
+ /** The customer key associated with the device, if any. */
110047
+ customer_key?: string | undefined
110048
+ /** Custom metadata of the device, present when device_id is provided. */
110049
+ device_custom_metadata?:
110050
+ | {
110051
+ [x: string]: string | boolean
110052
+ }
110053
+ | undefined
110054
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110055
+ connected_account_custom_metadata?:
110056
+ | {
110057
+ [x: string]: string | boolean
110058
+ }
110059
+ | undefined
110060
+ event_type: 'device.error.subscription_required'
110061
+ /** Errors associated with the connected account. */
110062
+ connected_account_errors: {
110063
+ /** Date and time at which Seam created the error. */
110064
+ created_at: string
110065
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
110066
+ message: string
110067
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
110068
+ error_code: string
110069
+ }[]
110070
+ /** Warnings associated with the connected account. */
110071
+ connected_account_warnings: {
110072
+ /** Date and time at which Seam created the warning. */
110073
+ created_at: string
110074
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
110075
+ message: string
110076
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
110077
+ warning_code: string
110078
+ }[]
110079
+ /** Errors associated with the device. */
110080
+ device_errors: {
110081
+ /** Date and time at which Seam created the error. */
110082
+ created_at: string
110083
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
110084
+ message: string
110085
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
110086
+ error_code: string
110087
+ }[]
110088
+ /** Warnings associated with the device. */
110089
+ device_warnings: {
110090
+ /** Date and time at which Seam created the warning. */
110091
+ created_at: string
110092
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
110093
+ message: string
110094
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
110095
+ warning_code: string
110096
+ }[]
110097
+ }
110098
+ | {
110099
+ /** ID of the event. */
110100
+ event_id: string
110101
+ /** ID of the workspace associated with the event. */
110102
+ workspace_id: string
110103
+ /** Date and time at which the event was created. */
110104
+ created_at: string
110105
+ /** Date and time at which the event occurred. */
110106
+ occurred_at: string
110107
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110108
+ event_description?: string | undefined
110109
+ /** ID of the affected device. */
110110
+ device_id: string
110111
+ /** ID of the connected account associated with the event. */
110112
+ connected_account_id: string
110113
+ /** The customer key associated with the device, if any. */
110114
+ customer_key?: string | undefined
110115
+ /** Custom metadata of the device, present when device_id is provided. */
110116
+ device_custom_metadata?:
110117
+ | {
110118
+ [x: string]: string | boolean
110119
+ }
110120
+ | undefined
110121
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110122
+ connected_account_custom_metadata?:
110123
+ | {
110124
+ [x: string]: string | boolean
110125
+ }
110126
+ | undefined
110127
+ event_type: 'device.error.subscription_required.resolved'
110128
+ }
110129
+ | {
110130
+ /** ID of the event. */
110131
+ event_id: string
110132
+ /** ID of the workspace associated with the event. */
110133
+ workspace_id: string
110134
+ /** Date and time at which the event was created. */
110135
+ created_at: string
110136
+ /** Date and time at which the event occurred. */
110137
+ occurred_at: string
110138
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110139
+ event_description?: string | undefined
110140
+ /** ID of the affected device. */
110141
+ device_id: string
110142
+ /** ID of the connected account associated with the event. */
110143
+ connected_account_id: string
110144
+ /** The customer key associated with the device, if any. */
110145
+ customer_key?: string | undefined
110146
+ /** Custom metadata of the device, present when device_id is provided. */
110147
+ device_custom_metadata?:
110148
+ | {
110149
+ [x: string]: string | boolean
110150
+ }
110151
+ | undefined
110152
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110153
+ connected_account_custom_metadata?:
110154
+ | {
110155
+ [x: string]: string | boolean
110156
+ }
110157
+ | undefined
110158
+ event_type: 'device.accessory_keypad_connected'
110159
+ }
110160
+ | {
110161
+ /** ID of the event. */
110162
+ event_id: string
110163
+ /** ID of the workspace associated with the event. */
110164
+ workspace_id: string
110165
+ /** Date and time at which the event was created. */
110166
+ created_at: string
110167
+ /** Date and time at which the event occurred. */
110168
+ occurred_at: string
110169
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110170
+ event_description?: string | undefined
110171
+ /** ID of the affected device. */
110172
+ device_id: string
110173
+ /** ID of the connected account associated with the event. */
110174
+ connected_account_id: string
110175
+ /** The customer key associated with the device, if any. */
110176
+ customer_key?: string | undefined
110177
+ /** Custom metadata of the device, present when device_id is provided. */
110178
+ device_custom_metadata?:
110179
+ | {
110180
+ [x: string]: string | boolean
110181
+ }
110182
+ | undefined
110183
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110184
+ connected_account_custom_metadata?:
110185
+ | {
110186
+ [x: string]: string | boolean
110187
+ }
110188
+ | undefined
110189
+ event_type: 'device.accessory_keypad_disconnected'
110190
+ /** Errors associated with the connected account. */
110191
+ connected_account_errors: {
110192
+ /** Date and time at which Seam created the error. */
110193
+ created_at: string
110194
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
110195
+ message: string
110196
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
110197
+ error_code: string
110198
+ }[]
110199
+ /** Warnings associated with the connected account. */
110200
+ connected_account_warnings: {
110201
+ /** Date and time at which Seam created the warning. */
110202
+ created_at: string
110203
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
110204
+ message: string
110205
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
110206
+ warning_code: string
110207
+ }[]
110208
+ /** Errors associated with the device. */
110209
+ device_errors: {
110210
+ /** Date and time at which Seam created the error. */
110211
+ created_at: string
110212
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
110213
+ message: string
110214
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
110215
+ error_code: string
110216
+ }[]
110217
+ /** Warnings associated with the device. */
110218
+ device_warnings: {
110219
+ /** Date and time at which Seam created the warning. */
110220
+ created_at: string
110221
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
110222
+ message: string
110223
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
110224
+ warning_code: string
110225
+ }[]
110226
+ }
110227
+ | {
110228
+ /** ID of the event. */
110229
+ event_id: string
110230
+ /** ID of the workspace associated with the event. */
110231
+ workspace_id: string
110232
+ /** Date and time at which the event was created. */
110233
+ created_at: string
110234
+ /** Date and time at which the event occurred. */
110235
+ occurred_at: string
110236
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110237
+ event_description?: string | undefined
110238
+ /** ID of the affected device. */
110239
+ device_id: string
110240
+ /** ID of the connected account associated with the event. */
110241
+ connected_account_id: string
110242
+ /** The customer key associated with the device, if any. */
110243
+ customer_key?: string | undefined
110244
+ /** Custom metadata of the device, present when device_id is provided. */
110245
+ device_custom_metadata?:
110246
+ | {
110247
+ [x: string]: string | boolean
110248
+ }
110249
+ | undefined
110250
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110251
+ connected_account_custom_metadata?:
110252
+ | {
110253
+ [x: string]: string | boolean
110254
+ }
110255
+ | undefined
110256
+ event_type: 'noise_sensor.noise_threshold_triggered'
110257
+ /** Detected noise level in decibels. */
110258
+ noise_level_decibels?: number | undefined
110259
+ /** Detected noise level in Noiseaware Noise Risk Score (NRS). */
110260
+ noise_level_nrs?: number | undefined
110261
+ /** ID of the noise threshold that was triggered. */
110262
+ noise_threshold_id?: string | undefined
110263
+ /** Name of the noise threshold that was triggered. */
110264
+ noise_threshold_name?: string | undefined
110265
+ /** Metadata from Noiseaware. */
110266
+ noiseaware_metadata?:
110267
+ | {
110268
+ [x: string]: unknown
110269
+ }
110270
+ | undefined
110271
+ /** Metadata from Minut. */
110272
+ minut_metadata?:
110273
+ | {
110274
+ [x: string]: unknown
110275
+ }
110276
+ | undefined
110277
+ }
110278
+ | {
110279
+ /** ID of the event. */
110280
+ event_id: string
110281
+ /** ID of the workspace associated with the event. */
110282
+ workspace_id: string
110283
+ /** Date and time at which the event was created. */
110284
+ created_at: string
110285
+ /** Date and time at which the event occurred. */
110286
+ occurred_at: string
110287
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110288
+ event_description?: string | undefined
110289
+ /** ID of the affected device. */
110290
+ device_id: string
110291
+ /** ID of the connected account associated with the event. */
110292
+ connected_account_id: string
110293
+ /** The customer key associated with the device, if any. */
110294
+ customer_key?: string | undefined
110295
+ /** Custom metadata of the device, present when device_id is provided. */
110296
+ device_custom_metadata?:
110297
+ | {
110298
+ [x: string]: string | boolean
110299
+ }
110300
+ | undefined
110301
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110302
+ connected_account_custom_metadata?:
110303
+ | {
110304
+ [x: string]: string | boolean
110305
+ }
110306
+ | undefined
110307
+ event_type: 'lock.locked'
110308
+ /** ID of the access code that was used to lock the device. */
110309
+ access_code_id?: string | undefined
110310
+ /**
110311
+ Code (PIN) that was used to lock the device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
110312
+ */
110313
+ code?: string | undefined
110314
+ /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
110315
+ access_code_is_managed?: boolean | undefined
110316
+ /** ID of the Seam action attempt that triggered this lock. Present only when the lock was initiated through Seam (via a `LOCK_DOOR` action attempt). */
110317
+ action_attempt_id?: string | undefined
110318
+ /** Method by which the lock was locked. `keycode`: an access code was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or button press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by an auto-relock timer. `unknown`: could not be determined. */
110319
+ method:
110320
+ | 'keycode'
110321
+ | 'manual'
110322
+ | 'automatic'
110323
+ | 'unknown'
110324
+ | 'remote'
110325
+ | 'card'
110326
+ | 'mobile_key'
110327
+ /** ID of the user identity associated with the lock event. */
110328
+ user_identity_id?: string | undefined
110329
+ /** ID of the ACS system associated with the lock event. */
110330
+ acs_system_id?: string | undefined
110331
+ /** ID of the ACS user associated with the lock event. */
110332
+ acs_user_id?: string | undefined
110333
+ /** ID of the ACS entrance associated with the lock event. */
110334
+ acs_entrance_id?: string | undefined
110335
+ /**
110336
+ Whether the lock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
110337
+ */
110338
+ is_via_bluetooth?: boolean | undefined
110339
+ /**
110340
+ Whether the lock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
110341
+ */
110342
+ is_via_nfc?: boolean | undefined
110343
+ }
110344
+ | {
110345
+ /** ID of the event. */
110346
+ event_id: string
110347
+ /** ID of the workspace associated with the event. */
110348
+ workspace_id: string
110349
+ /** Date and time at which the event was created. */
110350
+ created_at: string
110351
+ /** Date and time at which the event occurred. */
110352
+ occurred_at: string
110353
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110354
+ event_description?: string | undefined
110355
+ /** ID of the affected device. */
110356
+ device_id?: string | undefined
110357
+ /** ID of the connected account associated with the event. */
110358
+ connected_account_id: string
110359
+ /** The customer key associated with the device, if any. */
110360
+ customer_key?: string | undefined
110361
+ /** Custom metadata of the device, present when device_id is provided. */
110362
+ device_custom_metadata?:
110363
+ | {
110364
+ [x: string]: string | boolean
110365
+ }
110366
+ | undefined
110367
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110368
+ connected_account_custom_metadata?:
110369
+ | {
110370
+ [x: string]: string | boolean
110371
+ }
110372
+ | undefined
110373
+ event_type: 'lock.unlocked'
110374
+ /** ID of the access code that was used to unlock the affected device. */
110375
+ access_code_id?: string | undefined
110376
+ /**
110377
+ Code (PIN) that was used to unlock the affected device, if known. Taken from the matched managed or unmanaged access code, or from the code reported by the provider when no access code matched.
110378
+ */
110379
+ code?: string | undefined
110380
+ /** Whether the access code is managed by Seam (true) or unmanaged (false). Only present when access_code_id is set. */
110381
+ access_code_is_managed?: boolean | undefined
110382
+ /** ID of the Seam action attempt that triggered this unlock. Present only when the unlock was initiated through Seam (via an `UNLOCK_DOOR` action attempt). */
110383
+ action_attempt_id?: string | undefined
110384
+ /** Method by which the lock was unlocked. `keycode`: an [access code](https://docs.seam.co/low-level-apis/smart-locks/access-codes) was used (see `access_code_id`). `manual`: a physical action such as a thumbturn or handle press. `remote`: a remote action via an app, Bluetooth, or the Seam API (see `action_attempt_id` if Seam-initiated; see `is_via_bluetooth` or `is_via_nfc` for the transport). `automatic`: triggered automatically, for example by a time-based schedule. `unknown`: could not be determined. */
110385
+ method:
110386
+ | 'keycode'
110387
+ | 'manual'
110388
+ | 'automatic'
110389
+ | 'unknown'
110390
+ | 'remote'
110391
+ | 'card'
110392
+ | 'mobile_key'
110393
+ /** ID of the user identity associated with the unlock event. */
110394
+ user_identity_id?: string | undefined
110395
+ /** ID of the ACS system associated with the unlock event. */
110396
+ acs_system_id?: string | undefined
110397
+ /** ID of the ACS user associated with the unlock event. */
110398
+ acs_user_id?: string | undefined
110399
+ /** ID of the ACS entrance associated with the unlock event. */
110400
+ acs_entrance_id?: string | undefined
110401
+ /**
110402
+ Whether the unlock action was performed over Bluetooth by a remote client (such as the provider's mobile app), rather than a direct physical interaction or a Seam-initiated remote action.
110403
+ */
110404
+ is_via_bluetooth?: boolean | undefined
110405
+ /**
110406
+ Whether the unlock action was performed by an NFC credential tap (such as an Apple Home Key or an NFC key fob) presented to the lock, rather than a direct physical interaction or a Seam-initiated remote action.
110407
+ */
110408
+ is_via_nfc?: boolean | undefined
110409
+ }
110410
+ | {
110411
+ /** ID of the event. */
110412
+ event_id: string
110413
+ /** ID of the workspace associated with the event. */
110414
+ workspace_id: string
110415
+ /** Date and time at which the event was created. */
110416
+ created_at: string
110417
+ /** Date and time at which the event occurred. */
110418
+ occurred_at: string
110419
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110420
+ event_description?: string | undefined
110421
+ /** ID of the affected device. */
110422
+ device_id?: string | undefined
110423
+ /** ID of the connected account associated with the event. */
110424
+ connected_account_id: string
110425
+ /** The customer key associated with the device, if any. */
110426
+ customer_key?: string | undefined
110427
+ /** Custom metadata of the device, present when device_id is provided. */
110428
+ device_custom_metadata?:
110429
+ | {
110430
+ [x: string]: string | boolean
110431
+ }
110432
+ | undefined
110433
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110434
+ connected_account_custom_metadata?:
110435
+ | {
110436
+ [x: string]: string | boolean
110437
+ }
110438
+ | undefined
110439
+ event_type: 'lock.access_denied'
110440
+ /** ID of the access code that was used in the unlock attempts. */
110441
+ access_code_id?: string | undefined
110442
+ /** ID of the user identity associated with the access-denied event. */
110443
+ user_identity_id?: string | undefined
110444
+ /** ID of the ACS system associated with the access-denied event. */
110445
+ acs_system_id?: string | undefined
110446
+ /** ID of the ACS user associated with the access-denied event. */
110447
+ acs_user_id?: string | undefined
110448
+ /** ID of the ACS entrance associated with the access-denied event. */
110449
+ acs_entrance_id?: string | undefined
110450
+ /** Why access was denied, when the provider reports a determinable cause. Omitted when unknown. */
110451
+ reason?:
110452
+ | {
110453
+ /** Normalized reason a lock denied access. Provider-agnostic; not all providers report every value. */
110454
+ reason_code:
110455
+ | 'unknown_code'
110456
+ | 'expired_code'
110457
+ | 'blocklisted_code'
110458
+ | 'too_many_attempts'
110459
+ | 'blocked_by_privacy_mode'
110460
+ | 'credential_error'
110461
+ /** Human-readable explanation of why access was denied. */
110462
+ message: string
110463
+ }
110464
+ | undefined
110465
+ }
110466
+ | {
110467
+ /** ID of the event. */
110468
+ event_id: string
110469
+ /** ID of the workspace associated with the event. */
110470
+ workspace_id: string
110471
+ /** Date and time at which the event was created. */
110472
+ created_at: string
110473
+ /** Date and time at which the event occurred. */
110474
+ occurred_at: string
110475
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110476
+ event_description?: string | undefined
110477
+ /** ID of the affected device. */
110478
+ device_id: string
110479
+ /** ID of the connected account associated with the event. */
110480
+ connected_account_id: string
110481
+ /** The customer key associated with the device, if any. */
110482
+ customer_key?: string | undefined
110483
+ /** Custom metadata of the device, present when device_id is provided. */
110484
+ device_custom_metadata?:
110485
+ | {
110486
+ [x: string]: string | boolean
110487
+ }
110488
+ | undefined
110489
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110490
+ connected_account_custom_metadata?:
110491
+ | {
110492
+ [x: string]: string | boolean
110493
+ }
110494
+ | undefined
110495
+ event_type: 'thermostat.climate_preset_activated'
110496
+ /** ID of the thermostat schedule that prompted the affected climate preset to be activated. */
110497
+ thermostat_schedule_id: string | null
110498
+ /** Key of the climate preset that was activated. */
110499
+ climate_preset_key: string
110500
+ /** Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat. */
110501
+ is_fallback_climate_preset: boolean
110502
+ }
110503
+ | {
110504
+ /** ID of the event. */
110505
+ event_id: string
110506
+ /** ID of the workspace associated with the event. */
110507
+ workspace_id: string
110508
+ /** Date and time at which the event was created. */
110509
+ created_at: string
110510
+ /** Date and time at which the event occurred. */
110511
+ occurred_at: string
110512
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110513
+ event_description?: string | undefined
110514
+ /** ID of the affected device. */
110515
+ device_id: string
110516
+ /** ID of the connected account associated with the event. */
110517
+ connected_account_id: string
110518
+ /** The customer key associated with the device, if any. */
110519
+ customer_key?: string | undefined
110520
+ /** Custom metadata of the device, present when device_id is provided. */
110521
+ device_custom_metadata?:
110522
+ | {
110523
+ [x: string]: string | boolean
110524
+ }
110525
+ | undefined
110526
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110527
+ connected_account_custom_metadata?:
110528
+ | {
110529
+ [x: string]: string | boolean
110530
+ }
110531
+ | undefined
110532
+ event_type: 'thermostat.manually_adjusted'
110533
+ /** Method used to adjust the affected thermostat manually. `seam` indicates that the Seam API, Seam CLI, or Seam Console was used to adjust the thermostat. */
110534
+ method: 'seam' | 'external'
110535
+ /** Desired [fan mode setting](https://docs.seam.co/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
110536
+ fan_mode_setting?:
110537
+ (('auto' | 'on' | 'circulate') | undefined) | undefined
110538
+ /** Desired [HVAC mode](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
110539
+ hvac_mode_setting?:
110540
+ | (('off' | 'heat' | 'cool' | 'heat_cool' | 'eco') | undefined)
110541
+ | undefined
110542
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
110543
+ cooling_set_point_celsius?: (number | undefined) | undefined
110544
+ /** Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
110545
+ heating_set_point_celsius?: (number | undefined) | undefined
110546
+ /** Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
110547
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
110548
+ /** Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
110549
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
110550
+ }
110551
+ | {
110552
+ /** ID of the event. */
110553
+ event_id: string
110554
+ /** ID of the workspace associated with the event. */
110555
+ workspace_id: string
110556
+ /** Date and time at which the event was created. */
110557
+ created_at: string
110558
+ /** Date and time at which the event occurred. */
110559
+ occurred_at: string
110560
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110561
+ event_description?: string | undefined
110562
+ /** ID of the affected device. */
110563
+ device_id: string
110564
+ /** ID of the connected account associated with the event. */
110565
+ connected_account_id: string
110566
+ /** The customer key associated with the device, if any. */
110567
+ customer_key?: string | undefined
110568
+ /** Custom metadata of the device, present when device_id is provided. */
110569
+ device_custom_metadata?:
110570
+ | {
110571
+ [x: string]: string | boolean
110572
+ }
110573
+ | undefined
110574
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110575
+ connected_account_custom_metadata?:
110576
+ | {
110577
+ [x: string]: string | boolean
110578
+ }
110579
+ | undefined
110580
+ event_type: 'thermostat.temperature_threshold_exceeded'
110581
+ /** Temperature, in °C, reported by the affected thermostat. */
110582
+ temperature_celsius: number
110583
+ /** Temperature, in °F, reported by the affected thermostat. */
110584
+ temperature_fahrenheit: number
110585
+ /** Upper temperature limit, in °C, defined by the set threshold. */
110586
+ upper_limit_celsius: number | null
110587
+ /** Upper temperature limit, in °F, defined by the set threshold. */
110588
+ upper_limit_fahrenheit: number | null
110589
+ /** Lower temperature limit, in °C, defined by the set threshold. */
110590
+ lower_limit_celsius: number | null
110591
+ /** Lower temperature limit, in °F, defined by the set threshold. */
110592
+ lower_limit_fahrenheit: number | null
110593
+ }
110594
+ | {
110595
+ /** ID of the event. */
110596
+ event_id: string
110597
+ /** ID of the workspace associated with the event. */
110598
+ workspace_id: string
110599
+ /** Date and time at which the event was created. */
110600
+ created_at: string
110601
+ /** Date and time at which the event occurred. */
110602
+ occurred_at: string
110603
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110604
+ event_description?: string | undefined
110605
+ /** ID of the affected device. */
110606
+ device_id: string
110607
+ /** ID of the connected account associated with the event. */
110608
+ connected_account_id: string
110609
+ /** The customer key associated with the device, if any. */
110610
+ customer_key?: string | undefined
110611
+ /** Custom metadata of the device, present when device_id is provided. */
110612
+ device_custom_metadata?:
110613
+ | {
110614
+ [x: string]: string | boolean
110615
+ }
110616
+ | undefined
110617
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110618
+ connected_account_custom_metadata?:
110619
+ | {
110620
+ [x: string]: string | boolean
110621
+ }
110622
+ | undefined
110623
+ event_type: 'thermostat.temperature_threshold_no_longer_exceeded'
110624
+ /** Temperature, in °C, reported by the affected thermostat. */
110625
+ temperature_celsius: number
110626
+ /** Temperature, in °F, reported by the affected thermostat. */
110627
+ temperature_fahrenheit: number
110628
+ /** Upper temperature limit, in °C, defined by the set threshold. */
110629
+ upper_limit_celsius: number | null
110630
+ /** Upper temperature limit, in °F, defined by the set threshold. */
110631
+ upper_limit_fahrenheit: number | null
110632
+ /** Lower temperature limit, in °C, defined by the set threshold. */
110633
+ lower_limit_celsius: number | null
110634
+ /** Lower temperature limit, in °F, defined by the set threshold. */
110635
+ lower_limit_fahrenheit: number | null
110636
+ }
110637
+ | {
110638
+ /** ID of the event. */
110639
+ event_id: string
110640
+ /** ID of the workspace associated with the event. */
110641
+ workspace_id: string
110642
+ /** Date and time at which the event was created. */
110643
+ created_at: string
110644
+ /** Date and time at which the event occurred. */
110645
+ occurred_at: string
110646
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110647
+ event_description?: string | undefined
110648
+ /** ID of the affected device. */
110649
+ device_id: string
110650
+ /** ID of the connected account associated with the event. */
110651
+ connected_account_id: string
110652
+ /** The customer key associated with the device, if any. */
110653
+ customer_key?: string | undefined
110654
+ /** Custom metadata of the device, present when device_id is provided. */
110655
+ device_custom_metadata?:
110656
+ | {
110657
+ [x: string]: string | boolean
110658
+ }
110659
+ | undefined
110660
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110661
+ connected_account_custom_metadata?:
110662
+ | {
110663
+ [x: string]: string | boolean
110664
+ }
110665
+ | undefined
110666
+ event_type: 'thermostat.temperature_reached_set_point'
110667
+ /** Temperature, in °C, reported by the affected thermostat. */
110668
+ temperature_celsius: number
110669
+ /** Temperature, in °F, reported by the affected thermostat. */
110670
+ temperature_fahrenheit: number
110671
+ /** Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point. */
110672
+ desired_temperature_celsius?: number | undefined
110673
+ /** Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point. */
110674
+ desired_temperature_fahrenheit?: number | undefined
110675
+ }
110676
+ | {
110677
+ /** ID of the event. */
110678
+ event_id: string
110679
+ /** ID of the workspace associated with the event. */
110680
+ workspace_id: string
110681
+ /** Date and time at which the event was created. */
110682
+ created_at: string
110683
+ /** Date and time at which the event occurred. */
110684
+ occurred_at: string
110685
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110686
+ event_description?: string | undefined
110687
+ /** ID of the affected device. */
110688
+ device_id: string
110689
+ /** ID of the connected account associated with the event. */
110690
+ connected_account_id: string
110691
+ /** The customer key associated with the device, if any. */
110692
+ customer_key?: string | undefined
110693
+ /** Custom metadata of the device, present when device_id is provided. */
110694
+ device_custom_metadata?:
110695
+ | {
110696
+ [x: string]: string | boolean
110697
+ }
110698
+ | undefined
110699
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110700
+ connected_account_custom_metadata?:
110701
+ | {
110702
+ [x: string]: string | boolean
110703
+ }
110704
+ | undefined
110705
+ event_type: 'thermostat.temperature_changed'
110706
+ /** Temperature, in °C, reported by the affected thermostat. */
110707
+ temperature_celsius: number
110708
+ /** Temperature, in °F, reported by the affected thermostat. */
110709
+ temperature_fahrenheit: number
110710
+ }
110711
+ | {
110712
+ /** ID of the event. */
110713
+ event_id: string
110714
+ /** ID of the workspace associated with the event. */
110715
+ workspace_id: string
110716
+ /** Date and time at which the event was created. */
110717
+ created_at: string
110718
+ /** Date and time at which the event occurred. */
110719
+ occurred_at: string
110720
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110721
+ event_description?: string | undefined
110722
+ /** ID of the affected device. */
110723
+ device_id: string
110724
+ /** ID of the connected account associated with the event. */
110725
+ connected_account_id: string
110726
+ /** The customer key associated with the device, if any. */
110727
+ customer_key?: string | undefined
110728
+ /** Custom metadata of the device, present when device_id is provided. */
110729
+ device_custom_metadata?:
110730
+ | {
110731
+ [x: string]: string | boolean
110732
+ }
110733
+ | undefined
110734
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110735
+ connected_account_custom_metadata?:
110736
+ | {
110737
+ [x: string]: string | boolean
110738
+ }
110739
+ | undefined
110740
+ event_type: 'device.name_changed'
110741
+ /** The new name of the affected device. */
110742
+ device_name: string
110743
+ }
110744
+ | {
110745
+ /** ID of the event. */
110746
+ event_id: string
110747
+ /** ID of the workspace associated with the event. */
110748
+ workspace_id: string
110749
+ /** Date and time at which the event was created. */
110750
+ created_at: string
110751
+ /** Date and time at which the event occurred. */
110752
+ occurred_at: string
110753
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110754
+ event_description?: string | undefined
110755
+ /** ID of the affected device. */
110756
+ device_id: string
110757
+ /** ID of the connected account associated with the event. */
110758
+ connected_account_id: string
110759
+ /** The customer key associated with the device, if any. */
110760
+ customer_key?: string | undefined
110761
+ /** Custom metadata of the device, present when device_id is provided. */
110762
+ device_custom_metadata?:
110763
+ | {
110764
+ [x: string]: string | boolean
110765
+ }
110766
+ | undefined
110767
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110768
+ connected_account_custom_metadata?:
110769
+ | {
110770
+ [x: string]: string | boolean
110771
+ }
110772
+ | undefined
110773
+ event_type: 'camera.activated'
110774
+ /** The reason the camera was activated. */
110775
+ activation_reason: 'motion_detected'
110776
+ /** Sub-type of motion detected, if available. */
110777
+ motion_sub_type?:
110778
+ ('human' | 'vehicle' | 'package' | 'other') | undefined
110779
+ /** URL to a thumbnail image captured at the time of activation. */
110780
+ image_url?: string | undefined
110781
+ /** URL to a short video clip captured at the time of activation. */
110782
+ video_url?: string | undefined
110783
+ }
110784
+ | {
110785
+ /** ID of the event. */
110786
+ event_id: string
110787
+ /** ID of the workspace associated with the event. */
110788
+ workspace_id: string
110789
+ /** Date and time at which the event was created. */
110790
+ created_at: string
110791
+ /** Date and time at which the event occurred. */
110792
+ occurred_at: string
110793
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110794
+ event_description?: string | undefined
110795
+ /** ID of the affected device. */
110796
+ device_id: string
110797
+ /** ID of the connected account associated with the event. */
110798
+ connected_account_id: string
110799
+ /** The customer key associated with the device, if any. */
110800
+ customer_key?: string | undefined
110801
+ /** Custom metadata of the device, present when device_id is provided. */
110802
+ device_custom_metadata?:
110803
+ | {
110804
+ [x: string]: string | boolean
110805
+ }
110806
+ | undefined
110807
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
110808
+ connected_account_custom_metadata?:
110809
+ | {
110810
+ [x: string]: string | boolean
110811
+ }
110812
+ | undefined
110813
+ event_type: 'device.doorbell_rang'
110814
+ /** URL to a thumbnail image captured at the time the doorbell was pressed. */
110815
+ image_url?: string | undefined
110816
+ /** URL to a short video clip captured at the time the doorbell was pressed. */
110817
+ video_url?: string | undefined
110818
+ }
110819
+ | {
110820
+ /** ID of the event. */
110821
+ event_id: string
110822
+ /** ID of the workspace associated with the event. */
110823
+ workspace_id: string
110824
+ /** Date and time at which the event was created. */
110825
+ created_at: string
110826
+ /** Date and time at which the event occurred. */
110827
+ occurred_at: string
110828
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110829
+ event_description?: string | undefined
110830
+ /** ID of the affected enrollment automation. */
110831
+ enrollment_automation_id: string
110832
+ event_type: 'enrollment_automation.deleted'
110833
+ }
110834
+ | {
110835
+ /** ID of the event. */
110836
+ event_id: string
110837
+ /** ID of the workspace associated with the event. */
110838
+ workspace_id: string
110839
+ /** Date and time at which the event was created. */
110840
+ created_at: string
110841
+ /** Date and time at which the event occurred. */
110842
+ occurred_at: string
110843
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110844
+ event_description?: string | undefined
110845
+ /** ID of the affected phone device. */
110846
+ device_id: string
110847
+ /** Custom metadata of the device; present when device_id is provided. */
110848
+ device_custom_metadata?:
110849
+ | {
110850
+ [x: string]: string | boolean
110851
+ }
110852
+ | undefined
110853
+ event_type: 'phone.deactivated'
110854
+ }
110855
+ | {
110856
+ /** ID of the event. */
110857
+ event_id: string
110858
+ /** ID of the workspace associated with the event. */
110859
+ workspace_id: string
110860
+ /** Date and time at which the event was created. */
110861
+ created_at: string
110862
+ /** Date and time at which the event occurred. */
110863
+ occurred_at: string
110864
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110865
+ event_description?: string | undefined
110866
+ /** ID of the affected space. */
110867
+ space_id: string
110868
+ /** Type of the event. */
110869
+ event_type: 'space.device_membership_changed'
110870
+ /** Unique key for the space within the workspace. */
110871
+ space_key?: string | undefined
110872
+ /** IDs of all devices currently attached to the space. */
110873
+ device_ids: string[]
110874
+ /** IDs of all ACS entrances currently attached to the space. */
110875
+ acs_entrance_ids: string[]
110876
+ }
110877
+ | {
110878
+ /** ID of the event. */
110879
+ event_id: string
110880
+ /** ID of the workspace associated with the event. */
110881
+ workspace_id: string
110882
+ /** Date and time at which the event was created. */
110883
+ created_at: string
110884
+ /** Date and time at which the event occurred. */
110885
+ occurred_at: string
110886
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110887
+ event_description?: string | undefined
110888
+ /** ID of the affected space. */
110889
+ space_id: string
110890
+ /** Type of the event. */
110891
+ event_type: 'space.created'
110892
+ /** Unique key for the space within the workspace. */
110893
+ space_key?: string | undefined
110894
+ /** IDs of all devices attached to the space when it was created. */
110895
+ device_ids: string[]
110896
+ /** IDs of all ACS entrances attached to the space when it was created. */
110897
+ acs_entrance_ids: string[]
110898
+ }
110899
+ | {
110900
+ /** ID of the event. */
110901
+ event_id: string
110902
+ /** ID of the workspace associated with the event. */
110903
+ workspace_id: string
110904
+ /** Date and time at which the event was created. */
110905
+ created_at: string
110906
+ /** Date and time at which the event occurred. */
110907
+ occurred_at: string
110908
+ /** Human-readable description of the event. Persisted when the event is created (so the creating code, including a provider, can supply a tailored description) and otherwise derived from the event. */
110909
+ event_description?: string | undefined
110910
+ /** ID of the affected space. */
110911
+ space_id: string
110912
+ /** Type of the event. */
110913
+ event_type: 'space.deleted'
110914
+ /** Unique key for the space within the workspace. */
110915
+ space_key?: string | undefined
110916
+ /** IDs of all devices attached to the space when it was deleted. */
110917
+ device_ids: string[]
110918
+ /** IDs of all ACS entrances currently attached to the space when it was deleted. */
110919
+ acs_entrance_ids: string[]
110920
+ }
110921
+ simulation: {
110922
+ /** Payload fields that Seam set to a real resource in your workspace. */
110923
+ resolved_fields: string[]
110924
+ /** Number of webhooks in your workspace that are subscribed to this event type and therefore receive this event. If this is `0`, no webhook receives the event. `null` if Seam could not determine the count. */
110925
+ subscribed_webhook_count: number | null
110926
+ /** Payload fields that Seam set to a placeholder value because your workspace has no matching resource and you did not provide one. */
110927
+ synthesized_fields: string[]
110928
+ }
110929
+ }
110930
+ maxDuration: undefined
110931
+ }
106801
110932
  '/seam/wizard/v1/session': {
106802
110933
  route: '/seam/wizard/v1/session'
106803
110934
  method: 'POST'