@seamapi/types 1.466.1 → 1.468.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.
@@ -12548,6 +12548,14 @@ export type Routes = {
12548
12548
  | undefined
12549
12549
  )
12550
12550
  | undefined
12551
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
12552
+ thermostat_daily_program_period_precision_minutes?:
12553
+ | (number | undefined)
12554
+ | undefined
12555
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
12556
+ max_thermostat_daily_program_periods_per_day?:
12557
+ | (number | undefined)
12558
+ | undefined
12551
12559
  })
12552
12560
  /** Location information for the device. */
12553
12561
  location: {
@@ -12892,6 +12900,7 @@ export type Routes = {
12892
12900
  can_simulate_connection?: boolean | undefined
12893
12901
  can_simulate_disconnection?: boolean | undefined
12894
12902
  can_unlock_with_code?: boolean | undefined
12903
+ can_run_thermostat_programs?: boolean | undefined
12895
12904
  }[]
12896
12905
  | undefined
12897
12906
  acs_entrances?:
@@ -16257,6 +16266,14 @@ export type Routes = {
16257
16266
  | undefined
16258
16267
  )
16259
16268
  | undefined
16269
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
16270
+ thermostat_daily_program_period_precision_minutes?:
16271
+ | (number | undefined)
16272
+ | undefined
16273
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
16274
+ max_thermostat_daily_program_periods_per_day?:
16275
+ | (number | undefined)
16276
+ | undefined
16260
16277
  })
16261
16278
  /** Location information for the device. */
16262
16279
  location: {
@@ -16601,6 +16618,7 @@ export type Routes = {
16601
16618
  can_simulate_connection?: boolean | undefined
16602
16619
  can_simulate_disconnection?: boolean | undefined
16603
16620
  can_unlock_with_code?: boolean | undefined
16621
+ can_run_thermostat_programs?: boolean | undefined
16604
16622
  }[]
16605
16623
  | undefined
16606
16624
  acs_entrances?:
@@ -19461,6 +19479,7 @@ export type Routes = {
19461
19479
  can_simulate_connection?: boolean | undefined
19462
19480
  can_simulate_disconnection?: boolean | undefined
19463
19481
  can_unlock_with_code?: boolean | undefined
19482
+ can_run_thermostat_programs?: boolean | undefined
19464
19483
  }[]
19465
19484
  | undefined
19466
19485
  connect_webviews?:
@@ -33702,6 +33721,14 @@ export type Routes = {
33702
33721
  | undefined
33703
33722
  )
33704
33723
  | undefined
33724
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
33725
+ thermostat_daily_program_period_precision_minutes?:
33726
+ | (number | undefined)
33727
+ | undefined
33728
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
33729
+ max_thermostat_daily_program_periods_per_day?:
33730
+ | (number | undefined)
33731
+ | undefined
33705
33732
  })
33706
33733
  /** Location information for the device. */
33707
33734
  location: {
@@ -34046,6 +34073,7 @@ export type Routes = {
34046
34073
  can_simulate_connection?: boolean | undefined
34047
34074
  can_simulate_disconnection?: boolean | undefined
34048
34075
  can_unlock_with_code?: boolean | undefined
34076
+ can_run_thermostat_programs?: boolean | undefined
34049
34077
  }
34050
34078
  }
34051
34079
  }
@@ -34226,6 +34254,7 @@ export type Routes = {
34226
34254
  | 'can_simulate_connection'
34227
34255
  | 'can_simulate_disconnection'
34228
34256
  | 'can_unlock_with_code'
34257
+ | 'can_run_thermostat_programs'
34229
34258
  )[]
34230
34259
  | undefined
34231
34260
  /** */
@@ -34243,6 +34272,7 @@ export type Routes = {
34243
34272
  | 'can_simulate_connection'
34244
34273
  | 'can_simulate_disconnection'
34245
34274
  | 'can_unlock_with_code'
34275
+ | 'can_run_thermostat_programs'
34246
34276
  )[]
34247
34277
  | undefined
34248
34278
  /**
@@ -35408,6 +35438,14 @@ export type Routes = {
35408
35438
  | undefined
35409
35439
  )
35410
35440
  | undefined
35441
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
35442
+ thermostat_daily_program_period_precision_minutes?:
35443
+ | (number | undefined)
35444
+ | undefined
35445
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
35446
+ max_thermostat_daily_program_periods_per_day?:
35447
+ | (number | undefined)
35448
+ | undefined
35411
35449
  })
35412
35450
  /** Location information for the device. */
35413
35451
  location: {
@@ -35752,6 +35790,7 @@ export type Routes = {
35752
35790
  can_simulate_connection?: boolean | undefined
35753
35791
  can_simulate_disconnection?: boolean | undefined
35754
35792
  can_unlock_with_code?: boolean | undefined
35793
+ can_run_thermostat_programs?: boolean | undefined
35755
35794
  }[]
35756
35795
  /** Information about the current page of results. */
35757
35796
  pagination: {
@@ -35854,6 +35893,7 @@ export type Routes = {
35854
35893
  can_simulate_connection?: boolean | undefined
35855
35894
  can_simulate_disconnection?: boolean | undefined
35856
35895
  can_unlock_with_code?: boolean | undefined
35896
+ can_run_thermostat_programs?: boolean | undefined
35857
35897
  }[]
35858
35898
  }
35859
35899
  }
@@ -36398,6 +36438,7 @@ export type Routes = {
36398
36438
  can_simulate_connection?: boolean | undefined
36399
36439
  can_simulate_disconnection?: boolean | undefined
36400
36440
  can_unlock_with_code?: boolean | undefined
36441
+ can_run_thermostat_programs?: boolean | undefined
36401
36442
  }
36402
36443
  }
36403
36444
  }
@@ -36578,6 +36619,7 @@ export type Routes = {
36578
36619
  | 'can_simulate_connection'
36579
36620
  | 'can_simulate_disconnection'
36580
36621
  | 'can_unlock_with_code'
36622
+ | 'can_run_thermostat_programs'
36581
36623
  )[]
36582
36624
  | undefined
36583
36625
  /** */
@@ -36595,6 +36637,7 @@ export type Routes = {
36595
36637
  | 'can_simulate_connection'
36596
36638
  | 'can_simulate_disconnection'
36597
36639
  | 'can_unlock_with_code'
36640
+ | 'can_run_thermostat_programs'
36598
36641
  )[]
36599
36642
  | undefined
36600
36643
  /**
@@ -37076,6 +37119,7 @@ export type Routes = {
37076
37119
  can_simulate_connection?: boolean | undefined
37077
37120
  can_simulate_disconnection?: boolean | undefined
37078
37121
  can_unlock_with_code?: boolean | undefined
37122
+ can_run_thermostat_programs?: boolean | undefined
37079
37123
  }[]
37080
37124
  }
37081
37125
  }
@@ -42930,6 +42974,14 @@ export type Routes = {
42930
42974
  | undefined
42931
42975
  )
42932
42976
  | undefined
42977
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
42978
+ thermostat_daily_program_period_precision_minutes?:
42979
+ | (number | undefined)
42980
+ | undefined
42981
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
42982
+ max_thermostat_daily_program_periods_per_day?:
42983
+ | (number | undefined)
42984
+ | undefined
42933
42985
  })
42934
42986
  /** Location information for the device. */
42935
42987
  location: {
@@ -43274,6 +43326,7 @@ export type Routes = {
43274
43326
  can_simulate_connection?: boolean | undefined
43275
43327
  can_simulate_disconnection?: boolean | undefined
43276
43328
  can_unlock_with_code?: boolean | undefined
43329
+ can_run_thermostat_programs?: boolean | undefined
43277
43330
  }
43278
43331
  /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
43279
43332
  device: {
@@ -44427,6 +44480,14 @@ export type Routes = {
44427
44480
  | undefined
44428
44481
  )
44429
44482
  | undefined
44483
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
44484
+ thermostat_daily_program_period_precision_minutes?:
44485
+ | (number | undefined)
44486
+ | undefined
44487
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
44488
+ max_thermostat_daily_program_periods_per_day?:
44489
+ | (number | undefined)
44490
+ | undefined
44430
44491
  })
44431
44492
  /** Location information for the device. */
44432
44493
  location: {
@@ -44771,6 +44832,7 @@ export type Routes = {
44771
44832
  can_simulate_connection?: boolean | undefined
44772
44833
  can_simulate_disconnection?: boolean | undefined
44773
44834
  can_unlock_with_code?: boolean | undefined
44835
+ can_run_thermostat_programs?: boolean | undefined
44774
44836
  }
44775
44837
  }
44776
44838
  }
@@ -44915,6 +44977,7 @@ export type Routes = {
44915
44977
  | 'can_simulate_connection'
44916
44978
  | 'can_simulate_disconnection'
44917
44979
  | 'can_unlock_with_code'
44980
+ | 'can_run_thermostat_programs'
44918
44981
  )[]
44919
44982
  | undefined
44920
44983
  /** */
@@ -44932,6 +44995,7 @@ export type Routes = {
44932
44995
  | 'can_simulate_connection'
44933
44996
  | 'can_simulate_disconnection'
44934
44997
  | 'can_unlock_with_code'
44998
+ | 'can_run_thermostat_programs'
44935
44999
  )[]
44936
45000
  | undefined
44937
45001
  /**
@@ -46097,6 +46161,14 @@ export type Routes = {
46097
46161
  | undefined
46098
46162
  )
46099
46163
  | undefined
46164
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
46165
+ thermostat_daily_program_period_precision_minutes?:
46166
+ | (number | undefined)
46167
+ | undefined
46168
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
46169
+ max_thermostat_daily_program_periods_per_day?:
46170
+ | (number | undefined)
46171
+ | undefined
46100
46172
  })
46101
46173
  /** Location information for the device. */
46102
46174
  location: {
@@ -46441,6 +46513,7 @@ export type Routes = {
46441
46513
  can_simulate_connection?: boolean | undefined
46442
46514
  can_simulate_disconnection?: boolean | undefined
46443
46515
  can_unlock_with_code?: boolean | undefined
46516
+ can_run_thermostat_programs?: boolean | undefined
46444
46517
  }[]
46445
46518
  devices: {
46446
46519
  /** ID of the device. */
@@ -47593,6 +47666,14 @@ export type Routes = {
47593
47666
  | undefined
47594
47667
  )
47595
47668
  | undefined
47669
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
47670
+ thermostat_daily_program_period_precision_minutes?:
47671
+ | (number | undefined)
47672
+ | undefined
47673
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
47674
+ max_thermostat_daily_program_periods_per_day?:
47675
+ | (number | undefined)
47676
+ | undefined
47596
47677
  })
47597
47678
  /** Location information for the device. */
47598
47679
  location: {
@@ -47937,6 +48018,7 @@ export type Routes = {
47937
48018
  can_simulate_connection?: boolean | undefined
47938
48019
  can_simulate_disconnection?: boolean | undefined
47939
48020
  can_unlock_with_code?: boolean | undefined
48021
+ can_run_thermostat_programs?: boolean | undefined
47940
48022
  }[]
47941
48023
  }
47942
48024
  }
@@ -53752,6 +53834,7 @@ export type Routes = {
53752
53834
  | 'can_simulate_connection'
53753
53835
  | 'can_simulate_disconnection'
53754
53836
  | 'can_unlock_with_code'
53837
+ | 'can_run_thermostat_programs'
53755
53838
  )[]
53756
53839
  | undefined
53757
53840
  /** */
@@ -53769,6 +53852,7 @@ export type Routes = {
53769
53852
  | 'can_simulate_connection'
53770
53853
  | 'can_simulate_disconnection'
53771
53854
  | 'can_unlock_with_code'
53855
+ | 'can_run_thermostat_programs'
53772
53856
  )[]
53773
53857
  | undefined
53774
53858
  /**
@@ -54934,6 +55018,14 @@ export type Routes = {
54934
55018
  | undefined
54935
55019
  )
54936
55020
  | undefined
55021
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
55022
+ thermostat_daily_program_period_precision_minutes?:
55023
+ | (number | undefined)
55024
+ | undefined
55025
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
55026
+ max_thermostat_daily_program_periods_per_day?:
55027
+ | (number | undefined)
55028
+ | undefined
54937
55029
  })
54938
55030
  /** Location information for the device. */
54939
55031
  location: {
@@ -55278,6 +55370,7 @@ export type Routes = {
55278
55370
  can_simulate_connection?: boolean | undefined
55279
55371
  can_simulate_disconnection?: boolean | undefined
55280
55372
  can_unlock_with_code?: boolean | undefined
55373
+ can_run_thermostat_programs?: boolean | undefined
55281
55374
  }[]
55282
55375
  devices: {
55283
55376
  /** ID of the device. */
@@ -56430,6 +56523,14 @@ export type Routes = {
56430
56523
  | undefined
56431
56524
  )
56432
56525
  | undefined
56526
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
56527
+ thermostat_daily_program_period_precision_minutes?:
56528
+ | (number | undefined)
56529
+ | undefined
56530
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
56531
+ max_thermostat_daily_program_periods_per_day?:
56532
+ | (number | undefined)
56533
+ | undefined
56433
56534
  })
56434
56535
  /** Location information for the device. */
56435
56536
  location: {
@@ -56774,6 +56875,7 @@ export type Routes = {
56774
56875
  can_simulate_connection?: boolean | undefined
56775
56876
  can_simulate_disconnection?: boolean | undefined
56776
56877
  can_unlock_with_code?: boolean | undefined
56878
+ can_run_thermostat_programs?: boolean | undefined
56777
56879
  }[]
56778
56880
  }
56779
56881
  }
@@ -61966,310 +62068,2692 @@ export type Routes = {
61966
62068
  formData: {}
61967
62069
  jsonResponse: {}
61968
62070
  }
