@seamapi/types 1.1126.0 → 1.1128.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 (50) hide show
  1. package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js +26 -14
  2. package/lib/seam/connect/models/action-attempts/pause-speaker-playback.js.map +1 -1
  3. package/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.js +26 -14
  4. package/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.js.map +1 -1
  5. package/lib/seam/connect/models/action-attempts/play-speaker-chime.js +26 -14
  6. package/lib/seam/connect/models/action-attempts/play-speaker-chime.js.map +1 -1
  7. package/lib/seam/connect/models/action-attempts/play-speaker-favorite.js +26 -14
  8. package/lib/seam/connect/models/action-attempts/play-speaker-favorite.js.map +1 -1
  9. package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js +26 -14
  10. package/lib/seam/connect/models/action-attempts/resume-speaker-playback.js.map +1 -1
  11. package/lib/seam/connect/models/action-attempts/set-speaker-mute.js +26 -14
  12. package/lib/seam/connect/models/action-attempts/set-speaker-mute.js.map +1 -1
  13. package/lib/seam/connect/models/action-attempts/set-speaker-volume.js +26 -14
  14. package/lib/seam/connect/models/action-attempts/set-speaker-volume.js.map +1 -1
  15. package/lib/seam/connect/models/customer/access-grant-resources.d.ts +14 -14
  16. package/lib/seam/connect/models/customer/customer-data.d.ts +24 -24
  17. package/lib/seam/connect/models/customer/customer-delete-data.d.ts +2 -2
  18. package/lib/seam/connect/models/customer/customer-portal.d.ts +214 -24
  19. package/lib/seam/connect/models/customer/customer-portal.js +23 -0
  20. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
  21. package/lib/seam/connect/models/customization-profiles/customization-profile.d.ts +266 -0
  22. package/lib/seam/connect/models/customization-profiles/customization-profile.js +4 -0
  23. package/lib/seam/connect/models/customization-profiles/customization-profile.js.map +1 -1
  24. package/lib/seam/connect/models/devices/capability-properties/speaker.js +1 -0
  25. package/lib/seam/connect/models/devices/capability-properties/speaker.js.map +1 -1
  26. package/lib/seam/connect/models/devices/device-metadata.js +6 -2
  27. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  28. package/lib/seam/connect/models/devices/device.js +48 -24
  29. package/lib/seam/connect/models/devices/device.js.map +1 -1
  30. package/lib/seam/connect/models/events/seam-event.d.ts +12 -12
  31. package/lib/seam/connect/models/events/spaces.d.ts +24 -24
  32. package/lib/seam/connect/openapi.js +649 -38
  33. package/lib/seam/connect/openapi.js.map +1 -1
  34. package/lib/seam/connect/route-types.d.ts +693 -144
  35. package/package.json +1 -1
  36. package/src/lib/seam/connect/internal/schemas.ts +1 -0
  37. package/src/lib/seam/connect/models/action-attempts/pause-speaker-playback.ts +29 -19
  38. package/src/lib/seam/connect/models/action-attempts/play-speaker-audio-clip.ts +29 -19
  39. package/src/lib/seam/connect/models/action-attempts/play-speaker-chime.ts +29 -19
  40. package/src/lib/seam/connect/models/action-attempts/play-speaker-favorite.ts +29 -19
  41. package/src/lib/seam/connect/models/action-attempts/resume-speaker-playback.ts +29 -19
  42. package/src/lib/seam/connect/models/action-attempts/set-speaker-mute.ts +29 -19
  43. package/src/lib/seam/connect/models/action-attempts/set-speaker-volume.ts +29 -19
  44. package/src/lib/seam/connect/models/customer/customer-portal.ts +24 -0
  45. package/src/lib/seam/connect/models/customization-profiles/customization-profile.ts +6 -0
  46. package/src/lib/seam/connect/models/devices/capability-properties/speaker.ts +1 -0
  47. package/src/lib/seam/connect/models/devices/device-metadata.ts +6 -2
  48. package/src/lib/seam/connect/models/devices/device.ts +48 -28
  49. package/src/lib/seam/connect/openapi.ts +732 -38
  50. package/src/lib/seam/connect/route-types.ts +941 -154
