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