@seamapi/types 1.437.1 → 1.438.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (35) hide show
  1. package/dist/connect.cjs +913 -3
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +1333 -0
  4. package/lib/seam/connect/models/events/access-codes.d.ts +204 -0
  5. package/lib/seam/connect/models/events/access-codes.js +7 -0
  6. package/lib/seam/connect/models/events/access-codes.js.map +1 -1
  7. package/lib/seam/connect/models/events/connect-webviews.d.ts +6 -0
  8. package/lib/seam/connect/models/events/connect-webviews.js +5 -0
  9. package/lib/seam/connect/models/events/connect-webviews.js.map +1 -1
  10. package/lib/seam/connect/models/events/connected-accounts.d.ts +42 -0
  11. package/lib/seam/connect/models/events/connected-accounts.js +4 -0
  12. package/lib/seam/connect/models/events/connected-accounts.js.map +1 -1
  13. package/lib/seam/connect/models/events/devices.d.ts +396 -0
  14. package/lib/seam/connect/models/events/devices.js +7 -0
  15. package/lib/seam/connect/models/events/devices.js.map +1 -1
  16. package/lib/seam/connect/models/events/phones.d.ts +6 -0
  17. package/lib/seam/connect/models/events/phones.js +4 -0
  18. package/lib/seam/connect/models/events/phones.js.map +1 -1
  19. package/lib/seam/connect/models/events/seam-event.d.ts +327 -0
  20. package/lib/seam/connect/models/user-identities/user-identity.d.ts +3 -0
  21. package/lib/seam/connect/models/user-identities/user-identity.js +3 -0
  22. package/lib/seam/connect/models/user-identities/user-identity.js.map +1 -1
  23. package/lib/seam/connect/openapi.d.ts +535 -0
  24. package/lib/seam/connect/openapi.js +885 -0
  25. package/lib/seam/connect/openapi.js.map +1 -1
  26. package/lib/seam/connect/route-types.d.ts +468 -0
  27. package/package.json +1 -1
  28. package/src/lib/seam/connect/models/events/access-codes.ts +11 -0
  29. package/src/lib/seam/connect/models/events/connect-webviews.ts +8 -0
  30. package/src/lib/seam/connect/models/events/connected-accounts.ts +6 -0
  31. package/src/lib/seam/connect/models/events/devices.ts +11 -0
  32. package/src/lib/seam/connect/models/events/phones.ts +6 -0
  33. package/src/lib/seam/connect/models/user-identities/user-identity.ts +5 -0
  34. package/src/lib/seam/connect/openapi.ts +1001 -0
  35. package/src/lib/seam/connect/route-types.ts +904 -0
@@ -16481,6 +16481,8 @@ export interface Routes {
16481
16481
  access_method_id?: string | undefined;
16482
16482
  /** ID of the connected account for which you want to retrieve all entrances. */
16483
16483
  connected_account_id?: string | undefined;
16484
+ /** IDs of the entrances for which you want to retrieve all entrances. */
16485
+ acs_entrance_ids?: string[] | undefined;
16484
16486
  };
16485
16487
  formData: {};