61969
- '/seam/customer/v1/portals/get': {
61970
- route: '/seam/customer/v1/portals/get'
62071
+ '/seam/customer/v1/events/list': {
62072
+ route: '/seam/customer/v1/events/list'
61971
62073
  method: 'GET' | 'POST'
61972
62074
  queryParams: {}
61973
62075
  jsonBody: {}
61974
62076
  commonParams: {
61975
- /** Customer portal ID. */
61976
- customer_portal_id: string
61977
- }
61978
- formData: {}
61979
- jsonResponse: {
61980
- customer_portal: {
61981
- features?:
61982
- | {
61983
- connect?:
61984
- | {
61985
- exclude?: boolean | undefined
61986
- }
61987
- | undefined
61988
- manage_devices?:
61989
- | {
61990
- exclude?: boolean | undefined
61991
- }
61992
- | undefined
61993
- organize?:
61994
- | {
61995
- exclude?: boolean | undefined
61996
- }
61997
- | undefined
61998
- configure?:
61999
- | {
62000
- exclude?: boolean | undefined
62001
- allow_access_automation_rule_customization?:
62002
- | boolean
62003
- | undefined
62004
- allow_instant_key_customization?: boolean | undefined
62005
- }
62006
- | undefined
62007
- }
62008
- | undefined
62009
- is_embedded?: boolean | undefined
62010
- /** Business vertical of the customer portal. */
62011
- business_vertical?:
62012
- | (
62013
- | 'short_term_rental'
62014
- | 'hospitality'
62015
- | 'multi_family'
62016
- | 'gym_management'
62017
- | 'property_tours'
62018
- )
62019
- | undefined
62020
- }
62021
- }
62022
- }
62023
- '/seam/customer/v1/settings/update': {
62024
- route: '/seam/customer/v1/settings/update'
62025
- method: 'PATCH' | 'POST'
62026
- queryParams: {}
62027
- jsonBody: {
62028
- /** Business vertical to set on the workspace. */
62029
- business_vertical?:
62077
+ /** ID of the space for which you want to list events. */
62078
+ space_id: string
62079
+ /** Timestamp to indicate the beginning generation time for the events that you want to list. You must include `since` or `between`. */
62080
+ since?: string | undefined
62081
+ /** Lower and upper timestamps to define an exclusive interval containing the events that you want to list. You must include `since` or `between`. */
62082
+ between?: (string | Date)[] | undefined
62083
+ /** Type of the events that you want to list. */
62084
+ event_type?:
62030
62085
  | (
62031
- | 'short_term_rental'
62032
- | 'hospitality'
62033
- | 'multi_family'
62034
- | 'gym_management'
62035
- | 'property_tours'
62086
+ | 'access_code.created'
62087
+ | 'access_code.changed'
62088
+ | 'access_code.scheduled_on_device'
62089
+ | 'access_code.set_on_device'
62090
+ | 'access_code.removed_from_device'
62091
+ | 'access_code.delay_in_setting_on_device'
62092
+ | 'access_code.failed_to_set_on_device'
62093
+ | 'access_code.deleted'
62094
+ | 'access_code.delay_in_removing_from_device'
62095
+ | 'access_code.failed_to_remove_from_device'
62096
+ | 'access_code.modified_external_to_seam'
62097
+ | 'access_code.deleted_external_to_seam'
62098
+ | 'access_code.backup_access_code_pulled'
62099
+ | 'access_code.unmanaged.converted_to_managed'
62100
+ | 'access_code.unmanaged.failed_to_convert_to_managed'
62101
+ | 'access_code.unmanaged.created'
62102
+ | 'access_code.unmanaged.removed'
62103
+ | 'access_grant.created'
62104
+ | 'access_grant.deleted'
62105
+ | 'access_grant.access_granted_to_all_doors'
62106
+ | 'access_grant.access_granted_to_door'
62107
+ | 'access_grant.access_to_door_lost'
62108
+ | 'access_method.issued'
62109
+ | 'access_method.revoked'
62110
+ | 'access_method.card_encoding_required'
62111
+ | 'access_method.deleted'
62112
+ | 'access_method.reissued'
62113
+ | 'acs_system.connected'
62114
+ | 'acs_system.added'
62115
+ | 'acs_system.disconnected'
62116
+ | 'acs_credential.deleted'
62117
+ | 'acs_credential.issued'
62118
+ | 'acs_credential.reissued'
62119
+ | 'acs_credential.invalidated'
62120
+ | 'acs_user.created'
62121
+ | 'acs_user.deleted'
62122
+ | 'acs_encoder.added'
62123
+ | 'acs_encoder.removed'
62124
+ | 'acs_access_group.deleted'
62125
+ | 'acs_entrance.added'
62126
+ | 'acs_entrance.removed'
62127
+ | 'client_session.deleted'
62128
+ | 'connected_account.connected'
62129
+ | 'connected_account.created'
62130
+ | 'connected_account.successful_login'
62131
+ | 'connected_account.disconnected'
62132
+ | 'connected_account.completed_first_sync'
62133
+ | 'connected_account.deleted'
62134
+ | 'connected_account.completed_first_sync_after_reconnection'
62135
+ | 'action_attempt.lock_door.succeeded'
62136
+ | 'action_attempt.lock_door.failed'
62137
+ | 'action_attempt.unlock_door.succeeded'
62138
+ | 'action_attempt.unlock_door.failed'
62139
+ | 'connect_webview.login_succeeded'
62140
+ | 'connect_webview.login_failed'
62141
+ | 'device.connected'
62142
+ | 'device.added'
62143
+ | 'device.converted_to_unmanaged'
62144
+ | 'device.unmanaged.converted_to_managed'
62145
+ | 'device.unmanaged.connected'
62146
+ | 'device.disconnected'
62147
+ | 'device.unmanaged.disconnected'
62148
+ | 'device.tampered'
62149
+ | 'device.low_battery'
62150
+ | 'device.battery_status_changed'
62151
+ | 'device.removed'
62152
+ | 'device.deleted'
62153
+ | 'device.third_party_integration_detected'
62154
+ | 'device.third_party_integration_no_longer_detected'
62155
+ | 'device.salto.privacy_mode_activated'
62156
+ | 'device.salto.privacy_mode_deactivated'
62157
+ | 'device.connection_became_flaky'
62158
+ | 'device.connection_stabilized'
62159
+ | 'device.error.subscription_required'
62160
+ | 'device.error.subscription_required.resolved'
62161
+ | 'device.accessory_keypad_connected'
62162
+ | 'device.accessory_keypad_disconnected'
62163
+ | 'noise_sensor.noise_threshold_triggered'
62164
+ | 'lock.locked'
62165
+ | 'lock.unlocked'
62166
+ | 'lock.access_denied'
62167
+ | 'thermostat.climate_preset_activated'
62168
+ | 'thermostat.manually_adjusted'
62169
+ | 'thermostat.temperature_threshold_exceeded'
62170
+ | 'thermostat.temperature_threshold_no_longer_exceeded'
62171
+ | 'thermostat.temperature_reached_set_point'
62172
+ | 'thermostat.temperature_changed'
62173
+ | 'device.name_changed'
62174
+ | 'enrollment_automation.deleted'
62175
+ | 'phone.deactivated'
62036
62176
  )
62037
62177
  | undefined
62178
+ /** Types of the events that you want to list. */
62179
+ event_types?:
62180
+ | (
62181
+ | 'access_code.created'
62182
+ | 'access_code.changed'
62183
+ | 'access_code.scheduled_on_device'
62184
+ | 'access_code.set_on_device'
62185
+ | 'access_code.removed_from_device'
62186
+ | 'access_code.delay_in_setting_on_device'
62187
+ | 'access_code.failed_to_set_on_device'
62188
+ | 'access_code.deleted'
62189
+ | 'access_code.delay_in_removing_from_device'
62190
+ | 'access_code.failed_to_remove_from_device'
62191
+ | 'access_code.modified_external_to_seam'
62192
+ | 'access_code.deleted_external_to_seam'
62193
+ | 'access_code.backup_access_code_pulled'
62194
+ | 'access_code.unmanaged.converted_to_managed'
62195
+ | 'access_code.unmanaged.failed_to_convert_to_managed'
62196
+ | 'access_code.unmanaged.created'
62197
+ | 'access_code.unmanaged.removed'
62198
+ | 'access_grant.created'
62199
+ | 'access_grant.deleted'
62200
+ | 'access_grant.access_granted_to_all_doors'
62201
+ | 'access_grant.access_granted_to_door'
62202
+ | 'access_grant.access_to_door_lost'
62203
+ | 'access_method.issued'
62204
+ | 'access_method.revoked'
62205
+ | 'access_method.card_encoding_required'
62206
+ | 'access_method.deleted'
62207
+ | 'access_method.reissued'
62208
+ | 'acs_system.connected'
62209
+ | 'acs_system.added'
62210
+ | 'acs_system.disconnected'
62211
+ | 'acs_credential.deleted'
62212
+ | 'acs_credential.issued'
62213
+ | 'acs_credential.reissued'
62214
+ | 'acs_credential.invalidated'
62215
+ | 'acs_user.created'
62216
+ | 'acs_user.deleted'
62217
+ | 'acs_encoder.added'
62218
+ | 'acs_encoder.removed'
62219
+ | 'acs_access_group.deleted'
62220
+ | 'acs_entrance.added'
62221
+ | 'acs_entrance.removed'
62222
+ | 'client_session.deleted'
62223
+ | 'connected_account.connected'
62224
+ | 'connected_account.created'
62225
+ | 'connected_account.successful_login'
62226
+ | 'connected_account.disconnected'
62227
+ | 'connected_account.completed_first_sync'
62228
+ | 'connected_account.deleted'
62229
+ | 'connected_account.completed_first_sync_after_reconnection'
62230
+ | 'action_attempt.lock_door.succeeded'
62231
+ | 'action_attempt.lock_door.failed'
62232
+ | 'action_attempt.unlock_door.succeeded'
62233
+ | 'action_attempt.unlock_door.failed'
62234
+ | 'connect_webview.login_succeeded'
62235
+ | 'connect_webview.login_failed'
62236
+ | 'device.connected'
62237
+ | 'device.added'
62238
+ | 'device.converted_to_unmanaged'
62239
+ | 'device.unmanaged.converted_to_managed'
62240
+ | 'device.unmanaged.connected'
62241
+ | 'device.disconnected'
62242
+ | 'device.unmanaged.disconnected'
62243
+ | 'device.tampered'
62244
+ | 'device.low_battery'
62245
+ | 'device.battery_status_changed'
62246
+ | 'device.removed'
62247
+ | 'device.deleted'
62248
+ | 'device.third_party_integration_detected'
62249
+ | 'device.third_party_integration_no_longer_detected'
62250
+ | 'device.salto.privacy_mode_activated'
62251
+ | 'device.salto.privacy_mode_deactivated'
62252
+ | 'device.connection_became_flaky'
62253
+ | 'device.connection_stabilized'
62254
+ | 'device.error.subscription_required'
62255
+ | 'device.error.subscription_required.resolved'
62256
+ | 'device.accessory_keypad_connected'
62257
+ | 'device.accessory_keypad_disconnected'
62258
+ | 'noise_sensor.noise_threshold_triggered'
62259
+ | 'lock.locked'
62260
+ | 'lock.unlocked'
62261
+ | 'lock.access_denied'
62262
+ | 'thermostat.climate_preset_activated'
62263
+ | 'thermostat.manually_adjusted'
62264
+ | 'thermostat.temperature_threshold_exceeded'
62265
+ | 'thermostat.temperature_threshold_no_longer_exceeded'
62266
+ | 'thermostat.temperature_reached_set_point'
62267
+ | 'thermostat.temperature_changed'
62268
+ | 'device.name_changed'
62269
+ | 'enrollment_automation.deleted'
62270
+ | 'phone.deactivated'
62271
+ )[]
62272
+ | undefined
62273
+ /** Numerical limit on the number of events to return. */
62274
+ limit?: number
62038
62275
  }
62039
- commonParams: {}
62040
- formData: {}
62041
- jsonResponse: {}
62042
- }
62043
- '/seam/instant_key/v1/client_sessions/exchange_short_code': {
62044
- route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
62045
- method: 'POST'
62046
- queryParams: {}
62047
- jsonBody: {
62048
- /** Short code that you want to exchange for a client session token. */
62049
- short_code: string
62050
- }
62051
- commonParams: {}
62052
- formData: {}
62053
- jsonResponse: {
62054
- /** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
62055
-
62056
- You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
62057
-
62058
- When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
62059
-
62060
- A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
62061
-
62062
- See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
62063
- client_session: {
62064
- /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62065
- client_session_id: string
62066
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62067
- workspace_id: string
62068
- /** Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created. */
62069
- created_at: string
62070
- /** Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires. */
62071
- expires_at: string
62072
- /** Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62073
- token: string
62074
- /** Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62075
- user_identifier_key: string | null
62076
- /** Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62077
- device_count: number
62078
- /** Customer ID associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62079
- customer_id?: string | undefined
62080
- /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62081
- connected_account_ids: string[]
62082
- /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
62083
- connect_webview_ids: string[]
62084
- /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
62085
- * @deprecated Use `user_identity_id` instead.*/
62086
- user_identity_ids: string[]
62087
- /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. */
62088
- user_identity_id?: string | undefined
62089
- }
62090
- }
62091
- }
62092
- '/seam/mobile_sdk/v1/acs/credentials/list': {
62093
- route: '/seam/mobile_sdk/v1/acs/credentials/list'
62094
- method: 'GET' | 'POST'
62095
- queryParams: {}
62096
- jsonBody: {}
62097
- commonParams: {}
62098
62276
  formData: {}
62099
62277
  jsonResponse: {
62100
- acs_credentials: {
62101
- /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62102
- acs_credential_id: string
62103
- /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
62104
- acs_user_id?: string | undefined
62105
- /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
62106
- user_identity_id?: string | undefined
62107
- /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
62108
- connected_account_id: string
62109
- acs_credential_pool_id?: string | undefined
62110
- /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62111
- acs_system_id: string
62112
- /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62113
- parent_acs_credential_id?: string | undefined
62114
- /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
62115
- display_name: string
62116
- /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62117
- code?: (string | undefined) | null
62118
- /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
62119
- is_one_time_use?: boolean | undefined
62120
- /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62121
- card_number?: (string | undefined) | null
62122
- /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
62123
- is_issued?: boolean | undefined
62124
- /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
62125
- issued_at?: (string | undefined) | null
62126
- /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
62127
- access_method: 'code' | 'card' | 'mobile_key'
62128
- /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
62129
- external_type?:
62130
- | (
62131
- | 'pti_card'
62132
- | 'brivo_credential'
62133
- | 'hid_credential'
62134
- | 'visionline_card'
62135
- | 'salto_ks_credential'
62136
- | 'assa_abloy_vostio_key'
62137
- | 'salto_space_key'
62138
- | 'latch_access'
62139
- )
62140
- | undefined
62141
- /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
62142
- external_type_display_name?: string | undefined
62143
- /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
62144
- created_at: string
62145
- /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62146
- workspace_id: string
62147
- /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
62148
- starts_at?: string | undefined
62149
- /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
62150
- ends_at?: string | undefined
62151
- /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62152
- errors: {
62153
- error_code: string
62154
- message: string
62155
- }[]
62156
- /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62157
- warnings: (
62158
- | {
62159
- /** Date and time at which Seam created the warning. */
62160
- created_at: string
62161
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62162
- message: string
62163
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62164
- warning_code: 'waiting_to_be_issued'
62165
- }
62166
- | {
62167
- /** Date and time at which Seam created the warning. */
62168
- created_at: string
62169
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62170
- message: string
62171
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62172
- warning_code: 'schedule_externally_modified'
62173
- }
62174
- | {
62175
- /** Date and time at which Seam created the warning. */
62176
- created_at: string
62177
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62178
- message: string
62179
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62180
- warning_code: 'schedule_modified'
62181
- }
62182
- | {
62183
- /** Date and time at which Seam created the warning. */
62184
- created_at: string
62185
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62186
- message: string
62187
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62188
- warning_code: 'being_deleted'
62189
- }
62190
- | {
62191
- /** Date and time at which Seam created the warning. */
62192
- created_at: string
62193
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62194
- message: string
62195
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62196
- warning_code: 'unknown_issue_with_acs_credential'
62197
- }
62198
- | {
62199
- /** Date and time at which Seam created the warning. */
62200
- created_at: string
62201
- /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
62202
- message: string
62203
- /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62204
- warning_code: 'needs_to_be_reissued'
62205
- }
62206
- )[]
62207
- /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
62208
- is_multi_phone_sync_credential?: boolean | undefined
62209
- /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
62210
- is_latest_desired_state_synced_with_provider?:
62211
- | (boolean | null)
62212
- | undefined
62213
- /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
62214
- latest_desired_state_synced_with_provider_at?:
62215
- | (string | null)
62216
- | undefined
62217
- /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62218
- visionline_metadata?:
62219
- | {
62220
- /** Card function type in the Visionline access system. */
62221
- card_function_type: 'guest' | 'staff'
62222
- /** IDs of the credentials to which you want to join. */
62223
- joiner_acs_credential_ids?: string[] | undefined
62224
- /** Guest entrance IDs in the Visionline access system. */
62225
- guest_acs_entrance_ids?: string[] | undefined
62226
- /** Common entrance IDs in the Visionline access system. */
62227
- common_acs_entrance_ids?: string[] | undefined
62228
- /** Indicates whether the credential is valid. */
62229
- is_valid?: boolean | undefined
62230
- /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
62231
- auto_join?: boolean | undefined
62232
- /** ID of the card in the Visionline access system. */
62233
- card_id?: string | undefined
62234
- /** ID of the credential in the Visionline access system. */
62235
- credential_id?: string | undefined
62236
- }
62237
- | undefined
62238
- /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
62239
- assa_abloy_vostio_metadata?:
62240
- | {
62241
- /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
62242
- auto_join?: boolean | undefined
62243
- /** IDs of the guest entrances to override in the Vostio access system. */
62244
- override_guest_acs_entrance_ids?: string[] | undefined
62245
- /** Key ID in the Vostio access system. */
62246
- key_id?: string | undefined
62247
- /** Key issuing request ID in the Vostio access system. */
62248
- key_issuing_request_id?: string | undefined
62249
- /** Names of the doors to which to grant access in the Vostio access system. */
62250
- door_names?: string[] | undefined
62251
- /** Endpoint ID in the Vostio access system. */
62252
- endpoint_id?: string | undefined
62253
- }
62254
- | undefined
62255
- is_managed: true
62256
- }[]
62257
- }
62258
- }
62259
- '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
62260
- route: '/seam/mobile_sdk/v1/phone_sessions/get_or_create'
62261
- method: 'POST'
62262
- queryParams: {}
62263
- jsonBody: {
62264
- /** ID of the custom SDK installation that you want to use for the new session. */
62265
- custom_sdk_installation_id: string
62266
- /** Phone operating system that you want to use for the new session. */
62267
- phone_os: 'ios' | 'android'
62268
- /** Phone device metadata that you want to use for the new session. */
62269
- phone_device_metadata?:
62278
+ events: (
62270
62279
  | {
62271
- os_version?: string | undefined
62272
- manufacturer?: string | undefined
62280
+ /** ID of the event. */
62281
+ event_id: string
62282
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62283
+ workspace_id: string
62284
+ /** Date and time at which the event was created. */
62285
+ created_at: string
62286
+ /** Date and time at which the event occurred. */
62287
+ occurred_at: string
62288
+ /** ID of the affected access code. */
62289
+ access_code_id: string
62290
+ /** ID of the device associated with the affected access code. */
62291
+ device_id: string
62292
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62293
+ connected_account_id: string
62294
+ /** Custom metadata of the device, present when device_id is provided. */
62295
+ device_custom_metadata?:
62296
+ | {
62297
+ [x: string]: string | boolean
62298
+ }
62299
+ | undefined
62300
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62301
+ connected_account_custom_metadata?:
62302
+ | {
62303
+ [x: string]: string | boolean
62304
+ }
62305
+ | undefined
62306
+ event_type: 'access_code.created'
62307
+ }
62308
+ | {
62309
+ /** ID of the event. */
62310
+ event_id: string
62311
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62312
+ workspace_id: string
62313
+ /** Date and time at which the event was created. */
62314
+ created_at: string
62315
+ /** Date and time at which the event occurred. */
62316
+ occurred_at: string
62317
+ /** ID of the affected access code. */
62318
+ access_code_id: string
62319
+ /** ID of the device associated with the affected access code. */
62320
+ device_id: string
62321
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62322
+ connected_account_id: string
62323
+ /** Custom metadata of the device, present when device_id is provided. */
62324
+ device_custom_metadata?:
62325
+ | {
62326
+ [x: string]: string | boolean
62327
+ }
62328
+ | undefined
62329
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62330
+ connected_account_custom_metadata?:
62331
+ | {
62332
+ [x: string]: string | boolean
62333
+ }
62334
+ | undefined
62335
+ event_type: 'access_code.changed'
62336
+ }
62337
+ | {
62338
+ /** ID of the event. */
62339
+ event_id: string
62340
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62341
+ workspace_id: string
62342
+ /** Date and time at which the event was created. */
62343
+ created_at: string
62344
+ /** Date and time at which the event occurred. */
62345
+ occurred_at: string
62346
+ /** ID of the affected access code. */
62347
+ access_code_id: string
62348
+ /** ID of the device associated with the affected access code. */
62349
+ device_id: string
62350
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62351
+ connected_account_id: string
62352
+ /** Custom metadata of the device, present when device_id is provided. */
62353
+ device_custom_metadata?:
62354
+ | {
62355
+ [x: string]: string | boolean
62356
+ }
62357
+ | undefined
62358
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62359
+ connected_account_custom_metadata?:
62360
+ | {
62361
+ [x: string]: string | boolean
62362
+ }
62363
+ | undefined
62364
+ event_type: 'access_code.scheduled_on_device'
62365
+ /** Code for the affected access code. */
62366
+ code: string
62367
+ }
62368
+ | {
62369
+ /** ID of the event. */
62370
+ event_id: string
62371
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62372
+ workspace_id: string
62373
+ /** Date and time at which the event was created. */
62374
+ created_at: string
62375
+ /** Date and time at which the event occurred. */
62376
+ occurred_at: string
62377
+ /** ID of the affected access code. */
62378
+ access_code_id: string
62379
+ /** ID of the device associated with the affected access code. */
62380
+ device_id: string
62381
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62382
+ connected_account_id: string
62383
+ /** Custom metadata of the device, present when device_id is provided. */
62384
+ device_custom_metadata?:
62385
+ | {
62386
+ [x: string]: string | boolean
62387
+ }
62388
+ | undefined
62389
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62390
+ connected_account_custom_metadata?:
62391
+ | {
62392
+ [x: string]: string | boolean
62393
+ }
62394
+ | undefined
62395
+ event_type: 'access_code.set_on_device'
62396
+ /** Code for the affected access code. */
62397
+ code: string
62398
+ }
62399
+ | {
62400
+ /** ID of the event. */
62401
+ event_id: string
62402
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62403
+ workspace_id: string
62404
+ /** Date and time at which the event was created. */
62405
+ created_at: string
62406
+ /** Date and time at which the event occurred. */
62407
+ occurred_at: string
62408
+ /** ID of the affected access code. */
62409
+ access_code_id: string
62410
+ /** ID of the device associated with the affected access code. */
62411
+ device_id: string
62412
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62413
+ connected_account_id: string
62414
+ /** Custom metadata of the device, present when device_id is provided. */
62415
+ device_custom_metadata?:
62416
+ | {
62417
+ [x: string]: string | boolean
62418
+ }
62419
+ | undefined
62420
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62421
+ connected_account_custom_metadata?:
62422
+ | {
62423
+ [x: string]: string | boolean
62424
+ }
62425
+ | undefined
62426
+ event_type: 'access_code.removed_from_device'
62427
+ }
62428
+ | {
62429
+ /** ID of the event. */
62430
+ event_id: string
62431
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62432
+ workspace_id: string
62433
+ /** Date and time at which the event was created. */
62434
+ created_at: string
62435
+ /** Date and time at which the event occurred. */
62436
+ occurred_at: string
62437
+ /** ID of the affected access code. */
62438
+ access_code_id: string
62439
+ /** ID of the device associated with the affected access code. */
62440
+ device_id: string
62441
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62442
+ connected_account_id: string
62443
+ /** Custom metadata of the device, present when device_id is provided. */
62444
+ device_custom_metadata?:
62445
+ | {
62446
+ [x: string]: string | boolean
62447
+ }
62448
+ | undefined
62449
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62450
+ connected_account_custom_metadata?:
62451
+ | {
62452
+ [x: string]: string | boolean
62453
+ }
62454
+ | undefined
62455
+ event_type: 'access_code.delay_in_setting_on_device'
62456
+ }
62457
+ | {
62458
+ /** ID of the event. */
62459
+ event_id: string
62460
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62461
+ workspace_id: string
62462
+ /** Date and time at which the event was created. */
62463
+ created_at: string
62464
+ /** Date and time at which the event occurred. */
62465
+ occurred_at: string
62466
+ /** ID of the affected access code. */
62467
+ access_code_id: string
62468
+ /** ID of the device associated with the affected access code. */
62469
+ device_id: string
62470
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62471
+ connected_account_id: string
62472
+ /** Custom metadata of the device, present when device_id is provided. */
62473
+ device_custom_metadata?:
62474
+ | {
62475
+ [x: string]: string | boolean
62476
+ }
62477
+ | undefined
62478
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62479
+ connected_account_custom_metadata?:
62480
+ | {
62481
+ [x: string]: string | boolean
62482
+ }
62483
+ | undefined
62484
+ event_type: 'access_code.failed_to_set_on_device'
62485
+ }
62486
+ | {
62487
+ /** ID of the event. */
62488
+ event_id: string
62489
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62490
+ workspace_id: string
62491
+ /** Date and time at which the event was created. */
62492
+ created_at: string
62493
+ /** Date and time at which the event occurred. */
62494
+ occurred_at: string
62495
+ /** ID of the affected access code. */
62496
+ access_code_id: string
62497
+ /** ID of the device associated with the affected access code. */
62498
+ device_id: string
62499
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62500
+ connected_account_id: string
62501
+ /** Custom metadata of the device, present when device_id is provided. */
62502
+ device_custom_metadata?:
62503
+ | {
62504
+ [x: string]: string | boolean
62505
+ }
62506
+ | undefined
62507
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62508
+ connected_account_custom_metadata?:
62509
+ | {
62510
+ [x: string]: string | boolean
62511
+ }
62512
+ | undefined
62513
+ event_type: 'access_code.deleted'
62514
+ /** Code for the affected access code. */
62515
+ code: string | null
62516
+ }
62517
+ | {
62518
+ /** ID of the event. */
62519
+ event_id: string
62520
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62521
+ workspace_id: string
62522
+ /** Date and time at which the event was created. */
62523
+ created_at: string
62524
+ /** Date and time at which the event occurred. */
62525
+ occurred_at: string
62526
+ /** ID of the affected access code. */
62527
+ access_code_id: string
62528
+ /** ID of the device associated with the affected access code. */
62529
+ device_id: string
62530
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62531
+ connected_account_id: string
62532
+ /** Custom metadata of the device, present when device_id is provided. */
62533
+ device_custom_metadata?:
62534
+ | {
62535
+ [x: string]: string | boolean
62536
+ }
62537
+ | undefined
62538
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62539
+ connected_account_custom_metadata?:
62540
+ | {
62541
+ [x: string]: string | boolean
62542
+ }
62543
+ | undefined
62544
+ event_type: 'access_code.delay_in_removing_from_device'
62545
+ }
62546
+ | {
62547
+ /** ID of the event. */
62548
+ event_id: string
62549
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62550
+ workspace_id: string
62551
+ /** Date and time at which the event was created. */
62552
+ created_at: string
62553
+ /** Date and time at which the event occurred. */
62554
+ occurred_at: string
62555
+ /** ID of the affected access code. */
62556
+ access_code_id: string
62557
+ /** ID of the device associated with the affected access code. */
62558
+ device_id: string
62559
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62560
+ connected_account_id: string
62561
+ /** Custom metadata of the device, present when device_id is provided. */
62562
+ device_custom_metadata?:
62563
+ | {
62564
+ [x: string]: string | boolean
62565
+ }
62566
+ | undefined
62567
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62568
+ connected_account_custom_metadata?:
62569
+ | {
62570
+ [x: string]: string | boolean
62571
+ }
62572
+ | undefined
62573
+ event_type: 'access_code.failed_to_remove_from_device'
62574
+ }
62575
+ | {
62576
+ /** ID of the event. */
62577
+ event_id: string
62578
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62579
+ workspace_id: string
62580
+ /** Date and time at which the event was created. */
62581
+ created_at: string
62582
+ /** Date and time at which the event occurred. */
62583
+ occurred_at: string
62584
+ /** ID of the affected access code. */
62585
+ access_code_id: string
62586
+ /** ID of the device associated with the affected access code. */
62587
+ device_id: string
62588
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62589
+ connected_account_id: string
62590
+ /** Custom metadata of the device, present when device_id is provided. */
62591
+ device_custom_metadata?:
62592
+ | {
62593
+ [x: string]: string | boolean
62594
+ }
62595
+ | undefined
62596
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62597
+ connected_account_custom_metadata?:
62598
+ | {
62599
+ [x: string]: string | boolean
62600
+ }
62601
+ | undefined
62602
+ event_type: 'access_code.modified_external_to_seam'
62603
+ }
62604
+ | {
62605
+ /** ID of the event. */
62606
+ event_id: string
62607
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62608
+ workspace_id: string
62609
+ /** Date and time at which the event was created. */
62610
+ created_at: string
62611
+ /** Date and time at which the event occurred. */
62612
+ occurred_at: string
62613
+ /** ID of the affected access code. */
62614
+ access_code_id: string
62615
+ /** ID of the device associated with the affected access code. */
62616
+ device_id: string
62617
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62618
+ connected_account_id: string
62619
+ /** Custom metadata of the device, present when device_id is provided. */
62620
+ device_custom_metadata?:
62621
+ | {
62622
+ [x: string]: string | boolean
62623
+ }
62624
+ | undefined
62625
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62626
+ connected_account_custom_metadata?:
62627
+ | {
62628
+ [x: string]: string | boolean
62629
+ }
62630
+ | undefined
62631
+ event_type: 'access_code.deleted_external_to_seam'
62632
+ }
62633
+ | {
62634
+ /** ID of the event. */
62635
+ event_id: string
62636
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62637
+ workspace_id: string
62638
+ /** Date and time at which the event was created. */
62639
+ created_at: string
62640
+ /** Date and time at which the event occurred. */
62641
+ occurred_at: string
62642
+ /** ID of the affected access code. */
62643
+ access_code_id: string
62644
+ /** ID of the device associated with the affected access code. */
62645
+ device_id: string
62646
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62647
+ connected_account_id: string
62648
+ /** Custom metadata of the device, present when device_id is provided. */
62649
+ device_custom_metadata?:
62650
+ | {
62651
+ [x: string]: string | boolean
62652
+ }
62653
+ | undefined
62654
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62655
+ connected_account_custom_metadata?:
62656
+ | {
62657
+ [x: string]: string | boolean
62658
+ }
62659
+ | undefined
62660
+ event_type: 'access_code.backup_access_code_pulled'
62661
+ backup_access_code_id: string
62662
+ }
62663
+ | {
62664
+ /** ID of the event. */
62665
+ event_id: string
62666
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62667
+ workspace_id: string
62668
+ /** Date and time at which the event was created. */
62669
+ created_at: string
62670
+ /** Date and time at which the event occurred. */
62671
+ occurred_at: string
62672
+ /** ID of the affected access code. */
62673
+ access_code_id: string
62674
+ /** ID of the device associated with the affected access code. */
62675
+ device_id: string
62676
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62677
+ connected_account_id: string
62678
+ /** Custom metadata of the device, present when device_id is provided. */
62679
+ device_custom_metadata?:
62680
+ | {
62681
+ [x: string]: string | boolean
62682
+ }
62683
+ | undefined
62684
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62685
+ connected_account_custom_metadata?:
62686
+ | {
62687
+ [x: string]: string | boolean
62688
+ }
62689
+ | undefined
62690
+ event_type: 'access_code.unmanaged.converted_to_managed'
62691
+ }
62692
+ | {
62693
+ /** ID of the event. */
62694
+ event_id: string
62695
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62696
+ workspace_id: string
62697
+ /** Date and time at which the event was created. */
62698
+ created_at: string
62699
+ /** Date and time at which the event occurred. */
62700
+ occurred_at: string
62701
+ /** ID of the affected access code. */
62702
+ access_code_id: string
62703
+ /** ID of the device associated with the affected access code. */
62704
+ device_id: string
62705
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62706
+ connected_account_id: string
62707
+ /** Custom metadata of the device, present when device_id is provided. */
62708
+ device_custom_metadata?:
62709
+ | {
62710
+ [x: string]: string | boolean
62711
+ }
62712
+ | undefined
62713
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62714
+ connected_account_custom_metadata?:
62715
+ | {
62716
+ [x: string]: string | boolean
62717
+ }
62718
+ | undefined
62719
+ event_type: 'access_code.unmanaged.failed_to_convert_to_managed'
62720
+ }
62721
+ | {
62722
+ /** ID of the event. */
62723
+ event_id: string
62724
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62725
+ workspace_id: string
62726
+ /** Date and time at which the event was created. */
62727
+ created_at: string
62728
+ /** Date and time at which the event occurred. */
62729
+ occurred_at: string
62730
+ /** ID of the affected access code. */
62731
+ access_code_id: string
62732
+ /** ID of the device associated with the affected access code. */
62733
+ device_id: string
62734
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62735
+ connected_account_id: string
62736
+ /** Custom metadata of the device, present when device_id is provided. */
62737
+ device_custom_metadata?:
62738
+ | {
62739
+ [x: string]: string | boolean
62740
+ }
62741
+ | undefined
62742
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62743
+ connected_account_custom_metadata?:
62744
+ | {
62745
+ [x: string]: string | boolean
62746
+ }
62747
+ | undefined
62748
+ event_type: 'access_code.unmanaged.created'
62749
+ }
62750
+ | {
62751
+ /** ID of the event. */
62752
+ event_id: string
62753
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62754
+ workspace_id: string
62755
+ /** Date and time at which the event was created. */
62756
+ created_at: string
62757
+ /** Date and time at which the event occurred. */
62758
+ occurred_at: string
62759
+ /** ID of the affected access code. */
62760
+ access_code_id: string
62761
+ /** ID of the device associated with the affected access code. */
62762
+ device_id: string
62763
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
62764
+ connected_account_id: string
62765
+ /** Custom metadata of the device, present when device_id is provided. */
62766
+ device_custom_metadata?:
62767
+ | {
62768
+ [x: string]: string | boolean
62769
+ }
62770
+ | undefined
62771
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
62772
+ connected_account_custom_metadata?:
62773
+ | {
62774
+ [x: string]: string | boolean
62775
+ }
62776
+ | undefined
62777
+ event_type: 'access_code.unmanaged.removed'
62778
+ }
62779
+ | {
62780
+ /** ID of the event. */
62781
+ event_id: string
62782
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62783
+ workspace_id: string
62784
+ /** Date and time at which the event was created. */
62785
+ created_at: string
62786
+ /** Date and time at which the event occurred. */
62787
+ occurred_at: string
62788
+ /** ID of the affected Access Grant. */
62789
+ access_grant_id: string
62790
+ event_type: 'access_grant.created'
62791
+ }
62792
+ | {
62793
+ /** ID of the event. */
62794
+ event_id: string
62795
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62796
+ workspace_id: string
62797
+ /** Date and time at which the event was created. */
62798
+ created_at: string
62799
+ /** Date and time at which the event occurred. */
62800
+ occurred_at: string
62801
+ /** ID of the affected Access Grant. */
62802
+ access_grant_id: string
62803
+ event_type: 'access_grant.deleted'
62804
+ }
62805
+ | {
62806
+ /** ID of the event. */
62807
+ event_id: string
62808
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62809
+ workspace_id: string
62810
+ /** Date and time at which the event was created. */
62811
+ created_at: string
62812
+ /** Date and time at which the event occurred. */
62813
+ occurred_at: string
62814
+ /** ID of the affected Access Grant. */
62815
+ access_grant_id: string
62816
+ event_type: 'access_grant.access_granted_to_all_doors'
62817
+ }
62818
+ | {
62819
+ /** ID of the event. */
62820
+ event_id: string
62821
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62822
+ workspace_id: string
62823
+ /** Date and time at which the event was created. */
62824
+ created_at: string
62825
+ /** Date and time at which the event occurred. */
62826
+ occurred_at: string
62827
+ /** ID of the affected Access Grant. */
62828
+ access_grant_id: string
62829
+ event_type: 'access_grant.access_granted_to_door'
62830
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
62831
+ acs_entrance_id: string
62832
+ }
62833
+ | {
62834
+ /** ID of the event. */
62835
+ event_id: string
62836
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62837
+ workspace_id: string
62838
+ /** Date and time at which the event was created. */
62839
+ created_at: string
62840
+ /** Date and time at which the event occurred. */
62841
+ occurred_at: string
62842
+ /** ID of the affected Access Grant. */
62843
+ access_grant_id: string
62844
+ event_type: 'access_grant.access_to_door_lost'
62845
+ /** ID of the affected [entrance](https://docs.seam.co/latest/capability-guides/retrieving-entrance-details). */
62846
+ acs_entrance_id: string
62847
+ }
62848
+ | {
62849
+ /** ID of the event. */
62850
+ event_id: string
62851
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62852
+ workspace_id: string
62853
+ /** Date and time at which the event was created. */
62854
+ created_at: string
62855
+ /** Date and time at which the event occurred. */
62856
+ occurred_at: string
62857
+ /** ID of the affected access method. */
62858
+ access_method_id: string
62859
+ event_type: 'access_method.issued'
62860
+ }
62861
+ | {
62862
+ /** ID of the event. */
62863
+ event_id: string
62864
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62865
+ workspace_id: string
62866
+ /** Date and time at which the event was created. */
62867
+ created_at: string
62868
+ /** Date and time at which the event occurred. */
62869
+ occurred_at: string
62870
+ /** ID of the affected access method. */
62871
+ access_method_id: string
62872
+ event_type: 'access_method.revoked'
62873
+ }
62874
+ | {
62875
+ /** ID of the event. */
62876
+ event_id: string
62877
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62878
+ workspace_id: string
62879
+ /** Date and time at which the event was created. */
62880
+ created_at: string
62881
+ /** Date and time at which the event occurred. */
62882
+ occurred_at: string
62883
+ /** ID of the affected access method. */
62884
+ access_method_id: string
62885
+ event_type: 'access_method.card_encoding_required'
62886
+ }
62887
+ | {
62888
+ /** ID of the event. */
62889
+ event_id: string
62890
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62891
+ workspace_id: string
62892
+ /** Date and time at which the event was created. */
62893
+ created_at: string
62894
+ /** Date and time at which the event occurred. */
62895
+ occurred_at: string
62896
+ /** ID of the affected access method. */
62897
+ access_method_id: string
62898
+ event_type: 'access_method.deleted'
62899
+ }
62900
+ | {
62901
+ /** ID of the event. */
62902
+ event_id: string
62903
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62904
+ workspace_id: string
62905
+ /** Date and time at which the event was created. */
62906
+ created_at: string
62907
+ /** Date and time at which the event occurred. */
62908
+ occurred_at: string
62909
+ /** ID of the affected access method. */
62910
+ access_method_id: string
62911
+ event_type: 'access_method.reissued'
62912
+ }
62913
+ | {
62914
+ /** ID of the event. */
62915
+ event_id: string
62916
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62917
+ workspace_id: string
62918
+ /** Date and time at which the event was created. */
62919
+ created_at: string
62920
+ /** Date and time at which the event occurred. */
62921
+ occurred_at: string
62922
+ /** ID of the connected account. */
62923
+ connected_account_id?: string | undefined
62924
+ /** ID of the access system. */
62925
+ acs_system_id: string
62926
+ event_type: 'acs_system.connected'
62927
+ }
62928
+ | {
62929
+ /** ID of the event. */
62930
+ event_id: string
62931
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62932
+ workspace_id: string
62933
+ /** Date and time at which the event was created. */
62934
+ created_at: string
62935
+ /** Date and time at which the event occurred. */
62936
+ occurred_at: string
62937
+ /** ID of the connected account. */
62938
+ connected_account_id?: string | undefined
62939
+ /** ID of the access system. */
62940
+ acs_system_id: string
62941
+ event_type: 'acs_system.added'
62942
+ }
62943
+ | {
62944
+ /** ID of the event. */
62945
+ event_id: string
62946
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62947
+ workspace_id: string
62948
+ /** Date and time at which the event was created. */
62949
+ created_at: string
62950
+ /** Date and time at which the event occurred. */
62951
+ occurred_at: string
62952
+ /** ID of the connected account. */
62953
+ connected_account_id?: string | undefined
62954
+ /** ID of the access system. */
62955
+ acs_system_id: string
62956
+ event_type: 'acs_system.disconnected'
62957
+ }
62958
+ | {
62959
+ /** ID of the event. */
62960
+ event_id: string
62961
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62962
+ workspace_id: string
62963
+ /** Date and time at which the event was created. */
62964
+ created_at: string
62965
+ /** Date and time at which the event occurred. */
62966
+ occurred_at: string
62967
+ /** ID of the connected account. */
62968
+ connected_account_id?: string | undefined
62969
+ /** ID of the access system. */
62970
+ acs_system_id: string
62971
+ /** ID of the affected credential. */
62972
+ acs_credential_id: string
62973
+ event_type: 'acs_credential.deleted'
62974
+ }
62975
+ | {
62976
+ /** ID of the event. */
62977
+ event_id: string
62978
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62979
+ workspace_id: string
62980
+ /** Date and time at which the event was created. */
62981
+ created_at: string
62982
+ /** Date and time at which the event occurred. */
62983
+ occurred_at: string
62984
+ /** ID of the connected account. */
62985
+ connected_account_id?: string | undefined
62986
+ /** ID of the access system. */
62987
+ acs_system_id: string
62988
+ /** ID of the affected credential. */
62989
+ acs_credential_id: string
62990
+ event_type: 'acs_credential.issued'
62991
+ }
62992
+ | {
62993
+ /** ID of the event. */
62994
+ event_id: string
62995
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
62996
+ workspace_id: string
62997
+ /** Date and time at which the event was created. */
62998
+ created_at: string
62999
+ /** Date and time at which the event occurred. */
63000
+ occurred_at: string
63001
+ /** ID of the connected account. */
63002
+ connected_account_id?: string | undefined
63003
+ /** ID of the access system. */
63004
+ acs_system_id: string
63005
+ /** ID of the affected credential. */
63006
+ acs_credential_id: string
63007
+ event_type: 'acs_credential.reissued'
63008
+ }
63009
+ | {
63010
+ /** ID of the event. */
63011
+ event_id: string
63012
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63013
+ workspace_id: string
63014
+ /** Date and time at which the event was created. */
63015
+ created_at: string
63016
+ /** Date and time at which the event occurred. */
63017
+ occurred_at: string
63018
+ /** ID of the connected account. */
63019
+ connected_account_id?: string | undefined
63020
+ /** ID of the access system. */
63021
+ acs_system_id: string
63022
+ /** ID of the affected credential. */
63023
+ acs_credential_id: string
63024
+ event_type: 'acs_credential.invalidated'
63025
+ }
63026
+ | {
63027
+ /** ID of the event. */
63028
+ event_id: string
63029
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63030
+ workspace_id: string
63031
+ /** Date and time at which the event was created. */
63032
+ created_at: string
63033
+ /** Date and time at which the event occurred. */
63034
+ occurred_at: string
63035
+ /** ID of the connected account. */
63036
+ connected_account_id?: string | undefined
63037
+ /** ID of the access system. */
63038
+ acs_system_id: string
63039
+ acs_user_id: string
63040
+ event_type: 'acs_user.created'
63041
+ }
63042
+ | {
63043
+ /** ID of the event. */
63044
+ event_id: string
63045
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63046
+ workspace_id: string
63047
+ /** Date and time at which the event was created. */
63048
+ created_at: string
63049
+ /** Date and time at which the event occurred. */
63050
+ occurred_at: string
63051
+ /** ID of the connected account. */
63052
+ connected_account_id?: string | undefined
63053
+ /** ID of the access system. */
63054
+ acs_system_id: string
63055
+ acs_user_id: string
63056
+ event_type: 'acs_user.deleted'
63057
+ }
63058
+ | {
63059
+ /** ID of the event. */
63060
+ event_id: string
63061
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63062
+ workspace_id: string
63063
+ /** Date and time at which the event was created. */
63064
+ created_at: string
63065
+ /** Date and time at which the event occurred. */
63066
+ occurred_at: string
63067
+ /** ID of the connected account. */
63068
+ connected_account_id?: string | undefined
63069
+ /** ID of the access system. */
63070
+ acs_system_id: string
63071
+ /** ID of the affected encoder. */
63072
+ acs_encoder_id: string
63073
+ event_type: 'acs_encoder.added'
63074
+ }
63075
+ | {
63076
+ /** ID of the event. */
63077
+ event_id: string
63078
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63079
+ workspace_id: string
63080
+ /** Date and time at which the event was created. */
63081
+ created_at: string
63082
+ /** Date and time at which the event occurred. */
63083
+ occurred_at: string
63084
+ /** ID of the connected account. */
63085
+ connected_account_id?: string | undefined
63086
+ /** ID of the access system. */
63087
+ acs_system_id: string
63088
+ /** ID of the affected encoder. */
63089
+ acs_encoder_id: string
63090
+ event_type: 'acs_encoder.removed'
63091
+ }
63092
+ | {
63093
+ /** ID of the event. */
63094
+ event_id: string
63095
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63096
+ workspace_id: string
63097
+ /** Date and time at which the event was created. */
63098
+ created_at: string
63099
+ /** Date and time at which the event occurred. */
63100
+ occurred_at: string
63101
+ /** ID of the connected account. */
63102
+ connected_account_id?: string | undefined
63103
+ /** ID of the access system. */
63104
+ acs_system_id: string
63105
+ /** ID of the affected access group. */
63106
+ acs_access_group_id: string
63107
+ event_type: 'acs_access_group.deleted'
63108
+ }
63109
+ | {
63110
+ /** ID of the event. */
63111
+ event_id: string
63112
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63113
+ workspace_id: string
63114
+ /** Date and time at which the event was created. */
63115
+ created_at: string
63116
+ /** Date and time at which the event occurred. */
63117
+ occurred_at: string
63118
+ /** ID of the connected account. */
63119
+ connected_account_id?: string | undefined
63120
+ /** ID of the access system. */
63121
+ acs_system_id: string
63122
+ acs_entrance_id: string
63123
+ event_type: 'acs_entrance.added'
63124
+ }
63125
+ | {
63126
+ /** ID of the event. */
63127
+ event_id: string
63128
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63129
+ workspace_id: string
63130
+ /** Date and time at which the event was created. */
63131
+ created_at: string
63132
+ /** Date and time at which the event occurred. */
63133
+ occurred_at: string
63134
+ /** ID of the connected account. */
63135
+ connected_account_id?: string | undefined
63136
+ /** ID of the access system. */
63137
+ acs_system_id: string
63138
+ acs_entrance_id: string
63139
+ event_type: 'acs_entrance.removed'
63140
+ }
63141
+ | {
63142
+ /** ID of the event. */
63143
+ event_id: string
63144
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63145
+ workspace_id: string
63146
+ /** Date and time at which the event was created. */
63147
+ created_at: string
63148
+ /** Date and time at which the event occurred. */
63149
+ occurred_at: string
63150
+ /** ID of the affected client session. */
63151
+ client_session_id: string
63152
+ event_type: 'client_session.deleted'
63153
+ }
63154
+ | {
63155
+ /** ID of the event. */
63156
+ event_id: string
63157
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63158
+ workspace_id: string
63159
+ /** Date and time at which the event was created. */
63160
+ created_at: string
63161
+ /** Date and time at which the event occurred. */
63162
+ occurred_at: string
63163
+ /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
63164
+ connected_account_id: string
63165
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63166
+ connected_account_custom_metadata?:
63167
+ | {
63168
+ [x: string]: string | boolean
63169
+ }
63170
+ | undefined
63171
+ event_type: 'connected_account.connected'
63172
+ /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
63173
+ connect_webview_id: string
63174
+ }
63175
+ | {
63176
+ /** ID of the event. */
63177
+ event_id: string
63178
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63179
+ workspace_id: string
63180
+ /** Date and time at which the event was created. */
63181
+ created_at: string
63182
+ /** Date and time at which the event occurred. */
63183
+ occurred_at: string
63184
+ /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
63185
+ connected_account_id: string
63186
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63187
+ connected_account_custom_metadata?:
63188
+ | {
63189
+ [x: string]: string | boolean
63190
+ }
63191
+ | undefined
63192
+ event_type: 'connected_account.created'
63193
+ /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
63194
+ connect_webview_id: string
63195
+ }
63196
+ | {
63197
+ /** ID of the event. */
63198
+ event_id: string
63199
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63200
+ workspace_id: string
63201
+ /** Date and time at which the event was created. */
63202
+ created_at: string
63203
+ /** Date and time at which the event occurred. */
63204
+ occurred_at: string
63205
+ /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
63206
+ connected_account_id: string
63207
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63208
+ connected_account_custom_metadata?:
63209
+ | {
63210
+ [x: string]: string | boolean
63211
+ }
63212
+ | undefined
63213
+ event_type: 'connected_account.successful_login'
63214
+ /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
63215
+ connect_webview_id: string
63216
+ }
63217
+ | {
63218
+ /** ID of the event. */
63219
+ event_id: string
63220
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63221
+ workspace_id: string
63222
+ /** Date and time at which the event was created. */
63223
+ created_at: string
63224
+ /** Date and time at which the event occurred. */
63225
+ occurred_at: string
63226
+ /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
63227
+ connected_account_id: string
63228
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63229
+ connected_account_custom_metadata?:
63230
+ | {
63231
+ [x: string]: string | boolean
63232
+ }
63233
+ | undefined
63234
+ event_type: 'connected_account.disconnected'
63235
+ }
63236
+ | {
63237
+ /** ID of the event. */
63238
+ event_id: string
63239
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63240
+ workspace_id: string
63241
+ /** Date and time at which the event was created. */
63242
+ created_at: string
63243
+ /** Date and time at which the event occurred. */
63244
+ occurred_at: string
63245
+ /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
63246
+ connected_account_id: string
63247
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63248
+ connected_account_custom_metadata?:
63249
+ | {
63250
+ [x: string]: string | boolean
63251
+ }
63252
+ | undefined
63253
+ event_type: 'connected_account.completed_first_sync'
63254
+ }
63255
+ | {
63256
+ /** ID of the event. */
63257
+ event_id: string
63258
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63259
+ workspace_id: string
63260
+ /** Date and time at which the event was created. */
63261
+ created_at: string
63262
+ /** Date and time at which the event occurred. */
63263
+ occurred_at: string
63264
+ /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
63265
+ connected_account_id: string
63266
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63267
+ connected_account_custom_metadata?:
63268
+ | {
63269
+ [x: string]: string | boolean
63270
+ }
63271
+ | undefined
63272
+ event_type: 'connected_account.deleted'
63273
+ }
63274
+ | {
63275
+ /** ID of the event. */
63276
+ event_id: string
63277
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63278
+ workspace_id: string
63279
+ /** Date and time at which the event was created. */
63280
+ created_at: string
63281
+ /** Date and time at which the event occurred. */
63282
+ occurred_at: string
63283
+ /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
63284
+ connected_account_id: string
63285
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63286
+ connected_account_custom_metadata?:
63287
+ | {
63288
+ [x: string]: string | boolean
63289
+ }
63290
+ | undefined
63291
+ event_type: 'connected_account.completed_first_sync_after_reconnection'
63292
+ }
63293
+ | {
63294
+ /** ID of the event. */
63295
+ event_id: string
63296
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63297
+ workspace_id: string
63298
+ /** Date and time at which the event was created. */
63299
+ created_at: string
63300
+ /** Date and time at which the event occurred. */
63301
+ occurred_at: string
63302
+ /** ID of the affected action attempt. */
63303
+ action_attempt_id: string
63304
+ /** Type of the action. */
63305
+ action_type: string
63306
+ /** Status of the action. */
63307
+ status: string
63308
+ event_type: 'action_attempt.lock_door.succeeded'
63309
+ }
63310
+ | {
63311
+ /** ID of the event. */
63312
+ event_id: string
63313
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63314
+ workspace_id: string
63315
+ /** Date and time at which the event was created. */
63316
+ created_at: string
63317
+ /** Date and time at which the event occurred. */
63318
+ occurred_at: string
63319
+ /** ID of the affected action attempt. */
63320
+ action_attempt_id: string
63321
+ /** Type of the action. */
63322
+ action_type: string
63323
+ /** Status of the action. */
63324
+ status: string
63325
+ event_type: 'action_attempt.lock_door.failed'
63326
+ }
63327
+ | {
63328
+ /** ID of the event. */
63329
+ event_id: string
63330
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63331
+ workspace_id: string
63332
+ /** Date and time at which the event was created. */
63333
+ created_at: string
63334
+ /** Date and time at which the event occurred. */
63335
+ occurred_at: string
63336
+ /** ID of the affected action attempt. */
63337
+ action_attempt_id: string
63338
+ /** Type of the action. */
63339
+ action_type: string
63340
+ /** Status of the action. */
63341
+ status: string
63342
+ event_type: 'action_attempt.unlock_door.succeeded'
63343
+ }
63344
+ | {
63345
+ /** ID of the event. */
63346
+ event_id: string
63347
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63348
+ workspace_id: string
63349
+ /** Date and time at which the event was created. */
63350
+ created_at: string
63351
+ /** Date and time at which the event occurred. */
63352
+ occurred_at: string
63353
+ /** ID of the affected action attempt. */
63354
+ action_attempt_id: string
63355
+ /** Type of the action. */
63356
+ action_type: string
63357
+ /** Status of the action. */
63358
+ status: string
63359
+ event_type: 'action_attempt.unlock_door.failed'
63360
+ }
63361
+ | {
63362
+ /** ID of the event. */
63363
+ event_id: string
63364
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63365
+ workspace_id: string
63366
+ /** Date and time at which the event was created. */
63367
+ created_at: string
63368
+ /** Date and time at which the event occurred. */
63369
+ occurred_at: string
63370
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
63371
+ connect_webview_id: string
63372
+ event_type: 'connect_webview.login_succeeded'
63373
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63374
+ connected_account_id: string
63375
+ /** Custom metadata of the connected account; present when connected_account_id is provided. */
63376
+ connected_account_custom_metadata?:
63377
+ | {
63378
+ [x: string]: string | boolean
63379
+ }
63380
+ | undefined
63381
+ }
63382
+ | {
63383
+ /** ID of the event. */
63384
+ event_id: string
63385
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63386
+ workspace_id: string
63387
+ /** Date and time at which the event was created. */
63388
+ created_at: string
63389
+ /** Date and time at which the event occurred. */
63390
+ occurred_at: string
63391
+ /** ID of the affected [Connect Webview](https://docs.seam.co/latest/ui-components/connect-webviews). */
63392
+ connect_webview_id: string
63393
+ event_type: 'connect_webview.login_failed'
63394
+ }
63395
+ | {
63396
+ /** ID of the event. */
63397
+ event_id: string
63398
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63399
+ workspace_id: string
63400
+ /** Date and time at which the event was created. */
63401
+ created_at: string
63402
+ /** Date and time at which the event occurred. */
63403
+ occurred_at: string
63404
+ /** ID of the affected device. */
63405
+ device_id: string
63406
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63407
+ connected_account_id: string
63408
+ /** Custom metadata of the device, present when device_id is provided. */
63409
+ device_custom_metadata?:
63410
+ | {
63411
+ [x: string]: string | boolean
63412
+ }
63413
+ | undefined
63414
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63415
+ connected_account_custom_metadata?:
63416
+ | {
63417
+ [x: string]: string | boolean
63418
+ }
63419
+ | undefined
63420
+ event_type: 'device.connected'
63421
+ }
63422
+ | {
63423
+ /** ID of the event. */
63424
+ event_id: string
63425
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63426
+ workspace_id: string
63427
+ /** Date and time at which the event was created. */
63428
+ created_at: string
63429
+ /** Date and time at which the event occurred. */
63430
+ occurred_at: string
63431
+ /** ID of the affected device. */
63432
+ device_id: string
63433
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63434
+ connected_account_id: string
63435
+ /** Custom metadata of the device, present when device_id is provided. */
63436
+ device_custom_metadata?:
63437
+ | {
63438
+ [x: string]: string | boolean
63439
+ }
63440
+ | undefined
63441
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63442
+ connected_account_custom_metadata?:
63443
+ | {
63444
+ [x: string]: string | boolean
63445
+ }
63446
+ | undefined
63447
+ event_type: 'device.added'
63448
+ }
63449
+ | {
63450
+ /** ID of the event. */
63451
+ event_id: string
63452
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63453
+ workspace_id: string
63454
+ /** Date and time at which the event was created. */
63455
+ created_at: string
63456
+ /** Date and time at which the event occurred. */
63457
+ occurred_at: string
63458
+ /** ID of the affected device. */
63459
+ device_id: string
63460
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63461
+ connected_account_id: string
63462
+ /** Custom metadata of the device, present when device_id is provided. */
63463
+ device_custom_metadata?:
63464
+ | {
63465
+ [x: string]: string | boolean
63466
+ }
63467
+ | undefined
63468
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63469
+ connected_account_custom_metadata?:
63470
+ | {
63471
+ [x: string]: string | boolean
63472
+ }
63473
+ | undefined
63474
+ event_type: 'device.converted_to_unmanaged'
63475
+ }
63476
+ | {
63477
+ /** ID of the event. */
63478
+ event_id: string
63479
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63480
+ workspace_id: string
63481
+ /** Date and time at which the event was created. */
63482
+ created_at: string
63483
+ /** Date and time at which the event occurred. */
63484
+ occurred_at: string
63485
+ /** ID of the affected device. */
63486
+ device_id: string
63487
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63488
+ connected_account_id: string
63489
+ /** Custom metadata of the device, present when device_id is provided. */
63490
+ device_custom_metadata?:
63491
+ | {
63492
+ [x: string]: string | boolean
63493
+ }
63494
+ | undefined
63495
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63496
+ connected_account_custom_metadata?:
63497
+ | {
63498
+ [x: string]: string | boolean
63499
+ }
63500
+ | undefined
63501
+ event_type: 'device.unmanaged.converted_to_managed'
63502
+ }
63503
+ | {
63504
+ /** ID of the event. */
63505
+ event_id: string
63506
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63507
+ workspace_id: string
63508
+ /** Date and time at which the event was created. */
63509
+ created_at: string
63510
+ /** Date and time at which the event occurred. */
63511
+ occurred_at: string
63512
+ /** ID of the affected device. */
63513
+ device_id: string
63514
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63515
+ connected_account_id: string
63516
+ /** Custom metadata of the device, present when device_id is provided. */
63517
+ device_custom_metadata?:
63518
+ | {
63519
+ [x: string]: string | boolean
63520
+ }
63521
+ | undefined
63522
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63523
+ connected_account_custom_metadata?:
63524
+ | {
63525
+ [x: string]: string | boolean
63526
+ }
63527
+ | undefined
63528
+ event_type: 'device.unmanaged.connected'
63529
+ }
63530
+ | {
63531
+ /** ID of the event. */
63532
+ event_id: string
63533
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63534
+ workspace_id: string
63535
+ /** Date and time at which the event was created. */
63536
+ created_at: string
63537
+ /** Date and time at which the event occurred. */
63538
+ occurred_at: string
63539
+ /** ID of the affected device. */
63540
+ device_id: string
63541
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63542
+ connected_account_id: string
63543
+ /** Custom metadata of the device, present when device_id is provided. */
63544
+ device_custom_metadata?:
63545
+ | {
63546
+ [x: string]: string | boolean
63547
+ }
63548
+ | undefined
63549
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63550
+ connected_account_custom_metadata?:
63551
+ | {
63552
+ [x: string]: string | boolean
63553
+ }
63554
+ | undefined
63555
+ event_type: 'device.disconnected'
63556
+ /** Error code associated with the disconnection event, if any. */
63557
+ error_code:
63558
+ | 'account_disconnected'
63559
+ | 'hub_disconnected'
63560
+ | 'device_disconnected'
63561
+ }
63562
+ | {
63563
+ /** ID of the event. */
63564
+ event_id: string
63565
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63566
+ workspace_id: string
63567
+ /** Date and time at which the event was created. */
63568
+ created_at: string
63569
+ /** Date and time at which the event occurred. */
63570
+ occurred_at: string
63571
+ /** ID of the affected device. */
63572
+ device_id: string
63573
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63574
+ connected_account_id: string
63575
+ /** Custom metadata of the device, present when device_id is provided. */
63576
+ device_custom_metadata?:
63577
+ | {
63578
+ [x: string]: string | boolean
63579
+ }
63580
+ | undefined
63581
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63582
+ connected_account_custom_metadata?:
63583
+ | {
63584
+ [x: string]: string | boolean
63585
+ }
63586
+ | undefined
63587
+ event_type: 'device.unmanaged.disconnected'
63588
+ /** Error code associated with the disconnection event, if any. */
63589
+ error_code:
63590
+ | 'account_disconnected'
63591
+ | 'hub_disconnected'
63592
+ | 'device_disconnected'
63593
+ }
63594
+ | {
63595
+ /** ID of the event. */
63596
+ event_id: string
63597
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63598
+ workspace_id: string
63599
+ /** Date and time at which the event was created. */
63600
+ created_at: string
63601
+ /** Date and time at which the event occurred. */
63602
+ occurred_at: string
63603
+ /** ID of the affected device. */
63604
+ device_id: string
63605
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63606
+ connected_account_id: string
63607
+ /** Custom metadata of the device, present when device_id is provided. */
63608
+ device_custom_metadata?:
63609
+ | {
63610
+ [x: string]: string | boolean
63611
+ }
63612
+ | undefined
63613
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63614
+ connected_account_custom_metadata?:
63615
+ | {
63616
+ [x: string]: string | boolean
63617
+ }
63618
+ | undefined
63619
+ event_type: 'device.tampered'
63620
+ }
63621
+ | {
63622
+ /** ID of the event. */
63623
+ event_id: string
63624
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63625
+ workspace_id: string
63626
+ /** Date and time at which the event was created. */
63627
+ created_at: string
63628
+ /** Date and time at which the event occurred. */
63629
+ occurred_at: string
63630
+ /** ID of the affected device. */
63631
+ device_id: string
63632
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63633
+ connected_account_id: string
63634
+ /** Custom metadata of the device, present when device_id is provided. */
63635
+ device_custom_metadata?:
63636
+ | {
63637
+ [x: string]: string | boolean
63638
+ }
63639
+ | undefined
63640
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63641
+ connected_account_custom_metadata?:
63642
+ | {
63643
+ [x: string]: string | boolean
63644
+ }
63645
+ | undefined
63646
+ event_type: 'device.low_battery'
63647
+ /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
63648
+ battery_level: number
63649
+ }
63650
+ | {
63651
+ /** ID of the event. */
63652
+ event_id: string
63653
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63654
+ workspace_id: string
63655
+ /** Date and time at which the event was created. */
63656
+ created_at: string
63657
+ /** Date and time at which the event occurred. */
63658
+ occurred_at: string
63659
+ /** ID of the affected device. */
63660
+ device_id: string
63661
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63662
+ connected_account_id: string
63663
+ /** Custom metadata of the device, present when device_id is provided. */
63664
+ device_custom_metadata?:
63665
+ | {
63666
+ [x: string]: string | boolean
63667
+ }
63668
+ | undefined
63669
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63670
+ connected_account_custom_metadata?:
63671
+ | {
63672
+ [x: string]: string | boolean
63673
+ }
63674
+ | undefined
63675
+ event_type: 'device.battery_status_changed'
63676
+ /** Battery status of the affected device, calculated from the numeric `battery_level` value. */
63677
+ battery_status: 'critical' | 'low' | 'good' | 'full'
63678
+ /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
63679
+ battery_level: number
63680
+ }
63681
+ | {
63682
+ /** ID of the event. */
63683
+ event_id: string
63684
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63685
+ workspace_id: string
63686
+ /** Date and time at which the event was created. */
63687
+ created_at: string
63688
+ /** Date and time at which the event occurred. */
63689
+ occurred_at: string
63690
+ /** ID of the affected device. */
63691
+ device_id: string
63692
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63693
+ connected_account_id: string
63694
+ /** Custom metadata of the device, present when device_id is provided. */
63695
+ device_custom_metadata?:
63696
+ | {
63697
+ [x: string]: string | boolean
63698
+ }
63699
+ | undefined
63700
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63701
+ connected_account_custom_metadata?:
63702
+ | {
63703
+ [x: string]: string | boolean
63704
+ }
63705
+ | undefined
63706
+ event_type: 'device.removed'
63707
+ }
63708
+ | {
63709
+ /** ID of the event. */
63710
+ event_id: string
63711
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63712
+ workspace_id: string
63713
+ /** Date and time at which the event was created. */
63714
+ created_at: string
63715
+ /** Date and time at which the event occurred. */
63716
+ occurred_at: string
63717
+ /** ID of the affected device. */
63718
+ device_id: string
63719
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63720
+ connected_account_id: string
63721
+ /** Custom metadata of the device, present when device_id is provided. */
63722
+ device_custom_metadata?:
63723
+ | {
63724
+ [x: string]: string | boolean
63725
+ }
63726
+ | undefined
63727
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63728
+ connected_account_custom_metadata?:
63729
+ | {
63730
+ [x: string]: string | boolean
63731
+ }
63732
+ | undefined
63733
+ event_type: 'device.deleted'
63734
+ }
63735
+ | {
63736
+ /** ID of the event. */
63737
+ event_id: string
63738
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63739
+ workspace_id: string
63740
+ /** Date and time at which the event was created. */
63741
+ created_at: string
63742
+ /** Date and time at which the event occurred. */
63743
+ occurred_at: string
63744
+ /** ID of the affected device. */
63745
+ device_id: string
63746
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63747
+ connected_account_id: string
63748
+ /** Custom metadata of the device, present when device_id is provided. */
63749
+ device_custom_metadata?:
63750
+ | {
63751
+ [x: string]: string | boolean
63752
+ }
63753
+ | undefined
63754
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63755
+ connected_account_custom_metadata?:
63756
+ | {
63757
+ [x: string]: string | boolean
63758
+ }
63759
+ | undefined
63760
+ event_type: 'device.third_party_integration_detected'
63761
+ }
63762
+ | {
63763
+ /** ID of the event. */
63764
+ event_id: string
63765
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63766
+ workspace_id: string
63767
+ /** Date and time at which the event was created. */
63768
+ created_at: string
63769
+ /** Date and time at which the event occurred. */
63770
+ occurred_at: string
63771
+ /** ID of the affected device. */
63772
+ device_id: string
63773
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63774
+ connected_account_id: string
63775
+ /** Custom metadata of the device, present when device_id is provided. */
63776
+ device_custom_metadata?:
63777
+ | {
63778
+ [x: string]: string | boolean
63779
+ }
63780
+ | undefined
63781
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63782
+ connected_account_custom_metadata?:
63783
+ | {
63784
+ [x: string]: string | boolean
63785
+ }
63786
+ | undefined
63787
+ event_type: 'device.third_party_integration_no_longer_detected'
63788
+ }
63789
+ | {
63790
+ /** ID of the event. */
63791
+ event_id: string
63792
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63793
+ workspace_id: string
63794
+ /** Date and time at which the event was created. */
63795
+ created_at: string
63796
+ /** Date and time at which the event occurred. */
63797
+ occurred_at: string
63798
+ /** ID of the affected device. */
63799
+ device_id: string
63800
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63801
+ connected_account_id: string
63802
+ /** Custom metadata of the device, present when device_id is provided. */
63803
+ device_custom_metadata?:
63804
+ | {
63805
+ [x: string]: string | boolean
63806
+ }
63807
+ | undefined
63808
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63809
+ connected_account_custom_metadata?:
63810
+ | {
63811
+ [x: string]: string | boolean
63812
+ }
63813
+ | undefined
63814
+ event_type: 'device.salto.privacy_mode_activated'
63815
+ }
63816
+ | {
63817
+ /** ID of the event. */
63818
+ event_id: string
63819
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63820
+ workspace_id: string
63821
+ /** Date and time at which the event was created. */
63822
+ created_at: string
63823
+ /** Date and time at which the event occurred. */
63824
+ occurred_at: string
63825
+ /** ID of the affected device. */
63826
+ device_id: string
63827
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63828
+ connected_account_id: string
63829
+ /** Custom metadata of the device, present when device_id is provided. */
63830
+ device_custom_metadata?:
63831
+ | {
63832
+ [x: string]: string | boolean
63833
+ }
63834
+ | undefined
63835
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63836
+ connected_account_custom_metadata?:
63837
+ | {
63838
+ [x: string]: string | boolean
63839
+ }
63840
+ | undefined
63841
+ event_type: 'device.salto.privacy_mode_deactivated'
63842
+ }
63843
+ | {
63844
+ /** ID of the event. */
63845
+ event_id: string
63846
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63847
+ workspace_id: string
63848
+ /** Date and time at which the event was created. */
63849
+ created_at: string
63850
+ /** Date and time at which the event occurred. */
63851
+ occurred_at: string
63852
+ /** ID of the affected device. */
63853
+ device_id: string
63854
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63855
+ connected_account_id: string
63856
+ /** Custom metadata of the device, present when device_id is provided. */
63857
+ device_custom_metadata?:
63858
+ | {
63859
+ [x: string]: string | boolean
63860
+ }
63861
+ | undefined
63862
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63863
+ connected_account_custom_metadata?:
63864
+ | {
63865
+ [x: string]: string | boolean
63866
+ }
63867
+ | undefined
63868
+ event_type: 'device.connection_became_flaky'
63869
+ }
63870
+ | {
63871
+ /** ID of the event. */
63872
+ event_id: string
63873
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63874
+ workspace_id: string
63875
+ /** Date and time at which the event was created. */
63876
+ created_at: string
63877
+ /** Date and time at which the event occurred. */
63878
+ occurred_at: string
63879
+ /** ID of the affected device. */
63880
+ device_id: string
63881
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63882
+ connected_account_id: string
63883
+ /** Custom metadata of the device, present when device_id is provided. */
63884
+ device_custom_metadata?:
63885
+ | {
63886
+ [x: string]: string | boolean
63887
+ }
63888
+ | undefined
63889
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63890
+ connected_account_custom_metadata?:
63891
+ | {
63892
+ [x: string]: string | boolean
63893
+ }
63894
+ | undefined
63895
+ event_type: 'device.connection_stabilized'
63896
+ }
63897
+ | {
63898
+ /** ID of the event. */
63899
+ event_id: string
63900
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63901
+ workspace_id: string
63902
+ /** Date and time at which the event was created. */
63903
+ created_at: string
63904
+ /** Date and time at which the event occurred. */
63905
+ occurred_at: string
63906
+ /** ID of the affected device. */
63907
+ device_id: string
63908
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63909
+ connected_account_id: string
63910
+ /** Custom metadata of the device, present when device_id is provided. */
63911
+ device_custom_metadata?:
63912
+ | {
63913
+ [x: string]: string | boolean
63914
+ }
63915
+ | undefined
63916
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63917
+ connected_account_custom_metadata?:
63918
+ | {
63919
+ [x: string]: string | boolean
63920
+ }
63921
+ | undefined
63922
+ event_type: 'device.error.subscription_required'
63923
+ }
63924
+ | {
63925
+ /** ID of the event. */
63926
+ event_id: string
63927
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63928
+ workspace_id: string
63929
+ /** Date and time at which the event was created. */
63930
+ created_at: string
63931
+ /** Date and time at which the event occurred. */
63932
+ occurred_at: string
63933
+ /** ID of the affected device. */
63934
+ device_id: string
63935
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63936
+ connected_account_id: string
63937
+ /** Custom metadata of the device, present when device_id is provided. */
63938
+ device_custom_metadata?:
63939
+ | {
63940
+ [x: string]: string | boolean
63941
+ }
63942
+ | undefined
63943
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63944
+ connected_account_custom_metadata?:
63945
+ | {
63946
+ [x: string]: string | boolean
63947
+ }
63948
+ | undefined
63949
+ event_type: 'device.error.subscription_required.resolved'
63950
+ }
63951
+ | {
63952
+ /** ID of the event. */
63953
+ event_id: string
63954
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63955
+ workspace_id: string
63956
+ /** Date and time at which the event was created. */
63957
+ created_at: string
63958
+ /** Date and time at which the event occurred. */
63959
+ occurred_at: string
63960
+ /** ID of the affected device. */
63961
+ device_id: string
63962
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63963
+ connected_account_id: string
63964
+ /** Custom metadata of the device, present when device_id is provided. */
63965
+ device_custom_metadata?:
63966
+ | {
63967
+ [x: string]: string | boolean
63968
+ }
63969
+ | undefined
63970
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63971
+ connected_account_custom_metadata?:
63972
+ | {
63973
+ [x: string]: string | boolean
63974
+ }
63975
+ | undefined
63976
+ event_type: 'device.accessory_keypad_connected'
63977
+ }
63978
+ | {
63979
+ /** ID of the event. */
63980
+ event_id: string
63981
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
63982
+ workspace_id: string
63983
+ /** Date and time at which the event was created. */
63984
+ created_at: string
63985
+ /** Date and time at which the event occurred. */
63986
+ occurred_at: string
63987
+ /** ID of the affected device. */
63988
+ device_id: string
63989
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
63990
+ connected_account_id: string
63991
+ /** Custom metadata of the device, present when device_id is provided. */
63992
+ device_custom_metadata?:
63993
+ | {
63994
+ [x: string]: string | boolean
63995
+ }
63996
+ | undefined
63997
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
63998
+ connected_account_custom_metadata?:
63999
+ | {
64000
+ [x: string]: string | boolean
64001
+ }
64002
+ | undefined
64003
+ event_type: 'device.accessory_keypad_disconnected'
64004
+ }
64005
+ | {
64006
+ /** ID of the event. */
64007
+ event_id: string
64008
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64009
+ workspace_id: string
64010
+ /** Date and time at which the event was created. */
64011
+ created_at: string
64012
+ /** Date and time at which the event occurred. */
64013
+ occurred_at: string
64014
+ /** ID of the affected device. */
64015
+ device_id: string
64016
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64017
+ connected_account_id: string
64018
+ /** Custom metadata of the device, present when device_id is provided. */
64019
+ device_custom_metadata?:
64020
+ | {
64021
+ [x: string]: string | boolean
64022
+ }
64023
+ | undefined
64024
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64025
+ connected_account_custom_metadata?:
64026
+ | {
64027
+ [x: string]: string | boolean
64028
+ }
64029
+ | undefined
64030
+ event_type: 'noise_sensor.noise_threshold_triggered'
64031
+ /** Detected noise level in decibels. */
64032
+ noise_level_decibels?: number | undefined
64033
+ /** Detected noise level in Noiseaware Noise Risk Score (NRS). */
64034
+ noise_level_nrs?: number | undefined
64035
+ /** ID of the noise threshold that was triggered. */
64036
+ noise_threshold_id?: string | undefined
64037
+ /** Name of the noise threshold that was triggered. */
64038
+ noise_threshold_name?: string | undefined
64039
+ /** Metadata from Noiseaware. */
64040
+ noiseaware_metadata?:
64041
+ | {
64042
+ [x: string]: unknown
64043
+ }
64044
+ | undefined
64045
+ /** Metadata from Minut. */
64046
+ minut_metadata?:
64047
+ | {
64048
+ [x: string]: unknown
64049
+ }
64050
+ | undefined
64051
+ }
64052
+ | {
64053
+ /** ID of the event. */
64054
+ event_id: string
64055
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64056
+ workspace_id: string
64057
+ /** Date and time at which the event was created. */
64058
+ created_at: string
64059
+ /** Date and time at which the event occurred. */
64060
+ occurred_at: string
64061
+ /** ID of the affected device. */
64062
+ device_id: string
64063
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64064
+ connected_account_id: string
64065
+ /** Custom metadata of the device, present when device_id is provided. */
64066
+ device_custom_metadata?:
64067
+ | {
64068
+ [x: string]: string | boolean
64069
+ }
64070
+ | undefined
64071
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64072
+ connected_account_custom_metadata?:
64073
+ | {
64074
+ [x: string]: string | boolean
64075
+ }
64076
+ | undefined
64077
+ event_type: 'lock.locked'
64078
+ /** ID of the access code that was used to lock the device. */
64079
+ access_code_id?: string | undefined
64080
+ /** ID of the action attempt associated with the lock action. */
64081
+ action_attempt_id?: string | undefined
64082
+ /** Method by which the affected lock device was locked. When the method is `keycode`, the `access_code_id` indicates the access code that was used, if reported by the device. */
64083
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
64084
+ }
64085
+ | {
64086
+ /** ID of the event. */
64087
+ event_id: string
64088
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64089
+ workspace_id: string
64090
+ /** Date and time at which the event was created. */
64091
+ created_at: string
64092
+ /** Date and time at which the event occurred. */
64093
+ occurred_at: string
64094
+ /** ID of the affected device. */
64095
+ device_id: string
64096
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64097
+ connected_account_id: string
64098
+ /** Custom metadata of the device, present when device_id is provided. */
64099
+ device_custom_metadata?:
64100
+ | {
64101
+ [x: string]: string | boolean
64102
+ }
64103
+ | undefined
64104
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64105
+ connected_account_custom_metadata?:
64106
+ | {
64107
+ [x: string]: string | boolean
64108
+ }
64109
+ | undefined
64110
+ event_type: 'lock.unlocked'
64111
+ /** ID of the access code that was used to unlock the affected device. */
64112
+ access_code_id?: string | undefined
64113
+ /** ID of the action attempt associated with the unlock action. */
64114
+ action_attempt_id?: string | undefined
64115
+ /** Method by which the affected lock device was unlocked. When the method is `keycode`, the `access_code_id` indicates the [access code](https://docs.seam.co/latest/capability-guides/smart-locks/access-codes) that was used, if reported by the device. */
64116
+ method: 'keycode' | 'manual' | 'automatic' | 'unknown' | 'seamapi'
64117
+ }
64118
+ | {
64119
+ /** ID of the event. */
64120
+ event_id: string
64121
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64122
+ workspace_id: string
64123
+ /** Date and time at which the event was created. */
64124
+ created_at: string
64125
+ /** Date and time at which the event occurred. */
64126
+ occurred_at: string
64127
+ /** ID of the affected device. */
64128
+ device_id: string
64129
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64130
+ connected_account_id: string
64131
+ /** Custom metadata of the device, present when device_id is provided. */
64132
+ device_custom_metadata?:
64133
+ | {
64134
+ [x: string]: string | boolean
64135
+ }
64136
+ | undefined
64137
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64138
+ connected_account_custom_metadata?:
64139
+ | {
64140
+ [x: string]: string | boolean
64141
+ }
64142
+ | undefined
64143
+ event_type: 'lock.access_denied'
64144
+ /** ID of the access code that was used in the unlock attempts. */
64145
+ access_code_id?: string | undefined
64146
+ }
64147
+ | {
64148
+ /** ID of the event. */
64149
+ event_id: string
64150
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64151
+ workspace_id: string
64152
+ /** Date and time at which the event was created. */
64153
+ created_at: string
64154
+ /** Date and time at which the event occurred. */
64155
+ occurred_at: string
64156
+ /** ID of the affected device. */
64157
+ device_id: string
64158
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64159
+ connected_account_id: string
64160
+ /** Custom metadata of the device, present when device_id is provided. */
64161
+ device_custom_metadata?:
64162
+ | {
64163
+ [x: string]: string | boolean
64164
+ }
64165
+ | undefined
64166
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64167
+ connected_account_custom_metadata?:
64168
+ | {
64169
+ [x: string]: string | boolean
64170
+ }
64171
+ | undefined
64172
+ event_type: 'thermostat.climate_preset_activated'
64173
+ /** ID of the thermostat schedule that prompted the affected climate preset to be activated. */
64174
+ thermostat_schedule_id: string | null
64175
+ /** Key of the climate preset that was activated. */
64176
+ climate_preset_key: string
64177
+ /** Indicates whether the climate preset that was activated is the fallback climate preset for the thermostat. */
64178
+ is_fallback_climate_preset: boolean
64179
+ }
64180
+ | {
64181
+ /** ID of the event. */
64182
+ event_id: string
64183
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64184
+ workspace_id: string
64185
+ /** Date and time at which the event was created. */
64186
+ created_at: string
64187
+ /** Date and time at which the event occurred. */
64188
+ occurred_at: string
64189
+ /** ID of the affected device. */
64190
+ device_id: string
64191
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64192
+ connected_account_id: string
64193
+ /** Custom metadata of the device, present when device_id is provided. */
64194
+ device_custom_metadata?:
64195
+ | {
64196
+ [x: string]: string | boolean
64197
+ }
64198
+ | undefined
64199
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64200
+ connected_account_custom_metadata?:
64201
+ | {
64202
+ [x: string]: string | boolean
64203
+ }
64204
+ | undefined
64205
+ event_type: 'thermostat.manually_adjusted'
64206
+ /** 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. */
64207
+ method: 'seam' | 'external'
64208
+ /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
64209
+ fan_mode_setting?:
64210
+ | (('auto' | 'on' | 'circulate') | undefined)
64211
+ | undefined
64212
+ /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
64213
+ hvac_mode_setting?:
64214
+ | (('off' | 'heat' | 'cool' | 'heat_cool' | 'eco') | undefined)
64215
+ | undefined
64216
+ /** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
64217
+ cooling_set_point_celsius?: (number | undefined) | undefined
64218
+ /** Temperature to which the thermostat should heat (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
64219
+ heating_set_point_celsius?: (number | undefined) | undefined
64220
+ /** Temperature to which the thermostat should cool (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
64221
+ cooling_set_point_fahrenheit?: (number | undefined) | undefined
64222
+ /** Temperature to which the thermostat should heat (in °F). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
64223
+ heating_set_point_fahrenheit?: (number | undefined) | undefined
64224
+ }
64225
+ | {
64226
+ /** ID of the event. */
64227
+ event_id: string
64228
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64229
+ workspace_id: string
64230
+ /** Date and time at which the event was created. */
64231
+ created_at: string
64232
+ /** Date and time at which the event occurred. */
64233
+ occurred_at: string
64234
+ /** ID of the affected device. */
64235
+ device_id: string
64236
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64237
+ connected_account_id: string
64238
+ /** Custom metadata of the device, present when device_id is provided. */
64239
+ device_custom_metadata?:
64240
+ | {
64241
+ [x: string]: string | boolean
64242
+ }
64243
+ | undefined
64244
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64245
+ connected_account_custom_metadata?:
64246
+ | {
64247
+ [x: string]: string | boolean
64248
+ }
64249
+ | undefined
64250
+ event_type: 'thermostat.temperature_threshold_exceeded'
64251
+ /** Temperature, in °C, reported by the affected thermostat. */
64252
+ temperature_celsius: number
64253
+ /** Temperature, in °F, reported by the affected thermostat. */
64254
+ temperature_fahrenheit: number
64255
+ /** Upper temperature limit, in °C, defined by the set threshold. */
64256
+ upper_limit_celsius: number | null
64257
+ /** Upper temperature limit, in °F, defined by the set threshold. */
64258
+ upper_limit_fahrenheit: number | null
64259
+ /** Lower temperature limit, in °C, defined by the set threshold. */
64260
+ lower_limit_celsius: number | null
64261
+ /** Lower temperature limit, in °F, defined by the set threshold. */
64262
+ lower_limit_fahrenheit: number | null
64263
+ }
64264
+ | {
64265
+ /** ID of the event. */
64266
+ event_id: string
64267
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64268
+ workspace_id: string
64269
+ /** Date and time at which the event was created. */
64270
+ created_at: string
64271
+ /** Date and time at which the event occurred. */
64272
+ occurred_at: string
64273
+ /** ID of the affected device. */
64274
+ device_id: string
64275
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64276
+ connected_account_id: string
64277
+ /** Custom metadata of the device, present when device_id is provided. */
64278
+ device_custom_metadata?:
64279
+ | {
64280
+ [x: string]: string | boolean
64281
+ }
64282
+ | undefined
64283
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64284
+ connected_account_custom_metadata?:
64285
+ | {
64286
+ [x: string]: string | boolean
64287
+ }
64288
+ | undefined
64289
+ event_type: 'thermostat.temperature_threshold_no_longer_exceeded'
64290
+ /** Temperature, in °C, reported by the affected thermostat. */
64291
+ temperature_celsius: number
64292
+ /** Temperature, in °F, reported by the affected thermostat. */
64293
+ temperature_fahrenheit: number
64294
+ /** Upper temperature limit, in °C, defined by the set threshold. */
64295
+ upper_limit_celsius: number | null
64296
+ /** Upper temperature limit, in °F, defined by the set threshold. */
64297
+ upper_limit_fahrenheit: number | null
64298
+ /** Lower temperature limit, in °C, defined by the set threshold. */
64299
+ lower_limit_celsius: number | null
64300
+ /** Lower temperature limit, in °F, defined by the set threshold. */
64301
+ lower_limit_fahrenheit: number | null
64302
+ }
64303
+ | {
64304
+ /** ID of the event. */
64305
+ event_id: string
64306
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64307
+ workspace_id: string
64308
+ /** Date and time at which the event was created. */
64309
+ created_at: string
64310
+ /** Date and time at which the event occurred. */
64311
+ occurred_at: string
64312
+ /** ID of the affected device. */
64313
+ device_id: string
64314
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64315
+ connected_account_id: string
64316
+ /** Custom metadata of the device, present when device_id is provided. */
64317
+ device_custom_metadata?:
64318
+ | {
64319
+ [x: string]: string | boolean
64320
+ }
64321
+ | undefined
64322
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64323
+ connected_account_custom_metadata?:
64324
+ | {
64325
+ [x: string]: string | boolean
64326
+ }
64327
+ | undefined
64328
+ event_type: 'thermostat.temperature_reached_set_point'
64329
+ /** Temperature, in °C, reported by the affected thermostat. */
64330
+ temperature_celsius: number
64331
+ /** Temperature, in °F, reported by the affected thermostat. */
64332
+ temperature_fahrenheit: number
64333
+ /** Desired temperature, in °C, defined by the affected thermostat's cooling or heating set point. */
64334
+ desired_temperature_celsius?: number | undefined
64335
+ /** Desired temperature, in °F, defined by the affected thermostat's cooling or heating set point. */
64336
+ desired_temperature_fahrenheit?: number | undefined
64337
+ }
64338
+ | {
64339
+ /** ID of the event. */
64340
+ event_id: string
64341
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64342
+ workspace_id: string
64343
+ /** Date and time at which the event was created. */
64344
+ created_at: string
64345
+ /** Date and time at which the event occurred. */
64346
+ occurred_at: string
64347
+ /** ID of the affected device. */
64348
+ device_id: string
64349
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64350
+ connected_account_id: string
64351
+ /** Custom metadata of the device, present when device_id is provided. */
64352
+ device_custom_metadata?:
64353
+ | {
64354
+ [x: string]: string | boolean
64355
+ }
64356
+ | undefined
64357
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64358
+ connected_account_custom_metadata?:
64359
+ | {
64360
+ [x: string]: string | boolean
64361
+ }
64362
+ | undefined
64363
+ event_type: 'thermostat.temperature_changed'
64364
+ /** Temperature, in °C, reported by the affected thermostat. */
64365
+ temperature_celsius: number
64366
+ /** Temperature, in °F, reported by the affected thermostat. */
64367
+ temperature_fahrenheit: number
64368
+ }
64369
+ | {
64370
+ /** ID of the event. */
64371
+ event_id: string
64372
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64373
+ workspace_id: string
64374
+ /** Date and time at which the event was created. */
64375
+ created_at: string
64376
+ /** Date and time at which the event occurred. */
64377
+ occurred_at: string
64378
+ /** ID of the affected device. */
64379
+ device_id: string
64380
+ /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
64381
+ connected_account_id: string
64382
+ /** Custom metadata of the device, present when device_id is provided. */
64383
+ device_custom_metadata?:
64384
+ | {
64385
+ [x: string]: string | boolean
64386
+ }
64387
+ | undefined
64388
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
64389
+ connected_account_custom_metadata?:
64390
+ | {
64391
+ [x: string]: string | boolean
64392
+ }
64393
+ | undefined
64394
+ event_type: 'device.name_changed'
64395
+ /** The new name of the affected device. */
64396
+ device_name: string
64397
+ }
64398
+ | {
64399
+ /** ID of the event. */
64400
+ event_id: string
64401
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64402
+ workspace_id: string
64403
+ /** Date and time at which the event was created. */
64404
+ created_at: string
64405
+ /** Date and time at which the event occurred. */
64406
+ occurred_at: string
64407
+ /** ID of the affected enrollment automation. */
64408
+ enrollment_automation_id: string
64409
+ event_type: 'enrollment_automation.deleted'
64410
+ }
64411
+ | {
64412
+ /** ID of the event. */
64413
+ event_id: string
64414
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the event. */
64415
+ workspace_id: string
64416
+ /** Date and time at which the event was created. */
64417
+ created_at: string
64418
+ /** Date and time at which the event occurred. */
64419
+ occurred_at: string
64420
+ /** ID of the affected phone device. */
64421
+ device_id: string
64422
+ /** Custom metadata of the device; present when device_id is provided. */
64423
+ device_custom_metadata?:
64424
+ | {
64425
+ [x: string]: string | boolean
64426
+ }
64427
+ | undefined
64428
+ event_type: 'phone.deactivated'
64429
+ }
64430
+ )[]
64431
+ }
64432
+ }
64433
+ '/seam/customer/v1/portals/get': {
64434
+ route: '/seam/customer/v1/portals/get'
64435
+ method: 'GET' | 'POST'
64436
+ queryParams: {}
64437
+ jsonBody: {}
64438
+ commonParams: {
64439
+ /** Customer portal ID. */
64440
+ customer_portal_id: string
64441
+ }
64442
+ formData: {}
64443
+ jsonResponse: {
64444
+ customer_portal: {
64445
+ features?:
64446
+ | {
64447
+ connect?:
64448
+ | {
64449
+ exclude?: boolean | undefined
64450
+ }
64451
+ | undefined
64452
+ manage_devices?:
64453
+ | {
64454
+ exclude?: boolean | undefined
64455
+ }
64456
+ | undefined
64457
+ organize?:
64458
+ | {
64459
+ exclude?: boolean | undefined
64460
+ }
64461
+ | undefined
64462
+ configure?:
64463
+ | {
64464
+ exclude?: boolean | undefined
64465
+ allow_access_automation_rule_customization?:
64466
+ | boolean
64467
+ | undefined
64468
+ allow_instant_key_customization?: boolean | undefined
64469
+ }
64470
+ | undefined
64471
+ }
64472
+ | undefined
64473
+ is_embedded?: boolean | undefined
64474
+ /** Business vertical of the customer portal. */
64475
+ business_vertical?:
64476
+ | (
64477
+ | 'short_term_rental'
64478
+ | 'hospitality'
64479
+ | 'multi_family'
64480
+ | 'gym_management'
64481
+ | 'property_tours'
64482
+ )
64483
+ | undefined
64484
+ }
64485
+ }
64486
+ }
64487
+ '/seam/customer/v1/settings/get': {
64488
+ route: '/seam/customer/v1/settings/get'
64489
+ method: 'GET' | 'POST'
64490
+ queryParams: {}
64491
+ jsonBody: {}
64492
+ commonParams: {}
64493
+ formData: {}
64494
+ jsonResponse: {
64495
+ /** Business vertical of the customer portal. */
64496
+ business_vertical?:
64497
+ | (
64498
+ | 'short_term_rental'
64499
+ | 'hospitality'
64500
+ | 'multi_family'
64501
+ | 'gym_management'
64502
+ | 'property_tours'
64503
+ )
64504
+ | undefined
64505
+ }
64506
+ }
64507
+ '/seam/customer/v1/settings/update': {
64508
+ route: '/seam/customer/v1/settings/update'
64509
+ method: 'PATCH' | 'POST'
64510
+ queryParams: {}
64511
+ jsonBody: {
64512
+ /** Business vertical to set on the workspace. */
64513
+ business_vertical?:
64514
+ | (
64515
+ | 'short_term_rental'
64516
+ | 'hospitality'
64517
+ | 'multi_family'
64518
+ | 'gym_management'
64519
+ | 'property_tours'
64520
+ )
64521
+ | undefined
64522
+ }
64523
+ commonParams: {}
64524
+ formData: {}
64525
+ jsonResponse: {}
64526
+ }
64527
+ '/seam/instant_key/v1/client_sessions/exchange_short_code': {
64528
+ route: '/seam/instant_key/v1/client_sessions/exchange_short_code'
64529
+ method: 'POST'
64530
+ queryParams: {}
64531
+ jsonBody: {
64532
+ /** Short code that you want to exchange for a client session token. */
64533
+ short_code: string
64534
+ }
64535
+ commonParams: {}
64536
+ formData: {}
64537
+ jsonResponse: {
64538
+ /** Represents a [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). If you want to restrict your users' access to their own devices, use client sessions.
64539
+
64540
+ You create each client session with a custom `user_identifier_key`. Normally, the `user_identifier_key` is a user ID that your application provides.
64541
+
64542
+ When calling the Seam API from your backend using an API key, you can pass the `user_identifier_key` as a parameter to limit results to the associated client session. For example, `/devices/list?user_identifier_key=123` only returns devices associated with the client session created with the `user_identifier_key` `123`.
64543
+
64544
+ A client session has a token that you can use with the Seam JavaScript SDK to make requests from the client (browser) directly to the Seam API. The token restricts the user's access to only the devices that they own.
64545
+
64546
+ See also [Get Started with React](https://docs.seam.co/latest/ui-components/overview/getting-started-with-seam-components/get-started-with-react-components-and-client-session-tokens). */
64547
+ client_session: {
64548
+ /** ID of the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64549
+ client_session_id: string
64550
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64551
+ workspace_id: string
64552
+ /** Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) was created. */
64553
+ created_at: string
64554
+ /** Date and time at which the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens) expires. */
64555
+ expires_at: string
64556
+ /** Client session token associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64557
+ token: string
64558
+ /** Your user ID for the user associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64559
+ user_identifier_key: string | null
64560
+ /** Number of devices associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64561
+ device_count: number
64562
+ /** Customer ID associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64563
+ customer_id?: string | undefined
64564
+ /** IDs of the [connected accounts](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64565
+ connected_account_ids: string[]
64566
+ /** IDs of the [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the [client session](https://docs.seam.co/latest/core-concepts/authentication/client-session-tokens). */
64567
+ connect_webview_ids: string[]
64568
+ /** IDs of the [user identities](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session.
64569
+ * @deprecated Use `user_identity_id` instead.*/
64570
+ user_identity_ids: string[]
64571
+ /** ID of the [user identity](https://docs.seam.co/latest/capability-guides/mobile-access/managing-mobile-app-user-accounts-with-user-identities#what-is-a-user-identity) associated with the client session. */
64572
+ user_identity_id?: string | undefined
64573
+ }
64574
+ }
64575
+ }
64576
+ '/seam/mobile_sdk/v1/acs/credentials/list': {
64577
+ route: '/seam/mobile_sdk/v1/acs/credentials/list'
64578
+ method: 'GET' | 'POST'
64579
+ queryParams: {}
64580
+ jsonBody: {}
64581
+ commonParams: {}
64582
+ formData: {}
64583
+ jsonResponse: {
64584
+ acs_credentials: {
64585
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64586
+ acs_credential_id: string
64587
+ /** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
64588
+ acs_user_id?: string | undefined
64589
+ /** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
64590
+ user_identity_id?: string | undefined
64591
+ /** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
64592
+ connected_account_id: string
64593
+ acs_credential_pool_id?: string | undefined
64594
+ /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64595
+ acs_system_id: string
64596
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64597
+ parent_acs_credential_id?: string | undefined
64598
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
64599
+ display_name: string
64600
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64601
+ code?: (string | undefined) | null
64602
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
64603
+ is_one_time_use?: boolean | undefined
64604
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64605
+ card_number?: (string | undefined) | null
64606
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
64607
+ is_issued?: boolean | undefined
64608
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
64609
+ issued_at?: (string | undefined) | null
64610
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`. */
64611
+ access_method: 'code' | 'card' | 'mobile_key'
64612
+ /** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
64613
+ external_type?:
64614
+ | (
64615
+ | 'pti_card'
64616
+ | 'brivo_credential'
64617
+ | 'hid_credential'
64618
+ | 'visionline_card'
64619
+ | 'salto_ks_credential'
64620
+ | 'assa_abloy_vostio_key'
64621
+ | 'salto_space_key'
64622
+ | 'latch_access'
64623
+ )
64624
+ | undefined
64625
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
64626
+ external_type_display_name?: string | undefined
64627
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
64628
+ created_at: string
64629
+ /** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64630
+ workspace_id: string
64631
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
64632
+ starts_at?: string | undefined
64633
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
64634
+ ends_at?: string | undefined
64635
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64636
+ errors: {
64637
+ error_code: string
64638
+ message: string
64639
+ }[]
64640
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64641
+ warnings: (
64642
+ | {
64643
+ /** Date and time at which Seam created the warning. */
64644
+ created_at: string
64645
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64646
+ message: string
64647
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64648
+ warning_code: 'waiting_to_be_issued'
64649
+ }
64650
+ | {
64651
+ /** Date and time at which Seam created the warning. */
64652
+ created_at: string
64653
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64654
+ message: string
64655
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64656
+ warning_code: 'schedule_externally_modified'
64657
+ }
64658
+ | {
64659
+ /** Date and time at which Seam created the warning. */
64660
+ created_at: string
64661
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64662
+ message: string
64663
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64664
+ warning_code: 'schedule_modified'
64665
+ }
64666
+ | {
64667
+ /** Date and time at which Seam created the warning. */
64668
+ created_at: string
64669
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64670
+ message: string
64671
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64672
+ warning_code: 'being_deleted'
64673
+ }
64674
+ | {
64675
+ /** Date and time at which Seam created the warning. */
64676
+ created_at: string
64677
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64678
+ message: string
64679
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64680
+ warning_code: 'unknown_issue_with_acs_credential'
64681
+ }
64682
+ | {
64683
+ /** Date and time at which Seam created the warning. */
64684
+ created_at: string
64685
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
64686
+ message: string
64687
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
64688
+ warning_code: 'needs_to_be_reissued'
64689
+ }
64690
+ )[]
64691
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
64692
+ is_multi_phone_sync_credential?: boolean | undefined
64693
+ /** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
64694
+ is_latest_desired_state_synced_with_provider?:
64695
+ | (boolean | null)
64696
+ | undefined
64697
+ /** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
64698
+ latest_desired_state_synced_with_provider_at?:
64699
+ | (string | null)
64700
+ | undefined
64701
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64702
+ visionline_metadata?:
64703
+ | {
64704
+ /** Card function type in the Visionline access system. */
64705
+ card_function_type: 'guest' | 'staff'
64706
+ /** IDs of the credentials to which you want to join. */
64707
+ joiner_acs_credential_ids?: string[] | undefined
64708
+ /** Guest entrance IDs in the Visionline access system. */
64709
+ guest_acs_entrance_ids?: string[] | undefined
64710
+ /** Common entrance IDs in the Visionline access system. */
64711
+ common_acs_entrance_ids?: string[] | undefined
64712
+ /** Indicates whether the credential is valid. */
64713
+ is_valid?: boolean | undefined
64714
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
64715
+ auto_join?: boolean | undefined
64716
+ /** ID of the card in the Visionline access system. */
64717
+ card_id?: string | undefined
64718
+ /** ID of the credential in the Visionline access system. */
64719
+ credential_id?: string | undefined
64720
+ }
64721
+ | undefined
64722
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
64723
+ assa_abloy_vostio_metadata?:
64724
+ | {
64725
+ /** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
64726
+ auto_join?: boolean | undefined
64727
+ /** IDs of the guest entrances to override in the Vostio access system. */
64728
+ override_guest_acs_entrance_ids?: string[] | undefined
64729
+ /** Key ID in the Vostio access system. */
64730
+ key_id?: string | undefined
64731
+ /** Key issuing request ID in the Vostio access system. */
64732
+ key_issuing_request_id?: string | undefined
64733
+ /** Names of the doors to which to grant access in the Vostio access system. */
64734
+ door_names?: string[] | undefined
64735
+ /** Endpoint ID in the Vostio access system. */
64736
+ endpoint_id?: string | undefined
64737
+ }
64738
+ | undefined
64739
+ is_managed: true
64740
+ }[]
64741
+ }
64742
+ }
64743
+ '/seam/mobile_sdk/v1/phone_sessions/get_or_create': {
64744
+ route: '/seam/mobile_sdk/v1/phone_sessions/get_or_create'
64745
+ method: 'POST'
64746
+ queryParams: {}
64747
+ jsonBody: {
64748
+ /** ID of the custom SDK installation that you want to use for the new session. */
64749
+ custom_sdk_installation_id: string
64750
+ /** Phone operating system that you want to use for the new session. */
64751
+ phone_os: 'ios' | 'android'
64752
+ /** Phone device metadata that you want to use for the new session. */
64753
+ phone_device_metadata?:
64754
+ | {
64755
+ os_version?: string | undefined
64756
+ manufacturer?: string | undefined
62273
64757
  model?: string | undefined
62274
64758
  }
62275
64759
  | undefined
@@ -63998,6 +66482,14 @@ export type Routes = {
63998
66482
  | undefined
63999
66483
  )
64000
66484
  | undefined
66485
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
66486
+ thermostat_daily_program_period_precision_minutes?:
66487
+ | (number | undefined)
66488
+ | undefined
66489
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
66490
+ max_thermostat_daily_program_periods_per_day?:
66491
+ | (number | undefined)
66492
+ | undefined
64001
66493
  })