@@ -55776,82 +55776,6 @@ export type Routes = {
55776
55776
  method: 'POST'
55777
55777
  queryParams: {}
55778
55778
  jsonBody: {
55779
- features?: {
55780
- /** Configuration for the connect accounts feature. */
55781
- connect?: {
55782
- /** Whether to exclude this feature from the portal. */
55783
- exclude?: boolean
55784
- /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
55785
- accepted_providers?: string[] | undefined
55786
- /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
55787
- excluded_providers?: string[] | undefined
55788
- }
55789
- /** Configuration for the manage feature. */
55790
- manage?: {
55791
- /** Whether to exclude this feature from the portal. */
55792
- exclude?: boolean
55793
- /** Indicates whether the customer can manage reservations for their properties. */
55794
- exclude_reservation_management?: boolean
55795
- /** Indicates whether to exclude technical details from reservation views. */
55796
- exclude_reservation_technical_details?: boolean
55797
- /** Indicates whether the customer can manage staff for their properties. */
55798
- exclude_staff_management?: boolean
55799
- /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
55800
- exclude_device_management?: boolean
55801
- /** Configuration for event type filtering in the manage feature. */
55802
- events?:
55803
- | {
55804
- /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
55805
- allowed_events?: string[] | undefined
55806
- /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
55807
- default_events?: string[] | undefined
55808
- }
55809
- | undefined
55810
- /**
55811
- Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
55812
- */
55813
- device_management_confirmation?:
55814
- | {
55815
- /** Custom title for the confirmation modal. */
55816
- title?: string | undefined
55817
- /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
55818
- body?: string | undefined
55819
- /** Custom label for the confirm button. */
55820
- confirm_button_label?: string | undefined
55821
- /** Custom label for the cancel button. */
55822
- cancel_button_label?: string | undefined
55823
- }
55824
- | undefined
55825
- }
55826
- /** Configuration for the manage devices feature.
55827
- ---
55828
- deprecated: Use `manage` instead.
55829
- --- */
55830
- manage_devices?: {
55831
- /** Whether to exclude this feature from the portal. */
55832
- exclude?: boolean
55833
- }
55834
- /** Configuration for the organize feature. */
55835
- organize?: {
55836
- /** Whether to exclude this feature from the portal. */
55837
- exclude?: boolean
55838
- }
55839
- /** Configuration for the configure feature. */
55840
- configure?: {
55841
- /** Whether to exclude this feature from the portal. */
55842
- exclude?: boolean
55843
- /** Indicates whether the customer can customize the access automation rules for their properties. */
55844
- allow_access_automation_rule_customization?: boolean
55845
- /** Indicates whether the customer can customize the climate automation rules for their properties. */
55846
- allow_climate_automation_rule_customization?: boolean
55847
- /** Indicates whether the customer can customize the sound automation rules for their properties. */
55848
- allow_sound_automation_rule_customization?: boolean
55849
- /** Indicates whether the customer can customize the Instant Key profile for their properties. */
55850
- allow_instant_key_customization?: boolean
55851
- /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
55852
- allow_notification_customization?: boolean
55853
- }
55854
- }
55855
55779
  /** Whether the portal is embedded in another application. */
55856
55780
  is_embedded?: boolean
55857
55781
  /** Whether the portal is read-only. When true, the customer can browse the portal but cannot perform any mutating action; write requests made with the portal's client session are rejected. */
@@ -55963,6 +55887,104 @@ export type Routes = {
55963
55887
  | undefined
55964
55888
  /** Whether the portal is in developer mode. Only available for Seam employees. */
55965
55889
  _dev?: boolean
55890
+ /** Features to include in the portal. Settings you omit use the portal's customization profile, then the Seam default. Settings you pass take precedence over the customization profile's, so changing the profile doesn't change them. */
55891
+ features?:
55892
+ | {
55893
+ /** Configuration for the connect accounts feature. */
55894
+ connect?:
55895
+ | {
55896
+ /** Whether to exclude this feature from the portal. */
55897
+ exclude?: boolean | undefined
55898
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
55899
+ accepted_providers?: (string[] | undefined) | undefined
55900
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
55901
+ excluded_providers?: (string[] | undefined) | undefined
55902
+ }
55903
+ | undefined
55904
+ /** Configuration for the manage feature. */
55905
+ manage?:
55906
+ | {
55907
+ /** Whether to exclude this feature from the portal. */
55908
+ exclude?: boolean | undefined
55909
+ /** Indicates whether the customer can manage reservations for their properties. */
55910
+ exclude_reservation_management?: boolean | undefined
55911
+ /** Indicates whether to exclude technical details from reservation views. */
55912
+ exclude_reservation_technical_details?: boolean | undefined
55913
+ /** Indicates whether the customer can manage staff for their properties. */
55914
+ exclude_staff_management?: boolean | undefined
55915
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
55916
+ exclude_device_management?: boolean | undefined
55917
+ /** Configuration for event type filtering in the manage feature. */
55918
+ events?:
55919
+ | (
55920
+ | {
55921
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
55922
+ allowed_events?: string[] | undefined
55923
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
55924
+ default_events?: string[] | undefined
55925
+ }
55926
+ | undefined
55927
+ )
55928
+ | undefined
55929
+ /**
55930
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
55931
+ */
55932
+ device_management_confirmation?:
55933
+ | (
55934
+ | {
55935
+ /** Custom title for the confirmation modal. */
55936
+ title?: string | undefined
55937
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
55938
+ body?: string | undefined
55939
+ /** Custom label for the confirm button. */
55940
+ confirm_button_label?: string | undefined
55941
+ /** Custom label for the cancel button. */
55942
+ cancel_button_label?: string | undefined
55943
+ }
55944
+ | undefined
55945
+ )
55946
+ | undefined
55947
+ }
55948
+ | undefined
55949
+ /** Configuration for the manage devices feature.
55950
+ ---
55951
+ deprecated: Use `manage` instead.
55952
+ --- */
55953
+ manage_devices?:
55954
+ | {
55955
+ /** Whether to exclude this feature from the portal. */
55956
+ exclude?: boolean | undefined
55957
+ }
55958
+ | undefined
55959
+ /** Configuration for the organize feature. */
55960
+ organize?:
55961
+ | {
55962
+ /** Whether to exclude this feature from the portal. */
55963
+ exclude?: boolean | undefined
55964
+ }
55965
+ | undefined
55966
+ /** Configuration for the configure feature. */
55967
+ configure?:
55968
+ | {
55969
+ /** Whether to exclude this feature from the portal. */
55970
+ exclude?: boolean | undefined
55971
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
55972
+ allow_access_automation_rule_customization?:
55973
+ boolean | undefined
55974
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
55975
+ allow_climate_automation_rule_customization?:
55976
+ boolean | undefined
55977
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
55978
+ allow_sound_automation_rule_customization?:
55979
+ boolean | undefined
55980
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
55981
+ allow_instant_key_customization?: boolean | undefined
55982
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
55983
+ allow_notification_customization?: boolean | undefined
55984
+ }
55985
+ | undefined
55986
+ }
55987
+ | undefined
55966
55988
  } & {
55967
55989
  customer_data?:
55968
55990
  | {
@@ -107552,6 +107574,104 @@ export type Routes = {
107552
107574
  }
107553
107575
  }
107554
107576
  | undefined
107577
+ /** Features for customer portals that use this profile. A setting passed when creating the portal takes precedence over the profile's. Changes apply to existing portals the next time they load. */
107578
+ customer_portal_features?:
107579
+ | {
107580
+ /** Configuration for the connect accounts feature. */
107581
+ connect?:
107582
+ | {
107583
+ /** Whether to exclude this feature from the portal. */
107584
+ exclude?: boolean | undefined
107585
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
107586
+ accepted_providers?: (string[] | undefined) | undefined
107587
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
107588
+ excluded_providers?: (string[] | undefined) | undefined
107589
+ }
107590
+ | undefined
107591
+ /** Configuration for the manage feature. */
107592
+ manage?:
107593
+ | {
107594
+ /** Whether to exclude this feature from the portal. */
107595
+ exclude?: boolean | undefined
107596
+ /** Indicates whether the customer can manage reservations for their properties. */
107597
+ exclude_reservation_management?: boolean | undefined
107598
+ /** Indicates whether to exclude technical details from reservation views. */
107599
+ exclude_reservation_technical_details?: boolean | undefined
107600
+ /** Indicates whether the customer can manage staff for their properties. */
107601
+ exclude_staff_management?: boolean | undefined
107602
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
107603
+ exclude_device_management?: boolean | undefined
107604
+ /** Configuration for event type filtering in the manage feature. */
107605
+ events?:
107606
+ | (
107607
+ | {
107608
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
107609
+ allowed_events?: string[] | undefined
107610
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
107611
+ default_events?: string[] | undefined
107612
+ }
107613
+ | undefined
107614
+ )
107615
+ | undefined
107616
+ /**
107617
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
107618
+ */
107619
+ device_management_confirmation?:
107620
+ | (
107621
+ | {
107622
+ /** Custom title for the confirmation modal. */
107623
+ title?: string | undefined
107624
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
107625
+ body?: string | undefined
107626
+ /** Custom label for the confirm button. */
107627
+ confirm_button_label?: string | undefined
107628
+ /** Custom label for the cancel button. */
107629
+ cancel_button_label?: string | undefined
107630
+ }
107631
+ | undefined
107632
+ )
107633
+ | undefined
107634
+ }
107635
+ | undefined
107636
+ /** Configuration for the manage devices feature.
107637
+ ---
107638
+ deprecated: Use `manage` instead.
107639
+ --- */
107640
+ manage_devices?:
107641
+ | {
107642
+ /** Whether to exclude this feature from the portal. */
107643
+ exclude?: boolean | undefined
107644
+ }
107645
+ | undefined
107646
+ /** Configuration for the organize feature. */
107647
+ organize?:
107648
+ | {
107649
+ /** Whether to exclude this feature from the portal. */
107650
+ exclude?: boolean | undefined
107651
+ }
107652
+ | undefined
107653
+ /** Configuration for the configure feature. */
107654
+ configure?:
107655
+ | {
107656
+ /** Whether to exclude this feature from the portal. */
107657
+ exclude?: boolean | undefined
107658
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
107659
+ allow_access_automation_rule_customization?:
107660
+ boolean | undefined
107661
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
107662
+ allow_climate_automation_rule_customization?:
107663
+ boolean | undefined
107664
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
107665
+ allow_sound_automation_rule_customization?:
107666
+ boolean | undefined
107667
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
107668
+ allow_instant_key_customization?: boolean | undefined
107669
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
107670
+ allow_notification_customization?: boolean | undefined
107671
+ }
107672
+ | undefined
107673
+ }
107674
+ | undefined
107555
107675
  }
107556
107676
  }
107557
107677
  maxDuration: undefined
@@ -111335,6 +111455,19 @@ export type Routes = {
111335
111455
  set_volume_to?: number | undefined
111336
111456
  unmute?: boolean | undefined
111337
111457
  play_chime?: boolean | undefined
111458
+ play_favorite?:
111459
+ | {
111460
+ favorite_id: string
111461
+ shuffle?: boolean | undefined
111462
+ }
111463
+ | undefined
111464
+ play_audio_clip?:
111465
+ | {
111466
+ /** Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself. */
111467
+ audio_url: string
111468
+ volume?: number | undefined
111469
+ }
111470
+ | undefined
111338
111471
  }
111339
111472
  | undefined
111340
111473
  noise_sensors?:
@@ -111546,6 +111679,19 @@ export type Routes = {
111546
111679
  set_volume_to?: number | undefined
111547
111680
  unmute?: boolean | undefined
111548
111681
  play_chime?: boolean | undefined
111682
+ play_favorite?:
111683
+ | {
111684
+ favorite_id: string
111685
+ shuffle?: boolean | undefined
111686
+ }
111687
+ | undefined
111688
+ play_audio_clip?:
111689
+ | {
111690
+ /** Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself. */
111691
+ audio_url: string
111692
+ volume?: number | undefined
111693
+ }
111694
+ | undefined
111549
111695
  }
111550
111696
  | undefined
111551
111697
  noise_sensors?:
@@ -112077,6 +112223,19 @@ export type Routes = {
112077
112223
  set_volume_to?: number | undefined
112078
112224
  unmute?: boolean | undefined
112079
112225
  play_chime?: boolean | undefined
112226
+ play_favorite?:
112227
+ | {
112228
+ favorite_id: string
112229
+ shuffle?: boolean | undefined
112230
+ }
112231
+ | undefined
112232
+ play_audio_clip?:
112233
+ | {
112234
+ /** Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself. */
112235
+ audio_url: string
112236
+ volume?: number | undefined
112237
+ }
112238
+ | undefined
112080
112239
  }
112081
112240
  | undefined
112082
112241
  noise_sensors?:
@@ -112259,6 +112418,19 @@ export type Routes = {
112259
112418
  set_volume_to?: number | undefined
112260
112419
  unmute?: boolean | undefined
112261
112420
  play_chime?: boolean | undefined
112421
+ play_favorite?:
112422
+ | {
112423
+ favorite_id: string
112424
+ shuffle?: boolean | undefined
112425
+ }
112426
+ | undefined
112427
+ play_audio_clip?:
112428
+ | {
112429
+ /** Public HTTPS URL of the MP3 or WAV file to play. The speaker downloads the file itself. */
112430
+ audio_url: string
112431
+ volume?: number | undefined
112432
+ }
112433
+ | undefined
112262
112434
  }
112263
112435
  | undefined
112264
112436
  noise_sensors?:
@@ -116961,84 +117133,6 @@ export type Routes = {
116961
117133
  customer_portal_id: string
116962
117134
  /** Partial portal configuration to merge with the existing configuration. */
116963
117135
  portal_configuration: {
116964
- features?:
116965
- | {
116966
- /** Configuration for the connect accounts feature. */
116967
- connect?: {
116968
- /** Whether to exclude this feature from the portal. */
116969
- exclude?: boolean
116970
- /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
116971
- accepted_providers?: string[] | undefined
116972
- /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
116973
- excluded_providers?: string[] | undefined
116974
- }
116975
- /** Configuration for the manage feature. */
116976
- manage?: {
116977
- /** Whether to exclude this feature from the portal. */
116978
- exclude?: boolean
116979
- /** Indicates whether the customer can manage reservations for their properties. */
116980
- exclude_reservation_management?: boolean
116981
- /** Indicates whether to exclude technical details from reservation views. */
116982
- exclude_reservation_technical_details?: boolean
116983
- /** Indicates whether the customer can manage staff for their properties. */
116984
- exclude_staff_management?: boolean
116985
- /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
116986
- exclude_device_management?: boolean
116987
- /** Configuration for event type filtering in the manage feature. */
116988
- events?:
116989
- | {
116990
- /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
116991
- allowed_events?: string[] | undefined
116992
- /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
116993
- default_events?: string[] | undefined
116994
- }
116995
- | undefined
116996
- /**
116997
- Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
116998
- */
116999
- device_management_confirmation?:
117000
- | {
117001
- /** Custom title for the confirmation modal. */
117002
- title?: string | undefined
117003
- /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
117004
- body?: string | undefined
117005
- /** Custom label for the confirm button. */
117006
- confirm_button_label?: string | undefined
117007
- /** Custom label for the cancel button. */
117008
- cancel_button_label?: string | undefined
117009
- }
117010
- | undefined
117011
- }
117012
- /** Configuration for the manage devices feature.
117013
- ---
117014
- deprecated: Use `manage` instead.
117015
- --- */
117016
- manage_devices?: {
117017
- /** Whether to exclude this feature from the portal. */
117018
- exclude?: boolean
117019
- }
117020
- /** Configuration for the organize feature. */
117021
- organize?: {
117022
- /** Whether to exclude this feature from the portal. */
117023
- exclude?: boolean
117024
- }
117025
- /** Configuration for the configure feature. */
117026
- configure?: {
117027
- /** Whether to exclude this feature from the portal. */
117028
- exclude?: boolean
117029
- /** Indicates whether the customer can customize the access automation rules for their properties. */
117030
- allow_access_automation_rule_customization?: boolean
117031
- /** Indicates whether the customer can customize the climate automation rules for their properties. */
117032
- allow_climate_automation_rule_customization?: boolean
117033
- /** Indicates whether the customer can customize the sound automation rules for their properties. */
117034
- allow_sound_automation_rule_customization?: boolean
117035
- /** Indicates whether the customer can customize the Instant Key profile for their properties. */
117036
- allow_instant_key_customization?: boolean
117037
- /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
117038
- allow_notification_customization?: boolean
117039
- }
117040
- }
117041
- | undefined
117042
117136
  /** Whether the portal is embedded in another application. */
117043
117137
  is_embedded?: boolean | undefined
117044
117138
  /** Whether the portal is read-only. When true, the customer can browse the portal but cannot perform any mutating action; write requests made with the portal's client session are rejected. */
@@ -117160,6 +117254,104 @@ export type Routes = {
117160
117254
  | undefined
117161
117255
  )
117162
117256
  | undefined
117257
+ /** Customer portal features. Settings you omit use the Seam default. */
117258
+ features?:
117259
+ | {
117260
+ /** Configuration for the connect accounts feature. */
117261
+ connect?:
117262
+ | {
117263
+ /** Whether to exclude this feature from the portal. */
117264
+ exclude?: boolean | undefined
117265
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
117266
+ accepted_providers?: (string[] | undefined) | undefined
117267
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
117268
+ excluded_providers?: (string[] | undefined) | undefined
117269
+ }
117270
+ | undefined
117271
+ /** Configuration for the manage feature. */
117272
+ manage?:
117273
+ | {
117274
+ /** Whether to exclude this feature from the portal. */
117275
+ exclude?: boolean | undefined
117276
+ /** Indicates whether the customer can manage reservations for their properties. */
117277
+ exclude_reservation_management?: boolean | undefined
117278
+ /** Indicates whether to exclude technical details from reservation views. */
117279
+ exclude_reservation_technical_details?: boolean | undefined
117280
+ /** Indicates whether the customer can manage staff for their properties. */
117281
+ exclude_staff_management?: boolean | undefined
117282
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
117283
+ exclude_device_management?: boolean | undefined
117284
+ /** Configuration for event type filtering in the manage feature. */
117285
+ events?:
117286
+ | (
117287
+ | {
117288
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
117289
+ allowed_events?: string[] | undefined
117290
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
117291
+ default_events?: string[] | undefined
117292
+ }
117293
+ | undefined
117294
+ )
117295
+ | undefined
117296
+ /**
117297
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
117298
+ */
117299
+ device_management_confirmation?:
117300
+ | (
117301
+ | {
117302
+ /** Custom title for the confirmation modal. */
117303
+ title?: string | undefined
117304
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
117305
+ body?: string | undefined
117306
+ /** Custom label for the confirm button. */
117307
+ confirm_button_label?: string | undefined
117308
+ /** Custom label for the cancel button. */
117309
+ cancel_button_label?: string | undefined
117310
+ }
117311
+ | undefined
117312
+ )
117313
+ | undefined
117314
+ }
117315
+ | undefined
117316
+ /** Configuration for the manage devices feature.
117317
+ ---
117318
+ deprecated: Use `manage` instead.
117319
+ --- */
117320
+ manage_devices?:
117321
+ | {
117322
+ /** Whether to exclude this feature from the portal. */
117323
+ exclude?: boolean | undefined
117324
+ }
117325
+ | undefined
117326
+ /** Configuration for the organize feature. */
117327
+ organize?:
117328
+ | {
117329
+ /** Whether to exclude this feature from the portal. */
117330
+ exclude?: boolean | undefined
117331
+ }
117332
+ | undefined
117333
+ /** Configuration for the configure feature. */
117334
+ configure?:
117335
+ | {
117336
+ /** Whether to exclude this feature from the portal. */
117337
+ exclude?: boolean | undefined
117338
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
117339
+ allow_access_automation_rule_customization?:
117340
+ boolean | undefined
117341
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
117342
+ allow_climate_automation_rule_customization?:
117343
+ boolean | undefined
117344
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
117345
+ allow_sound_automation_rule_customization?:
117346
+ boolean | undefined
117347
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
117348
+ allow_instant_key_customization?: boolean | undefined
117349
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
117350
+ allow_notification_customization?: boolean | undefined
117351
+ }
117352
+ | undefined
117353
+ }
117354
+ | undefined
117163
117355
  }
117164
117356
  }
117165
117357
  commonParams: {}
@@ -184854,6 +185046,104 @@ export type Routes = {
184854
185046
  }
184855
185047
  }
