@seamapi/types 1.410.1 → 1.411.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.
@@ -48460,7 +48460,7 @@ export interface Routes {
48460
48460
  method: 'DELETE' | 'POST'
48461
48461
  queryParams: {}
48462
48462
  jsonBody: {
48463
- /** Device ID of the desired phone. */
48463
+ /** Device ID of the phone that you want to deactivate. */
48464
48464
  device_id: string
48465
48465
  }
48466
48466
  commonParams: {}
@@ -48473,7 +48473,7 @@ export interface Routes {
48473
48473
  queryParams: {}
48474
48474
  jsonBody: {}
48475
48475
  commonParams: {
48476
- /** Device ID of the desired phone. */
48476
+ /** Device ID of the phone that you want to get. */
48477
48477
  device_id: string
48478
48478
  }
48479
48479
  formData: {}
@@ -48546,9 +48546,9 @@ export interface Routes {
48546
48546
  queryParams: {}
48547
48547
  jsonBody: {}
48548
48548
  commonParams: {
48549
- /** ID of the user identity that represents the owner by which to filter the list of returned phones. */
48549
+ /** ID of the user identity that represents the owner by which you want to filter the list of returned phones. */
48550
48550
  owner_user_identity_id?: string | undefined
48551
- /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones. */
48551
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which you want to filter the list of returned phones. */
48552
48552
  acs_credential_id?: string | undefined
48553
48553
  }
48554
48554
  formData: {}
@@ -48619,11 +48619,11 @@ export interface Routes {
48619
48619
  method: 'GET' | 'POST'
48620
48620
  queryParams: {}
48621
48621
  jsonBody: {
48622
- /** ID of the custom SDK installation to use for the simulated phone. */
48622
+ /** ID of the custom SDK installation that you want to use for the simulated phone. */
48623
48623
  custom_sdk_installation_id?: string | undefined
48624
- /** ID of the user identity to associate with the simulated phone. */
48624
+ /** ID of the user identity that you want to associate with the simulated phone. */
48625
48625
  user_identity_id: string
48626
- /** Metadata to associate with the simulated phone. */
48626
+ /** Metadata that you want to associate with the simulated phone. */
48627
48627
  phone_metadata?: {
48628
48628
  /** Mobile operating system that you want to use for the simulated phone. */
48629
48629
  operating_system?: 'android' | 'ios'
@@ -48634,7 +48634,7 @@ export interface Routes {
48634
48634
  /** Device model that you want to use for the simulated phone. */
48635
48635
  device_model?: string
48636
48636
  }
48637
- /** ASSA ABLOY metadata to associate with the simulated phone. */
48637
+ /** ASSA ABLOY metadata that you want to associate with the simulated phone. */
48638
48638
  assa_abloy_metadata?: {
48639
48639
  /** Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability. */
48640
48640
  ble_capability?: boolean
@@ -48720,8 +48720,11 @@ export interface Routes {
48720
48720
  method: 'POST'
48721
48721
  queryParams: {}
48722
48722
  jsonBody: {
48723
+ /** Name of the Seam Bridge client that you want to create. */
48723
48724
  bridge_client_name: string
48725
+ /** Time zone for the Seam Bridge that you want to create. */
48724
48726
  bridge_client_time_zone: string
48727
+ /** Identifier key of the client machine for the Seam Bridge client that you want to create. */
48725
48728
  bridge_client_machine_identifier_key: string
48726
48729
  }
48727
48730
  commonParams: {}
@@ -48924,7 +48927,9 @@ export interface Routes {
48924
48927
  method: 'POST'
48925
48928
  queryParams: {}
48926
48929
  jsonBody: {
48930
+ /** Indicates whether Tailscale is connected. */
48927
48931
  is_tailscale_connected: boolean | null
48932
+ /** Tailscale IPv4 address. */
48928
48933
  tailscale_ip_v4: string | null
48929
48934
  }
48930
48935
  commonParams: {}
@@ -48956,7 +48961,7 @@ export interface Routes {
48956
48961
  method: 'POST'
48957
48962
  queryParams: {}
48958
48963
  jsonBody: {
48959
- /** The short code to exchange for a client session token */
48964
+ /** Short code that you want to exchange for a client session token. */
48960
48965
  short_code: string
48961
48966
  }
48962
48967
  commonParams: {}
@@ -49140,8 +49145,11 @@ export interface Routes {
49140
49145
  method: 'POST'
49141
49146
  queryParams: {}
49142
49147
  jsonBody: {
49148
+ /** ID of the custom SDK installation that you want to use for the new session. */
49143
49149
  custom_sdk_installation_id: string
49150
+ /** Phone operating system that you want to use for the new session. */
49144
49151
  phone_os: 'ios' | 'android'
49152
+ /** Phone device metadata that you want to use for the new session. */
49145
49153
  phone_device_metadata?:
49146
49154
  | {
49147
49155
  os_version?: string | undefined
@@ -49400,6 +49408,7 @@ export interface Routes {
49400
49408
  queryParams: {}
49401
49409
  jsonBody: {}
49402
49410
  commonParams: {
49411
+ /** Collection key. */
49403
49412
  collection_key: string
49404
49413
  }
49405
49414
  formData: {}
@@ -49426,7 +49435,7 @@ export interface Routes {
49426
49435
  queryParams: {}
49427
49436
  jsonBody: {}
49428
49437
  commonParams: {
49429
- /** Filter by resource type alias. */
49438
+ /** Resource type alias by which you want to filter partner resources. */
49430
49439
  resource_type_alias?: string | undefined
49431
49440
  }
49432
49441
  formData: {}
@@ -49452,7 +49461,9 @@ export interface Routes {
49452
49461
  method: 'POST' | 'PUT'
49453
49462
  queryParams: {}
49454
49463
  jsonBody: {
49464
+ /** ID of the space to which you want to add entrances. */
49455
49465
  space_id: string
49466
+ /** IDs of the entrances that you want to add to the space. */
49456
49467
  acs_entrance_ids: string[]
49457
49468
  }
49458
49469
  commonParams: {}
@@ -49464,7 +49475,9 @@ export interface Routes {
49464
49475
  method: 'POST' | 'PUT'
49465
49476
  queryParams: {}
49466
49477
  jsonBody: {
49478
+ /** ID of the space to which you want to add devices. */
49467
49479
  space_id: string
49480
+ /** IDs of the devices that you want to add to the space. */
49468
49481
  device_ids: string[]
49469
49482
  }
49470
49483
  commonParams: {}
@@ -49476,8 +49489,11 @@ export interface Routes {
49476
49489
  method: 'POST'
49477
49490
  queryParams: {}
49478
49491
  jsonBody: {
49492
+ /** Name of the space that you want to create. */
49479
49493
  name: string
49494
+ /** IDs of the devices that you want to add to the new space. */
49480
49495
  device_ids?: string[] | undefined
49496
+ /** IDs of the entrances that you want to add to the new space. */
49481
49497
  acs_entrance_ids?: string[] | undefined
49482
49498
  }
49483
49499
  commonParams: {}
@@ -49503,6 +49519,7 @@ export interface Routes {
49503
49519
  method: 'DELETE' | 'POST'
49504
49520
  queryParams: {}
49505
49521
  jsonBody: {
49522
+ /** ID of the space that you want to delete. */
49506
49523
  space_id: string
49507
49524
  }
49508
49525
  commonParams: {}
@@ -49515,6 +49532,7 @@ export interface Routes {
49515
49532
  queryParams: {}
49516
49533
  jsonBody: {}
49517
49534
  commonParams: {
49535
+ /** ID of the space that you want to get. */
49518
49536
  space_id: string
49519
49537
  }
49520
49538
  formData: {}
@@ -49562,7 +49580,9 @@ export interface Routes {
49562
49580
  queryParams: {}
49563
49581
  jsonBody: {}
49564
49582
  commonParams: {
49583
+ /** ID of the space from which you want to remove entrances. */
49565
49584
  space_id: string
49585
+ /** IDs of the entrances that you want to remove from the space. */
49566
49586
  acs_entrance_ids: string[]
49567
49587
  }
49568
49588
  formData: {}
@@ -49574,7 +49594,9 @@ export interface Routes {
49574
49594
  queryParams: {}
49575
49595
  jsonBody: {}
49576
49596
  commonParams: {
49597
+ /** ID of the space from which you want to remove devices. */
49577
49598
  space_id: string
49599
+ /** IDs of the devices that you want to remove from the space. */
49578
49600
  device_ids: string[]
49579
49601
  }
49580
49602
  formData: {}
@@ -49585,7 +49607,9 @@ export interface Routes {
49585
49607
  method: 'POST' | 'PATCH'
49586
49608
  queryParams: {}
49587
49609
  jsonBody: {
49610
+ /** ID of the space that you want to update. */
49588
49611
  space_id: string
49612
+ /** Name of the space. */
49589
49613
  name?: string | undefined
49590
49614
  }
49591
49615
  commonParams: {}
@@ -50920,9 +50944,9 @@ export interface Routes {
50920
50944
  jsonBody: {
50921
50945
  /** ID of the thermostat device that you want to set to cool mode. */
50922
50946
  device_id: string
50923
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
50947
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
50924
50948
  cooling_set_point_celsius?: number | undefined
50925
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
50949
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
50926
50950
  cooling_set_point_fahrenheit?: number | undefined
50927
50951
  /** */
50928
50952
  sync?: boolean
@@ -52262,7 +52286,7 @@ export interface Routes {
52262
52286
  jsonBody: {
52263
52287
  /** ID of the thermostat device for which you want to create a daily program. */
52264
52288
  device_id: string
52265
- /** User-friendly name to identify the thermostat daily program. */
52289
+ /** Name of the thermostat daily program. */
52266
52290
  name: string
52267
52291
  /** Array of thermostat daily program periods. */
52268
52292
  periods: Array<{
@@ -52316,7 +52340,7 @@ export interface Routes {
52316
52340
  jsonBody: {
52317
52341
  /** ID of the thermostat daily program that you want to update. */
52318
52342
  thermostat_daily_program_id: string
52319
- /** User-friendly name to identify the thermostat daily program that you want to update. */
52343
+ /** Name of the thermostat daily program that you want to update. */
52320
52344
  name: string
52321
52345
  /** Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. */
52322
52346
  periods: Array<{
@@ -53643,9 +53667,9 @@ export interface Routes {
53643
53667
  queryParams: {}
53644
53668
  jsonBody: {}
53645
53669
  commonParams: {
53646
- /** ID of the thermostat device that you want to retrieve. */
53670
+ /** ID of the thermostat device that you want to get. */
53647
53671
  device_id?: string | undefined
53648
- /** User-friendly name of the thermostat device that you want to retrieve. */
53672
+ /** Name of the thermostat device that you want to retrieve. */
53649
53673
  name?: string | undefined
53650
53674
  }
53651
53675
  formData: {}
@@ -55098,9 +55122,9 @@ export interface Routes {
55098
55122
  jsonBody: {
55099
55123
  /** ID of the thermostat device that you want to set to heat mode. */
55100
55124
  device_id: string
55101
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
55125
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
55102
55126
  heating_set_point_celsius?: number | undefined
55103
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
55127
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
55104
55128
  heating_set_point_fahrenheit?: number | undefined
55105
55129
  /** */
55106
55130
  sync?: boolean
@@ -56409,13 +56433,13 @@ export interface Routes {
56409
56433
  jsonBody: {
56410
56434
  /** ID of the thermostat device that you want to set to heat-cool mode. */
56411
56435
  device_id: string
56412
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
56436
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
56413
56437
  heating_set_point_celsius?: number | undefined
56414
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
56438
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
56415
56439
  heating_set_point_fahrenheit?: number | undefined
56416
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
56440
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
56417
56441
  cooling_set_point_celsius?: number | undefined
56418
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
56442
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
56419
56443
  cooling_set_point_fahrenheit?: number | undefined
56420
56444
  /** */
56421
56445
  sync?: boolean
@@ -57730,7 +57754,7 @@ export interface Routes {
57730
57754
  connected_account_ids?: string[] | undefined
57731
57755
  /** ID of the Connect Webview for which you want to list devices. */
57732
57756
  connect_webview_id?: string | undefined
57733
- /** Device type by which to filter thermostat devices. */
57757
+ /** Device type by which you want to filter thermostat devices. */
57734
57758
  device_type?:
57735
57759
  | (
57736
57760
  | 'ecobee_thermostat'
@@ -57741,7 +57765,7 @@ export interface Routes {
57741
57765
  | 'smartthings_thermostat'
57742
57766
  )
57743
57767
  | undefined
57744
- /** Array of device types by which to filter thermostat devices. */
57768
+ /** Array of device types by which you want to filter thermostat devices. */
57745
57769
  device_types?:
57746
57770
  | Array<
57747
57771
  | 'ecobee_thermostat'
@@ -57752,7 +57776,7 @@ export interface Routes {
57752
57776
  | 'smartthings_thermostat'
57753
57777
  >
57754
57778
  | undefined
57755
- /** Manufacturer by which to filter thermostat devices. */
57779
+ /** Manufacturer by which you want to filter thermostat devices. */
57756
57780
  manufacturer?:
57757
57781
  | (
57758
57782
  | 'ecobee'
@@ -62005,19 +62029,19 @@ export interface Routes {
62005
62029
  method: 'POST'
62006
62030
  queryParams: {}
62007
62031
  jsonBody: {
62008
- /** ID of the desired thermostat device. */
62032
+ /** ID of the thermostat device for which you want to create a schedule. */
62009
62033
  device_id: string
62010
- /** User-friendly name to identify the thermostat schedule. */
62034
+ /** Name of the thermostat schedule. */
62011
62035
  name?: string | undefined
62012
- /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
62036
+ /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the new thermostat schedule. */
62013
62037
  climate_preset_key: string
62014
62038
  /** Number of minutes for which a person at the thermostat or using the API can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
62015
62039
  max_override_period_minutes?: (number | null) | undefined
62016
- /** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
62040
+ /** Date and time at which the new thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
62017
62041
  starts_at: string
62018
- /** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
62042
+ /** Date and time at which the new thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
62019
62043
  ends_at: string
62020
- /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
62044
+ /** Indicates whether a person at the thermostat or using the API can change the thermostat's settings while the new schedule is active. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
62021
62045
  is_override_allowed?: boolean | undefined
62022
62046
  }
62023
62047
  commonParams: {}
@@ -62061,7 +62085,7 @@ export interface Routes {
62061
62085
  queryParams: {}
62062
62086
  jsonBody: {}
62063
62087
  commonParams: {
62064
- /** ID of the desired thermostat schedule. */
62088
+ /** ID of the thermostat schedule that you want to delete. */
62065
62089
  thermostat_schedule_id: string
62066
62090
  }
62067
62091
  formData: {}
@@ -62073,7 +62097,7 @@ export interface Routes {
62073
62097
  queryParams: {}
62074
62098
  jsonBody: {}
62075
62099
  commonParams: {
62076
- /** ID of the desired thermostat schedule. */
62100
+ /** ID of the thermostat schedule that you want to get. */
62077
62101
  thermostat_schedule_id: string
62078
62102
  }
62079
62103
  formData: {}
@@ -62116,7 +62140,7 @@ export interface Routes {
62116
62140
  queryParams: {}
62117
62141
  jsonBody: {}
62118
62142
  commonParams: {
62119
- /** ID of the desired thermostat device. */
62143
+ /** ID of the thermostat device for which you want to list schedules. */
62120
62144
  device_id: string
62121
62145
  /** User identifier key by which to filter the list of returned thermostat schedules. */
62122
62146
  user_identifier_key?: string | undefined
@@ -62159,9 +62183,9 @@ export interface Routes {
62159
62183
  method: 'PATCH' | 'POST'
62160
62184
  queryParams: {}
62161
62185
  jsonBody: {
62162
- /** ID of the desired thermostat schedule. */
62186
+ /** ID of the thermostat schedule that you want to update. */
62163
62187
  thermostat_schedule_id: string
62164
- /** User-friendly name to identify the thermostat schedule. */
62188
+ /** Name of the thermostat schedule. */
62165
62189
  name?: string | undefined
62166
62190
  /** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
62167
62191
  climate_preset_key?: string | undefined
@@ -62202,7 +62226,7 @@ export interface Routes {
62202
62226
  /**
62203
62227
  * @deprecated Use `fan_mode_setting` instead. */
62204
62228
  fan_mode?: ('auto' | 'on' | 'circulate') | undefined
62205
- /** Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) for the thermostat. */
62229
+ /** [Fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings) that you want to set for the thermostat. */
62206
62230
  fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined
62207
62231
  /** */
62208
62232
  sync?: boolean
@@ -63518,31 +63542,31 @@ export interface Routes {
63518
63542
  hvac_mode_setting: 'cool'
63519
63543
  /** ID of the thermostat device for which you want to set the HVAC mode. */
63520
63544
  device_id: string
63521
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
63545
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
63522
63546
  cooling_set_point_celsius?: number | undefined
63523
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
63547
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
63524
63548
  cooling_set_point_fahrenheit?: number | undefined
63525
63549
  }
63526
63550
  | {
63527
63551
  hvac_mode_setting: 'heat'
63528
63552
  /** ID of the thermostat device for which you want to set the HVAC mode. */
63529
63553
  device_id: string
63530
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
63554
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
63531
63555
  heating_set_point_celsius?: number | undefined
63532
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
63556
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
63533
63557
  heating_set_point_fahrenheit?: number | undefined
63534
63558
  }
63535
63559
  | {
63536
63560
  hvac_mode_setting: 'heat_cool'
63537
63561
  /** ID of the thermostat device for which you want to set the HVAC mode. */
63538
63562
  device_id: string
63539
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `cooling_set_point` parameters. */
63563
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
63540
63564
  cooling_set_point_celsius?: number | undefined
63541
- /** Desired [cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `cooling_set_point` parameters. */
63565
+ /** [Cooling set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
63542
63566
  cooling_set_point_fahrenheit?: number | undefined
63543
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set one of the `heating_set_point` parameters. */
63567
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
63544
63568
  heating_set_point_celsius?: number | undefined
63545
- /** Desired [heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set one of the `heating_set_point` parameters. */
63569
+ /** [Heating set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `heating_set_point` parameters. */
63546
63570
  heating_set_point_fahrenheit?: number | undefined
63547
63571
  }
63548
63572
  commonParams: {}
@@ -64868,43 +64892,43 @@ export interface Routes {
64868
64892
  queryParams: {}
64869
64893
  jsonBody:
64870
64894
  | {
64871
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
64895
+ /** HVAC mode that you want to simulate. */
64872
64896
  hvac_mode: 'off'
64873
- /** ID of the desired thermostat device. */
64897
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
64874
64898
  device_id: string
64875
64899
  }
64876
64900
  | {
64877
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
64901
+ /** HVAC mode that you want to simulate. */
64878
64902
  hvac_mode: 'cool'
64879
- /** ID of the desired thermostat device. */
64903
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
64880
64904
  device_id: string
64881
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
64905
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
64882
64906
  cooling_set_point_celsius?: number | undefined
64883
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
64907
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
64884
64908
  cooling_set_point_fahrenheit?: number | undefined
64885
64909
  }
64886
64910
  | {
64887
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
64911
+ /** HVAC mode that you want to simulate. */
64888
64912
  hvac_mode: 'heat'
64889
- /** ID of the desired thermostat device. */
64913
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
64890
64914
  device_id: string
64891
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
64915
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
64892
64916
  heating_set_point_celsius?: number | undefined
64893
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
64917
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
64894
64918
  heating_set_point_fahrenheit?: number | undefined
64895
64919
  }
64896
64920
  | {
64897
- /** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate. */
64921
+ /** HVAC mode that you want to simulate. */
64898
64922
  hvac_mode: 'heat_cool'
64899
- /** ID of the desired thermostat device. */
64923
+ /** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
64900
64924
  device_id: string
64901
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
64925
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`. */
64902
64926
  cooling_set_point_celsius?: number | undefined
64903
- /** Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
64927
+ /** Cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`. */
64904
64928
  cooling_set_point_fahrenheit?: number | undefined
64905
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
64929
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to simulate. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`. */
64906
64930
  heating_set_point_celsius?: number | undefined
64907
- /** Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
64931
+ /** Heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to simulate. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`. */
64908
64932
  heating_set_point_fahrenheit?: number | undefined
64909
64933
  }
64910
64934
  commonParams: {}
@@ -64916,11 +64940,11 @@ export interface Routes {
64916
64940
  method: 'POST'
64917
64941
  queryParams: {}
64918
64942
  jsonBody: {
64919
- /** ID of the desired thermostat device. */
64943
+ /** ID of the thermostat device that you want to simulate reaching a specified temperature. */
64920
64944
  device_id: string
64921
- /** Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`. */
64945
+ /** Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`. */
64922
64946
  temperature_celsius?: number | undefined
64923
- /** Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`. */
64947
+ /** Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`. */
64924
64948
  temperature_fahrenheit?: number | undefined
64925
64949
  }
64926
64950
  commonParams: {}
@@ -66284,11 +66308,11 @@ export interface Routes {
66284
66308
  jsonBody: {}
66285
66309
  commonParams: (
66286
66310
  | {
66287
- /** ID of user identity for whom access is being granted. */
66311
+ /** ID of user identity for whom you want to grant access. */
66288
66312
  user_identity_id: string
66289
66313
  }
66290
66314
  | {
66291
- /** When used, creates a new user identity with the given details, and grants them access. */
66315
+ /** User identity. When used, creates a new user identity with the specified details and grants them access. */
66292
66316
  user_identity: {
66293
66317
  /** Unique email address for the user identity. */
66294
66318
  email_address?: (string | null) | undefined
@@ -66301,9 +66325,9 @@ export interface Routes {
66301
66325
  /**
66302
66326
  * @deprecated Use `space_ids`. */
66303
66327
  location_ids?: string[] | undefined
66304
- /** Set of IDs of existing spaces to which access is being granted. */
66328
+ /** IDs of the existing spaces to which you want to grant access. */
66305
66329
  space_ids?: string[] | undefined
66306
- /** When used, creates a new location with the given entrances and devices, and gives the user access to this location. */
66330
+ /** Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location. */
66307
66331
  location?:
66308
66332
  | {
66309
66333
  /** Name of the location. */
@@ -66316,12 +66340,12 @@ export interface Routes {
66316
66340
  device_ids?: string[]
66317
66341
  }
66318
66342
  | undefined
66319
- /** Set of IDs of the [entrances](https://docs.seam.co/latest/api/acs/systems/list) to which access is being granted. */
66343
+ /** IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access. */
66320
66344
  acs_entrance_ids?: string[]
66321
- /** Set of IDs of the [devices](https://docs.seam.co/latest/api/devices/list) to which access is being granted. */
66345
+ /** IDs of the devices to which you want to grant access. */
66322
66346
  device_ids?: string[]
66323
66347
  requested_access_methods: Array<{
66324
- /** Access method mode. Supported values: `code`, `card`, `mobile_key`. */
66348
+ /** Access method mode. */
66325
66349
  mode: 'code' | 'card' | 'mobile_key'
66326
66350
  }>
66327
66351
  /** Date and time at which the validity of the new grant starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
@@ -66370,7 +66394,7 @@ export interface Routes {
66370
66394
  queryParams: {}
66371
66395
  jsonBody: {}
66372
66396
  commonParams: {
66373
- /** ID of access grant to delete. */
66397
+ /** ID of access grant that you want to delete. */
66374
66398
  access_grant_id: string
66375
66399
  }
66376
66400
  formData: {}
@@ -66382,7 +66406,7 @@ export interface Routes {
66382
66406
  queryParams: {}
66383
66407
  jsonBody: {}
66384
66408
  commonParams: {
66385
- /** ID of access grant to get. */
66409
+ /** ID of access grant that you want to get. */
66386
66410
  access_grant_id: string
66387
66411
  }
66388
66412
  formData: {}
@@ -66426,16 +66450,16 @@ export interface Routes {
66426
66450
  queryParams: {}
66427
66451
  jsonBody: {}
66428
66452
  commonParams: {
66429
- /** ID of user identity to filter list of access grants by. */
66453
+ /** ID of the user identity by which you want to filter the list of access grants. */
66430
66454
  user_identity_id?: string | undefined
66431
- /** ID of system to filter list of access grants by. */
66455
+ /** ID of the access system by which you want to filter the list of access grants. */
66432
66456
  acs_system_id?: string | undefined
66433
- /** ID of entrance to filter list of access grants by. */
66457
+ /** ID of the entrance by which you want to filter the list of access grants. */
66434
66458
  acs_entrance_id?: string | undefined
66435
66459
  /**
66436
66460
  * @deprecated Use `space_id`. */
66437
66461
  location_id?: string | undefined
66438
- /** ID of space to filter list of access grants by. */
66462
+ /** ID of the space by which you want to filter the list of access grants. */
66439
66463
  space_id?: string | undefined
66440
66464
  }
66441
66465
  formData: {}
@@ -66478,7 +66502,7 @@ export interface Routes {
66478
66502
  queryParams: {}
66479
66503
  jsonBody: {}
66480
66504
  commonParams: {
66481
- /** ID of access method to get. */
66505
+ /** ID of the access method that you want to delete. */
66482
66506
  access_method_id: string
66483
66507
  }
66484
66508
  formData: {}
@@ -66490,7 +66514,7 @@ export interface Routes {
66490
66514
  queryParams: {}
66491
66515
  jsonBody: {}
66492
66516
  commonParams: {
66493
- /** ID of access method to get. */
66517
+ /** ID of the access method that you want to get. */
66494
66518
  access_method_id: string
66495
66519
  }
66496
66520
  formData: {}
@@ -66522,7 +66546,7 @@ export interface Routes {
66522
66546
  queryParams: {}
66523
66547
  jsonBody: {}
66524
66548
  commonParams: {
66525
- /** ID of access grant to list access methods for. */
66549
+ /** ID of the access grant by which to filter the list of access methods. */
66526
66550
  access_grant_id: string
66527
66551
  }
66528
66552
  formData: {}
@@ -66552,7 +66576,9 @@ export interface Routes {
66552
66576
  method: 'POST' | 'PUT'
66553
66577
  queryParams: {}
66554
66578
  jsonBody: {
66579
+ /** ID of the location to which you want to add entrances. */
66555
66580
  location_id: string
66581
+ /** IDs of the entrances that you want to add to the location. */
66556
66582
  acs_entrance_ids: string[]
66557
66583
  }
66558
66584
  commonParams: {}
@@ -66564,7 +66590,9 @@ export interface Routes {
66564
66590
  method: 'POST' | 'PUT'
66565
66591
  queryParams: {}
66566
66592
  jsonBody: {
66593
+ /** ID of the location to which you want to add devices. */
66567
66594
  location_id: string
66595
+ /** IDs of the devices that you want to add to the location. */
66568
66596
  device_ids: string[]
66569
66597
  }
66570
66598
  commonParams: {}
@@ -66576,15 +66604,20 @@ export interface Routes {
66576
66604
  method: 'POST'
66577
66605
  queryParams: {}
66578
66606
  jsonBody: {
66607
+ /** Name of the new location. */
66579
66608
  name: string
66609
+ /** Geolocation of the new location. */
66580
66610
  geolocation?:
66581
66611
  | {
66582
66612
  latitude: number
66583
66613
  longitude: number
66584
66614
  }
66585
66615
  | undefined
66616
+ /** Time zone of the new location. */
66586
66617
  time_zone?: string | undefined
66618
+ /** IDs of the devices that you want to add to the new location. */
66587
66619
  device_ids?: string[] | undefined
66620
+ /** IDs of the entrances that you want to add to the new location. */
66588
66621
  acs_entrance_ids?: string[] | undefined
66589
66622
  }
66590
66623
  commonParams: {}
@@ -66618,6 +66651,7 @@ export interface Routes {
66618
66651
  method: 'DELETE' | 'POST'
66619
66652
  queryParams: {}
66620
66653
  jsonBody: {
66654
+ /** ID of the location that you want to delete. */
66621
66655
  location_id: string
66622
66656
  }
66623
66657
  commonParams: {}
@@ -66630,6 +66664,7 @@ export interface Routes {
66630
66664
  queryParams: {}
66631
66665
  jsonBody: {}
66632
66666
  commonParams: {
66667
+ /** ID of the location that you want to get. */
66633
66668
  location_id: string
66634
66669
  }
66635
66670
  formData: {}
@@ -66694,7 +66729,9 @@ export interface Routes {
66694
66729
  queryParams: {}
66695
66730
  jsonBody: {}
66696
66731
  commonParams: {
66732
+ /** ID of the location from which you want to remove entrances. */
66697
66733
  location_id: string
66734
+ /** IDs of the entrances that you want to remove from the location. */
66698
66735
  acs_entrance_ids: string[]
66699
66736
  }
66700
66737
  formData: {}
@@ -66706,7 +66743,9 @@ export interface Routes {
66706
66743
  queryParams: {}
66707
66744
  jsonBody: {}
66708
66745
  commonParams: {
66746
+ /** ID of the location from which you want to remove devices. */
66709
66747
  location_id: string
66748
+ /** IDs of the devices that you want to remove from the location. */
66710
66749
  device_ids: string[]
66711
66750
  }
66712
66751
  formData: {}
@@ -66717,14 +66756,18 @@ export interface Routes {
66717
66756
  method: 'POST' | 'PATCH'
66718
66757
  queryParams: {}
66719
66758
  jsonBody: {
66759
+ /** ID of the location that you want to update. */
66720
66760
  location_id: string
66761
+ /** Name of the location. */
66721
66762
  name?: string | undefined
66763
+ /** Geolocation of the location. */
66722
66764
  geolocation?:
66723
66765
  | {
66724
66766
  latitude: number
66725
66767
  longitude: number
66726
66768
  }
66727
66769
  | undefined
66770
+ /** Time zone of the the location. */
66728
66771
  time_zone?: string | undefined
66729
66772
  }
66730
66773
  commonParams: {}
@@ -66759,6 +66802,7 @@ export interface Routes {
66759
66802
  queryParams: {}
66760
66803
  jsonBody: {}
66761
66804
  commonParams: {
66805
+ /** Customer key for which you want to connect accounts. */
66762
66806
  customer_key: string
66763
66807
  }
66764
66808
  formData: {}
@@ -66770,6 +66814,7 @@ export interface Routes {
66770
66814
  | 'connect_accounts'
66771
66815
  | 'manage_devices'
66772
66816
  | 'organize_spaces'
66817
+ | 'console'
66773
66818
  customer_key: string
66774
66819
  expires_at: string
66775
66820
  workspace_id: string
@@ -66782,28 +66827,25 @@ export interface Routes {
66782
66827
  method: 'POST' | 'GET'
66783
66828
  queryParams: {}
66784
66829
  jsonBody: {}
66785
- commonParams:
66786
- | {
66787
- building_block_type: 'connect_accounts'
66788
- customer_key: string
66789
- }
66790
- | {
66791
- building_block_type: 'manage_devices'
66792
- customer_key: string
66793
- }
66794
- | {
66795
- building_block_type: 'organize_spaces'
66796
- customer_key: string
66797
- /** Optional list of partner resources to include in the magic link. */
66798
- partner_resources?:
66799
- | Array<{
66800
- partner_resource_key: string
66801
- name: string
66802
- description?: string | undefined
66803
- custom_metadata?: Record<string, string> | undefined
66804
- }>
66805
- | undefined
66806
- }
66830
+ commonParams: {
66831
+ /** Type of building block to create a magic link for. */
66832
+ building_block_type:
66833
+ | 'connect_accounts'
66834
+ | 'organize_spaces'
66835
+ | 'console'
66836
+ | 'manage_devices'
66837
+ /** Customer key for which you want to create a new building block magic link. */
66838
+ customer_key: string
66839
+ /** Optional list of spaces that you want to include in the new building block magic link. */
66840
+ spaces?:
66841
+ | Array<{
66842
+ space_key: string
66843
+ name: string
66844
+ description?: string | undefined
66845
+ custom_metadata?: Record<string, string> | undefined
66846
+ }>
66847
+ | undefined
66848
+ }
66807
66849
  formData: {}
66808
66850
  jsonResponse: {
66809
66851
  /** */
@@ -66813,6 +66855,7 @@ export interface Routes {
66813
66855
  | 'connect_accounts'
66814
66856
  | 'manage_devices'
66815
66857
  | 'organize_spaces'
66858
+ | 'console'
66816
66859
  customer_key: string
66817
66860
  expires_at: string
66818
66861
  workspace_id: string
@@ -66826,6 +66869,7 @@ export interface Routes {
66826
66869
  queryParams: {}
66827
66870
  jsonBody: {}
66828
66871
  commonParams: {
66872
+ /** Customer key for which you want to manage devices. */
66829
66873
  customer_key: string
66830
66874
  }
66831
66875
  formData: {}
@@ -66837,6 +66881,7 @@ export interface Routes {
66837
66881
  | 'connect_accounts'
66838
66882
  | 'manage_devices'
66839
66883
  | 'organize_spaces'
66884
+ | 'console'
66840
66885
  customer_key: string
66841
66886
  expires_at: string
66842
66887
  workspace_id: string
@@ -66850,10 +66895,12 @@ export interface Routes {
66850
66895
  queryParams: {}
66851
66896
  jsonBody: {}
66852
66897
  commonParams: {
66898
+ /** Customer key for which you want to organize spaces. */
66853
66899
  customer_key: string
66854
- partner_resources?:
66900
+ /** Optional list of spaces that you want to include in the new building block magic link. */
66901
+ spaces?:
66855
66902
  | Array<{
66856
- partner_resource_key: string
66903
+ space_key: string
66857
66904
  name: string
66858
66905
  description?: string | undefined
66859
66906
  custom_metadata?: Record<string, string> | undefined
@@ -66869,6 +66916,7 @@ export interface Routes {
66869
66916
  | 'connect_accounts'
66870
66917
  | 'manage_devices'
66871
66918
  | 'organize_spaces'
66919
+ | 'console'
66872
66920
  customer_key: string
66873
66921
  expires_at: string
66874
66922
  workspace_id: string
@@ -66882,8 +66930,11 @@ export interface Routes {
66882
66930
  queryParams: {}
66883
66931
  jsonBody:
66884
66932
  | Array<{
66933
+ /** Type of the resource that you want to push to Seam. */
66885
66934
  partner_resource_type?: string | undefined
66935
+ /** Key of the resource that you want to push to Seam. */
66886
66936
  partner_resource_key?: string | undefined
66937
+ /** Customer key associated with the resource that you want to push to Seam. */
66887
66938
  customer_key?: string | undefined
66888
66939
  email_address?: string | undefined
66889
66940
  phone_number?: string | undefined
@@ -66896,8 +66947,11 @@ export interface Routes {
66896
66947
  custom_metadata?: Record<string, string> | undefined
66897
66948
  }>
66898
66949
  | {
66950
+ /** Type of the resource that you want to push to Seam. */
66899
66951
  partner_resource_type?: string | undefined
66952
+ /** Key of the resource that you want to push to Seam. */
66900
66953
  partner_resource_key?: string | undefined
66954
+ /** Customer key associated with the resource that you want to push to Seam. */
66901
66955
  customer_key?: string | undefined
66902
66956
  email_address?: string | undefined
66903
66957
  phone_number?: string | undefined
@@ -66919,9 +66973,9 @@ export interface Routes {
66919
66973
  queryParams: {}
66920
66974
  jsonBody: {}
66921
66975
  commonParams: {
66922
- /** ID of the desired user identity. */
66976
+ /** ID of the user identity to which you want to add an access system user. */
66923
66977
  user_identity_id: string
66924
- /** ID of the desired ACS user. */
66978
+ /** ID of the access system user that you want to add to the user identity. */
66925
66979
  acs_user_id: string
66926
66980
  }
66927
66981
  formData: {}
@@ -66933,15 +66987,15 @@ export interface Routes {
66933
66987
  queryParams: {}
66934
66988
  jsonBody: {}
66935
66989
  commonParams: {
66936
- /** Unique key for the user identity. */
66990
+ /** Unique key for the new user identity. */
66937
66991
  user_identity_key?: (string | null) | undefined
66938
- /** Unique email address for the user identity. */
66992
+ /** Unique email address for the new user identity. */
66939
66993
  email_address?: (string | null) | undefined
66940
- /** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
66994
+ /** Unique phone number for the new user identity in E.164 format (for example, +15555550100). */
66941
66995
  phone_number?: (string | null) | undefined
66942
- /** Full name of the user associated with the user identity. */
66996
+ /** Full name of the user associated with the new user identity. */
66943
66997
  full_name?: (string | null) | undefined
66944
- /** List of ACS system IDs to associate with the user identity through ACS users. If there's no user with the same email address or phone number in the specified ACS systems, a new ACS user is created. If there is an existing user with the same email or phone number in the specified ACS systems, the user is linked to the user identity. */
66998
+ /** List of access system IDs to associate with the new user identity through access system users. If there's no user with the same email address or phone number in the specified access systems, a new access system user is created. If there is an existing user with the same email or phone number in the specified access systems, the user is linked to the user identity. */
66945
66999
  acs_system_ids?: string[] | undefined
66946
67000
  }
66947
67001
  formData: {}
@@ -66971,7 +67025,7 @@ export interface Routes {
66971
67025
  queryParams: {}
66972
67026
  jsonBody: {}
66973
67027
  commonParams: {
66974
- /** ID of the desired user identity. */
67028
+ /** ID of the user identity that you want to delete. */
66975
67029
  user_identity_id: string
66976
67030
  }
66977
67031
  formData: {}
@@ -66983,7 +67037,7 @@ export interface Routes {
66983
67037
  queryParams: {}
66984
67038
  jsonBody: {}
66985
67039
  commonParams: {
66986
- /** ID of the desired enrollment automation. */
67040
+ /** ID of the enrollment automation that you want to delete. */
66987
67041
  enrollment_automation_id: string
66988
67042
  }
66989
67043
  formData: {}
@@ -66995,7 +67049,7 @@ export interface Routes {
66995
67049
  queryParams: {}
66996
67050
  jsonBody: {}
66997
67051
  commonParams: {
66998
- /** ID of the desired enrollment automation. */
67052
+ /** ID of the enrollment automation that you want to get. */
66999
67053
  enrollment_automation_id: string
67000
67054
  }
67001
67055
  formData: {}
@@ -67021,15 +67075,15 @@ export interface Routes {
67021
67075
  queryParams: {}
67022
67076
  jsonBody: {}
67023
67077
  commonParams: {
67024
- /** ID of the desired user identity. */
67078
+ /** ID of the user identity for which you want to launch an enrollment automation. */
67025
67079
  user_identity_id: string
67026
- /** ID of the desired ACS system that serves as the credential manager. */
67080
+ /** ID of the desired access system that serves as the credential manager for the enrollment automation. */
67027
67081
  credential_manager_acs_system_id: string
67028
- /** ID of the ACS credential pool from which to obtain credentials for the user identity. */
67082
+ /** ID of the credential pool from which to obtain credentials for the user identity. */
67029
67083
  acs_credential_pool_id?: string | undefined
67030
67084
  /** Indicates whether to create an associated credential manager user. If you set `create_credential_manager_user` to `true`, you cannot specify a `credential_manager_acs_user_id`. */
67031
67085
  create_credential_manager_user?: boolean | undefined
67032
- /** ID of the associated ACS user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
67086
+ /** ID of the associated access system user within the credential manager. If you specify a `credential_manager_acs_user_id`, you cannot set `create_credential_manager_user` to `true`. */
67033
67087
  credential_manager_acs_user_id?: string | undefined
67034
67088
  }
67035
67089
  formData: {}
@@ -67050,7 +67104,7 @@ export interface Routes {
67050
67104
  queryParams: {}
67051
67105
  jsonBody: {}
67052
67106
  commonParams: {
67053
- /** ID of the user identity for which you want to retrieve all enrollment automations. */
67107
+ /** ID of the user identity for which you want to retrieve enrollment automations. */
67054
67108
  user_identity_id: string
67055
67109
  }
67056
67110
  formData: {}
@@ -67077,7 +67131,7 @@ export interface Routes {
67077
67131
  commonParams: {
67078
67132
  /** ID of the user identity for which you want to generate an instant key. */
67079
67133
  user_identity_id: string
67080
- /** The maximum number of times the instant key can be used. Defaults to 1. */
67134
+ /** Maximum number of times the instant key can be used. Default: 1. */
67081
67135
  max_use_count?: number
67082
67136
  }
67083
67137
  formData: {}
@@ -67101,7 +67155,7 @@ export interface Routes {
67101
67155
  jsonBody: {}
67102
67156
  commonParams:
67103
67157
  | {
67104
- /** ID of the desired user identity. */
67158
+ /** ID of the user identity that you want to get. */
67105
67159
  user_identity_id: string
67106
67160
  }
67107
67161
  | {
@@ -67134,9 +67188,9 @@ export interface Routes {
67134
67188
  queryParams: {}
67135
67189
  jsonBody: {}
67136
67190
  commonParams: {
67137
- /** ID of the desired user identity. */
67191
+ /** ID of the user identity that you want to grant access to a device. */
67138
67192
  user_identity_id: string
67139
- /** ID of the desired managed device. */
67193
+ /** ID of the managed device to which you want to grant access to the user identity. */
67140
67194
  device_id: string
67141
67195
  }
67142
67196
  formData: {}
@@ -67148,6 +67202,7 @@ export interface Routes {
67148
67202
  queryParams: {}
67149
67203
  jsonBody: {}
67150
67204
  commonParams: {
67205
+ /** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
67151
67206
  credential_manager_acs_system_id?: string | undefined
67152
67207
  }
67153
67208
  formData: {}
@@ -68620,7 +68675,7 @@ export interface Routes {
68620
68675
  can_simulate_disconnection?: boolean | undefined
68621
68676
  }>
68622
68677
  /**
68623
- * @deprecated use devices. */
68678
+ * @deprecated Use devices. */
68624
68679
  accessible_devices: Array<{
68625
68680
  /** Unique identifier for the device. */
68626
68681
  device_id: string
@@ -70067,7 +70122,7 @@ export interface Routes {
70067
70122
  queryParams: {}
70068
70123
  jsonBody: {}
70069
70124
  commonParams: {
70070
- /** ID of the user identity for which you want to retrieve all access control systems. */
70125
+ /** ID of the user identity for which you want to retrieve all access systems. */
70071
70126
  user_identity_id: string
70072
70127
  }
70073
70128
  formData: {}
@@ -70243,7 +70298,7 @@ export interface Routes {
70243
70298
  queryParams: {}
70244
70299
  jsonBody: {}
70245
70300
  commonParams: {
70246
- /** ID of the user identity for which you want to retrieve all ACS users. */
70301
+ /** ID of the user identity for which you want to retrieve all access system users. */
70247
70302
  user_identity_id: string
70248
70303
  }
70249
70304
  formData: {}
@@ -70475,9 +70530,9 @@ export interface Routes {
70475
70530
  queryParams: {}
70476
70531
  jsonBody: {}
70477
70532
  commonParams: {
70478
- /** ID of the desired user identity. */
70533
+ /** ID of the user identity from which you want to remove an access system user. */
70479
70534
  user_identity_id: string
70480
- /** ID of the ACS user. */
70535
+ /** ID of the access system user that you want to remove from the user identity.. */
70481
70536
  acs_user_id: string
70482
70537
  }
70483
70538
  formData: {}
@@ -70489,9 +70544,9 @@ export interface Routes {
70489
70544
  queryParams: {}
70490
70545
  jsonBody: {}
70491
70546
  commonParams: {
70492
- /** ID of the desired user identity. */
70547
+ /** ID of the user identity from which you want to revoke access to a device. */
70493
70548
  user_identity_id: string
70494
- /** ID of the desired managed device. */
70549
+ /** ID of the managed device to which you want to revoke access from the user identity. */
70495
70550
  device_id: string
70496
70551
  }
70497
70552
  formData: {}
@@ -70502,14 +70557,15 @@ export interface Routes {
70502
70557
  method: 'PATCH' | 'POST'
70503
70558
  queryParams: {}
70504
70559
  jsonBody: {
70505
- /** ID of the user identity. */
70560
+ /** ID of the user identity that you want to update. */
70506
70561
  user_identity_id: string
70507
70562
  /** Unique key for the user identity. */
70508
70563
  user_identity_key?: (string | null) | undefined
70509
70564
  /** Unique email address for the user identity. */
70510
70565
  email_address?: (string | null) | undefined
70511
- /** Unique phone number for the user identity in [E.164 format](https://www.itu.int/rec/T-REC-E.164/en) (for example, +15555550100). */
70566
+ /** Unique phone number for the user identity. */
70512
70567
  phone_number?: (string | null) | undefined
70568
+ /** Full name of the user associated with the user identity. */
70513
70569
  full_name?: (string | null) | undefined
70514
70570
  }
70515
70571
  commonParams: {}
@@ -70521,7 +70577,9 @@ export interface Routes {
70521
70577
  method: 'POST'
70522
70578
  queryParams: {}
70523
70579
  jsonBody: {
70580
+ /** URL for the new webhook. */
70524
70581
  url: string
70582
+ /** Types of events that you want the new webhook to receive. */
70525
70583
  event_types?: string[]
70526
70584
  }
70527
70585
  commonParams: {}
@@ -70542,6 +70600,7 @@ export interface Routes {
70542
70600
  queryParams: {}
70543
70601
  jsonBody: {}
70544
70602
  commonParams: {
70603
+ /** ID of the webhook that you want to delete. */
70545
70604
  webhook_id: string
70546
70605
  }
70547
70606
  formData: {}
@@ -70553,6 +70612,7 @@ export interface Routes {
70553
70612
  queryParams: {}
70554
70613
  jsonBody: {}
70555
70614
  commonParams: {
70615
+ /** ID of the webhook that you want to get. */
70556
70616
  webhook_id: string
70557
70617
  }
70558
70618
  formData: {}
@@ -70587,7 +70647,9 @@ export interface Routes {
70587
70647
  method: 'PUT' | 'POST'
70588
70648
  queryParams: {}
70589
70649
  jsonBody: {
70650
+ /** ID of the webhook that you want to update. */
70590
70651
  webhook_id: string
70652
+ /** Types of events that you want the webhook to receive. */
70591
70653
  event_types: string[]
70592
70654
  }
70593
70655
  commonParams: {}
@@ -70599,11 +70661,13 @@ export interface Routes {
70599
70661
  method: 'POST'
70600
70662
  queryParams: {}
70601
70663
  jsonBody: {
70664
+ /** Name of the new workspace. */
70602
70665
  name: string
70666
+ /** Company name for the new workspace. */
70603
70667
  company_name?: string | undefined
70604
- /**
70605
- * @deprecated use company_name */
70668
+ /** Connect partner name for the new workspace. */
70606
70669
  connect_partner_name?: ((string | null) | null) | undefined
70670
+ /** Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
70607
70671
  is_sandbox?: boolean
70608
70672
  /**
70609
70673
  * @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
@@ -70617,11 +70681,16 @@ export interface Routes {
70617
70681
  /**
70618
70682
  * @deprecated Use `connect_webview_customization.webview_success_message` instead. */
70619
70683
  webview_success_message?: string | undefined
70684
+ /** [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
70620
70685
  connect_webview_customization?:
70621
70686
  | {
70687
+ /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
70622
70688
  primary_button_color?: (string | null) | undefined
70689
+ /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
70623
70690
  primary_button_text_color?: (string | null) | undefined
70691
+ /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
70624
70692
  success_message?: (string | null) | undefined
70693
+ /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the new workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
70625
70694
  logo_shape?: (('circle' | 'square') | null) | undefined
70626
70695
  }
70627
70696
  | undefined
@@ -72014,16 +72083,24 @@ export interface Routes {
72014
72083
  method: 'POST' | 'PATCH'
72015
72084
  queryParams: {}
72016
72085
  jsonBody: {
72086
+ /** Name of the workspace. */
72017
72087
  name?: string | undefined
72088
+ /** Connect partner name for the workspace. */
72018
72089
  connect_partner_name?: string | undefined
72090
+ /** [Connect Webview](https://docs.seam.co/latest/core-concepts/connect-webviews) customizations for the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
72019
72091
  connect_webview_customization?:
72020
72092
  | {
72093
+ /** Primary button color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
72021
72094
  primary_button_color?: (string | null) | undefined
72095
+ /** Primary button text color for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
72022
72096
  primary_button_text_color?: (string | null) | undefined
72097
+ /** Success message for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
72023
72098
  success_message?: (string | null) | undefined
72099
+ /** Logo shape for [Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews) in the workspace. See also [Customize the Look and Feel of Your Connect Webviews](https://docs.seam.co/latest/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-look-and-feel-of-your-connect-webviews). */
72024
72100
  logo_shape?: (('circle' | 'square') | null) | undefined
72025
72101
  }
72026
72102
  | undefined
72103
+ /** Indicates whether the workspace is suspended. */
72027
72104
  is_suspended?: boolean | undefined
72028
72105
  }
72029
72106
  commonParams: {}