64002
66494
  /** Location information for the device. */
64003
66495
  location: {
@@ -64342,6 +66834,7 @@ export type Routes = {
64342
66834
  can_simulate_connection?: boolean | undefined
64343
66835
  can_simulate_disconnection?: boolean | undefined
64344
66836
  can_unlock_with_code?: boolean | undefined
66837
+ can_run_thermostat_programs?: boolean | undefined
64345
66838
  }[]
64346
66839
  | undefined
64347
66840
  acs_entrances?:
@@ -70517,6 +73010,14 @@ export type Routes = {
70517
73010
  | undefined
70518
73011
  )
70519
73012
  | undefined
73013
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
73014
+ thermostat_daily_program_period_precision_minutes?:
73015
+ | (number | undefined)
73016
+ | undefined
73017
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
73018
+ max_thermostat_daily_program_periods_per_day?:
73019
+ | (number | undefined)
73020
+ | undefined
70520
73021
  })
70521
73022
  /** Location information for the device. */
70522
73023
  location: {
@@ -70861,6 +73362,7 @@ export type Routes = {
70861
73362
  can_simulate_connection?: boolean | undefined
70862
73363
  can_simulate_disconnection?: boolean | undefined
70863
73364
  can_unlock_with_code?: boolean | undefined
73365
+ can_run_thermostat_programs?: boolean | undefined
70864
73366
  }
70865
73367
  }