184856
185048
  | undefined
185049
+ /** Features for customer portals that use this profile. Settings passed when creating a portal take precedence. */
185050
+ customer_portal_features?:
185051
+ | {
185052
+ /** Configuration for the connect accounts feature. */
185053
+ connect?:
185054
+ | {
185055
+ /** Whether to exclude this feature from the portal. */
185056
+ exclude?: boolean | undefined
185057
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
185058
+ accepted_providers?: (string[] | undefined) | undefined
185059
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
185060
+ excluded_providers?: (string[] | undefined) | undefined
185061
+ }
185062
+ | undefined
185063
+ /** Configuration for the manage feature. */
185064
+ manage?:
185065
+ | {
185066
+ /** Whether to exclude this feature from the portal. */
185067
+ exclude?: boolean | undefined
185068
+ /** Indicates whether the customer can manage reservations for their properties. */
185069
+ exclude_reservation_management?: boolean | undefined
185070
+ /** Indicates whether to exclude technical details from reservation views. */
185071
+ exclude_reservation_technical_details?: boolean | undefined
185072
+ /** Indicates whether the customer can manage staff for their properties. */
185073
+ exclude_staff_management?: boolean | undefined
185074
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
185075
+ exclude_device_management?: boolean | undefined
185076
+ /** Configuration for event type filtering in the manage feature. */
185077
+ events?:
185078
+ | (
185079
+ | {
185080
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
185081
+ allowed_events?: string[] | undefined
185082
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
185083
+ default_events?: string[] | undefined
185084
+ }
185085
+ | undefined
185086
+ )
185087
+ | undefined
185088
+ /**
185089
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
185090
+ */
185091
+ device_management_confirmation?:
185092
+ | (
185093
+ | {
185094
+ /** Custom title for the confirmation modal. */
185095
+ title?: string | undefined
185096
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
185097
+ body?: string | undefined
185098
+ /** Custom label for the confirm button. */
185099
+ confirm_button_label?: string | undefined
185100
+ /** Custom label for the cancel button. */
185101
+ cancel_button_label?: string | undefined
185102
+ }
185103
+ | undefined
185104
+ )
185105
+ | undefined
185106
+ }
185107
+ | undefined
185108
+ /** Configuration for the manage devices feature.
185109
+ ---
185110
+ deprecated: Use `manage` instead.
185111
+ --- */
185112
+ manage_devices?:
185113
+ | {
185114
+ /** Whether to exclude this feature from the portal. */
185115
+ exclude?: boolean | undefined
185116
+ }
185117
+ | undefined
185118
+ /** Configuration for the organize feature. */
185119
+ organize?:
185120
+ | {
185121
+ /** Whether to exclude this feature from the portal. */
185122
+ exclude?: boolean | undefined
185123
+ }
185124
+ | undefined
185125
+ /** Configuration for the configure feature. */
185126
+ configure?:
185127
+ | {
185128
+ /** Whether to exclude this feature from the portal. */
185129
+ exclude?: boolean | undefined
185130
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
185131
+ allow_access_automation_rule_customization?:
185132
+ boolean | undefined
185133
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
185134
+ allow_climate_automation_rule_customization?:
185135
+ boolean | undefined
185136
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
185137
+ allow_sound_automation_rule_customization?:
185138
+ boolean | undefined
185139
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
185140
+ allow_instant_key_customization?: boolean | undefined
185141
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
185142
+ allow_notification_customization?: boolean | undefined
185143
+ }
185144
+ | undefined
185145
+ }
185146
+ | undefined
184857
185147
  }
184858
185148
  commonParams: {}
184859
185149
  formData: {}
@@ -185017,6 +185307,104 @@ export type Routes = {
185017
185307
  }
185018
185308
  }
185019
185309
  | undefined
185310
+ /** Features for customer portals that use this profile. A setting passed when creating the portal takes precedence over the profile's. Changes apply to existing portals the next time they load. */
185311
+ customer_portal_features?:
185312
+ | {
185313
+ /** Configuration for the connect accounts feature. */
185314
+ connect?:
185315
+ | {
185316
+ /** Whether to exclude this feature from the portal. */
185317
+ exclude?: boolean | undefined
185318
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
185319
+ accepted_providers?: (string[] | undefined) | undefined
185320
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
185321
+ excluded_providers?: (string[] | undefined) | undefined
185322
+ }
185323
+ | undefined
185324
+ /** Configuration for the manage feature. */
185325
+ manage?:
185326
+ | {
185327
+ /** Whether to exclude this feature from the portal. */
185328
+ exclude?: boolean | undefined
185329
+ /** Indicates whether the customer can manage reservations for their properties. */
185330
+ exclude_reservation_management?: boolean | undefined
185331
+ /** Indicates whether to exclude technical details from reservation views. */
185332
+ exclude_reservation_technical_details?: boolean | undefined
185333
+ /** Indicates whether the customer can manage staff for their properties. */
185334
+ exclude_staff_management?: boolean | undefined
185335
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
185336
+ exclude_device_management?: boolean | undefined
185337
+ /** Configuration for event type filtering in the manage feature. */
185338
+ events?:
185339
+ | (
185340
+ | {
185341
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
185342
+ allowed_events?: string[] | undefined
185343
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
185344
+ default_events?: string[] | undefined
185345
+ }
185346
+ | undefined
185347
+ )
185348
+ | undefined
185349
+ /**
185350
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
185351
+ */
185352
+ device_management_confirmation?:
185353
+ | (
185354
+ | {
185355
+ /** Custom title for the confirmation modal. */
185356
+ title?: string | undefined
185357
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
185358
+ body?: string | undefined
185359
+ /** Custom label for the confirm button. */
185360
+ confirm_button_label?: string | undefined
185361
+ /** Custom label for the cancel button. */
185362
+ cancel_button_label?: string | undefined
185363
+ }
185364
+ | undefined
185365
+ )
185366
+ | undefined
185367
+ }
185368
+ | undefined
185369
+ /** Configuration for the manage devices feature.
185370
+ ---
185371
+ deprecated: Use `manage` instead.
185372
+ --- */
185373
+ manage_devices?:
185374
+ | {
185375
+ /** Whether to exclude this feature from the portal. */
185376
+ exclude?: boolean | undefined
185377
+ }
185378
+ | undefined
185379
+ /** Configuration for the organize feature. */
185380
+ organize?:
185381
+ | {
185382
+ /** Whether to exclude this feature from the portal. */
185383
+ exclude?: boolean | undefined
185384
+ }
185385
+ | undefined
185386
+ /** Configuration for the configure feature. */
185387
+ configure?:
185388
+ | {
185389
+ /** Whether to exclude this feature from the portal. */
185390
+ exclude?: boolean | undefined
185391
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
185392
+ allow_access_automation_rule_customization?:
185393
+ boolean | undefined
185394
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
185395
+ allow_climate_automation_rule_customization?:
185396
+ boolean | undefined
185397
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
185398
+ allow_sound_automation_rule_customization?:
185399
+ boolean | undefined
185400
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
185401
+ allow_instant_key_customization?: boolean | undefined
185402
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
185403
+ allow_notification_customization?: boolean | undefined
185404
+ }
185405
+ | undefined
185406
+ }
185407
+ | undefined
185020
185408
  }
185021
185409
  }
185022
185410
  maxDuration: undefined
@@ -185190,6 +185578,104 @@ export type Routes = {
185190
185578
  }
185191
185579
  }
185192
185580
  | undefined
185581
+ /** Features for customer portals that use this profile. A setting passed when creating the portal takes precedence over the profile's. Changes apply to existing portals the next time they load. */
185582
+ customer_portal_features?:
185583
+ | {
185584
+ /** Configuration for the connect accounts feature. */
185585
+ connect?:
185586
+ | {
185587
+ /** Whether to exclude this feature from the portal. */
185588
+ exclude?: boolean | undefined
185589
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
185590
+ accepted_providers?: (string[] | undefined) | undefined
185591
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
185592
+ excluded_providers?: (string[] | undefined) | undefined
185593
+ }
185594
+ | undefined
185595
+ /** Configuration for the manage feature. */
185596
+ manage?:
185597
+ | {
185598
+ /** Whether to exclude this feature from the portal. */
185599
+ exclude?: boolean | undefined
185600
+ /** Indicates whether the customer can manage reservations for their properties. */
185601
+ exclude_reservation_management?: boolean | undefined
185602
+ /** Indicates whether to exclude technical details from reservation views. */
185603
+ exclude_reservation_technical_details?: boolean | undefined
185604
+ /** Indicates whether the customer can manage staff for their properties. */
185605
+ exclude_staff_management?: boolean | undefined
185606
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
185607
+ exclude_device_management?: boolean | undefined
185608
+ /** Configuration for event type filtering in the manage feature. */
185609
+ events?:
185610
+ | (
185611
+ | {
185612
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
185613
+ allowed_events?: string[] | undefined
185614
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
185615
+ default_events?: string[] | undefined
185616
+ }
185617
+ | undefined
185618
+ )
185619
+ | undefined
185620
+ /**
185621
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
185622
+ */
185623
+ device_management_confirmation?:
185624
+ | (
185625
+ | {
185626
+ /** Custom title for the confirmation modal. */
185627
+ title?: string | undefined
185628
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
185629
+ body?: string | undefined
185630
+ /** Custom label for the confirm button. */
185631
+ confirm_button_label?: string | undefined
185632
+ /** Custom label for the cancel button. */
185633
+ cancel_button_label?: string | undefined
185634
+ }
185635
+ | undefined
185636
+ )
185637
+ | undefined
185638
+ }
185639
+ | undefined
185640
+ /** Configuration for the manage devices feature.
185641
+ ---
185642
+ deprecated: Use `manage` instead.
185643
+ --- */
185644
+ manage_devices?:
185645
+ | {
185646
+ /** Whether to exclude this feature from the portal. */
185647
+ exclude?: boolean | undefined
185648
+ }
185649
+ | undefined
185650
+ /** Configuration for the organize feature. */
185651
+ organize?:
185652
+ | {
185653
+ /** Whether to exclude this feature from the portal. */
185654
+ exclude?: boolean | undefined
185655
+ }
185656
+ | undefined
185657
+ /** Configuration for the configure feature. */
185658
+ configure?:
185659
+ | {
185660
+ /** Whether to exclude this feature from the portal. */
185661
+ exclude?: boolean | undefined
185662
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
185663
+ allow_access_automation_rule_customization?:
185664
+ boolean | undefined
185665
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
185666
+ allow_climate_automation_rule_customization?:
185667
+ boolean | undefined
185668
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
185669
+ allow_sound_automation_rule_customization?:
185670
+ boolean | undefined
185671
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
185672
+ allow_instant_key_customization?: boolean | undefined
185673
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
185674
+ allow_notification_customization?: boolean | undefined
185675
+ }
185676
+ | undefined
185677
+ }
185678
+ | undefined
185193
185679
  }
185194
185680
  }
185195
185681
  maxDuration: undefined
@@ -185363,6 +185849,104 @@ export type Routes = {
185363
185849
  }
185364
185850
  }
185365
185851
  | undefined
185852
+ /** Features for customer portals that use this profile. A setting passed when creating the portal takes precedence over the profile's. Changes apply to existing portals the next time they load. */
185853
+ customer_portal_features?:
185854
+ | {
185855
+ /** Configuration for the connect accounts feature. */
185856
+ connect?:
185857
+ | {
185858
+ /** Whether to exclude this feature from the portal. */
185859
+ exclude?: boolean | undefined
185860
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
185861
+ accepted_providers?: (string[] | undefined) | undefined
185862
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
185863
+ excluded_providers?: (string[] | undefined) | undefined
185864
+ }
185865
+ | undefined
185866
+ /** Configuration for the manage feature. */
185867
+ manage?:
185868
+ | {
185869
+ /** Whether to exclude this feature from the portal. */
185870
+ exclude?: boolean | undefined
185871
+ /** Indicates whether the customer can manage reservations for their properties. */
185872
+ exclude_reservation_management?: boolean | undefined
185873
+ /** Indicates whether to exclude technical details from reservation views. */
185874
+ exclude_reservation_technical_details?: boolean | undefined
185875
+ /** Indicates whether the customer can manage staff for their properties. */
185876
+ exclude_staff_management?: boolean | undefined
185877
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
185878
+ exclude_device_management?: boolean | undefined
185879
+ /** Configuration for event type filtering in the manage feature. */
185880
+ events?:
185881
+ | (
185882
+ | {
185883
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
185884
+ allowed_events?: string[] | undefined
185885
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
185886
+ default_events?: string[] | undefined
185887
+ }
185888
+ | undefined
185889
+ )
185890
+ | undefined
185891
+ /**
185892
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
185893
+ */
185894
+ device_management_confirmation?:
185895
+ | (
185896
+ | {
185897
+ /** Custom title for the confirmation modal. */
185898
+ title?: string | undefined
185899
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
185900
+ body?: string | undefined
185901
+ /** Custom label for the confirm button. */
185902
+ confirm_button_label?: string | undefined
185903
+ /** Custom label for the cancel button. */
185904
+ cancel_button_label?: string | undefined
185905
+ }
185906
+ | undefined
185907
+ )
185908
+ | undefined
185909
+ }
185910
+ | undefined
185911
+ /** Configuration for the manage devices feature.
185912
+ ---
185913
+ deprecated: Use `manage` instead.
185914
+ --- */
185915
+ manage_devices?:
185916
+ | {
185917
+ /** Whether to exclude this feature from the portal. */
185918
+ exclude?: boolean | undefined
185919
+ }
185920
+ | undefined
185921
+ /** Configuration for the organize feature. */
185922
+ organize?:
185923
+ | {
185924
+ /** Whether to exclude this feature from the portal. */
185925
+ exclude?: boolean | undefined
185926
+ }
185927
+ | undefined
185928
+ /** Configuration for the configure feature. */
185929
+ configure?:
185930
+ | {
185931
+ /** Whether to exclude this feature from the portal. */
185932
+ exclude?: boolean | undefined
185933
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
185934
+ allow_access_automation_rule_customization?:
185935
+ boolean | undefined
185936
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
185937
+ allow_climate_automation_rule_customization?:
185938
+ boolean | undefined
185939
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
185940
+ allow_sound_automation_rule_customization?:
185941
+ boolean | undefined
185942
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
185943
+ allow_instant_key_customization?: boolean | undefined
185944
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
185945
+ allow_notification_customization?: boolean | undefined
185946
+ }
185947
+ | undefined
185948
+ }
185949
+ | undefined
185366
185950
  }[]
