@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
|
@@ -41081,7 +41081,7 @@ export interface Routes {
|
|
|
41081
41081
|
method: 'DELETE' | 'POST';
|
|
41082
41082
|
queryParams: {};
|
|
41083
41083
|
jsonBody: {
|
|
41084
|
-
/** Device ID of the
|
|
41084
|
+
/** Device ID of the phone that you want to deactivate. */
|
|
41085
41085
|
device_id: string;
|
|
41086
41086
|
};
|
|
41087
41087
|
commonParams: {};
|
|
@@ -41094,7 +41094,7 @@ export interface Routes {
|
|
|
41094
41094
|
queryParams: {};
|
|
41095
41095
|
jsonBody: {};
|
|
41096
41096
|
commonParams: {
|
|
41097
|
-
/** Device ID of the
|
|
41097
|
+
/** Device ID of the phone that you want to get. */
|
|
41098
41098
|
device_id: string;
|
|
41099
41099
|
};
|
|
41100
41100
|
formData: {};
|
|
@@ -41163,9 +41163,9 @@ export interface Routes {
|
|
|
41163
41163
|
queryParams: {};
|
|
41164
41164
|
jsonBody: {};
|
|
41165
41165
|
commonParams: {
|
|
41166
|
-
/** ID of the user identity that represents the owner by which to filter the list of returned phones. */
|
|
41166
|
+
/** ID of the user identity that represents the owner by which you want to filter the list of returned phones. */
|
|
41167
41167
|
owner_user_identity_id?: string | undefined;
|
|
41168
|
-
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) by which to filter the list of returned phones. */
|
|
41168
|
+
/** 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. */
|
|
41169
41169
|
acs_credential_id?: string | undefined;
|
|
41170
41170
|
};
|
|
41171
41171
|
formData: {};
|
|
@@ -41232,11 +41232,11 @@ export interface Routes {
|
|
|
41232
41232
|
method: 'GET' | 'POST';
|
|
41233
41233
|
queryParams: {};
|
|
41234
41234
|
jsonBody: {
|
|
41235
|
-
/** ID of the custom SDK installation to use for the simulated phone. */
|
|
41235
|
+
/** ID of the custom SDK installation that you want to use for the simulated phone. */
|
|
41236
41236
|
custom_sdk_installation_id?: string | undefined;
|
|
41237
|
-
/** ID of the user identity to associate with the simulated phone. */
|
|
41237
|
+
/** ID of the user identity that you want to associate with the simulated phone. */
|
|
41238
41238
|
user_identity_id: string;
|
|
41239
|
-
/** Metadata to associate with the simulated phone. */
|
|
41239
|
+
/** Metadata that you want to associate with the simulated phone. */
|
|
41240
41240
|
phone_metadata?: {
|
|
41241
41241
|
/** Mobile operating system that you want to use for the simulated phone. */
|
|
41242
41242
|
operating_system?: 'android' | 'ios';
|
|
@@ -41247,7 +41247,7 @@ export interface Routes {
|
|
|
41247
41247
|
/** Device model that you want to use for the simulated phone. */
|
|
41248
41248
|
device_model?: string;
|
|
41249
41249
|
};
|
|
41250
|
-
/** ASSA ABLOY metadata to associate with the simulated phone. */
|
|
41250
|
+
/** ASSA ABLOY metadata that you want to associate with the simulated phone. */
|
|
41251
41251
|
assa_abloy_metadata?: {
|
|
41252
41252
|
/** Indicates whether the simulated phone should have Bluetooth low energy (BLE) capability. */
|
|
41253
41253
|
ble_capability?: boolean;
|
|
@@ -41329,8 +41329,11 @@ export interface Routes {
|
|
|
41329
41329
|
method: 'POST';
|
|
41330
41330
|
queryParams: {};
|
|
41331
41331
|
jsonBody: {
|
|
41332
|
+
/** Name of the Seam Bridge client that you want to create. */
|
|
41332
41333
|
bridge_client_name: string;
|
|
41334
|
+
/** Time zone for the Seam Bridge that you want to create. */
|
|
41333
41335
|
bridge_client_time_zone: string;
|
|
41336
|
+
/** Identifier key of the client machine for the Seam Bridge client that you want to create. */
|
|
41334
41337
|
bridge_client_machine_identifier_key: string;
|
|
41335
41338
|
};
|
|
41336
41339
|
commonParams: {};
|
|
@@ -41521,7 +41524,9 @@ export interface Routes {
|
|
|
41521
41524
|
method: 'POST';
|
|
41522
41525
|
queryParams: {};
|
|
41523
41526
|
jsonBody: {
|
|
41527
|
+
/** Indicates whether Tailscale is connected. */
|
|
41524
41528
|
is_tailscale_connected: boolean | null;
|
|
41529
|
+
/** Tailscale IPv4 address. */
|
|
41525
41530
|
tailscale_ip_v4: string | null;
|
|
41526
41531
|
};
|
|
41527
41532
|
commonParams: {};
|
|
@@ -41553,7 +41558,7 @@ export interface Routes {
|
|
|
41553
41558
|
method: 'POST';
|
|
41554
41559
|
queryParams: {};
|
|
41555
41560
|
jsonBody: {
|
|
41556
|
-
/**
|
|
41561
|
+
/** Short code that you want to exchange for a client session token. */
|
|
41557
41562
|
short_code: string;
|
|
41558
41563
|
};
|
|
41559
41564
|
commonParams: {};
|
|
@@ -41711,8 +41716,11 @@ export interface Routes {
|
|
|
41711
41716
|
method: 'POST';
|
|
41712
41717
|
queryParams: {};
|
|
41713
41718
|
jsonBody: {
|
|
41719
|
+
/** ID of the custom SDK installation that you want to use for the new session. */
|
|
41714
41720
|
custom_sdk_installation_id: string;
|
|
41721
|
+
/** Phone operating system that you want to use for the new session. */
|
|
41715
41722
|
phone_os: 'ios' | 'android';
|
|
41723
|
+
/** Phone device metadata that you want to use for the new session. */
|
|
41716
41724
|
phone_device_metadata?: {
|
|
41717
41725
|
os_version?: string | undefined;
|
|
41718
41726
|
manufacturer?: string | undefined;
|
|
@@ -41917,6 +41925,7 @@ export interface Routes {
|
|
|
41917
41925
|
queryParams: {};
|
|
41918
41926
|
jsonBody: {};
|
|
41919
41927
|
commonParams: {
|
|
41928
|
+
/** Collection key. */
|
|
41920
41929
|
collection_key: string;
|
|
41921
41930
|
};
|
|
41922
41931
|
formData: {};
|
|
@@ -41943,7 +41952,7 @@ export interface Routes {
|
|
|
41943
41952
|
queryParams: {};
|
|
41944
41953
|
jsonBody: {};
|
|
41945
41954
|
commonParams: {
|
|
41946
|
-
/**
|
|
41955
|
+
/** Resource type alias by which you want to filter partner resources. */
|
|
41947
41956
|
resource_type_alias?: string | undefined;
|
|
41948
41957
|
};
|
|
41949
41958
|
formData: {};
|
|
@@ -41969,7 +41978,9 @@ export interface Routes {
|
|
|
41969
41978
|
method: 'POST' | 'PUT';
|
|
41970
41979
|
queryParams: {};
|
|
41971
41980
|
jsonBody: {
|
|
41981
|
+
/** ID of the space to which you want to add entrances. */
|
|
41972
41982
|
space_id: string;
|
|
41983
|
+
/** IDs of the entrances that you want to add to the space. */
|
|
41973
41984
|
acs_entrance_ids: string[];
|
|
41974
41985
|
};
|
|
41975
41986
|
commonParams: {};
|
|
@@ -41981,7 +41992,9 @@ export interface Routes {
|
|
|
41981
41992
|
method: 'POST' | 'PUT';
|
|
41982
41993
|
queryParams: {};
|
|
41983
41994
|
jsonBody: {
|
|
41995
|
+
/** ID of the space to which you want to add devices. */
|
|
41984
41996
|
space_id: string;
|
|
41997
|
+
/** IDs of the devices that you want to add to the space. */
|
|
41985
41998
|
device_ids: string[];
|
|
41986
41999
|
};
|
|
41987
42000
|
commonParams: {};
|
|
@@ -41993,8 +42006,11 @@ export interface Routes {
|
|
|
41993
42006
|
method: 'POST';
|
|
41994
42007
|
queryParams: {};
|
|
41995
42008
|
jsonBody: {
|
|
42009
|
+
/** Name of the space that you want to create. */
|
|
41996
42010
|
name: string;
|
|
42011
|
+
/** IDs of the devices that you want to add to the new space. */
|
|
41997
42012
|
device_ids?: string[] | undefined;
|
|
42013
|
+
/** IDs of the entrances that you want to add to the new space. */
|
|
41998
42014
|
acs_entrance_ids?: string[] | undefined;
|
|
41999
42015
|
};
|
|
42000
42016
|
commonParams: {};
|
|
@@ -42020,6 +42036,7 @@ export interface Routes {
|
|
|
42020
42036
|
method: 'DELETE' | 'POST';
|
|
42021
42037
|
queryParams: {};
|
|
42022
42038
|
jsonBody: {
|
|
42039
|
+
/** ID of the space that you want to delete. */
|
|
42023
42040
|
space_id: string;
|
|
42024
42041
|
};
|
|
42025
42042
|
commonParams: {};
|
|
@@ -42032,6 +42049,7 @@ export interface Routes {
|
|
|
42032
42049
|
queryParams: {};
|
|
42033
42050
|
jsonBody: {};
|
|
42034
42051
|
commonParams: {
|
|
42052
|
+
/** ID of the space that you want to get. */
|
|
42035
42053
|
space_id: string;
|
|
42036
42054
|
};
|
|
42037
42055
|
formData: {};
|
|
@@ -42079,7 +42097,9 @@ export interface Routes {
|
|
|
42079
42097
|
queryParams: {};
|
|
42080
42098
|
jsonBody: {};
|
|
42081
42099
|
commonParams: {
|
|
42100
|
+
/** ID of the space from which you want to remove entrances. */
|
|
42082
42101
|
space_id: string;
|
|
42102
|
+
/** IDs of the entrances that you want to remove from the space. */
|
|
42083
42103
|
acs_entrance_ids: string[];
|
|
42084
42104
|
};
|
|
42085
42105
|
formData: {};
|
|
@@ -42091,7 +42111,9 @@ export interface Routes {
|
|
|
42091
42111
|
queryParams: {};
|
|
42092
42112
|
jsonBody: {};
|
|
42093
42113
|
commonParams: {
|
|
42114
|
+
/** ID of the space from which you want to remove devices. */
|
|
42094
42115
|
space_id: string;
|
|
42116
|
+
/** IDs of the devices that you want to remove from the space. */
|
|
42095
42117
|
device_ids: string[];
|
|
42096
42118
|
};
|
|
42097
42119
|
formData: {};
|
|
@@ -42102,7 +42124,9 @@ export interface Routes {
|
|
|
42102
42124
|
method: 'POST' | 'PATCH';
|
|
42103
42125
|
queryParams: {};
|
|
42104
42126
|
jsonBody: {
|
|
42127
|
+
/** ID of the space that you want to update. */
|
|
42105
42128
|
space_id: string;
|
|
42129
|
+
/** Name of the space. */
|
|
42106
42130
|
name?: string | undefined;
|
|
42107
42131
|
};
|
|
42108
42132
|
commonParams: {};
|
|
@@ -43248,9 +43272,9 @@ export interface Routes {
|
|
|
43248
43272
|
jsonBody: {
|
|
43249
43273
|
/** ID of the thermostat device that you want to set to cool mode. */
|
|
43250
43274
|
device_id: string;
|
|
43251
|
-
/**
|
|
43275
|
+
/** [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. */
|
|
43252
43276
|
cooling_set_point_celsius?: number | undefined;
|
|
43253
|
-
/**
|
|
43277
|
+
/** [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. */
|
|
43254
43278
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
43255
43279
|
/** */
|
|
43256
43280
|
sync?: boolean;
|
|
@@ -44401,7 +44425,7 @@ export interface Routes {
|
|
|
44401
44425
|
jsonBody: {
|
|
44402
44426
|
/** ID of the thermostat device for which you want to create a daily program. */
|
|
44403
44427
|
device_id: string;
|
|
44404
|
-
/**
|
|
44428
|
+
/** Name of the thermostat daily program. */
|
|
44405
44429
|
name: string;
|
|
44406
44430
|
/** Array of thermostat daily program periods. */
|
|
44407
44431
|
periods: Array<{
|
|
@@ -44455,7 +44479,7 @@ export interface Routes {
|
|
|
44455
44479
|
jsonBody: {
|
|
44456
44480
|
/** ID of the thermostat daily program that you want to update. */
|
|
44457
44481
|
thermostat_daily_program_id: string;
|
|
44458
|
-
/**
|
|
44482
|
+
/** Name of the thermostat daily program that you want to update. */
|
|
44459
44483
|
name: string;
|
|
44460
44484
|
/** Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. */
|
|
44461
44485
|
periods: Array<{
|
|
@@ -45593,9 +45617,9 @@ export interface Routes {
|
|
|
45593
45617
|
queryParams: {};
|
|
45594
45618
|
jsonBody: {};
|
|
45595
45619
|
commonParams: {
|
|
45596
|
-
/** ID of the thermostat device that you want to
|
|
45620
|
+
/** ID of the thermostat device that you want to get. */
|
|
45597
45621
|
device_id?: string | undefined;
|
|
45598
|
-
/**
|
|
45622
|
+
/** Name of the thermostat device that you want to retrieve. */
|
|
45599
45623
|
name?: string | undefined;
|
|
45600
45624
|
};
|
|
45601
45625
|
formData: {};
|
|
@@ -46813,9 +46837,9 @@ export interface Routes {
|
|
|
46813
46837
|
jsonBody: {
|
|
46814
46838
|
/** ID of the thermostat device that you want to set to heat mode. */
|
|
46815
46839
|
device_id: string;
|
|
46816
|
-
/**
|
|
46840
|
+
/** [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. */
|
|
46817
46841
|
heating_set_point_celsius?: number | undefined;
|
|
46818
|
-
/**
|
|
46842
|
+
/** [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. */
|
|
46819
46843
|
heating_set_point_fahrenheit?: number | undefined;
|
|
46820
46844
|
/** */
|
|
46821
46845
|
sync?: boolean;
|
|
@@ -47935,13 +47959,13 @@ export interface Routes {
|
|
|
47935
47959
|
jsonBody: {
|
|
47936
47960
|
/** ID of the thermostat device that you want to set to heat-cool mode. */
|
|
47937
47961
|
device_id: string;
|
|
47938
|
-
/**
|
|
47962
|
+
/** [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. */
|
|
47939
47963
|
heating_set_point_celsius?: number | undefined;
|
|
47940
|
-
/**
|
|
47964
|
+
/** [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. */
|
|
47941
47965
|
heating_set_point_fahrenheit?: number | undefined;
|
|
47942
|
-
/**
|
|
47966
|
+
/** [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. */
|
|
47943
47967
|
cooling_set_point_celsius?: number | undefined;
|
|
47944
|
-
/**
|
|
47968
|
+
/** [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. */
|
|
47945
47969
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
47946
47970
|
/** */
|
|
47947
47971
|
sync?: boolean;
|
|
@@ -49067,11 +49091,11 @@ export interface Routes {
|
|
|
49067
49091
|
connected_account_ids?: string[] | undefined;
|
|
49068
49092
|
/** ID of the Connect Webview for which you want to list devices. */
|
|
49069
49093
|
connect_webview_id?: string | undefined;
|
|
49070
|
-
/** Device type by which to filter thermostat devices. */
|
|
49094
|
+
/** Device type by which you want to filter thermostat devices. */
|
|
49071
49095
|
device_type?: ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | undefined;
|
|
49072
|
-
/** Array of device types by which to filter thermostat devices. */
|
|
49096
|
+
/** Array of device types by which you want to filter thermostat devices. */
|
|
49073
49097
|
device_types?: Array<'ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat'> | undefined;
|
|
49074
|
-
/** Manufacturer by which to filter thermostat devices. */
|
|
49098
|
+
/** Manufacturer by which you want to filter thermostat devices. */
|
|
49075
49099
|
manufacturer?: ('ecobee' | 'honeywell_resideo' | 'nest' | 'tado' | 'sensi' | 'smartthings') | undefined;
|
|
49076
49100
|
/** Array of device IDs for which you want to list devices. */
|
|
49077
49101
|
device_ids?: string[] | undefined;
|
|
@@ -52628,19 +52652,19 @@ export interface Routes {
|
|
|
52628
52652
|
method: 'POST';
|
|
52629
52653
|
queryParams: {};
|
|
52630
52654
|
jsonBody: {
|
|
52631
|
-
/** ID of the
|
|
52655
|
+
/** ID of the thermostat device for which you want to create a schedule. */
|
|
52632
52656
|
device_id: string;
|
|
52633
|
-
/**
|
|
52657
|
+
/** Name of the thermostat schedule. */
|
|
52634
52658
|
name?: string | undefined;
|
|
52635
|
-
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
52659
|
+
/** 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. */
|
|
52636
52660
|
climate_preset_key: string;
|
|
52637
52661
|
/** 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). */
|
|
52638
52662
|
max_override_period_minutes?: (number | null) | undefined;
|
|
52639
|
-
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
52663
|
+
/** 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. */
|
|
52640
52664
|
starts_at: string;
|
|
52641
|
-
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
52665
|
+
/** 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. */
|
|
52642
52666
|
ends_at: string;
|
|
52643
|
-
/** 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). */
|
|
52667
|
+
/** 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). */
|
|
52644
52668
|
is_override_allowed?: boolean | undefined;
|
|
52645
52669
|
};
|
|
52646
52670
|
commonParams: {};
|
|
@@ -52684,7 +52708,7 @@ export interface Routes {
|
|
|
52684
52708
|
queryParams: {};
|
|
52685
52709
|
jsonBody: {};
|
|
52686
52710
|
commonParams: {
|
|
52687
|
-
/** ID of the
|
|
52711
|
+
/** ID of the thermostat schedule that you want to delete. */
|
|
52688
52712
|
thermostat_schedule_id: string;
|
|
52689
52713
|
};
|
|
52690
52714
|
formData: {};
|
|
@@ -52696,7 +52720,7 @@ export interface Routes {
|
|
|
52696
52720
|
queryParams: {};
|
|
52697
52721
|
jsonBody: {};
|
|
52698
52722
|
commonParams: {
|
|
52699
|
-
/** ID of the
|
|
52723
|
+
/** ID of the thermostat schedule that you want to get. */
|
|
52700
52724
|
thermostat_schedule_id: string;
|
|
52701
52725
|
};
|
|
52702
52726
|
formData: {};
|
|
@@ -52739,7 +52763,7 @@ export interface Routes {
|
|
|
52739
52763
|
queryParams: {};
|
|
52740
52764
|
jsonBody: {};
|
|
52741
52765
|
commonParams: {
|
|
52742
|
-
/** ID of the
|
|
52766
|
+
/** ID of the thermostat device for which you want to list schedules. */
|
|
52743
52767
|
device_id: string;
|
|
52744
52768
|
/** User identifier key by which to filter the list of returned thermostat schedules. */
|
|
52745
52769
|
user_identifier_key?: string | undefined;
|
|
@@ -52782,9 +52806,9 @@ export interface Routes {
|
|
|
52782
52806
|
method: 'PATCH' | 'POST';
|
|
52783
52807
|
queryParams: {};
|
|
52784
52808
|
jsonBody: {
|
|
52785
|
-
/** ID of the
|
|
52809
|
+
/** ID of the thermostat schedule that you want to update. */
|
|
52786
52810
|
thermostat_schedule_id: string;
|
|
52787
|
-
/**
|
|
52811
|
+
/** Name of the thermostat schedule. */
|
|
52788
52812
|
name?: string | undefined;
|
|
52789
52813
|
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
52790
52814
|
climate_preset_key?: string | undefined;
|
|
@@ -52825,7 +52849,7 @@ export interface Routes {
|
|
|
52825
52849
|
/**
|
|
52826
52850
|
* @deprecated Use `fan_mode_setting` instead. */
|
|
52827
52851
|
fan_mode?: ('auto' | 'on' | 'circulate') | undefined;
|
|
52828
|
-
/**
|
|
52852
|
+
/** [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. */
|
|
52829
52853
|
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
52830
52854
|
/** */
|
|
52831
52855
|
sync?: boolean;
|
|
@@ -53950,29 +53974,29 @@ export interface Routes {
|
|
|
53950
53974
|
hvac_mode_setting: 'cool';
|
|
53951
53975
|
/** ID of the thermostat device for which you want to set the HVAC mode. */
|
|
53952
53976
|
device_id: string;
|
|
53953
|
-
/**
|
|
53977
|
+
/** [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. */
|
|
53954
53978
|
cooling_set_point_celsius?: number | undefined;
|
|
53955
|
-
/**
|
|
53979
|
+
/** [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. */
|
|
53956
53980
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
53957
53981
|
} | {
|
|
53958
53982
|
hvac_mode_setting: 'heat';
|
|
53959
53983
|
/** ID of the thermostat device for which you want to set the HVAC mode. */
|
|
53960
53984
|
device_id: string;
|
|
53961
|
-
/**
|
|
53985
|
+
/** [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. */
|
|
53962
53986
|
heating_set_point_celsius?: number | undefined;
|
|
53963
|
-
/**
|
|
53987
|
+
/** [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. */
|
|
53964
53988
|
heating_set_point_fahrenheit?: number | undefined;
|
|
53965
53989
|
} | {
|
|
53966
53990
|
hvac_mode_setting: 'heat_cool';
|
|
53967
53991
|
/** ID of the thermostat device for which you want to set the HVAC mode. */
|
|
53968
53992
|
device_id: string;
|
|
53969
|
-
/**
|
|
53993
|
+
/** [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. */
|
|
53970
53994
|
cooling_set_point_celsius?: number | undefined;
|
|
53971
|
-
/**
|
|
53995
|
+
/** [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. */
|
|
53972
53996
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
53973
|
-
/**
|
|
53997
|
+
/** [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. */
|
|
53974
53998
|
heating_set_point_celsius?: number | undefined;
|
|
53975
|
-
/**
|
|
53999
|
+
/** [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. */
|
|
53976
54000
|
heating_set_point_fahrenheit?: number | undefined;
|
|
53977
54001
|
};
|
|
53978
54002
|
commonParams: {};
|
|
@@ -55108,40 +55132,40 @@ export interface Routes {
|
|
|
55108
55132
|
method: 'POST';
|
|
55109
55133
|
queryParams: {};
|
|
55110
55134
|
jsonBody: {
|
|
55111
|
-
/**
|
|
55135
|
+
/** HVAC mode that you want to simulate. */
|
|
55112
55136
|
hvac_mode: 'off';
|
|
55113
|
-
/** ID of the
|
|
55137
|
+
/** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
|
|
55114
55138
|
device_id: string;
|
|
55115
55139
|
} | {
|
|
55116
|
-
/**
|
|
55140
|
+
/** HVAC mode that you want to simulate. */
|
|
55117
55141
|
hvac_mode: 'cool';
|
|
55118
|
-
/** ID of the
|
|
55142
|
+
/** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
|
|
55119
55143
|
device_id: string;
|
|
55120
|
-
/**
|
|
55144
|
+
/** 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`. */
|
|
55121
55145
|
cooling_set_point_celsius?: number | undefined;
|
|
55122
|
-
/**
|
|
55146
|
+
/** 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`. */
|
|
55123
55147
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
55124
55148
|
} | {
|
|
55125
|
-
/**
|
|
55149
|
+
/** HVAC mode that you want to simulate. */
|
|
55126
55150
|
hvac_mode: 'heat';
|
|
55127
|
-
/** ID of the
|
|
55151
|
+
/** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
|
|
55128
55152
|
device_id: string;
|
|
55129
|
-
/**
|
|
55153
|
+
/** 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`. */
|
|
55130
55154
|
heating_set_point_celsius?: number | undefined;
|
|
55131
|
-
/**
|
|
55155
|
+
/** 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`. */
|
|
55132
55156
|
heating_set_point_fahrenheit?: number | undefined;
|
|
55133
55157
|
} | {
|
|
55134
|
-
/**
|
|
55158
|
+
/** HVAC mode that you want to simulate. */
|
|
55135
55159
|
hvac_mode: 'heat_cool';
|
|
55136
|
-
/** ID of the
|
|
55160
|
+
/** ID of the thermostat device for which you want to simulate having adjusted the HVAC mode. */
|
|
55137
55161
|
device_id: string;
|
|
55138
|
-
/**
|
|
55162
|
+
/** 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`. */
|
|
55139
55163
|
cooling_set_point_celsius?: number | undefined;
|
|
55140
|
-
/**
|
|
55164
|
+
/** 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`. */
|
|
55141
55165
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
55142
|
-
/**
|
|
55166
|
+
/** 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`. */
|
|
55143
55167
|
heating_set_point_celsius?: number | undefined;
|
|
55144
|
-
/**
|
|
55168
|
+
/** 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`. */
|
|
55145
55169
|
heating_set_point_fahrenheit?: number | undefined;
|
|
55146
55170
|
};
|
|
55147
55171
|
commonParams: {};
|
|
@@ -55153,11 +55177,11 @@ export interface Routes {
|
|
|
55153
55177
|
method: 'POST';
|
|
55154
55178
|
queryParams: {};
|
|
55155
55179
|
jsonBody: {
|
|
55156
|
-
/** ID of the
|
|
55180
|
+
/** ID of the thermostat device that you want to simulate reaching a specified temperature. */
|
|
55157
55181
|
device_id: string;
|
|
55158
|
-
/**
|
|
55182
|
+
/** Temperature in °C that you want simulate the thermostat reaching. You must set `temperature_celsius` or `temperature_fahrenheit`. */
|
|
55159
55183
|
temperature_celsius?: number | undefined;
|
|
55160
|
-
/**
|
|
55184
|
+
/** Temperature in °F that you want simulate the thermostat reaching. You must set `temperature_fahrenheit` or `temperature_celsius`. */
|
|
55161
55185
|
temperature_fahrenheit?: number | undefined;
|
|
55162
55186
|
};
|
|
55163
55187
|
commonParams: {};
|
|
@@ -56331,10 +56355,10 @@ export interface Routes {
|
|
|
56331
56355
|
queryParams: {};
|
|
56332
56356
|
jsonBody: {};
|
|
56333
56357
|
commonParams: ({
|
|
56334
|
-
/** ID of user identity for whom
|
|
56358
|
+
/** ID of user identity for whom you want to grant access. */
|
|
56335
56359
|
user_identity_id: string;
|
|
56336
56360
|
} | {
|
|
56337
|
-
/** When used, creates a new user identity with the
|
|
56361
|
+
/** User identity. When used, creates a new user identity with the specified details and grants them access. */
|
|
56338
56362
|
user_identity: {
|
|
56339
56363
|
/** Unique email address for the user identity. */
|
|
56340
56364
|
email_address?: (string | null) | undefined;
|
|
@@ -56346,9 +56370,9 @@ export interface Routes {
|
|
|
56346
56370
|
/**
|
|
56347
56371
|
* @deprecated Use `space_ids`. */
|
|
56348
56372
|
location_ids?: string[] | undefined;
|
|
56349
|
-
/**
|
|
56373
|
+
/** IDs of the existing spaces to which you want to grant access. */
|
|
56350
56374
|
space_ids?: string[] | undefined;
|
|
56351
|
-
/** When used, creates a new location with the
|
|
56375
|
+
/** Location. When used, creates a new location with the specified entrances and devices, and gives the user access to this location. */
|
|
56352
56376
|
location?: {
|
|
56353
56377
|
/** Name of the location. */
|
|
56354
56378
|
name?: string | undefined;
|
|
@@ -56359,12 +56383,12 @@ export interface Routes {
|
|
|
56359
56383
|
* @deprecated Use `device_ids` at the top level. */
|
|
56360
56384
|
device_ids?: string[];
|
|
56361
56385
|
} | undefined;
|
|
56362
|
-
/**
|
|
56386
|
+
/** IDs of the [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) to which you want to grant access. */
|
|
56363
56387
|
acs_entrance_ids?: string[];
|
|
56364
|
-
/**
|
|
56388
|
+
/** IDs of the devices to which you want to grant access. */
|
|
56365
56389
|
device_ids?: string[];
|
|
56366
56390
|
requested_access_methods: Array<{
|
|
56367
|
-
/** Access method mode.
|
|
56391
|
+
/** Access method mode. */
|
|
56368
56392
|
mode: 'code' | 'card' | 'mobile_key';
|
|
56369
56393
|
}>;
|
|
56370
56394
|
/** 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. */
|
|
@@ -56413,7 +56437,7 @@ export interface Routes {
|
|
|
56413
56437
|
queryParams: {};
|
|
56414
56438
|
jsonBody: {};
|
|
56415
56439
|
commonParams: {
|
|
56416
|
-
/** ID of access grant to delete. */
|
|
56440
|
+
/** ID of access grant that you want to delete. */
|
|
56417
56441
|
access_grant_id: string;
|
|
56418
56442
|
};
|
|
56419
56443
|
formData: {};
|
|
@@ -56425,7 +56449,7 @@ export interface Routes {
|
|
|
56425
56449
|
queryParams: {};
|
|
56426
56450
|
jsonBody: {};
|
|
56427
56451
|
commonParams: {
|
|
56428
|
-
/** ID of access grant to get. */
|
|
56452
|
+
/** ID of access grant that you want to get. */
|
|
56429
56453
|
access_grant_id: string;
|
|
56430
56454
|
};
|
|
56431
56455
|
formData: {};
|
|
@@ -56469,16 +56493,16 @@ export interface Routes {
|
|
|
56469
56493
|
queryParams: {};
|
|
56470
56494
|
jsonBody: {};
|
|
56471
56495
|
commonParams: {
|
|
56472
|
-
/** ID of user identity to filter list of access grants
|
|
56496
|
+
/** ID of the user identity by which you want to filter the list of access grants. */
|
|
56473
56497
|
user_identity_id?: string | undefined;
|
|
56474
|
-
/** ID of system to filter list of access grants
|
|
56498
|
+
/** ID of the access system by which you want to filter the list of access grants. */
|
|
56475
56499
|
acs_system_id?: string | undefined;
|
|
56476
|
-
/** ID of entrance to filter list of access grants
|
|
56500
|
+
/** ID of the entrance by which you want to filter the list of access grants. */
|
|
56477
56501
|
acs_entrance_id?: string | undefined;
|
|
56478
56502
|
/**
|
|
56479
56503
|
* @deprecated Use `space_id`. */
|
|
56480
56504
|
location_id?: string | undefined;
|
|
56481
|
-
/** ID of space to filter list of access grants
|
|
56505
|
+
/** ID of the space by which you want to filter the list of access grants. */
|
|
56482
56506
|
space_id?: string | undefined;
|
|
56483
56507
|
};
|
|
56484
56508
|
formData: {};
|
|
@@ -56521,7 +56545,7 @@ export interface Routes {
|
|
|
56521
56545
|
queryParams: {};
|
|
56522
56546
|
jsonBody: {};
|
|
56523
56547
|
commonParams: {
|
|
56524
|
-
/** ID of access method to
|
|
56548
|
+
/** ID of the access method that you want to delete. */
|
|
56525
56549
|
access_method_id: string;
|
|
56526
56550
|
};
|
|
56527
56551
|
formData: {};
|
|
@@ -56533,7 +56557,7 @@ export interface Routes {
|
|
|
56533
56557
|
queryParams: {};
|
|
56534
56558
|
jsonBody: {};
|
|
56535
56559
|
commonParams: {
|
|
56536
|
-
/** ID of access method to get. */
|
|
56560
|
+
/** ID of the access method that you want to get. */
|
|
56537
56561
|
access_method_id: string;
|
|
56538
56562
|
};
|
|
56539
56563
|
formData: {};
|
|
@@ -56565,7 +56589,7 @@ export interface Routes {
|
|
|
56565
56589
|
queryParams: {};
|
|
56566
56590
|
jsonBody: {};
|
|
56567
56591
|
commonParams: {
|
|
56568
|
-
/** ID of access grant to list access methods
|
|
56592
|
+
/** ID of the access grant by which to filter the list of access methods. */
|
|
56569
56593
|
access_grant_id: string;
|
|
56570
56594
|
};
|
|
56571
56595
|
formData: {};
|
|
@@ -56595,7 +56619,9 @@ export interface Routes {
|
|
|
56595
56619
|
method: 'POST' | 'PUT';
|
|
56596
56620
|
queryParams: {};
|
|
56597
56621
|
jsonBody: {
|
|
56622
|
+
/** ID of the location to which you want to add entrances. */
|
|
56598
56623
|
location_id: string;
|
|
56624
|
+
/** IDs of the entrances that you want to add to the location. */
|
|
56599
56625
|
acs_entrance_ids: string[];
|
|
56600
56626
|
};
|
|
56601
56627
|
commonParams: {};
|
|
@@ -56607,7 +56633,9 @@ export interface Routes {
|
|
|
56607
56633
|
method: 'POST' | 'PUT';
|
|
56608
56634
|
queryParams: {};
|
|
56609
56635
|
jsonBody: {
|
|
56636
|
+
/** ID of the location to which you want to add devices. */
|
|
56610
56637
|
location_id: string;
|
|
56638
|
+
/** IDs of the devices that you want to add to the location. */
|
|
56611
56639
|
device_ids: string[];
|
|
56612
56640
|
};
|
|
56613
56641
|
commonParams: {};
|
|
@@ -56619,13 +56647,18 @@ export interface Routes {
|
|
|
56619
56647
|
method: 'POST';
|
|
56620
56648
|
queryParams: {};
|
|
56621
56649
|
jsonBody: {
|
|
56650
|
+
/** Name of the new location. */
|
|
56622
56651
|
name: string;
|
|
56652
|
+
/** Geolocation of the new location. */
|
|
56623
56653
|
geolocation?: {
|
|
56624
56654
|
latitude: number;
|
|
56625
56655
|
longitude: number;
|
|
56626
56656
|
} | undefined;
|
|
56657
|
+
/** Time zone of the new location. */
|
|
56627
56658
|
time_zone?: string | undefined;
|
|
56659
|
+
/** IDs of the devices that you want to add to the new location. */
|
|
56628
56660
|
device_ids?: string[] | undefined;
|
|
56661
|
+
/** IDs of the entrances that you want to add to the new location. */
|
|
56629
56662
|
acs_entrance_ids?: string[] | undefined;
|
|
56630
56663
|
};
|
|
56631
56664
|
commonParams: {};
|
|
@@ -56657,6 +56690,7 @@ export interface Routes {
|
|
|
56657
56690
|
method: 'DELETE' | 'POST';
|
|
56658
56691
|
queryParams: {};
|
|
56659
56692
|
jsonBody: {
|
|
56693
|
+
/** ID of the location that you want to delete. */
|
|
56660
56694
|
location_id: string;
|
|
56661
56695
|
};
|
|
56662
56696
|
commonParams: {};
|
|
@@ -56669,6 +56703,7 @@ export interface Routes {
|
|
|
56669
56703
|
queryParams: {};
|
|
56670
56704
|
jsonBody: {};
|
|
56671
56705
|
commonParams: {
|
|
56706
|
+
/** ID of the location that you want to get. */
|
|
56672
56707
|
location_id: string;
|
|
56673
56708
|
};
|
|
56674
56709
|
formData: {};
|
|
@@ -56729,7 +56764,9 @@ export interface Routes {
|
|
|
56729
56764
|
queryParams: {};
|
|
56730
56765
|
jsonBody: {};
|
|
56731
56766
|
commonParams: {
|
|
56767
|
+
/** ID of the location from which you want to remove entrances. */
|
|
56732
56768
|
location_id: string;
|
|
56769
|
+
/** IDs of the entrances that you want to remove from the location. */
|
|
56733
56770
|
acs_entrance_ids: string[];
|
|
56734
56771
|
};
|
|
56735
56772
|
formData: {};
|
|
@@ -56741,7 +56778,9 @@ export interface Routes {
|
|
|
56741
56778
|
queryParams: {};
|
|
56742
56779
|
jsonBody: {};
|
|
56743
56780
|
commonParams: {
|
|
56781
|
+
/** ID of the location from which you want to remove devices. */
|
|
56744
56782
|
location_id: string;
|
|
56783
|
+
/** IDs of the devices that you want to remove from the location. */
|
|
56745
56784
|
device_ids: string[];
|
|
56746
56785
|
};
|
|
56747
56786
|
formData: {};
|
|
@@ -56752,12 +56791,16 @@ export interface Routes {
|
|
|
56752
56791
|
method: 'POST' | 'PATCH';
|
|
56753
56792
|
queryParams: {};
|
|
56754
56793
|
jsonBody: {
|
|
56794
|
+
/** ID of the location that you want to update. */
|
|
56755
56795
|
location_id: string;
|
|
56796
|
+
/** Name of the location. */
|
|
56756
56797
|
name?: string | undefined;
|
|
56798
|
+
/** Geolocation of the location. */
|
|
56757
56799
|
geolocation?: {
|
|
56758
56800
|
latitude: number;
|
|
56759
56801
|
longitude: number;
|
|
56760
56802
|
} | undefined;
|
|
56803
|
+
/** Time zone of the the location. */
|
|
56761
56804
|
time_zone?: string | undefined;
|
|
56762
56805
|
};
|
|
56763
56806
|
commonParams: {};
|
|
@@ -56790,6 +56833,7 @@ export interface Routes {
|
|
|
56790
56833
|
queryParams: {};
|
|
56791
56834
|
jsonBody: {};
|
|
56792
56835
|
commonParams: {
|
|
56836
|
+
/** Customer key for which you want to connect accounts. */
|
|
56793
56837
|
customer_key: string;
|
|
56794
56838
|
};
|
|
56795
56839
|
formData: {};
|
|
@@ -56811,15 +56855,21 @@ export interface Routes {
|
|
|
56811
56855
|
queryParams: {};
|
|
56812
56856
|
jsonBody: {};
|
|
56813
56857
|
commonParams: {
|
|
56858
|
+
/** `connect_accounts` building block type. */
|
|
56814
56859
|
building_block_type: 'connect_accounts';
|
|
56860
|
+
/** Customer key for which you want to create a new building block magic link. */
|
|
56815
56861
|
customer_key: string;
|
|
56816
56862
|
} | {
|
|
56863
|
+
/** `manage_devices` building block type. */
|
|
56817
56864
|
building_block_type: 'manage_devices';
|
|
56865
|
+
/** Customer key for which you want to create a new building block magic link. */
|
|
56818
56866
|
customer_key: string;
|
|
56819
56867
|
} | {
|
|
56868
|
+
/** `organize_spaces` building block type. */
|
|
56820
56869
|
building_block_type: 'organize_spaces';
|
|
56870
|
+
/** Customer key for which you want to create a new building block magic link. */
|
|
56821
56871
|
customer_key: string;
|
|
56822
|
-
/** Optional list of partner resources to include in the magic link. */
|
|
56872
|
+
/** Optional list of partner resources that you want to include in the new building block magic link. */
|
|
56823
56873
|
partner_resources?: Array<{
|
|
56824
56874
|
partner_resource_key: string;
|
|
56825
56875
|
name: string;
|
|
@@ -56846,6 +56896,7 @@ export interface Routes {
|
|
|
56846
56896
|
queryParams: {};
|
|
56847
56897
|
jsonBody: {};
|
|
56848
56898
|
commonParams: {
|
|
56899
|
+
/** Customer key for which you want to manage devices. */
|
|
56849
56900
|
customer_key: string;
|
|
56850
56901
|
};
|
|
56851
56902
|
formData: {};
|
|
@@ -56867,7 +56918,9 @@ export interface Routes {
|
|
|
56867
56918
|
queryParams: {};
|
|
56868
56919
|
jsonBody: {};
|
|
56869
56920
|
commonParams: {
|
|
56921
|
+
/** Customer key for which you want to organize spaces. */
|
|
56870
56922
|
customer_key: string;
|
|
56923
|
+
/** Optional list of partner resources that you want to include in the new building block magic link. */
|
|
56871
56924
|
partner_resources?: Array<{
|
|
56872
56925
|
partner_resource_key: string;
|
|
56873
56926
|
name: string;
|
|
@@ -56893,8 +56946,11 @@ export interface Routes {
|
|
|
56893
56946
|
method: 'POST';
|
|
56894
56947
|
queryParams: {};
|
|
56895
56948
|
jsonBody: Array<{
|
|
56949
|
+
/** Type of the resource that you want to push to Seam. */
|
|
56896
56950
|
partner_resource_type?: string | undefined;
|
|
56951
|
+
/** Key of the resource that you want to push to Seam. */
|
|
56897
56952
|
partner_resource_key?: string | undefined;
|
|
56953
|
+
/** Customer key associated with the resource that you want to push to Seam. */
|
|
56898
56954
|
customer_key?: string | undefined;
|
|
56899
56955
|
email_address?: string | undefined;
|
|
56900
56956
|
phone_number?: string | undefined;
|
|
@@ -56906,8 +56962,11 @@ export interface Routes {
|
|
|
56906
56962
|
description?: string | undefined;
|
|
56907
56963
|
custom_metadata?: Record<string, string> | undefined;
|
|
56908
56964
|
}> | {
|
|
56965
|
+
/** Type of the resource that you want to push to Seam. */
|
|
56909
56966
|
partner_resource_type?: string | undefined;
|
|
56967
|
+
/** Key of the resource that you want to push to Seam. */
|
|
56910
56968
|
partner_resource_key?: string | undefined;
|
|
56969
|
+
/** Customer key associated with the resource that you want to push to Seam. */
|
|
56911
56970
|
customer_key?: string | undefined;
|
|
56912
56971
|
email_address?: string | undefined;
|
|
56913
56972
|
phone_number?: string | undefined;
|
|
@@ -56929,9 +56988,9 @@ export interface Routes {
|
|
|
56929
56988
|
queryParams: {};
|
|
56930
56989
|
jsonBody: {};
|
|
56931
56990
|
commonParams: {
|
|
56932
|
-
/** ID of the
|
|
56991
|
+
/** ID of the user identity to which you want to add an access system user. */
|
|
56933
56992
|
user_identity_id: string;
|
|
56934
|
-
/** ID of the
|
|
56993
|
+
/** ID of the access system user that you want to add to the user identity. */
|
|
56935
56994
|
acs_user_id: string;
|
|
56936
56995
|
};
|
|
56937
56996
|
formData: {};
|
|
@@ -56943,15 +57002,15 @@ export interface Routes {
|
|
|
56943
57002
|
queryParams: {};
|
|
56944
57003
|
jsonBody: {};
|
|
56945
57004
|
commonParams: {
|
|
56946
|
-
/** Unique key for the user identity. */
|
|
57005
|
+
/** Unique key for the new user identity. */
|
|
56947
57006
|
user_identity_key?: (string | null) | undefined;
|
|
56948
|
-
/** Unique email address for the user identity. */
|
|
57007
|
+
/** Unique email address for the new user identity. */
|
|
56949
57008
|
email_address?: (string | null) | undefined;
|
|
56950
|
-
/** Unique phone number for the user identity in E.164 format (for example, +15555550100). */
|
|
57009
|
+
/** Unique phone number for the new user identity in E.164 format (for example, +15555550100). */
|
|
56951
57010
|
phone_number?: (string | null) | undefined;
|
|
56952
|
-
/** Full name of the user associated with the user identity. */
|
|
57011
|
+
/** Full name of the user associated with the new user identity. */
|
|
56953
57012
|
full_name?: (string | null) | undefined;
|
|
56954
|
-
/** List of
|
|
57013
|
+
/** 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. */
|
|
56955
57014
|
acs_system_ids?: string[] | undefined;
|
|
56956
57015
|
};
|
|
56957
57016
|
formData: {};
|
|
@@ -56981,7 +57040,7 @@ export interface Routes {
|
|
|
56981
57040
|
queryParams: {};
|
|
56982
57041
|
jsonBody: {};
|
|
56983
57042
|
commonParams: {
|
|
56984
|
-
/** ID of the
|
|
57043
|
+
/** ID of the user identity that you want to delete. */
|
|
56985
57044
|
user_identity_id: string;
|
|
56986
57045
|
};
|
|
56987
57046
|
formData: {};
|
|
@@ -56993,7 +57052,7 @@ export interface Routes {
|
|
|
56993
57052
|
queryParams: {};
|
|
56994
57053
|
jsonBody: {};
|
|
56995
57054
|
commonParams: {
|
|
56996
|
-
/** ID of the
|
|
57055
|
+
/** ID of the enrollment automation that you want to delete. */
|
|
56997
57056
|
enrollment_automation_id: string;
|
|
56998
57057
|
};
|
|
56999
57058
|
formData: {};
|
|
@@ -57005,7 +57064,7 @@ export interface Routes {
|
|
|
57005
57064
|
queryParams: {};
|
|
57006
57065
|
jsonBody: {};
|
|
57007
57066
|
commonParams: {
|
|
57008
|
-
/** ID of the
|
|
57067
|
+
/** ID of the enrollment automation that you want to get. */
|
|
57009
57068
|
enrollment_automation_id: string;
|
|
57010
57069
|
};
|
|
57011
57070
|
formData: {};
|
|
@@ -57031,15 +57090,15 @@ export interface Routes {
|
|
|
57031
57090
|
queryParams: {};
|
|
57032
57091
|
jsonBody: {};
|
|
57033
57092
|
commonParams: {
|
|
57034
|
-
/** ID of the
|
|
57093
|
+
/** ID of the user identity for which you want to launch an enrollment automation. */
|
|
57035
57094
|
user_identity_id: string;
|
|
57036
|
-
/** ID of the desired
|
|
57095
|
+
/** ID of the desired access system that serves as the credential manager for the enrollment automation. */
|
|
57037
57096
|
credential_manager_acs_system_id: string;
|
|
57038
|
-
/** ID of the
|
|
57097
|
+
/** ID of the credential pool from which to obtain credentials for the user identity. */
|
|
57039
57098
|
acs_credential_pool_id?: string | undefined;
|
|
57040
57099
|
/** 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`. */
|
|
57041
57100
|
create_credential_manager_user?: boolean | undefined;
|
|
57042
|
-
/** ID of the associated
|
|
57101
|
+
/** 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`. */
|
|
57043
57102
|
credential_manager_acs_user_id?: string | undefined;
|
|
57044
57103
|
};
|
|
57045
57104
|
formData: {};
|
|
@@ -57060,7 +57119,7 @@ export interface Routes {
|
|
|
57060
57119
|
queryParams: {};
|
|
57061
57120
|
jsonBody: {};
|
|
57062
57121
|
commonParams: {
|
|
57063
|
-
/** ID of the user identity for which you want to retrieve
|
|
57122
|
+
/** ID of the user identity for which you want to retrieve enrollment automations. */
|
|
57064
57123
|
user_identity_id: string;
|
|
57065
57124
|
};
|
|
57066
57125
|
formData: {};
|
|
@@ -57087,7 +57146,7 @@ export interface Routes {
|
|
|
57087
57146
|
commonParams: {
|
|
57088
57147
|
/** ID of the user identity for which you want to generate an instant key. */
|
|
57089
57148
|
user_identity_id: string;
|
|
57090
|
-
/**
|
|
57149
|
+
/** Maximum number of times the instant key can be used. Default: 1. */
|
|
57091
57150
|
max_use_count?: number;
|
|
57092
57151
|
};
|
|
57093
57152
|
formData: {};
|
|
@@ -57110,7 +57169,7 @@ export interface Routes {
|
|
|
57110
57169
|
queryParams: {};
|
|
57111
57170
|
jsonBody: {};
|
|
57112
57171
|
commonParams: {
|
|
57113
|
-
/** ID of the
|
|
57172
|
+
/** ID of the user identity that you want to get. */
|
|
57114
57173
|
user_identity_id: string;
|
|
57115
57174
|
} | {
|
|
57116
57175
|
user_identity_key: string;
|
|
@@ -57142,9 +57201,9 @@ export interface Routes {
|
|
|
57142
57201
|
queryParams: {};
|
|
57143
57202
|
jsonBody: {};
|
|
57144
57203
|
commonParams: {
|
|
57145
|
-
/** ID of the
|
|
57204
|
+
/** ID of the user identity that you want to grant access to a device. */
|
|
57146
57205
|
user_identity_id: string;
|
|
57147
|
-
/** ID of the
|
|
57206
|
+
/** ID of the managed device to which you want to grant access to the user identity. */
|
|
57148
57207
|
device_id: string;
|
|
57149
57208
|
};
|
|
57150
57209
|
formData: {};
|
|
@@ -57156,6 +57215,7 @@ export interface Routes {
|
|
|
57156
57215
|
queryParams: {};
|
|
57157
57216
|
jsonBody: {};
|
|
57158
57217
|
commonParams: {
|
|
57218
|
+
/** `acs_system_id` of the credential manager by which you want to filter the list of user identities. */
|
|
57159
57219
|
credential_manager_acs_system_id?: string | undefined;
|
|
57160
57220
|
};
|
|
57161
57221
|
formData: {};
|
|
@@ -58393,7 +58453,7 @@ export interface Routes {
|
|
|
58393
58453
|
can_simulate_disconnection?: boolean | undefined;
|
|
58394
58454
|
}>;
|
|
58395
58455
|
/**
|
|
58396
|
-
* @deprecated
|
|
58456
|
+
* @deprecated Use devices. */
|
|
58397
58457
|
accessible_devices: Array<{
|
|
58398
58458
|
/** Unique identifier for the device. */
|
|
58399
58459
|
device_id: string;
|
|
@@ -59605,7 +59665,7 @@ export interface Routes {
|
|
|
59605
59665
|
queryParams: {};
|
|
59606
59666
|
jsonBody: {};
|
|
59607
59667
|
commonParams: {
|
|
59608
|
-
/** ID of the user identity for which you want to retrieve all access
|
|
59668
|
+
/** ID of the user identity for which you want to retrieve all access systems. */
|
|
59609
59669
|
user_identity_id: string;
|
|
59610
59670
|
};
|
|
59611
59671
|
formData: {};
|
|
@@ -59736,7 +59796,7 @@ export interface Routes {
|
|
|
59736
59796
|
queryParams: {};
|
|
59737
59797
|
jsonBody: {};
|
|
59738
59798
|
commonParams: {
|
|
59739
|
-
/** ID of the user identity for which you want to retrieve all
|
|
59799
|
+
/** ID of the user identity for which you want to retrieve all access system users. */
|
|
59740
59800
|
user_identity_id: string;
|
|
59741
59801
|
};
|
|
59742
59802
|
formData: {};
|
|
@@ -59935,9 +59995,9 @@ export interface Routes {
|
|
|
59935
59995
|
queryParams: {};
|
|
59936
59996
|
jsonBody: {};
|
|
59937
59997
|
commonParams: {
|
|
59938
|
-
/** ID of the
|
|
59998
|
+
/** ID of the user identity from which you want to remove an access system user. */
|
|
59939
59999
|
user_identity_id: string;
|
|
59940
|
-
/** ID of the
|
|
60000
|
+
/** ID of the access system user that you want to remove from the user identity.. */
|
|
59941
60001
|
acs_user_id: string;
|
|
59942
60002
|
};
|
|
59943
60003
|
formData: {};
|
|
@@ -59949,9 +60009,9 @@ export interface Routes {
|
|
|
59949
60009
|
queryParams: {};
|
|
59950
60010
|
jsonBody: {};
|
|
59951
60011
|
commonParams: {
|
|
59952
|
-
/** ID of the
|
|
60012
|
+
/** ID of the user identity from which you want to revoke access to a device. */
|
|
59953
60013
|
user_identity_id: string;
|
|
59954
|
-
/** ID of the
|
|
60014
|
+
/** ID of the managed device to which you want to revoke access from the user identity. */
|
|
59955
60015
|
device_id: string;
|
|
59956
60016
|
};
|
|
59957
60017
|
formData: {};
|
|
@@ -59962,14 +60022,15 @@ export interface Routes {
|
|
|
59962
60022
|
method: 'PATCH' | 'POST';
|
|
59963
60023
|
queryParams: {};
|
|
59964
60024
|
jsonBody: {
|
|
59965
|
-
/** ID of the user identity. */
|
|
60025
|
+
/** ID of the user identity that you want to update. */
|
|
59966
60026
|
user_identity_id: string;
|
|
59967
60027
|
/** Unique key for the user identity. */
|
|
59968
60028
|
user_identity_key?: (string | null) | undefined;
|
|
59969
60029
|
/** Unique email address for the user identity. */
|
|
59970
60030
|
email_address?: (string | null) | undefined;
|
|
59971
|
-
/** Unique phone number for the user identity
|
|
60031
|
+
/** Unique phone number for the user identity. */
|
|
59972
60032
|
phone_number?: (string | null) | undefined;
|
|
60033
|
+
/** Full name of the user associated with the user identity. */
|
|
59973
60034
|
full_name?: (string | null) | undefined;
|
|
59974
60035
|
};
|
|
59975
60036
|
commonParams: {};
|
|
@@ -59981,7 +60042,9 @@ export interface Routes {
|
|
|
59981
60042
|
method: 'POST';
|
|
59982
60043
|
queryParams: {};
|
|
59983
60044
|
jsonBody: {
|
|
60045
|
+
/** URL for the new webhook. */
|
|
59984
60046
|
url: string;
|
|
60047
|
+
/** Types of events that you want the new webhook to receive. */
|
|
59985
60048
|
event_types?: string[];
|
|
59986
60049
|
};
|
|
59987
60050
|
commonParams: {};
|
|
@@ -60002,6 +60065,7 @@ export interface Routes {
|
|
|
60002
60065
|
queryParams: {};
|
|
60003
60066
|
jsonBody: {};
|
|
60004
60067
|
commonParams: {
|
|
60068
|
+
/** ID of the webhook that you want to delete. */
|
|
60005
60069
|
webhook_id: string;
|
|
60006
60070
|
};
|
|
60007
60071
|
formData: {};
|
|
@@ -60013,6 +60077,7 @@ export interface Routes {
|
|
|
60013
60077
|
queryParams: {};
|
|
60014
60078
|
jsonBody: {};
|
|
60015
60079
|
commonParams: {
|
|
60080
|
+
/** ID of the webhook that you want to get. */
|
|
60016
60081
|
webhook_id: string;
|
|
60017
60082
|
};
|
|
60018
60083
|
formData: {};
|
|
@@ -60047,7 +60112,9 @@ export interface Routes {
|
|
|
60047
60112
|
method: 'PUT' | 'POST';
|
|
60048
60113
|
queryParams: {};
|
|
60049
60114
|
jsonBody: {
|
|
60115
|
+
/** ID of the webhook that you want to update. */
|
|
60050
60116
|
webhook_id: string;
|
|
60117
|
+
/** Types of events that you want the webhook to receive. */
|
|
60051
60118
|
event_types: string[];
|
|
60052
60119
|
};
|
|
60053
60120
|
commonParams: {};
|
|
@@ -60059,11 +60126,13 @@ export interface Routes {
|
|
|
60059
60126
|
method: 'POST';
|
|
60060
60127
|
queryParams: {};
|
|
60061
60128
|
jsonBody: {
|
|
60129
|
+
/** Name of the new workspace. */
|
|
60062
60130
|
name: string;
|
|
60131
|
+
/** Company name for the new workspace. */
|
|
60063
60132
|
company_name?: string | undefined;
|
|
60064
|
-
/**
|
|
60065
|
-
* @deprecated use company_name */
|
|
60133
|
+
/** Connect partner name for the new workspace. */
|
|
60066
60134
|
connect_partner_name?: ((string | null) | null) | undefined;
|
|
60135
|
+
/** Indicates whether the new workspace is a [sandbox workspace](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). */
|
|
60067
60136
|
is_sandbox?: boolean;
|
|
60068
60137
|
/**
|
|
60069
60138
|
* @deprecated Use `connect_webview_customization.webview_primary_button_color` instead. */
|
|
@@ -60077,10 +60146,15 @@ export interface Routes {
|
|
|
60077
60146
|
/**
|
|
60078
60147
|
* @deprecated Use `connect_webview_customization.webview_success_message` instead. */
|
|
60079
60148
|
webview_success_message?: string | undefined;
|
|
60149
|
+
/** [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). */
|
|
60080
60150
|
connect_webview_customization?: {
|
|
60151
|
+
/** 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). */
|
|
60081
60152
|
primary_button_color?: (string | null) | undefined;
|
|
60153
|
+
/** 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). */
|
|
60082
60154
|
primary_button_text_color?: (string | null) | undefined;
|
|
60155
|
+
/** 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). */
|
|
60083
60156
|
success_message?: (string | null) | undefined;
|
|
60157
|
+
/** 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). */
|
|
60084
60158
|
logo_shape?: (('circle' | 'square') | null) | undefined;
|
|
60085
60159
|
} | undefined;
|
|
60086
60160
|
};
|
|
@@ -61283,14 +61357,22 @@ export interface Routes {
|
|
|
61283
61357
|
method: 'POST' | 'PATCH';
|
|
61284
61358
|
queryParams: {};
|
|
61285
61359
|
jsonBody: {
|
|
61360
|
+
/** Name of the workspace. */
|
|
61286
61361
|
name?: string | undefined;
|
|
61362
|
+
/** Connect partner name for the workspace. */
|
|
61287
61363
|
connect_partner_name?: string | undefined;
|
|
61364
|
+
/** [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). */
|
|
61288
61365
|
connect_webview_customization?: {
|
|
61366
|
+
/** 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). */
|
|
61289
61367
|
primary_button_color?: (string | null) | undefined;
|
|
61368
|
+
/** 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). */
|
|
61290
61369
|
primary_button_text_color?: (string | null) | undefined;
|
|
61370
|
+
/** 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). */
|
|
61291
61371
|
success_message?: (string | null) | undefined;
|
|
61372
|
+
/** 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). */
|
|
61292
61373
|
logo_shape?: (('circle' | 'square') | null) | undefined;
|
|
61293
61374
|
} | undefined;
|
|
61375
|
+
/** Indicates whether the workspace is suspended. */
|
|
61294
61376
|
is_suspended?: boolean | undefined;
|
|
61295
61377
|
};
|
|
61296
61378
|
commonParams: {};
|