70866
73368
  }
@@ -73835,6 +76337,7 @@ export type Routes = {
73835
76337
  | 'can_simulate_connection'
73836
76338
  | 'can_simulate_disconnection'
73837
76339
  | 'can_unlock_with_code'
76340
+ | 'can_run_thermostat_programs'
73838
76341
  )[]
73839
76342
  | undefined
73840
76343
  /** */
@@ -73852,6 +76355,7 @@ export type Routes = {
73852
76355
  | 'can_simulate_connection'
73853
76356
  | 'can_simulate_disconnection'
73854
76357
  | 'can_unlock_with_code'
76358
+ | 'can_run_thermostat_programs'
73855
76359
  )[]
73856
76360
  | undefined
73857
76361
  /**
@@ -75017,6 +77521,14 @@ export type Routes = {
75017
77521
  | undefined
75018
77522
  )
75019
77523
  | undefined
77524
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
77525
+ thermostat_daily_program_period_precision_minutes?:
77526
+ | (number | undefined)
77527
+ | undefined
77528
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
77529
+ max_thermostat_daily_program_periods_per_day?:
77530
+ | (number | undefined)
77531
+ | undefined
75020
77532
  })
75021
77533
  /** Location information for the device. */
75022
77534
  location: {
@@ -75361,6 +77873,7 @@ export type Routes = {
75361
77873
  can_simulate_connection?: boolean | undefined
75362
77874
  can_simulate_disconnection?: boolean | undefined
75363
77875
  can_unlock_with_code?: boolean | undefined
77876
+ can_run_thermostat_programs?: boolean | undefined
75364
77877
  }[]
75365
77878
  devices: {
75366
77879
  /** ID of the device. */
@@ -76513,6 +79026,14 @@ export type Routes = {
76513
79026
  | undefined
76514
79027
  )
76515
79028
  | undefined
79029
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
79030
+ thermostat_daily_program_period_precision_minutes?:
79031
+ | (number | undefined)
79032
+ | undefined
79033
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
79034
+ max_thermostat_daily_program_periods_per_day?:
79035
+ | (number | undefined)
79036
+ | undefined
76516
79037
  })