16486
16488
  jsonResponse: {
@@ -25075,6 +25077,18 @@ export interface Routes {
25075
25077
  formData: {};
25076
25078
  jsonResponse: {};
25077
25079
  };
25080
+ '/devices/simulate/connect_to_hub': {
25081
+ route: '/devices/simulate/connect_to_hub';
25082
+ method: 'POST';
25083
+ queryParams: {};
25084
+ jsonBody: {
25085
+ /** ID of the device whose hub you want to reconnect. */
25086
+ device_id: string;
25087
+ };
25088
+ commonParams: {};
25089
+ formData: {};
25090
+ jsonResponse: {};
25091
+ };
25078
25092
  '/devices/simulate/disconnect': {
25079
25093
  route: '/devices/simulate/disconnect';
25080
25094
  method: 'POST';
@@ -25087,6 +25101,18 @@ export interface Routes {
25087
25101
  formData: {};
25088
25102
  jsonResponse: {};
25089
25103
  };
25104
+ '/devices/simulate/disconnect_from_hub': {
25105
+ route: '/devices/simulate/disconnect_from_hub';
25106
+ method: 'POST';
25107
+ queryParams: {};
25108
+ jsonBody: {
25109
+ /** ID of the device whose hub you want to disconnect. */
25110
+ device_id: string;
25111
+ };
25112
+ commonParams: {};
25113
+ formData: {};
25114
+ jsonResponse: {};
25115
+ };
25090
25116
  '/devices/simulate/remove': {
25091
25117
  route: '/devices/simulate/remove';
25092
25118
  method: 'POST';
@@ -26007,6 +26033,10 @@ export interface Routes {
26007
26033
  device_id: string;
26008
26034
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26009
26035
  connected_account_id: string;
26036
+ /** Custom metadata of the device, present when device_id is provided. */
26037
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26038
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26039
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26010
26040
  event_type: 'access_code.created';
26011
26041
  } | {
26012
26042
  /** ID of the event. */
@@ -26023,6 +26053,10 @@ export interface Routes {
26023
26053
  device_id: string;
26024
26054
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26025
26055
  connected_account_id: string;
26056
+ /** Custom metadata of the device, present when device_id is provided. */
26057
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26058
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26059
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26026
26060
  event_type: 'access_code.changed';
26027
26061
  } | {
26028
26062
  /** ID of the event. */
@@ -26039,6 +26073,10 @@ export interface Routes {
26039
26073
  device_id: string;
26040
26074
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26041
26075
  connected_account_id: string;
26076
+ /** Custom metadata of the device, present when device_id is provided. */
26077
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26078
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26079
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26042
26080
  event_type: 'access_code.scheduled_on_device';
26043
26081
  /** Code for the affected access code. */
26044
26082
  code: string;
@@ -26057,6 +26095,10 @@ export interface Routes {
26057
26095
  device_id: string;
26058
26096
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26059
26097
  connected_account_id: string;
26098
+ /** Custom metadata of the device, present when device_id is provided. */
26099
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26100
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26101
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26060
26102
  event_type: 'access_code.set_on_device';
26061
26103
  /** Code for the affected access code. */
26062
26104
  code: string;
@@ -26075,6 +26117,10 @@ export interface Routes {
26075
26117
  device_id: string;
26076
26118
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26077
26119
  connected_account_id: string;
26120
+ /** Custom metadata of the device, present when device_id is provided. */
26121
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26122
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26123
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26078
26124
  event_type: 'access_code.removed_from_device';
26079
26125
  } | {
26080
26126
  /** ID of the event. */
@@ -26091,6 +26137,10 @@ export interface Routes {
26091
26137
  device_id: string;
26092
26138
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26093
26139
  connected_account_id: string;
26140
+ /** Custom metadata of the device, present when device_id is provided. */
26141
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26142
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26143
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26094
26144
  event_type: 'access_code.delay_in_setting_on_device';
26095
26145
  } | {
26096
26146
  /** ID of the event. */
@@ -26107,6 +26157,10 @@ export interface Routes {
26107
26157
  device_id: string;
26108
26158
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26109
26159
  connected_account_id: string;
26160
+ /** Custom metadata of the device, present when device_id is provided. */
26161
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26162
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26163
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26110
26164
  event_type: 'access_code.failed_to_set_on_device';
26111
26165
  } | {
26112
26166
  /** ID of the event. */
@@ -26123,6 +26177,10 @@ export interface Routes {
26123
26177
  device_id: string;
26124
26178
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26125
26179
  connected_account_id: string;
26180
+ /** Custom metadata of the device, present when device_id is provided. */
26181
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26182
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26183
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26126
26184
  event_type: 'access_code.deleted';
26127
26185
  /** Code for the affected access code. */
26128
26186
  code: string | null;
@@ -26141,6 +26199,10 @@ export interface Routes {
26141
26199
  device_id: string;
26142
26200
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26143
26201
  connected_account_id: string;
26202
+ /** Custom metadata of the device, present when device_id is provided. */
26203
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26204
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26205
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26144
26206
  event_type: 'access_code.delay_in_removing_from_device';
26145
26207
  } | {
26146
26208
  /** ID of the event. */
@@ -26157,6 +26219,10 @@ export interface Routes {
26157
26219
  device_id: string;
26158
26220
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26159
26221
  connected_account_id: string;
26222
+ /** Custom metadata of the device, present when device_id is provided. */
26223
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26224
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26225
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26160
26226
  event_type: 'access_code.failed_to_remove_from_device';
26161
26227
  } | {
26162
26228
  /** ID of the event. */
@@ -26173,6 +26239,10 @@ export interface Routes {
26173
26239
  device_id: string;
26174
26240
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26175
26241
  connected_account_id: string;
26242
+ /** Custom metadata of the device, present when device_id is provided. */
26243
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26244
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26245
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26176
26246
  event_type: 'access_code.modified_external_to_seam';
26177
26247
  } | {
26178
26248
  /** ID of the event. */
@@ -26189,6 +26259,10 @@ export interface Routes {
26189
26259
  device_id: string;
26190
26260
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26191
26261
  connected_account_id: string;
26262
+ /** Custom metadata of the device, present when device_id is provided. */
26263
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26264
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26265
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26192
26266
  event_type: 'access_code.deleted_external_to_seam';
26193
26267
  } | {
26194
26268
  /** ID of the event. */
@@ -26205,6 +26279,10 @@ export interface Routes {
26205
26279
  device_id: string;
26206
26280
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26207
26281
  connected_account_id: string;
26282
+ /** Custom metadata of the device, present when device_id is provided. */
26283
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26284
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26285
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26208
26286
  event_type: 'access_code.backup_access_code_pulled';
26209
26287
  backup_access_code_id: string;
26210
26288
  } | {
@@ -26222,6 +26300,10 @@ export interface Routes {
26222
26300
  device_id: string;
26223
26301
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26224
26302
  connected_account_id: string;
26303
+ /** Custom metadata of the device, present when device_id is provided. */
26304
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26305
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26306
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26225
26307
  event_type: 'access_code.unmanaged.converted_to_managed';
26226
26308
  } | {
26227
26309
  /** ID of the event. */
@@ -26238,6 +26320,10 @@ export interface Routes {
26238
26320
  device_id: string;
26239
26321
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26240
26322
  connected_account_id: string;
26323
+ /** Custom metadata of the device, present when device_id is provided. */
26324
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26325
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26326
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26241
26327
  event_type: 'access_code.unmanaged.failed_to_convert_to_managed';
26242
26328
  } | {
26243
26329
  /** ID of the event. */
@@ -26254,6 +26340,10 @@ export interface Routes {
26254
26340
  device_id: string;
26255
26341
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26256
26342
  connected_account_id: string;
26343
+ /** Custom metadata of the device, present when device_id is provided. */
26344
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26345
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26346
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26257
26347
  event_type: 'access_code.unmanaged.created';
26258
26348
  } | {
26259
26349
  /** ID of the event. */
@@ -26270,6 +26360,10 @@ export interface Routes {
26270
26360
  device_id: string;
26271
26361
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
26272
26362
  connected_account_id: string;
26363
+ /** Custom metadata of the device, present when device_id is provided. */
26364
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26365
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26366
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26273
26367
  event_type: 'access_code.unmanaged.removed';
26274
26368
  } | {
26275
26369
  /** ID of the event. */
@@ -26632,6 +26726,8 @@ export interface Routes {
26632
26726
  occurred_at: string;
26633
26727
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
26634
26728
  connected_account_id: string;
26729
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26730
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26635
26731
  event_type: 'connected_account.connected';
26636
26732
  /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
26637
26733
  connect_webview_id: string;
@@ -26646,6 +26742,8 @@ export interface Routes {
26646
26742
  occurred_at: string;
26647
26743
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
26648
26744
  connected_account_id: string;
26745
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26746
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26649
26747
  event_type: 'connected_account.created';
26650
26748
  /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
26651
26749
  connect_webview_id: string;
@@ -26660,6 +26758,8 @@ export interface Routes {
26660
26758
  occurred_at: string;
26661
26759
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
26662
26760
  connected_account_id: string;
26761
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26762
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26663
26763
  event_type: 'connected_account.successful_login';
26664
26764
  /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
26665
26765
  connect_webview_id: string;
@@ -26674,6 +26774,8 @@ export interface Routes {
26674
26774
  occurred_at: string;
26675
26775
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
26676
26776
  connected_account_id: string;
26777
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26778
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26677
26779
  event_type: 'connected_account.disconnected';
26678
26780
  } | {
26679
26781
  /** ID of the event. */
@@ -26686,6 +26788,8 @@ export interface Routes {
26686
26788
  occurred_at: string;
26687
26789
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
26688
26790
  connected_account_id: string;
26791
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26792
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26689
26793
  event_type: 'connected_account.completed_first_sync';
26690
26794
  } | {
26691
26795
  /** ID of the event. */
@@ -26698,6 +26802,8 @@ export interface Routes {
26698
26802
  occurred_at: string;
26699
26803
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
26700
26804
  connected_account_id: string;
26805
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26806
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26701
26807
  event_type: 'connected_account.deleted';
26702
26808
  } | {
26703
26809
  /** ID of the event. */
@@ -26710,6 +26816,8 @@ export interface Routes {
26710
26816
  occurred_at: string;
26711
26817
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
26712
26818
  connected_account_id: string;
26819
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26820
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26713
26821
  event_type: 'connected_account.completed_first_sync_after_reconnection';
26714
26822
  } | {
26715
26823
  /** ID of the event. */
@@ -26789,6 +26897,8 @@ export interface Routes {
26789
26897
  event_type: 'connect_webview.login_succeeded';
26790
26898
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26791
26899
  connected_account_id: string;
26900
+ /** Custom metadata of the connected account; present when connected_account_id is provided. */
26901
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26792
26902
  } | {
26793
26903
  /** ID of the event. */
26794
26904
  event_id: string;
@@ -26814,6 +26924,10 @@ export interface Routes {
26814
26924
  device_id: string;
26815
26925
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26816
26926
  connected_account_id: string;
26927
+ /** Custom metadata of the device, present when device_id is provided. */
26928
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26929
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26930
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26817
26931
  event_type: 'device.connected';
26818
26932
  } | {
26819
26933
  /** ID of the event. */
@@ -26828,6 +26942,10 @@ export interface Routes {
26828
26942
  device_id: string;
26829
26943
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26830
26944
  connected_account_id: string;
26945
+ /** Custom metadata of the device, present when device_id is provided. */
26946
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26947
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26948
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26831
26949
  event_type: 'device.added';
26832
26950
  } | {
26833
26951
  /** ID of the event. */
@@ -26842,6 +26960,10 @@ export interface Routes {
26842
26960
  device_id: string;
26843
26961
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26844
26962
  connected_account_id: string;
26963
+ /** Custom metadata of the device, present when device_id is provided. */
26964
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26965
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26966
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26845
26967
  event_type: 'device.converted_to_unmanaged';
26846
26968
  } | {
26847
26969
  /** ID of the event. */
@@ -26856,6 +26978,10 @@ export interface Routes {
26856
26978
  device_id: string;
26857
26979
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26858
26980
  connected_account_id: string;
26981
+ /** Custom metadata of the device, present when device_id is provided. */
26982
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
26983
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
26984
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26859
26985
  event_type: 'device.unmanaged.converted_to_managed';
26860
26986
  } | {
26861
26987
  /** ID of the event. */
@@ -26870,6 +26996,10 @@ export interface Routes {
26870
26996
  device_id: string;
26871
26997
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26872
26998
  connected_account_id: string;
26999
+ /** Custom metadata of the device, present when device_id is provided. */
27000
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27001
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27002
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26873
27003
  event_type: 'device.unmanaged.connected';
26874
27004
  } | {
26875
27005
  /** ID of the event. */
@@ -26884,6 +27014,10 @@ export interface Routes {
26884
27014
  device_id: string;
26885
27015
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26886
27016
  connected_account_id: string;
27017
+ /** Custom metadata of the device, present when device_id is provided. */
27018
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27019
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27020
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26887
27021
  event_type: 'device.disconnected';
26888
27022
  /** Error code associated with the disconnection event, if any. */
26889
27023
  error_code: 'account_disconnected' | 'hub_disconnected' | 'device_disconnected';
@@ -26900,6 +27034,10 @@ export interface Routes {
26900
27034
  device_id: string;
26901
27035
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26902
27036
  connected_account_id: string;
27037
+ /** Custom metadata of the device, present when device_id is provided. */
27038
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27039
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27040
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26903
27041
  event_type: 'device.unmanaged.disconnected';
26904
27042
  /** Error code associated with the disconnection event, if any. */
26905
27043
  error_code: 'account_disconnected' | 'hub_disconnected' | 'device_disconnected';
@@ -26916,6 +27054,10 @@ export interface Routes {
26916
27054
  device_id: string;
26917
27055
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26918
27056
  connected_account_id: string;
27057
+ /** Custom metadata of the device, present when device_id is provided. */
27058
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27059
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27060
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26919
27061
  event_type: 'device.tampered';
26920
27062
  } | {
26921
27063
  /** ID of the event. */
@@ -26930,6 +27072,10 @@ export interface Routes {
26930
27072
  device_id: string;
26931
27073
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26932
27074
  connected_account_id: string;
27075
+ /** Custom metadata of the device, present when device_id is provided. */
27076
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27077
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27078
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26933
27079
  event_type: 'device.low_battery';
26934
27080
  /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
26935
27081
  battery_level: number;
@@ -26946,6 +27092,10 @@ export interface Routes {
26946
27092
  device_id: string;
26947
27093
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26948
27094
  connected_account_id: string;
27095
+ /** Custom metadata of the device, present when device_id is provided. */
27096
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27097
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27098
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26949
27099
  event_type: 'device.battery_status_changed';
26950
27100
  /** Battery status of the affected device, calculated from the numeric `battery_level` value. */
26951
27101
  battery_status: 'critical' | 'low' | 'good' | 'full';
@@ -26964,6 +27114,10 @@ export interface Routes {
26964
27114
  device_id: string;
26965
27115
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26966
27116
  connected_account_id: string;
27117
+ /** Custom metadata of the device, present when device_id is provided. */
27118
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27119
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27120
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26967
27121
  event_type: 'device.removed';
26968
27122
  } | {
26969
27123
  /** ID of the event. */
@@ -26978,6 +27132,10 @@ export interface Routes {
26978
27132
  device_id: string;
26979
27133
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26980
27134
  connected_account_id: string;
27135
+ /** Custom metadata of the device, present when device_id is provided. */
27136
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27137
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27138
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26981
27139
  event_type: 'device.deleted';
26982
27140
  } | {
26983
27141
  /** ID of the event. */
@@ -26992,6 +27150,10 @@ export interface Routes {
26992
27150
  device_id: string;
26993
27151
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
26994
27152
  connected_account_id: string;
27153
+ /** Custom metadata of the device, present when device_id is provided. */
27154
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27155
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27156
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
26995
27157
  event_type: 'device.third_party_integration_detected';
26996
27158
  } | {
26997
27159
  /** ID of the event. */
@@ -27006,6 +27168,10 @@ export interface Routes {
27006
27168
  device_id: string;
27007
27169
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27008
27170
  connected_account_id: string;
27171
+ /** Custom metadata of the device, present when device_id is provided. */
27172
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27173
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27174
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27009
27175
  event_type: 'device.third_party_integration_no_longer_detected';
27010
27176
  } | {
27011
27177
  /** ID of the event. */
@@ -27020,6 +27186,10 @@ export interface Routes {
27020
27186
  device_id: string;
27021
27187
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27022
27188
  connected_account_id: string;
27189
+ /** Custom metadata of the device, present when device_id is provided. */
27190
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27191
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27192
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27023
27193
  event_type: 'device.salto.privacy_mode_activated';
27024
27194
  } | {
27025
27195
  /** ID of the event. */
@@ -27034,6 +27204,10 @@ export interface Routes {
27034
27204
  device_id: string;
27035
27205
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27036
27206
  connected_account_id: string;
27207
+ /** Custom metadata of the device, present when device_id is provided. */
27208
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27209
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27210
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27037
27211
  event_type: 'device.salto.privacy_mode_deactivated';
27038
27212
  } | {
27039
27213
  /** ID of the event. */
@@ -27048,6 +27222,10 @@ export interface Routes {
27048
27222
  device_id: string;
27049
27223
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27050
27224
  connected_account_id: string;
27225
+ /** Custom metadata of the device, present when device_id is provided. */
27226
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27227
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27228
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27051
27229
  event_type: 'device.connection_became_flaky';
27052
27230
  } | {
27053
27231
  /** ID of the event. */
@@ -27062,6 +27240,10 @@ export interface Routes {
27062
27240
  device_id: string;
27063
27241
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27064
27242
  connected_account_id: string;
27243
+ /** Custom metadata of the device, present when device_id is provided. */
27244
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27245
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27246
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27065
27247
  event_type: 'device.connection_stabilized';
27066
27248
  } | {
27067
27249
  /** ID of the event. */
@@ -27076,6 +27258,10 @@ export interface Routes {
27076
27258
  device_id: string;
27077
27259
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27078
27260
  connected_account_id: string;
27261
+ /** Custom metadata of the device, present when device_id is provided. */
27262
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27263
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27264
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27079
27265
  event_type: 'device.error.subscription_required';
27080
27266
  } | {
27081
27267
  /** ID of the event. */
@@ -27090,6 +27276,10 @@ export interface Routes {
27090
27276
  device_id: string;
27091
27277
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27092
27278
  connected_account_id: string;
27279
+ /** Custom metadata of the device, present when device_id is provided. */
27280
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27281
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27282
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27093
27283
  event_type: 'device.error.subscription_required.resolved';
27094
27284
  } | {
27095
27285
  /** ID of the event. */
@@ -27104,6 +27294,10 @@ export interface Routes {
27104
27294
  device_id: string;
27105
27295
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27106
27296
  connected_account_id: string;
27297
+ /** Custom metadata of the device, present when device_id is provided. */
27298
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27299
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27300
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27107
27301
  event_type: 'device.accessory_keypad_connected';
27108
27302
  } | {
27109
27303
  /** ID of the event. */
@@ -27118,6 +27312,10 @@ export interface Routes {
27118
27312
  device_id: string;
27119
27313
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27120
27314
  connected_account_id: string;
27315
+ /** Custom metadata of the device, present when device_id is provided. */
27316
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27317
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27318
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27121
27319
  event_type: 'device.accessory_keypad_disconnected';
27122
27320
  } | {
27123
27321
  /** ID of the event. */
@@ -27132,6 +27330,10 @@ export interface Routes {
27132
27330
  device_id: string;
27133
27331
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27134
27332
  connected_account_id: string;
27333
+ /** Custom metadata of the device, present when device_id is provided. */
27334
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27335
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27336
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27135
27337
  event_type: 'noise_sensor.noise_threshold_triggered';
27136
27338
  /** Detected noise level in decibels. */
27137
27339
  noise_level_decibels?: number | undefined;
@@ -27158,6 +27360,10 @@ export interface Routes {
27158
27360
  device_id: string;
27159
27361
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27160
27362
  connected_account_id: string;
27363
+ /** Custom metadata of the device, present when device_id is provided. */
27364
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27365
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27366
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27161
27367
  event_type: 'lock.locked';
27162
27368
  /** ID of the access code that was used to lock the device. */
27163
27369
  access_code_id?: string | undefined;
@@ -27178,6 +27384,10 @@ export interface Routes {
27178
27384
  device_id: string;
27179
27385
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27180
27386
  connected_account_id: string;
27387
+ /** Custom metadata of the device, present when device_id is provided. */
27388
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27389
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27390
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27181
27391
  event_type: 'lock.unlocked';
27182
27392
  /** ID of the access code that was used to unlock the affected device. */
27183
27393
  access_code_id?: string | undefined;
@@ -27198,6 +27408,10 @@ export interface Routes {
27198
27408
  device_id: string;
27199
27409
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27200
27410
  connected_account_id: string;
27411
+ /** Custom metadata of the device, present when device_id is provided. */
27412
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27413
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27414
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27201
27415
  event_type: 'lock.access_denied';
27202
27416
  /** ID of the access code that was used in the unlock attempts. */
27203
27417
  access_code_id?: string | undefined;
@@ -27214,6 +27428,10 @@ export interface Routes {
27214
27428
  device_id: string;
27215
27429
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27216
27430
  connected_account_id: string;
27431
+ /** Custom metadata of the device, present when device_id is provided. */
27432
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27433
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27434
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27217
27435
  event_type: 'thermostat.climate_preset_activated';
27218
27436
  /** ID of the thermostat schedule that prompted the affected climate preset to be activated. */
27219
27437
  thermostat_schedule_id: string | null;
@@ -27234,6 +27452,10 @@ export interface Routes {
27234
27452
  device_id: string;
27235
27453
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27236
27454
  connected_account_id: string;
27455
+ /** Custom metadata of the device, present when device_id is provided. */
27456
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27457
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27458
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27237
27459
  event_type: 'thermostat.manually_adjusted';
27238
27460
  /** 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. */
27239
27461
  method: 'seam' | 'external';
@@ -27262,6 +27484,10 @@ export interface Routes {
27262
27484
  device_id: string;
27263
27485
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27264
27486
  connected_account_id: string;
27487
+ /** Custom metadata of the device, present when device_id is provided. */
27488
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27489
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27490
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27265
27491
  event_type: 'thermostat.temperature_threshold_exceeded';
27266
27492
  /** Temperature, in °C, reported by the affected thermostat. */
27267
27493
  temperature_celsius: number;
@@ -27288,6 +27514,10 @@ export interface Routes {
27288
27514
  device_id: string;
27289
27515
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27290
27516
  connected_account_id: string;
27517
+ /** Custom metadata of the device, present when device_id is provided. */
27518
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27519
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27520
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27291
27521
  event_type: 'thermostat.temperature_threshold_no_longer_exceeded';
27292
27522
  /** Temperature, in °C, reported by the affected thermostat. */
27293
27523
  temperature_celsius: number;
@@ -27314,6 +27544,10 @@ export interface Routes {
27314
27544
  device_id: string;
27315
27545
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27316
27546
  connected_account_id: string;
27547
+ /** Custom metadata of the device, present when device_id is provided. */
27548
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27549
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27550
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27317
27551
  event_type: 'thermostat.temperature_reached_set_point';
27318
27552
  /** Temperature, in °C, reported by the affected thermostat. */
27319
27553
  temperature_celsius: number;
@@ -27336,6 +27570,10 @@ export interface Routes {
27336
27570
  device_id: string;
27337
27571
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27338
27572
  connected_account_id: string;
27573
+ /** Custom metadata of the device, present when device_id is provided. */
27574
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27575
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27576
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27339
27577
  event_type: 'thermostat.temperature_changed';
27340
27578
  /** Temperature, in °C, reported by the affected thermostat. */
27341
27579
  temperature_celsius: number;
@@ -27354,6 +27592,10 @@ export interface Routes {
27354
27592
  device_id: string;
27355
27593
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
27356
27594
  connected_account_id: string;
27595
+ /** Custom metadata of the device, present when device_id is provided. */
27596
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27597
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27598
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27357
27599
  event_type: 'device.name_changed';
27358
27600
  /** The new name of the affected device. */
27359
27601
  device_name: string;
@@ -27380,6 +27622,8 @@ export interface Routes {
27380
27622
  occurred_at: string;
27381
27623
  /** ID of the affected phone device. */
27382
27624
  device_id: string;
27625
+ /** Custom metadata of the device; present when device_id is provided. */
27626
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27383
27627
  event_type: 'phone.deactivated';
27384
27628
  }) | undefined;
27385
27629
  message?: string | undefined;
@@ -27441,6 +27685,10 @@ export interface Routes {
27441
27685
  device_id: string;
27442
27686
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27443
27687
  connected_account_id: string;
27688
+ /** Custom metadata of the device, present when device_id is provided. */
27689
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27690
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27691
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27444
27692
  event_type: 'access_code.created';
27445
27693
  } | {
27446
27694
  /** ID of the event. */
@@ -27457,6 +27705,10 @@ export interface Routes {
27457
27705
  device_id: string;
27458
27706
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27459
27707
  connected_account_id: string;
27708
+ /** Custom metadata of the device, present when device_id is provided. */
27709
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27710
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27711
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27460
27712
  event_type: 'access_code.changed';
27461
27713
  } | {
27462
27714
  /** ID of the event. */
@@ -27473,6 +27725,10 @@ export interface Routes {
27473
27725
  device_id: string;
27474
27726
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27475
27727
  connected_account_id: string;
27728
+ /** Custom metadata of the device, present when device_id is provided. */
27729
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27730
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27731
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27476
27732
  event_type: 'access_code.scheduled_on_device';
27477
27733
  /** Code for the affected access code. */
27478
27734
  code: string;
@@ -27491,6 +27747,10 @@ export interface Routes {
27491
27747
  device_id: string;
27492
27748
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27493
27749
  connected_account_id: string;
27750
+ /** Custom metadata of the device, present when device_id is provided. */
27751
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27752
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27753
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27494
27754
  event_type: 'access_code.set_on_device';
27495
27755
  /** Code for the affected access code. */
27496
27756
  code: string;
@@ -27509,6 +27769,10 @@ export interface Routes {
27509
27769
  device_id: string;
27510
27770
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27511
27771
  connected_account_id: string;
27772
+ /** Custom metadata of the device, present when device_id is provided. */
27773
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27774
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27775
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27512
27776
  event_type: 'access_code.removed_from_device';
27513
27777
  } | {
27514
27778
  /** ID of the event. */
@@ -27525,6 +27789,10 @@ export interface Routes {
27525
27789
  device_id: string;
27526
27790
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27527
27791
  connected_account_id: string;
27792
+ /** Custom metadata of the device, present when device_id is provided. */
27793
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27794
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27795
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27528
27796
  event_type: 'access_code.delay_in_setting_on_device';
27529
27797
  } | {
27530
27798
  /** ID of the event. */
@@ -27541,6 +27809,10 @@ export interface Routes {
27541
27809
  device_id: string;
27542
27810
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27543
27811
  connected_account_id: string;
27812
+ /** Custom metadata of the device, present when device_id is provided. */
27813
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27814
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27815
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27544
27816
  event_type: 'access_code.failed_to_set_on_device';
27545
27817
  } | {
27546
27818
  /** ID of the event. */
@@ -27557,6 +27829,10 @@ export interface Routes {
27557
27829
  device_id: string;
27558
27830
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27559
27831
  connected_account_id: string;
27832
+ /** Custom metadata of the device, present when device_id is provided. */
27833
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27834
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27835
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27560
27836
  event_type: 'access_code.deleted';
27561
27837
  /** Code for the affected access code. */
27562
27838
  code: string | null;
@@ -27575,6 +27851,10 @@ export interface Routes {
27575
27851
  device_id: string;
27576
27852
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27577
27853
  connected_account_id: string;
27854
+ /** Custom metadata of the device, present when device_id is provided. */
27855
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27856
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27857
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27578
27858
  event_type: 'access_code.delay_in_removing_from_device';
27579
27859
  } | {
27580
27860
  /** ID of the event. */
@@ -27591,6 +27871,10 @@ export interface Routes {
27591
27871
  device_id: string;
27592
27872
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27593
27873
  connected_account_id: string;
27874
+ /** Custom metadata of the device, present when device_id is provided. */
27875
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27876
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27877
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27594
27878
  event_type: 'access_code.failed_to_remove_from_device';
27595
27879
  } | {
27596
27880
  /** ID of the event. */
@@ -27607,6 +27891,10 @@ export interface Routes {
27607
27891
  device_id: string;
27608
27892
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27609
27893
  connected_account_id: string;
27894
+ /** Custom metadata of the device, present when device_id is provided. */
27895
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27896
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27897
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27610
27898
  event_type: 'access_code.modified_external_to_seam';
27611
27899
  } | {
27612
27900
  /** ID of the event. */
@@ -27623,6 +27911,10 @@ export interface Routes {
27623
27911
  device_id: string;
27624
27912
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27625
27913
  connected_account_id: string;
27914
+ /** Custom metadata of the device, present when device_id is provided. */
27915
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27916
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27917
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27626
27918
  event_type: 'access_code.deleted_external_to_seam';
27627
27919
  } | {
27628
27920
  /** ID of the event. */
@@ -27639,6 +27931,10 @@ export interface Routes {
27639
27931
  device_id: string;
27640
27932
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27641
27933
  connected_account_id: string;
27934
+ /** Custom metadata of the device, present when device_id is provided. */
27935
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27936
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27937
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27642
27938
  event_type: 'access_code.backup_access_code_pulled';
27643
27939
  backup_access_code_id: string;
27644
27940
  } | {
@@ -27656,6 +27952,10 @@ export interface Routes {
27656
27952
  device_id: string;
27657
27953
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27658
27954
  connected_account_id: string;
27955
+ /** Custom metadata of the device, present when device_id is provided. */
27956
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27957
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27958
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27659
27959
  event_type: 'access_code.unmanaged.converted_to_managed';
27660
27960
  } | {
27661
27961
  /** ID of the event. */
@@ -27672,6 +27972,10 @@ export interface Routes {
27672
27972
  device_id: string;
27673
27973
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27674
27974
  connected_account_id: string;
27975
+ /** Custom metadata of the device, present when device_id is provided. */
27976
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27977
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27978
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27675
27979
  event_type: 'access_code.unmanaged.failed_to_convert_to_managed';
27676
27980
  } | {
27677
27981
  /** ID of the event. */
@@ -27688,6 +27992,10 @@ export interface Routes {
27688
27992
  device_id: string;
27689
27993
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27690
27994
  connected_account_id: string;
27995
+ /** Custom metadata of the device, present when device_id is provided. */
27996
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
27997
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
27998
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27691
27999
  event_type: 'access_code.unmanaged.created';
27692
28000
  } | {
27693
28001
  /** ID of the event. */
@@ -27704,6 +28012,10 @@ export interface Routes {
27704
28012
  device_id: string;
27705
28013
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the affected access code. */
27706
28014
  connected_account_id: string;
28015
+ /** Custom metadata of the device, present when device_id is provided. */
28016
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28017
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28018
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
27707
28019
  event_type: 'access_code.unmanaged.removed';
27708
28020
  } | {
27709
28021
  /** ID of the event. */
@@ -28066,6 +28378,8 @@ export interface Routes {
28066
28378
  occurred_at: string;
28067
28379
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
28068
28380
  connected_account_id: string;
28381
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28382
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28069
28383
  event_type: 'connected_account.connected';
28070
28384
  /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
28071
28385
  connect_webview_id: string;
@@ -28080,6 +28394,8 @@ export interface Routes {
28080
28394
  occurred_at: string;
28081
28395
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
28082
28396
  connected_account_id: string;
28397
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28398
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28083
28399
  event_type: 'connected_account.created';
28084
28400
  /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
28085
28401
  connect_webview_id: string;
@@ -28094,6 +28410,8 @@ export interface Routes {
28094
28410
  occurred_at: string;
28095
28411
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
28096
28412
  connected_account_id: string;
28413
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28414
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28097
28415
  event_type: 'connected_account.successful_login';
28098
28416
  /** ID of the [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) associated with the event. */
28099
28417
  connect_webview_id: string;
@@ -28108,6 +28426,8 @@ export interface Routes {
28108
28426
  occurred_at: string;
28109
28427
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
28110
28428
  connected_account_id: string;
28429
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28430
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28111
28431
  event_type: 'connected_account.disconnected';
28112
28432
  } | {
28113
28433
  /** ID of the event. */
@@ -28120,6 +28440,8 @@ export interface Routes {
28120
28440
  occurred_at: string;
28121
28441
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
28122
28442
  connected_account_id: string;
28443
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28444
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28123
28445
  event_type: 'connected_account.completed_first_sync';
28124
28446
  } | {
28125
28447
  /** ID of the event. */
@@ -28132,6 +28454,8 @@ export interface Routes {
28132
28454
  occurred_at: string;
28133
28455
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
28134
28456
  connected_account_id: string;
28457
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28458
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28135
28459
  event_type: 'connected_account.deleted';
28136
28460
  } | {
28137
28461
  /** ID of the event. */
@@ -28144,6 +28468,8 @@ export interface Routes {
28144
28468
  occurred_at: string;
28145
28469
  /** ID of the affected [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts). */
28146
28470
  connected_account_id: string;
28471
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28472
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28147
28473
  event_type: 'connected_account.completed_first_sync_after_reconnection';
28148
28474
  } | {
28149
28475
  /** ID of the event. */
@@ -28223,6 +28549,8 @@ export interface Routes {
28223
28549
  event_type: 'connect_webview.login_succeeded';
28224
28550
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28225
28551
  connected_account_id: string;
28552
+ /** Custom metadata of the connected account; present when connected_account_id is provided. */
28553
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28226
28554
  } | {
28227
28555
  /** ID of the event. */
28228
28556
  event_id: string;
@@ -28248,6 +28576,10 @@ export interface Routes {
28248
28576
  device_id: string;
28249
28577
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28250
28578
  connected_account_id: string;
28579
+ /** Custom metadata of the device, present when device_id is provided. */
28580
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28581
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28582
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28251
28583
  event_type: 'device.connected';
28252
28584
  } | {
28253
28585
  /** ID of the event. */
@@ -28262,6 +28594,10 @@ export interface Routes {
28262
28594
  device_id: string;
28263
28595
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28264
28596
  connected_account_id: string;
28597
+ /** Custom metadata of the device, present when device_id is provided. */
28598
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28599
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28600
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28265
28601
  event_type: 'device.added';
28266
28602
  } | {
28267
28603
  /** ID of the event. */
@@ -28276,6 +28612,10 @@ export interface Routes {
28276
28612
  device_id: string;
28277
28613
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28278
28614
  connected_account_id: string;
28615
+ /** Custom metadata of the device, present when device_id is provided. */
28616
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28617
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28618
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28279
28619
  event_type: 'device.converted_to_unmanaged';
28280
28620
  } | {
28281
28621
  /** ID of the event. */
@@ -28290,6 +28630,10 @@ export interface Routes {
28290
28630
  device_id: string;
28291
28631
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28292
28632
  connected_account_id: string;
28633
+ /** Custom metadata of the device, present when device_id is provided. */
28634
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28635
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28636
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28293
28637
  event_type: 'device.unmanaged.converted_to_managed';
28294
28638
  } | {
28295
28639
  /** ID of the event. */
@@ -28304,6 +28648,10 @@ export interface Routes {
28304
28648
  device_id: string;
28305
28649
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28306
28650
  connected_account_id: string;
28651
+ /** Custom metadata of the device, present when device_id is provided. */
28652
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28653
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28654
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28307
28655
  event_type: 'device.unmanaged.connected';
28308
28656
  } | {
28309
28657
  /** ID of the event. */
@@ -28318,6 +28666,10 @@ export interface Routes {
28318
28666
  device_id: string;
28319
28667
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28320
28668
  connected_account_id: string;
28669
+ /** Custom metadata of the device, present when device_id is provided. */
28670
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28671
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28672
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28321
28673
  event_type: 'device.disconnected';
28322
28674
  /** Error code associated with the disconnection event, if any. */
28323
28675
  error_code: 'account_disconnected' | 'hub_disconnected' | 'device_disconnected';
@@ -28334,6 +28686,10 @@ export interface Routes {
28334
28686
  device_id: string;
28335
28687
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28336
28688
  connected_account_id: string;
28689
+ /** Custom metadata of the device, present when device_id is provided. */
28690
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28691
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28692
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28337
28693
  event_type: 'device.unmanaged.disconnected';
28338
28694
  /** Error code associated with the disconnection event, if any. */
28339
28695
  error_code: 'account_disconnected' | 'hub_disconnected' | 'device_disconnected';
@@ -28350,6 +28706,10 @@ export interface Routes {
28350
28706
  device_id: string;
28351
28707
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28352
28708
  connected_account_id: string;
28709
+ /** Custom metadata of the device, present when device_id is provided. */
28710
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28711
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28712
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28353
28713
  event_type: 'device.tampered';
28354
28714
  } | {
28355
28715
  /** ID of the event. */
@@ -28364,6 +28724,10 @@ export interface Routes {
28364
28724
  device_id: string;
28365
28725
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28366
28726
  connected_account_id: string;
28727
+ /** Custom metadata of the device, present when device_id is provided. */
28728
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28729
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28730
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28367
28731
  event_type: 'device.low_battery';
28368
28732
  /** Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device. */
28369
28733
  battery_level: number;
@@ -28380,6 +28744,10 @@ export interface Routes {
28380
28744
  device_id: string;
28381
28745
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28382
28746
  connected_account_id: string;
28747
+ /** Custom metadata of the device, present when device_id is provided. */
28748
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28749
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28750
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28383
28751
  event_type: 'device.battery_status_changed';
28384
28752
  /** Battery status of the affected device, calculated from the numeric `battery_level` value. */
28385
28753
  battery_status: 'critical' | 'low' | 'good' | 'full';
@@ -28398,6 +28766,10 @@ export interface Routes {
28398
28766
  device_id: string;
28399
28767
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28400
28768
  connected_account_id: string;
28769
+ /** Custom metadata of the device, present when device_id is provided. */
28770
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28771
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28772
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28401
28773
  event_type: 'device.removed';
28402
28774
  } | {
28403
28775
  /** ID of the event. */
@@ -28412,6 +28784,10 @@ export interface Routes {
28412
28784
  device_id: string;
28413
28785
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28414
28786
  connected_account_id: string;
28787
+ /** Custom metadata of the device, present when device_id is provided. */
28788
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28789
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28790
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28415
28791
  event_type: 'device.deleted';
28416
28792
  } | {
28417
28793
  /** ID of the event. */
@@ -28426,6 +28802,10 @@ export interface Routes {
28426
28802
  device_id: string;
28427
28803
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28428
28804
  connected_account_id: string;
28805
+ /** Custom metadata of the device, present when device_id is provided. */
28806
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28807
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28808
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28429
28809
  event_type: 'device.third_party_integration_detected';
28430
28810
  } | {
28431
28811
  /** ID of the event. */
@@ -28440,6 +28820,10 @@ export interface Routes {
28440
28820
  device_id: string;
28441
28821
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28442
28822
  connected_account_id: string;
28823
+ /** Custom metadata of the device, present when device_id is provided. */
28824
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28825
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28826
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28443
28827
  event_type: 'device.third_party_integration_no_longer_detected';
28444
28828
  } | {
28445
28829
  /** ID of the event. */
@@ -28454,6 +28838,10 @@ export interface Routes {
28454
28838
  device_id: string;
28455
28839
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28456
28840
  connected_account_id: string;
28841
+ /** Custom metadata of the device, present when device_id is provided. */
28842
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28843
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28844
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28457
28845
  event_type: 'device.salto.privacy_mode_activated';
28458
28846
  } | {
28459
28847
  /** ID of the event. */
@@ -28468,6 +28856,10 @@ export interface Routes {
28468
28856
  device_id: string;
28469
28857
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28470
28858
  connected_account_id: string;
28859
+ /** Custom metadata of the device, present when device_id is provided. */
28860
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28861
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28862
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28471
28863
  event_type: 'device.salto.privacy_mode_deactivated';
28472
28864
  } | {
28473
28865
  /** ID of the event. */
@@ -28482,6 +28874,10 @@ export interface Routes {
28482
28874
  device_id: string;
28483
28875
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28484
28876
  connected_account_id: string;
28877
+ /** Custom metadata of the device, present when device_id is provided. */
28878
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28879
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28880
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28485
28881
  event_type: 'device.connection_became_flaky';
28486
28882
  } | {
28487
28883
  /** ID of the event. */
@@ -28496,6 +28892,10 @@ export interface Routes {
28496
28892
  device_id: string;
28497
28893
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28498
28894
  connected_account_id: string;
28895
+ /** Custom metadata of the device, present when device_id is provided. */
28896
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28897
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28898
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28499
28899
  event_type: 'device.connection_stabilized';
28500
28900
  } | {
28501
28901
  /** ID of the event. */
@@ -28510,6 +28910,10 @@ export interface Routes {
28510
28910
  device_id: string;
28511
28911
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28512
28912
  connected_account_id: string;
28913
+ /** Custom metadata of the device, present when device_id is provided. */
28914
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28915
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28916
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28513
28917
  event_type: 'device.error.subscription_required';
28514
28918
  } | {
28515
28919
  /** ID of the event. */
@@ -28524,6 +28928,10 @@ export interface Routes {
28524
28928
  device_id: string;
28525
28929
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28526
28930
  connected_account_id: string;
28931
+ /** Custom metadata of the device, present when device_id is provided. */
28932
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28933
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28934
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28527
28935
  event_type: 'device.error.subscription_required.resolved';
28528
28936
  } | {
28529
28937
  /** ID of the event. */
@@ -28538,6 +28946,10 @@ export interface Routes {
28538
28946
  device_id: string;
28539
28947
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28540
28948
  connected_account_id: string;
28949
+ /** Custom metadata of the device, present when device_id is provided. */
28950
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28951
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28952
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28541
28953
  event_type: 'device.accessory_keypad_connected';
28542
28954
  } | {
28543
28955
  /** ID of the event. */
@@ -28552,6 +28964,10 @@ export interface Routes {
28552
28964
  device_id: string;
28553
28965
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28554
28966
  connected_account_id: string;
28967
+ /** Custom metadata of the device, present when device_id is provided. */
28968
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28969
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28970
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28555
28971
  event_type: 'device.accessory_keypad_disconnected';
28556
28972
  } | {
28557
28973
  /** ID of the event. */
@@ -28566,6 +28982,10 @@ export interface Routes {
28566
28982
  device_id: string;
28567
28983
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28568
28984
  connected_account_id: string;
28985
+ /** Custom metadata of the device, present when device_id is provided. */
28986
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28987
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
28988
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28569
28989
  event_type: 'noise_sensor.noise_threshold_triggered';
28570
28990
  /** Detected noise level in decibels. */
28571
28991
  noise_level_decibels?: number | undefined;
@@ -28592,6 +29012,10 @@ export interface Routes {
28592
29012
  device_id: string;
28593
29013
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28594
29014
  connected_account_id: string;
29015
+ /** Custom metadata of the device, present when device_id is provided. */
29016
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29017
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29018
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28595
29019
  event_type: 'lock.locked';
28596
29020
  /** ID of the access code that was used to lock the device. */
28597
29021
  access_code_id?: string | undefined;
@@ -28612,6 +29036,10 @@ export interface Routes {
28612
29036
  device_id: string;
28613
29037
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28614
29038
  connected_account_id: string;
29039
+ /** Custom metadata of the device, present when device_id is provided. */
29040
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29041
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29042
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28615
29043
  event_type: 'lock.unlocked';
28616
29044
  /** ID of the access code that was used to unlock the affected device. */
28617
29045
  access_code_id?: string | undefined;
@@ -28632,6 +29060,10 @@ export interface Routes {
28632
29060
  device_id: string;
28633
29061
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28634
29062
  connected_account_id: string;
29063
+ /** Custom metadata of the device, present when device_id is provided. */
29064
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29065
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29066
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28635
29067
  event_type: 'lock.access_denied';
28636
29068
  /** ID of the access code that was used in the unlock attempts. */
28637
29069
  access_code_id?: string | undefined;
@@ -28648,6 +29080,10 @@ export interface Routes {
28648
29080
  device_id: string;
28649
29081
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28650
29082
  connected_account_id: string;
29083
+ /** Custom metadata of the device, present when device_id is provided. */
29084
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29085
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29086
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28651
29087
  event_type: 'thermostat.climate_preset_activated';
28652
29088
  /** ID of the thermostat schedule that prompted the affected climate preset to be activated. */
28653
29089
  thermostat_schedule_id: string | null;
@@ -28668,6 +29104,10 @@ export interface Routes {
28668
29104
  device_id: string;
28669
29105
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28670
29106
  connected_account_id: string;
29107
+ /** Custom metadata of the device, present when device_id is provided. */
29108
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29109
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29110
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28671
29111
  event_type: 'thermostat.manually_adjusted';
28672
29112
  /** 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. */
28673
29113
  method: 'seam' | 'external';
@@ -28696,6 +29136,10 @@ export interface Routes {
28696
29136
  device_id: string;
28697
29137
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28698
29138
  connected_account_id: string;
29139
+ /** Custom metadata of the device, present when device_id is provided. */
29140
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29141
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29142
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28699
29143
  event_type: 'thermostat.temperature_threshold_exceeded';
28700
29144
  /** Temperature, in °C, reported by the affected thermostat. */
28701
29145
  temperature_celsius: number;
@@ -28722,6 +29166,10 @@ export interface Routes {
28722
29166
  device_id: string;
28723
29167
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28724
29168
  connected_account_id: string;
29169
+ /** Custom metadata of the device, present when device_id is provided. */
29170
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29171
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29172
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28725
29173
  event_type: 'thermostat.temperature_threshold_no_longer_exceeded';
28726
29174
  /** Temperature, in °C, reported by the affected thermostat. */
28727
29175
  temperature_celsius: number;
@@ -28748,6 +29196,10 @@ export interface Routes {
28748
29196
  device_id: string;
28749
29197
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28750
29198
  connected_account_id: string;
29199
+ /** Custom metadata of the device, present when device_id is provided. */
29200
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29201
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29202
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28751
29203
  event_type: 'thermostat.temperature_reached_set_point';
28752
29204
  /** Temperature, in °C, reported by the affected thermostat. */
28753
29205
  temperature_celsius: number;
@@ -28770,6 +29222,10 @@ export interface Routes {
28770
29222
  device_id: string;
28771
29223
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28772
29224
  connected_account_id: string;
29225
+ /** Custom metadata of the device, present when device_id is provided. */
29226
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29227
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29228
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28773
29229
  event_type: 'thermostat.temperature_changed';
28774
29230
  /** Temperature, in °C, reported by the affected thermostat. */
28775
29231
  temperature_celsius: number;
@@ -28788,6 +29244,10 @@ export interface Routes {
28788
29244
  device_id: string;
28789
29245
  /** ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts) associated with the event. */
28790
29246
  connected_account_id: string;
29247
+ /** Custom metadata of the device, present when device_id is provided. */
29248
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
29249
+ /** Custom metadata of the connected account, present when connected_account_id is provided. */
29250
+ connected_account_custom_metadata?: Record<string, string | boolean> | undefined;
28791
29251
  event_type: 'device.name_changed';
28792
29252
  /** The new name of the affected device. */
28793
29253
  device_name: string;
@@ -28814,6 +29274,8 @@ export interface Routes {
28814
29274
  occurred_at: string;
28815
29275
  /** ID of the affected phone device. */
28816
29276
  device_id: string;
29277
+ /** Custom metadata of the device; present when device_id is provided. */
29278
+ device_custom_metadata?: Record<string, string | boolean> | undefined;
28817
29279
  event_type: 'phone.deactivated';
28818
29280
  }>;
28819
29281
  };
@@ -62329,6 +62791,8 @@ export interface Routes {
62329
62791
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62330
62792
  warning_code: 'acs_user_profile_does_not_match_user_identity';
62331
62793
  }>;
62794
+ /** Array of access system user IDs associated with the user identity. */
62795
+ acs_user_ids: string[];
62332
62796
  };
62333
62797
  };
62334
62798
  };
@@ -62535,6 +62999,8 @@ export interface Routes {
62535
62999
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62536
63000
  warning_code: 'acs_user_profile_does_not_match_user_identity';
62537
63001
  }>;
63002
+ /** Array of access system user IDs associated with the user identity. */
63003
+ acs_user_ids: string[];
62538
63004
  };
62539
63005
  };
62540
63006
  };
@@ -62609,6 +63075,8 @@ export interface Routes {
62609
63075
  /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
62610
63076
  warning_code: 'acs_user_profile_does_not_match_user_identity';
62611
63077
  }>;
63078
+ /** Array of access system user IDs associated with the user identity. */
63079
+ acs_user_ids: string[];
62612
63080
  }>;
62613
63081
  };
62614
63082
  };