185367
185951
  }
185368
185952
  maxDuration: undefined
@@ -185530,6 +186114,108 @@ export type Routes = {
185530
186114
  | undefined
185531
186115
  )
185532
186116
  | null
186117
+ /** Features for customer portals that use this profile. Replaces the profile's current features; pass `null` to remove them. Portals pick up the change the next time they load. */
186118
+ customer_portal_features?:
186119
+ | (
186120
+ | {
186121
+ /** Configuration for the connect accounts feature. */
186122
+ connect?:
186123
+ | {
186124
+ /** Whether to exclude this feature from the portal. */
186125
+ exclude?: boolean | undefined
186126
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
186127
+ accepted_providers?: (string[] | undefined) | undefined
186128
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
186129
+ excluded_providers?: (string[] | undefined) | undefined
186130
+ }
186131
+ | undefined
186132
+ /** Configuration for the manage feature. */
186133
+ manage?:
186134
+ | {
186135
+ /** Whether to exclude this feature from the portal. */
186136
+ exclude?: boolean | undefined
186137
+ /** Indicates whether the customer can manage reservations for their properties. */
186138
+ exclude_reservation_management?: boolean | undefined
186139
+ /** Indicates whether to exclude technical details from reservation views. */
186140
+ exclude_reservation_technical_details?:
186141
+ boolean | undefined
186142
+ /** Indicates whether the customer can manage staff for their properties. */
186143
+ exclude_staff_management?: boolean | undefined
186144
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
186145
+ exclude_device_management?: boolean | undefined
186146
+ /** Configuration for event type filtering in the manage feature. */
186147
+ events?:
186148
+ | (
186149
+ | {
186150
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
186151
+ allowed_events?: string[] | undefined
186152
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
186153
+ default_events?: string[] | undefined
186154
+ }
186155
+ | undefined
186156
+ )
186157
+ | undefined
186158
+ /**
186159
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
186160
+ */
186161
+ device_management_confirmation?:
186162
+ | (
186163
+ | {
186164
+ /** Custom title for the confirmation modal. */
186165
+ title?: string | undefined
186166
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
186167
+ body?: string | undefined
186168
+ /** Custom label for the confirm button. */
186169
+ confirm_button_label?: string | undefined
186170
+ /** Custom label for the cancel button. */
186171
+ cancel_button_label?: string | undefined
186172
+ }
186173
+ | undefined
186174
+ )
186175
+ | undefined
186176
+ }
186177
+ | undefined
186178
+ /** Configuration for the manage devices feature.
186179
+ ---
186180
+ deprecated: Use `manage` instead.
186181
+ --- */
186182
+ manage_devices?:
186183
+ | {
186184
+ /** Whether to exclude this feature from the portal. */
186185
+ exclude?: boolean | undefined
186186
+ }
186187
+ | undefined
186188
+ /** Configuration for the organize feature. */
186189
+ organize?:
186190
+ | {
186191
+ /** Whether to exclude this feature from the portal. */
186192
+ exclude?: boolean | undefined
186193
+ }
186194
+ | undefined
186195
+ /** Configuration for the configure feature. */
186196
+ configure?:
186197
+ | {
186198
+ /** Whether to exclude this feature from the portal. */
186199
+ exclude?: boolean | undefined
186200
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
186201
+ allow_access_automation_rule_customization?:
186202
+ boolean | undefined
186203
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
186204
+ allow_climate_automation_rule_customization?:
186205
+ boolean | undefined
186206
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
186207
+ allow_sound_automation_rule_customization?:
186208
+ boolean | undefined
186209
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
186210
+ allow_instant_key_customization?: boolean | undefined
186211
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
186212
+ allow_notification_customization?: boolean | undefined
186213
+ }
186214
+ | undefined
186215
+ }
186216
+ | undefined
186217
+ )
186218
+ | null
185533
186219
  is_workspace_default?: boolean | undefined