76517
79038
  /** Location information for the device. */
76518
79039
  location: {
@@ -76857,6 +79378,7 @@ export type Routes = {
76857
79378
  can_simulate_connection?: boolean | undefined
76858
79379
  can_simulate_disconnection?: boolean | undefined
76859
79380
  can_unlock_with_code?: boolean | undefined
79381
+ can_run_thermostat_programs?: boolean | undefined
76860
79382
  }[]
76861
79383
  }
76862
79384
  }
@@ -85258,6 +87780,14 @@ export type Routes = {
85258
87780
  | undefined
85259
87781
  )
85260
87782
  | undefined
87783
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
87784
+ thermostat_daily_program_period_precision_minutes?:
87785
+ | (number | undefined)
87786
+ | undefined
87787
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
87788
+ max_thermostat_daily_program_periods_per_day?:
87789
+ | (number | undefined)
87790
+ | undefined
85261
87791
  })
85262
87792
  /** Location information for the device. */
85263
87793
  location: {
@@ -85602,6 +88132,7 @@ export type Routes = {
85602
88132
  can_simulate_connection?: boolean | undefined
85603
88133
  can_simulate_disconnection?: boolean | undefined
85604
88134
  can_unlock_with_code?: boolean | undefined
88135
+ can_run_thermostat_programs?: boolean | undefined
85605
88136
  }[]
85606
88137
  /**
85607
88138
  * @deprecated Use devices.*/
@@ -86756,6 +89287,14 @@ export type Routes = {
86756
89287
  | undefined
86757
89288
  )
86758
89289
  | undefined
89290
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
89291
+ thermostat_daily_program_period_precision_minutes?:
89292
+ | (number | undefined)
89293
+ | undefined
89294
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
89295
+ max_thermostat_daily_program_periods_per_day?:
89296
+ | (number | undefined)
89297
+ | undefined
86759
89298
  })
