@seamapi/types 1.410.1 → 1.410.2
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.
- package/dist/connect.cjs +653 -304
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +447 -111
- package/lib/seam/connect/openapi.d.ts +254 -0
- package/lib/seam/connect/openapi.js +632 -283
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +193 -111
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +763 -294
- package/src/lib/seam/connect/route-types.ts +193 -111
|
@@ -48460,7 +48460,7 @@ export interface Routes {
|
|
|
48460
48460
|
method: 'DELETE' | 'POST'
|
|
48461
48461
|
queryParams: {}
|
|
48462
48462
|
jsonBody: {
|
|
48463
|
-
/** Device ID of the
|
|
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
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
|
53670
|
+
/** ID of the thermostat device that you want to get. */
|
|
53647
53671
|
device_id?: string | undefined
|
|
53648
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
|
62032
|
+
/** ID of the thermostat device for which you want to create a schedule. */
|
|
62009
62033
|
device_id: string
|
|
62010
|
-
/**
|
|
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
|
|
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
|
|
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
|
|
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
|
|
62186
|
+
/** ID of the thermostat schedule that you want to update. */
|
|
62163
62187
|
thermostat_schedule_id: string
|
|
62164
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
64895
|
+
/** HVAC mode that you want to simulate. */
|
|
64872
64896
|
hvac_mode: 'off'
|
|
64873
|
-
/** ID of the
|
|
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
|
-
/**
|
|
64901
|
+
/** HVAC mode that you want to simulate. */
|
|
64878
64902
|
hvac_mode: 'cool'
|
|
64879
|
-
/** ID of the
|
|
64903
|
+
/** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
|
|
64880
64904
|
device_id: string
|
|
64881
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
64911
|
+
/** HVAC mode that you want to simulate. */
|
|
64888
64912
|
hvac_mode: 'heat'
|
|
64889
|
-
/** ID of the
|
|
64913
|
+
/** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
|
|
64890
64914
|
device_id: string
|
|
64891
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
64921
|
+
/** HVAC mode that you want to simulate. */
|
|
64898
64922
|
hvac_mode: 'heat_cool'
|
|
64899
|
-
/** ID of the
|
|
64923
|
+
/** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
|
|
64900
64924
|
device_id: string
|
|
64901
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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
|
|
64943
|
+
/** ID of the thermostat device that you want to simulate reaching a specified temperature. */
|
|
64920
64944
|
device_id: string
|
|
64921
|
-
/**
|
|
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
|
-
/**
|
|
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
|
|
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
|
|
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
|
-
/**
|
|
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
|
|
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
|
-
/**
|
|
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
|
-
/**
|
|
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.
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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
|
|
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: {}
|
|
@@ -66784,17 +66828,23 @@ export interface Routes {
|
|
|
66784
66828
|
jsonBody: {}
|
|
66785
66829
|
commonParams:
|
|
66786
66830
|
| {
|
|
66831
|
+
/** `connect_accounts` building block type. */
|
|
66787
66832
|
building_block_type: 'connect_accounts'
|
|
66833
|
+
/** Customer key for which you want to create a new building block magic link. */
|
|
66788
66834
|
customer_key: string
|
|
66789
66835
|
}
|
|
66790
66836
|
| {
|
|
66837
|
+
/** `manage_devices` building block type. */
|
|
66791
66838
|
building_block_type: 'manage_devices'
|
|
66839
|
+
/** Customer key for which you want to create a new building block magic link. */
|
|
66792
66840
|
customer_key: string
|
|
66793
66841
|
}
|
|
66794
66842
|
| {
|
|
66843
|
+
/** `organize_spaces` building block type. */
|
|
66795
66844
|
building_block_type: 'organize_spaces'
|
|
66845
|
+
/** Customer key for which you want to create a new building block magic link. */
|
|
66796
66846
|
customer_key: string
|
|
66797
|
-
/** Optional list of partner resources to include in the magic link. */
|
|
66847
|
+
/** Optional list of partner resources that you want to include in the new building block magic link. */
|
|
66798
66848
|
partner_resources?:
|
|
66799
66849
|
| Array<{
|
|
66800
66850
|
partner_resource_key: string
|
|
@@ -66826,6 +66876,7 @@ export interface Routes {
|
|
|
66826
66876
|
queryParams: {}
|
|
66827
66877
|
jsonBody: {}
|
|
66828
66878
|
commonParams: {
|
|
66879
|
+
/** Customer key for which you want to manage devices. */
|
|
66829
66880
|
customer_key: string
|
|
66830
66881
|
}
|
|
66831
66882
|
formData: {}
|
|
@@ -66850,7 +66901,9 @@ export interface Routes {
|
|
|
66850
66901
|
queryParams: {}
|
|
66851
66902
|
jsonBody: {}
|
|
66852
66903
|
commonParams: {
|
|
66904
|
+
/** Customer key for which you want to organize spaces. */
|
|
66853
66905
|
customer_key: string
|
|
66906
|
+
/** Optional list of partner resources that you want to include in the new building block magic link. */
|
|
66854
66907
|
partner_resources?:
|
|
66855
66908
|
| Array<{
|
|
66856
66909
|
partner_resource_key: string
|
|
@@ -66882,8 +66935,11 @@ export interface Routes {
|
|
|
66882
66935
|
queryParams: {}
|
|
66883
66936
|
jsonBody:
|
|
66884
66937
|
| Array<{
|
|
66938
|
+
/** Type of the resource that you want to push to Seam. */
|
|
66885
66939
|
partner_resource_type?: string | undefined
|
|
66940
|
+
/** Key of the resource that you want to push to Seam. */
|
|
66886
66941
|
partner_resource_key?: string | undefined
|
|
66942
|
+
/** Customer key associated with the resource that you want to push to Seam. */
|
|
66887
66943
|
customer_key?: string | undefined
|
|
66888
66944
|
email_address?: string | undefined
|
|
66889
66945
|
phone_number?: string | undefined
|
|
@@ -66896,8 +66952,11 @@ export interface Routes {
|
|
|
66896
66952
|
custom_metadata?: Record<string, string> | undefined
|
|
66897
66953
|
}>
|
|
66898
66954
|
| {
|
|
66955
|
+
/** Type of the resource that you want to push to Seam. */
|
|
66899
66956
|
partner_resource_type?: string | undefined
|
|
66957
|
+
/** Key of the resource that you want to push to Seam. */
|
|
66900
66958
|
partner_resource_key?: string | undefined
|
|
66959
|
+
/** Customer key associated with the resource that you want to push to Seam. */
|
|
66901
66960
|
customer_key?: string | undefined
|
|
66902
66961
|
email_address?: string | undefined
|
|
66903
66962
|
phone_number?: string | undefined
|
|
@@ -66919,9 +66978,9 @@ export interface Routes {
|
|
|
66919
66978
|
queryParams: {}
|
|
66920
66979
|
jsonBody: {}
|
|
66921
66980
|
commonParams: {
|
|
66922
|
-
/** ID of the
|
|
66981
|
+
/** ID of the user identity to which you want to add an access system user. */
|
|
66923
66982
|
user_identity_id: string
|
|
66924
|
-
/** ID of the
|
|
66983
|
+
/** ID of the access system user that you want to add to the user identity. */
|
|
66925
66984
|
acs_user_id: string
|
|
66926
66985
|
}
|
|
66927
66986
|
formData: {}
|
|
@@ -66933,15 +66992,15 @@ export interface Routes {
|
|
|
66933
66992
|
queryParams: {}
|
|
66934
66993
|
jsonBody: {}
|
|
66935
66994
|
commonParams: {
|
|
66936
|
-
/** Unique key for the user identity. */
|
|
66995
|
+
/** Unique key for the new user identity. */
|
|
66937
66996
|
user_identity_key?: (string | null) | undefined
|
|
66938
|
-
/** Unique email address for the user identity. */
|
|
66997
|
+
/** Unique email address for the new user identity. */
|
|
66939
66998
|
email_address?: (string | null) | undefined
|
|
66940
|
-
/** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
|
|
66999
|
+
/** Unique phone number for the new user identity in E.164 format (for example, +15555550100). */
|
|
66941
67000
|
phone_number?: (string | null) | undefined
|
|
66942
|
-
/** Full name of the user associated with the user identity. */
|
|
67001
|
+
/** Full name of the user associated with the new user identity. */
|
|
66943
67002
|
full_name?: (string | null) | undefined
|
|
66944
|
-
/** List of
|
|
67003
|
+
/** 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
67004
|
acs_system_ids?: string[] | undefined
|
|
66946
67005
|
}
|
|
66947
67006
|
formData: {}
|
|
@@ -66971,7 +67030,7 @@ export interface Routes {
|
|
|
66971
67030
|
queryParams: {}
|
|
66972
67031
|
jsonBody: {}
|
|
66973
67032
|
commonParams: {
|
|
66974
|
-
/** ID of the
|
|
67033
|
+
/** ID of the user identity that you want to delete. */
|
|
66975
67034
|
user_identity_id: string
|
|
66976
67035
|
}
|
|
66977
67036
|
formData: {}
|
|
@@ -66983,7 +67042,7 @@ export interface Routes {
|
|
|
66983
67042
|
queryParams: {}
|
|
66984
67043
|
jsonBody: {}
|
|
66985
67044
|
commonParams: {
|
|
66986
|
-
/** ID of the
|
|
67045
|
+
/** ID of the enrollment automation that you want to delete. */
|
|
66987
67046
|
enrollment_automation_id: string
|
|
66988
67047
|
}
|
|
66989
67048
|
formData: {}
|
|
@@ -66995,7 +67054,7 @@ export interface Routes {
|
|
|
66995
67054
|
queryParams: {}
|
|
66996
67055
|
jsonBody: {}
|
|
66997
67056
|
commonParams: {
|
|
66998
|
-
/** ID of the
|
|
67057
|
+
/** ID of the enrollment automation that you want to get. */
|
|
66999
67058
|
enrollment_automation_id: string
|
|
67000
67059
|
}
|
|
67001
67060
|
formData: {}
|
|
@@ -67021,15 +67080,15 @@ export interface Routes {
|
|
|
67021
67080
|
queryParams: {}
|
|
67022
67081
|
jsonBody: {}
|
|
67023
67082
|
commonParams: {
|
|
67024
|
-
/** ID of the
|
|
67083
|
+
/** ID of the user identity for which you want to launch an enrollment automation. */
|
|
67025
67084
|
user_identity_id: string
|
|
67026
|
-
/** ID of the desired
|
|
67085
|
+
/** ID of the desired access system that serves as the credential manager for the enrollment automation. */
|
|
67027
67086
|
credential_manager_acs_system_id: string
|
|
67028
|
-
/** ID of the
|
|
67087
|
+
/** ID of the credential pool from which to obtain credentials for the user identity. */
|
|
67029
67088
|
acs_credential_pool_id?: string | undefined
|
|
67030
67089
|
/** 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
67090
|
create_credential_manager_user?: boolean | undefined
|
|
67032
|
-
/** ID of the associated
|
|
67091
|
+
/** 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
67092
|
credential_manager_acs_user_id?: string | undefined
|
|
67034
67093
|
}
|
|
67035
67094
|
formData: {}
|
|
@@ -67050,7 +67109,7 @@ export interface Routes {
|
|
|
67050
67109
|
queryParams: {}
|
|
67051
67110
|
jsonBody: {}
|
|
67052
67111
|
commonParams: {
|
|
67053
|
-
/** ID of the user identity for which you want to retrieve
|
|
67112
|
+
/** ID of the user identity for which you want to retrieve enrollment automations. */
|
|
67054
67113
|
user_identity_id: string
|
|
67055
67114
|
}
|
|
67056
67115
|
formData: {}
|
|
@@ -67077,7 +67136,7 @@ export interface Routes {
|
|
|
67077
67136
|
commonParams: {
|
|
67078
67137
|
/** ID of the user identity for which you want to generate an instant key. */
|
|
67079
67138
|
user_identity_id: string
|
|
67080
|
-
/**
|
|
67139
|
+
/** Maximum number of times the instant key can be used. Default: 1. */
|
|
67081
67140
|
max_use_count?: number
|
|
67082
67141
|
}
|
|
67083
67142
|
formData: {}
|
|
@@ -67101,7 +67160,7 @@ export interface Routes {
|
|
|
67101
67160
|
jsonBody: {}
|
|
67102
67161
|
commonParams:
|
|
67103
67162
|
| {
|
|
67104
|
-
/** ID of the
|
|
67163
|
+
/** ID of the user identity that you want to get. */
|
|
67105
67164
|
user_identity_id: string
|
|
67106
67165
|
}
|
|
67107
67166
|
| {
|
|
@@ -67134,9 +67193,9 @@ export interface Routes {
|
|
|
67134
67193
|
queryParams: {}
|
|
67135
67194
|
jsonBody: {}
|
|
67136
67195
|
commonParams: {
|
|
67137
|
-
/** ID of the
|
|
67196
|
+
/** ID of the user identity that you want to grant access to a device. */
|
|
67138
67197
|
user_identity_id: string
|
|
67139
|
-
/** ID of the
|
|
67198
|
+
/** ID of the managed device to which you want to grant access to the user identity. */
|
|
67140
67199
|
device_id: string
|
|
67141
67200
|
}
|
|
67142
67201
|
formData: {}
|
|
@@ -67148,6 +67207,7 @@ export interface Routes {
|
|
|
67148
67207
|
queryParams: {}
|
|
67149
67208
|
jsonBody: {}
|
|
67150
67209
|
commonParams: {
|
|
67210
|
+
/** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
|
|
67151
67211
|
credential_manager_acs_system_id?: string | undefined
|
|
67152
67212
|
}
|
|
67153
67213
|
formData: {}
|
|
@@ -68620,7 +68680,7 @@ export interface Routes {
|
|
|
68620
68680
|
can_simulate_disconnection?: boolean | undefined
|
|
68621
68681
|
}>
|
|
68622
68682
|
/**
|
|
68623
|
-
* @deprecated
|
|
68683
|
+
* @deprecated Use devices. */
|
|
68624
68684
|
accessible_devices: Array<{
|
|
68625
68685
|
/** Unique identifier for the device. */
|
|
68626
68686
|
device_id: string
|
|
@@ -70067,7 +70127,7 @@ export interface Routes {
|
|
|
70067
70127
|
queryParams: {}
|
|
70068
70128
|
jsonBody: {}
|
|
70069
70129
|
commonParams: {
|
|
70070
|
-
/** ID of the user identity for which you want to retrieve all access
|
|
70130
|
+
/** ID of the user identity for which you want to retrieve all access systems. */
|
|
70071
70131
|
user_identity_id: string
|
|
70072
70132
|
}
|
|
70073
70133
|
formData: {}
|
|
@@ -70243,7 +70303,7 @@ export interface Routes {
|
|
|
70243
70303
|
queryParams: {}
|
|
70244
70304
|
jsonBody: {}
|
|
70245
70305
|
commonParams: {
|
|
70246
|
-
/** ID of the user identity for which you want to retrieve all
|
|
70306
|
+
/** ID of the user identity for which you want to retrieve all access system users. */
|
|
70247
70307
|
user_identity_id: string
|
|
70248
70308
|
}
|
|
70249
70309
|
formData: {}
|
|
@@ -70475,9 +70535,9 @@ export interface Routes {
|
|
|
70475
70535
|
queryParams: {}
|
|
70476
70536
|
jsonBody: {}
|
|
70477
70537
|
commonParams: {
|
|
70478
|
-
/** ID of the
|
|
70538
|
+
/** ID of the user identity from which you want to remove an access system user. */
|
|
70479
70539
|
user_identity_id: string
|
|
70480
|
-
/** ID of the
|
|
70540
|
+
/** ID of the access system user that you want to remove from the user identity.. */
|
|
70481
70541
|
acs_user_id: string
|
|
70482
70542
|
}
|
|
70483
70543
|
formData: {}
|
|
@@ -70489,9 +70549,9 @@ export interface Routes {
|
|
|
70489
70549
|
queryParams: {}
|
|
70490
70550
|
jsonBody: {}
|
|
70491
70551
|
commonParams: {
|
|
70492
|
-
/** ID of the
|
|
70552
|
+
/** ID of the user identity from which you want to revoke access to a device. */
|
|
70493
70553
|
user_identity_id: string
|
|
70494
|
-
/** ID of the
|
|
70554
|
+
/** ID of the managed device to which you want to revoke access from the user identity. */
|
|
70495
70555
|
device_id: string
|
|
70496
70556
|
}
|
|
70497
70557
|
formData: {}
|
|
@@ -70502,14 +70562,15 @@ export interface Routes {
|
|
|
70502
70562
|
method: 'PATCH' | 'POST'
|
|
70503
70563
|
queryParams: {}
|
|
70504
70564
|
jsonBody: {
|
|
70505
|
-
/** ID of the user identity. */
|
|
70565
|
+
/** ID of the user identity that you want to update. */
|
|
70506
70566
|
user_identity_id: string
|
|
70507
70567
|
/** Unique key for the user identity. */
|
|
70508
70568
|
user_identity_key?: (string | null) | undefined
|
|
70509
70569
|
/** Unique email address for the user identity. */
|
|
70510
70570
|
email_address?: (string | null) | undefined
|
|
70511
|
-
/** Unique phone number for the user identity
|
|
70571
|
+
/** Unique phone number for the user identity. */
|
|
70512
70572
|
phone_number?: (string | null) | undefined
|
|
70573
|
+
/** Full name of the user associated with the user identity. */
|
|
70513
70574
|
full_name?: (string | null) | undefined
|
|
70514
70575
|
}
|
|
70515
70576
|
commonParams: {}
|
|
@@ -70521,7 +70582,9 @@ export interface Routes {
|
|
|
70521
70582
|
method: 'POST'
|
|
70522
70583
|
queryParams: {}
|
|
70523
70584
|
jsonBody: {
|
|
70585
|
+
/** URL for the new webhook. */
|
|
70524
70586
|
url: string
|
|
70587
|
+
/** Types of events that you want the new webhook to receive. */
|
|
70525
70588
|
event_types?: string[]
|
|
70526
70589
|
}
|
|
70527
70590
|
commonParams: {}
|
|
@@ -70542,6 +70605,7 @@ export interface Routes {
|
|
|
70542
70605
|
queryParams: {}
|
|
70543
70606
|
jsonBody: {}
|
|
70544
70607
|
commonParams: {
|
|
70608
|
+
/** ID of the webhook that you want to delete. */
|
|
70545
70609
|
webhook_id: string
|
|
70546
70610
|
}
|
|
70547
70611
|
formData: {}
|
|
@@ -70553,6 +70617,7 @@ export interface Routes {
|
|
|
70553
70617
|
queryParams: {}
|
|
70554
70618
|
jsonBody: {}
|
|
70555
70619
|
commonParams: {
|
|
70620
|
+
/** ID of the webhook that you want to get. */
|
|
70556
70621
|
webhook_id: string
|
|
70557
70622
|
}
|
|
70558
70623
|
formData: {}
|
|
@@ -70587,7 +70652,9 @@ export interface Routes {
|
|
|
70587
70652
|
method: 'PUT' | 'POST'
|
|
70588
70653
|
queryParams: {}
|
|
70589
70654
|
jsonBody: {
|
|
70655
|
+
/** ID of the webhook that you want to update. */
|
|
70590
70656
|
webhook_id: string
|
|
70657
|
+
/** Types of events that you want the webhook to receive. */
|
|
70591
70658
|
event_types: string[]
|
|
70592
70659
|
}
|
|
70593
70660
|
commonParams: {}
|
|
@@ -70599,11 +70666,13 @@ export interface Routes {
|
|
|
70599
70666
|
method: 'POST'
|
|
70600
70667
|
queryParams: {}
|
|
70601
70668
|
jsonBody: {
|
|
70669
|
+
/** Name of the new workspace. */
|
|
70602
70670
|
name: string
|
|
70671
|
+
/** Company name for the new workspace. */
|
|
70603
70672
|
company_name?: string | undefined
|
|
70604
|
-
/**
|
|
70605
|
-
* @deprecated use company_name */
|
|
70673
|
+
/** Connect partner name for the new workspace. */
|
|
70606
70674
|
connect_partner_name?: ((string | null) | null) | undefined
|
|
70675
|
+
/** Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
|
|
70607
70676
|
is_sandbox?: boolean
|
|
70608
70677
|
/**
|
|
70609
70678
|
* @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
|
|
@@ -70617,11 +70686,16 @@ export interface Routes {
|
|
|
70617
70686
|
/**
|
|
70618
70687
|
* @deprecated Use `connect_webview_customization.webview_success_message` instead. */
|
|
70619
70688
|
webview_success_message?: string | undefined
|
|
70689
|
+
/** [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
70690
|
connect_webview_customization?:
|
|
70621
70691
|
| {
|
|
70692
|
+
/** 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
70693
|
primary_button_color?: (string | null) | undefined
|
|
70694
|
+
/** 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
70695
|
primary_button_text_color?: (string | null) | undefined
|
|
70696
|
+
/** 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
70697
|
success_message?: (string | null) | undefined
|
|
70698
|
+
/** 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
70699
|
logo_shape?: (('circle' | 'square') | null) | undefined
|
|
70626
70700
|
}
|
|
70627
70701
|
| undefined
|
|
@@ -72014,16 +72088,24 @@ export interface Routes {
|
|
|
72014
72088
|
method: 'POST' | 'PATCH'
|
|
72015
72089
|
queryParams: {}
|
|
72016
72090
|
jsonBody: {
|
|
72091
|
+
/** Name of the workspace. */
|
|
72017
72092
|
name?: string | undefined
|
|
72093
|
+
/** Connect partner name for the workspace. */
|
|
72018
72094
|
connect_partner_name?: string | undefined
|
|
72095
|
+
/** [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
72096
|
connect_webview_customization?:
|
|
72020
72097
|
| {
|
|
72098
|
+
/** 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
72099
|
primary_button_color?: (string | null) | undefined
|
|
72100
|
+
/** 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
72101
|
primary_button_text_color?: (string | null) | undefined
|
|
72102
|
+
/** 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
72103
|
success_message?: (string | null) | undefined
|
|
72104
|
+
/** 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
72105
|
logo_shape?: (('circle' | 'square') | null) | undefined
|
|
72025
72106
|
}
|
|
72026
72107
|
| undefined
|
|
72108
|
+
/** Indicates whether the workspace is suspended. */
|
|
72027
72109
|
is_suspended?: boolean | undefined
|
|
72028
72110
|
}
|
|
72029
72111
|
commonParams: {}
|