185534
186220
  }
185535
186221
  commonParams: {}
@@ -198921,6 +199607,107 @@ export type Routes = {
198921
199607
  }
198922
199608
  }
198923
199609
  | undefined
199610
+ /** Features for customer portals that use this profile. A setting passed when creating the portal takes precedence over the profile's. Changes apply to existing portals the next time they load. */
199611
+ customer_portal_features?:
199612
+ | {
199613
+ /** Configuration for the connect accounts feature. */
199614
+ connect?:
199615
+ | {
199616
+ /** Whether to exclude this feature from the portal. */
199617
+ exclude?: boolean | undefined
199618
+ /** List of provider keys to allow for the connect feature. These providers will be shown when the customer tries to connect an account. */
199619
+ accepted_providers?:
199620
+ (string[] | undefined) | undefined
199621
+ /** List of provider keys to exclude from the connect feature. These providers will not be shown when the customer tries to connect an account. */
199622
+ excluded_providers?:
199623
+ (string[] | undefined) | undefined
199624
+ }
199625
+ | undefined
199626
+ /** Configuration for the manage feature. */
199627
+ manage?:
199628
+ | {
199629
+ /** Whether to exclude this feature from the portal. */
199630
+ exclude?: boolean | undefined
199631
+ /** Indicates whether the customer can manage reservations for their properties. */
199632
+ exclude_reservation_management?: boolean | undefined
199633
+ /** Indicates whether to exclude technical details from reservation views. */
199634
+ exclude_reservation_technical_details?:
199635
+ boolean | undefined
199636
+ /** Indicates whether the customer can manage staff for their properties. */
199637
+ exclude_staff_management?: boolean | undefined
199638
+ /** Indicates whether to prevent the customer from converting their devices between managed and unmanaged. Managed devices are billed. */
199639
+ exclude_device_management?: boolean | undefined
199640
+ /** Configuration for event type filtering in the manage feature. */
199641
+ events?:
199642
+ | (
199643
+ | {
199644
+ /** List of event types to show in the events filter. When set, only these event types will be available. Leave empty to show all events. */
199645
+ allowed_events?: string[] | undefined
199646
+ /** List of event types that are pre-selected in the events filter when the user first loads the events tab. */
199647
+ default_events?: string[] | undefined
199648
+ }
199649
+ | undefined
199650
+ )
199651
+ | undefined
199652
+ /**
199653
+ Custom copy for the confirmation modal shown before unmanaged devices are added to a space and begin being managed (and billed). Only takes effect when the MANAGE_DEVICES_CONFIRMATION_MODAL feature flag is enabled for the workspace. Any omitted string falls back to a localized default.
199654
+ */
199655
+ device_management_confirmation?:
199656
+ | (
199657
+ | {
199658
+ /** Custom title for the confirmation modal. */
199659
+ title?: string | undefined
199660
+ /** Custom body text for the confirmation modal. May include the {count} token, which is replaced with the number of devices that will begin being managed. */
199661
+ body?: string | undefined
199662
+ /** Custom label for the confirm button. */
199663
+ confirm_button_label?: string | undefined
199664
+ /** Custom label for the cancel button. */
199665
+ cancel_button_label?: string | undefined
199666
+ }
199667
+ | undefined
199668
+ )
199669
+ | undefined
199670
+ }
199671
+ | undefined
199672
+ /** Configuration for the manage devices feature.
199673
+ ---
199674
+ deprecated: Use `manage` instead.
199675
+ --- */
199676
+ manage_devices?:
199677
+ | {
199678
+ /** Whether to exclude this feature from the portal. */
199679
+ exclude?: boolean | undefined
199680
+ }
199681
+ | undefined
199682
+ /** Configuration for the organize feature. */
199683
+ organize?:
199684
+ | {
199685
+ /** Whether to exclude this feature from the portal. */
199686
+ exclude?: boolean | undefined
199687
+ }
199688
+ | undefined
199689
+ /** Configuration for the configure feature. */
199690
+ configure?:
199691
+ | {
199692
+ /** Whether to exclude this feature from the portal. */
199693
+ exclude?: boolean | undefined
199694
+ /** Indicates whether the customer can customize the access automation rules for their properties. */
199695
+ allow_access_automation_rule_customization?:
199696
+ boolean | undefined
199697
+ /** Indicates whether the customer can customize the climate automation rules for their properties. */
199698
+ allow_climate_automation_rule_customization?:
199699
+ boolean | undefined
199700
+ /** Indicates whether the customer can customize the sound automation rules for their properties. */
199701
+ allow_sound_automation_rule_customization?:
199702
+ boolean | undefined
199703
+ /** Indicates whether the customer can customize the Instant Key profile for their properties. */
199704
+ allow_instant_key_customization?: boolean | undefined
199705
+ /** Indicates whether the customer can customize their notification settings, such as the low-battery alert threshold. */
199706
+ allow_notification_customization?: boolean | undefined
199707
+ }
199708
+ | undefined
199709
+ }
199710
+ | undefined
198924
199711
  }[]
198925
199712
  | undefined
198926
199713
  }