86760
89299
  /** Location information for the device. */
86761
89300
  location: {
@@ -87100,6 +89639,7 @@ export type Routes = {
87100
89639
  can_simulate_connection?: boolean | undefined
87101
89640
  can_simulate_disconnection?: boolean | undefined
87102
89641
  can_unlock_with_code?: boolean | undefined
89642
+ can_run_thermostat_programs?: boolean | undefined
87103
89643
  }[]
87104
89644
  }
87105
89645
  }
@@ -89033,6 +91573,14 @@ export type Routes = {
89033
91573
  | undefined
89034
91574
  )
89035
91575
  | undefined
91576
+ /** Precision of the thermostat's period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour. */
91577
+ thermostat_daily_program_period_precision_minutes?:
91578
+ | (number | undefined)
91579
+ | undefined
91580
+ /** Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4. */
91581
+ max_thermostat_daily_program_periods_per_day?:
91582
+ | (number | undefined)
91583
+ | undefined
89036
91584
  })
89037
91585
  /** Location information for the device. */
89038
91586
  location: {
@@ -89377,6 +91925,7 @@ export type Routes = {
89377
91925
  can_simulate_connection?: boolean | undefined
89378
91926
  can_simulate_disconnection?: boolean | undefined
89379
91927
  can_unlock_with_code?: boolean | undefined
91928
+ can_run_thermostat_programs?: boolean | undefined
89380
91929
  }[]
89381
91930
  | undefined
89382
91931
  acs_entrances?:
@@ -92237,6 +94786,7 @@ export type Routes = {
92237
94786
  can_simulate_connection?: boolean | undefined
92238
94787
  can_simulate_disconnection?: boolean | undefined
92239
94788
  can_unlock_with_code?: boolean | undefined
94789
+ can_run_thermostat_programs?: boolean | undefined
92240
94790
  }[]
92241
94791
  | undefined
92242
94792
  connect_webviews?: