@seamapi/types 1.70.0 → 1.72.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +2600 -895
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +11812 -8664
- package/dist/devicedb.cjs +1 -1
- package/dist/devicedb.cjs.map +1 -1
- package/dist/devicedb.d.cts +3 -1
- package/lib/seam/connect/openapi.d.ts +3483 -1430
- package/lib/seam/connect/openapi.js +2595 -890
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +1325 -230
- package/lib/seam/connect/unstable/models/acs/credential.js +1 -0
- package/lib/seam/connect/unstable/models/acs/credential.js.map +1 -1
- package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.d.ts +22 -2
- package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js +7 -0
- package/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.js.map +1 -1
- package/lib/seam/connect/unstable/models/acs/system.d.ts +7 -7
- package/lib/seam/connect/unstable/models/acs/system.js +1 -1
- package/lib/seam/connect/unstable/models/acs/system.js.map +1 -1
- package/lib/seam/connect/unstable/models/devices/index.d.ts +1 -0
- package/lib/seam/connect/unstable/models/devices/index.js +1 -0
- package/lib/seam/connect/unstable/models/devices/index.js.map +1 -1
- package/lib/seam/connect/unstable/models/devices/managed-device.d.ts +82 -8
- package/lib/seam/connect/unstable/models/devices/managed-device.js +2 -0
- package/lib/seam/connect/unstable/models/devices/managed-device.js.map +1 -1
- package/lib/seam/connect/unstable/models/devices/phone-properties.d.ts +44 -0
- package/lib/seam/connect/unstable/models/devices/phone-properties.js +13 -0
- package/lib/seam/connect/unstable/models/devices/phone-properties.js.map +1 -0
- package/lib/seam/connect/unstable/models/devices/phone.d.ts +3529 -0
- package/lib/seam/connect/unstable/models/devices/phone.js +13 -0
- package/lib/seam/connect/unstable/models/devices/phone.js.map +1 -0
- package/lib/seam/connect/unstable/models/index.d.ts +1 -0
- package/lib/seam/connect/unstable/models/index.js +1 -0
- package/lib/seam/connect/unstable/models/index.js.map +1 -1
- package/lib/seam/connect/unstable/models/network.d.ts +18 -0
- package/lib/seam/connect/unstable/models/network.js +8 -0
- package/lib/seam/connect/unstable/models/network.js.map +1 -0
- package/lib/seam/connect/unstable/schemas.d.ts +1 -1
- package/lib/seam/connect/unstable/schemas.js +1 -1
- package/lib/seam/connect/unstable/schemas.js.map +1 -1
- package/lib/seam/devicedb/public-models/manufacturer.d.ts +1 -0
- package/lib/seam/devicedb/public-models/manufacturer.js +1 -1
- package/lib/seam/devicedb/public-models/manufacturer.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/openapi.ts +2644 -915
- package/src/lib/seam/connect/route-types.ts +1701 -211
- package/src/lib/seam/connect/unstable/models/acs/credential.ts +1 -0
- package/src/lib/seam/connect/unstable/models/acs/credential_provisioning_automation.ts +12 -0
- package/src/lib/seam/connect/unstable/models/acs/system.ts +1 -1
- package/src/lib/seam/connect/unstable/models/devices/index.ts +1 -0
- package/src/lib/seam/connect/unstable/models/devices/managed-device.ts +2 -0
- package/src/lib/seam/connect/unstable/models/devices/phone-properties.ts +15 -0
- package/src/lib/seam/connect/unstable/models/devices/phone.ts +15 -0
- package/src/lib/seam/connect/unstable/models/index.ts +1 -0
- package/src/lib/seam/connect/unstable/models/network.ts +10 -0
- package/src/lib/seam/connect/unstable/schemas.ts +3 -0
- package/src/lib/seam/devicedb/public-models/manufacturer.ts +3 -1
|
@@ -1012,10 +1012,10 @@ export interface Routes {
|
|
|
1012
1012
|
jsonResponse: {
|
|
1013
1013
|
acs_system: {
|
|
1014
1014
|
acs_system_id: string;
|
|
1015
|
-
external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | '
|
|
1015
|
+
external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service';
|
|
1016
1016
|
external_type_display_name: string;
|
|
1017
1017
|
/** deprecated: use external_type */
|
|
1018
|
-
system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | '
|
|
1018
|
+
system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service';
|
|
1019
1019
|
/** deprecated: use external_type_display_name */
|
|
1020
1020
|
system_type_display_name: string;
|
|
1021
1021
|
name: string;
|
|
@@ -1037,10 +1037,10 @@ export interface Routes {
|
|
|
1037
1037
|
jsonResponse: {
|
|
1038
1038
|
acs_systems: Array<{
|
|
1039
1039
|
acs_system_id: string;
|
|
1040
|
-
external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | '
|
|
1040
|
+
external_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service';
|
|
1041
1041
|
external_type_display_name: string;
|
|
1042
1042
|
/** deprecated: use external_type */
|
|
1043
|
-
system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | '
|
|
1043
|
+
system_type: 'pti_site' | 'alta_org' | 'salto_site' | 'brivo_account' | 'hid_credential_manager_organization' | 'visionline_system' | 'assa_abloy_credential_service';
|
|
1044
1044
|
/** deprecated: use external_type_display_name */
|
|
1045
1045
|
system_type_display_name: string;
|
|
1046
1046
|
name: string;
|
|
@@ -1219,6 +1219,10 @@ export interface Routes {
|
|
|
1219
1219
|
method: 'PATCH' | 'POST';
|
|
1220
1220
|
queryParams: {};
|
|
1221
1221
|
jsonBody: {
|
|
1222
|
+
access_schedule?: {
|
|
1223
|
+
starts_at: string;
|
|
1224
|
+
ends_at: string;
|
|
1225
|
+
} | undefined;
|
|
1222
1226
|
acs_user_id: string;
|
|
1223
1227
|
full_name?: string | undefined;
|
|
1224
1228
|
/** Deprecated: use email_address. */
|
|
@@ -1702,7 +1706,7 @@ export interface Routes {
|
|
|
1702
1706
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
1703
1707
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
1704
1708
|
/** Properties of the device. */
|
|
1705
|
-
properties: ({
|
|
1709
|
+
properties: (({
|
|
1706
1710
|
/** Indicates whether the device is online. */
|
|
1707
1711
|
online: boolean;
|
|
1708
1712
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -2110,7 +2114,15 @@ export interface Routes {
|
|
|
2110
2114
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
2111
2115
|
max_cooling_set_point_celsius?: number | undefined;
|
|
2112
2116
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
2113
|
-
}))
|
|
2117
|
+
}))) & {
|
|
2118
|
+
assa_abloy_credential_service_metadata?: ({
|
|
2119
|
+
has_active_endpoint: boolean;
|
|
2120
|
+
endpoints: Array<{
|
|
2121
|
+
endpoint_id: string;
|
|
2122
|
+
is_active: boolean;
|
|
2123
|
+
}>;
|
|
2124
|
+
} | undefined) | undefined;
|
|
2125
|
+
};
|
|
2114
2126
|
/** Location information for the device. */
|
|
2115
2127
|
location: {
|
|
2116
2128
|
/** Name of the device location. */
|
|
@@ -2167,7 +2179,7 @@ export interface Routes {
|
|
|
2167
2179
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
2168
2180
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
2169
2181
|
/** Properties of the device. */
|
|
2170
|
-
properties: ({
|
|
2182
|
+
properties: (({
|
|
2171
2183
|
/** Indicates whether the device is online. */
|
|
2172
2184
|
online: boolean;
|
|
2173
2185
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -2575,7 +2587,15 @@ export interface Routes {
|
|
|
2575
2587
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
2576
2588
|
max_cooling_set_point_celsius?: number | undefined;
|
|
2577
2589
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
2578
|
-
}))
|
|
2590
|
+
}))) & {
|
|
2591
|
+
assa_abloy_credential_service_metadata?: ({
|
|
2592
|
+
has_active_endpoint: boolean;
|
|
2593
|
+
endpoints: Array<{
|
|
2594
|
+
endpoint_id: string;
|
|
2595
|
+
is_active: boolean;
|
|
2596
|
+
}>;
|
|
2597
|
+
} | undefined) | undefined;
|
|
2598
|
+
};
|
|
2579
2599
|
/** Location information for the device. */
|
|
2580
2600
|
location: {
|
|
2581
2601
|
/** Name of the device location. */
|
|
@@ -2951,7 +2971,7 @@ export interface Routes {
|
|
|
2951
2971
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
2952
2972
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
2953
2973
|
/** Properties of the device. */
|
|
2954
|
-
properties: ({
|
|
2974
|
+
properties: (({
|
|
2955
2975
|
/** Indicates whether the device is online. */
|
|
2956
2976
|
online: boolean;
|
|
2957
2977
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -3359,7 +3379,15 @@ export interface Routes {
|
|
|
3359
3379
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
3360
3380
|
max_cooling_set_point_celsius?: number | undefined;
|
|
3361
3381
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
3362
|
-
}))
|
|
3382
|
+
}))) & {
|
|
3383
|
+
assa_abloy_credential_service_metadata?: ({
|
|
3384
|
+
has_active_endpoint: boolean;
|
|
3385
|
+
endpoints: Array<{
|
|
3386
|
+
endpoint_id: string;
|
|
3387
|
+
is_active: boolean;
|
|
3388
|
+
}>;
|
|
3389
|
+
} | undefined) | undefined;
|
|
3390
|
+
};
|
|
3363
3391
|
/** Location information for the device. */
|
|
3364
3392
|
location: {
|
|
3365
3393
|
/** Name of the device location. */
|
|
@@ -3394,7 +3422,7 @@ export interface Routes {
|
|
|
3394
3422
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
3395
3423
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
3396
3424
|
/** Properties of the device. */
|
|
3397
|
-
properties: ({
|
|
3425
|
+
properties: (({
|
|
3398
3426
|
/** Indicates whether the device is online. */
|
|
3399
3427
|
online: boolean;
|
|
3400
3428
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -3802,7 +3830,15 @@ export interface Routes {
|
|
|
3802
3830
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
3803
3831
|
max_cooling_set_point_celsius?: number | undefined;
|
|
3804
3832
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
3805
|
-
}))
|
|
3833
|
+
}))) & {
|
|
3834
|
+
assa_abloy_credential_service_metadata?: ({
|
|
3835
|
+
has_active_endpoint: boolean;
|
|
3836
|
+
endpoints: Array<{
|
|
3837
|
+
endpoint_id: string;
|
|
3838
|
+
is_active: boolean;
|
|
3839
|
+
}>;
|
|
3840
|
+
} | undefined) | undefined;
|
|
3841
|
+
};
|
|
3806
3842
|
/** Location information for the device. */
|
|
3807
3843
|
location: {
|
|
3808
3844
|
/** Name of the device location. */
|
|
@@ -3859,7 +3895,7 @@ export interface Routes {
|
|
|
3859
3895
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
3860
3896
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
3861
3897
|
/** Properties of the device. */
|
|
3862
|
-
properties: ({
|
|
3898
|
+
properties: (({
|
|
3863
3899
|
/** Indicates whether the device is online. */
|
|
3864
3900
|
online: boolean;
|
|
3865
3901
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -4267,7 +4303,15 @@ export interface Routes {
|
|
|
4267
4303
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
4268
4304
|
max_cooling_set_point_celsius?: number | undefined;
|
|
4269
4305
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
4270
|
-
}))
|
|
4306
|
+
}))) & {
|
|
4307
|
+
assa_abloy_credential_service_metadata?: ({
|
|
4308
|
+
has_active_endpoint: boolean;
|
|
4309
|
+
endpoints: Array<{
|
|
4310
|
+
endpoint_id: string;
|
|
4311
|
+
is_active: boolean;
|
|
4312
|
+
}>;
|
|
4313
|
+
} | undefined) | undefined;
|
|
4314
|
+
};
|
|
4271
4315
|
/** Location information for the device. */
|
|
4272
4316
|
location: {
|
|
4273
4317
|
/** Name of the device location. */
|
|
@@ -4302,7 +4346,7 @@ export interface Routes {
|
|
|
4302
4346
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
4303
4347
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
4304
4348
|
/** Properties of the device. */
|
|
4305
|
-
properties: ({
|
|
4349
|
+
properties: (({
|
|
4306
4350
|
/** Indicates whether the device is online. */
|
|
4307
4351
|
online: boolean;
|
|
4308
4352
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -4710,7 +4754,15 @@ export interface Routes {
|
|
|
4710
4754
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
4711
4755
|
max_cooling_set_point_celsius?: number | undefined;
|
|
4712
4756
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
4713
|
-
}))
|
|
4757
|
+
}))) & {
|
|
4758
|
+
assa_abloy_credential_service_metadata?: ({
|
|
4759
|
+
has_active_endpoint: boolean;
|
|
4760
|
+
endpoints: Array<{
|
|
4761
|
+
endpoint_id: string;
|
|
4762
|
+
is_active: boolean;
|
|
4763
|
+
}>;
|
|
4764
|
+
} | undefined) | undefined;
|
|
4765
|
+
};
|
|
4714
4766
|
/** Location information for the device. */
|
|
4715
4767
|
location: {
|
|
4716
4768
|
/** Name of the device location. */
|
|
@@ -4809,6 +4861,40 @@ export interface Routes {
|
|
|
4809
4861
|
};
|
|
4810
4862
|
};
|
|
4811
4863
|
};
|
|
4864
|
+
'/networks/get': {
|
|
4865
|
+
route: '/networks/get';
|
|
4866
|
+
method: 'GET' | 'POST';
|
|
4867
|
+
queryParams: {};
|
|
4868
|
+
jsonBody: {};
|
|
4869
|
+
commonParams: {
|
|
4870
|
+
network_id: string;
|
|
4871
|
+
};
|
|
4872
|
+
formData: {};
|
|
4873
|
+
jsonResponse: {
|
|
4874
|
+
network: {
|
|
4875
|
+
network_id: string;
|
|
4876
|
+
workspace_id: string;
|
|
4877
|
+
display_name: string;
|
|
4878
|
+
created_at: string;
|
|
4879
|
+
};
|
|
4880
|
+
};
|
|
4881
|
+
};
|
|
4882
|
+
'/networks/list': {
|
|
4883
|
+
route: '/networks/list';
|
|
4884
|
+
method: 'GET' | 'POST';
|
|
4885
|
+
queryParams: {};
|
|
4886
|
+
jsonBody: {};
|
|
4887
|
+
commonParams: {};
|
|
4888
|
+
formData: {};
|
|
4889
|
+
jsonResponse: {
|
|
4890
|
+
networks: Array<{
|
|
4891
|
+
network_id: string;
|
|
4892
|
+
workspace_id: string;
|
|
4893
|
+
display_name: string;
|
|
4894
|
+
created_at: string;
|
|
4895
|
+
}>;
|
|
4896
|
+
};
|
|
4897
|
+
};
|
|
4812
4898
|
'/noise_sensors/noise_thresholds/create': {
|
|
4813
4899
|
route: '/noise_sensors/noise_thresholds/create';
|
|
4814
4900
|
method: 'POST';
|
|
@@ -4989,201 +5075,24 @@ export interface Routes {
|
|
|
4989
5075
|
formData: {};
|
|
4990
5076
|
jsonResponse: {};
|
|
4991
5077
|
};
|
|
4992
|
-
'/
|
|
4993
|
-
route: '/
|
|
4994
|
-
method: 'POST';
|
|
4995
|
-
queryParams: {};
|
|
4996
|
-
jsonBody: {
|
|
4997
|
-
schedule_type?: 'time_bound';
|
|
4998
|
-
device_id: string;
|
|
4999
|
-
name?: string | undefined;
|
|
5000
|
-
schedule_starts_at: string;
|
|
5001
|
-
schedule_ends_at: string;
|
|
5002
|
-
automatic_heating_enabled?: boolean | undefined;
|
|
5003
|
-
automatic_cooling_enabled?: boolean | undefined;
|
|
5004
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5005
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5006
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5007
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5008
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5009
|
-
manual_override_allowed?: boolean | undefined;
|
|
5010
|
-
};
|
|
5011
|
-
commonParams: {};
|
|
5012
|
-
formData: {};
|
|
5013
|
-
jsonResponse: {
|
|
5014
|
-
climate_setting_schedule: {
|
|
5015
|
-
climate_setting_schedule_id: string;
|
|
5016
|
-
schedule_type: 'time_bound';
|
|
5017
|
-
device_id: string;
|
|
5018
|
-
name?: string | undefined;
|
|
5019
|
-
schedule_starts_at: string;
|
|
5020
|
-
schedule_ends_at: string;
|
|
5021
|
-
created_at: string;
|
|
5022
|
-
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
5023
|
-
errors?: any;
|
|
5024
|
-
automatic_heating_enabled?: boolean | undefined;
|
|
5025
|
-
automatic_cooling_enabled?: boolean | undefined;
|
|
5026
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5027
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5028
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5029
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5030
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5031
|
-
manual_override_allowed?: boolean | undefined;
|
|
5032
|
-
};
|
|
5033
|
-
};
|
|
5034
|
-
};
|
|
5035
|
-
'/thermostats/climate_setting_schedules/delete': {
|
|
5036
|
-
route: '/thermostats/climate_setting_schedules/delete';
|
|
5037
|
-
method: 'DELETE' | 'POST' | 'PUT';
|
|
5038
|
-
queryParams: {};
|
|
5039
|
-
jsonBody: {};
|
|
5040
|
-
commonParams: {
|
|
5041
|
-
climate_setting_schedule_id: string;
|
|
5042
|
-
};
|
|
5043
|
-
formData: {};
|
|
5044
|
-
jsonResponse: {};
|
|
5045
|
-
};
|
|
5046
|
-
'/thermostats/climate_setting_schedules/get': {
|
|
5047
|
-
route: '/thermostats/climate_setting_schedules/get';
|
|
5048
|
-
method: 'GET' | 'POST';
|
|
5049
|
-
queryParams: {};
|
|
5050
|
-
jsonBody: {};
|
|
5051
|
-
commonParams: {
|
|
5052
|
-
climate_setting_schedule_id?: string | undefined;
|
|
5053
|
-
device_id?: string | undefined;
|
|
5054
|
-
};
|
|
5055
|
-
formData: {};
|
|
5056
|
-
jsonResponse: {
|
|
5057
|
-
climate_setting_schedule: {
|
|
5058
|
-
climate_setting_schedule_id: string;
|
|
5059
|
-
schedule_type: 'time_bound';
|
|
5060
|
-
device_id: string;
|
|
5061
|
-
name?: string | undefined;
|
|
5062
|
-
schedule_starts_at: string;
|
|
5063
|
-
schedule_ends_at: string;
|
|
5064
|
-
created_at: string;
|
|
5065
|
-
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
5066
|
-
errors?: any;
|
|
5067
|
-
automatic_heating_enabled?: boolean | undefined;
|
|
5068
|
-
automatic_cooling_enabled?: boolean | undefined;
|
|
5069
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5070
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5071
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5072
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5073
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5074
|
-
manual_override_allowed?: boolean | undefined;
|
|
5075
|
-
};
|
|
5076
|
-
};
|
|
5077
|
-
};
|
|
5078
|
-
'/thermostats/climate_setting_schedules/list': {
|
|
5079
|
-
route: '/thermostats/climate_setting_schedules/list';
|
|
5080
|
-
method: 'GET' | 'POST';
|
|
5081
|
-
queryParams: {};
|
|
5082
|
-
jsonBody: {};
|
|
5083
|
-
commonParams: {
|
|
5084
|
-
device_id: string;
|
|
5085
|
-
user_identifier_key?: string | undefined;
|
|
5086
|
-
};
|
|
5087
|
-
formData: {};
|
|
5088
|
-
jsonResponse: {
|
|
5089
|
-
climate_setting_schedules: Array<{
|
|
5090
|
-
climate_setting_schedule_id: string;
|
|
5091
|
-
schedule_type: 'time_bound';
|
|
5092
|
-
device_id: string;
|
|
5093
|
-
name?: string | undefined;
|
|
5094
|
-
schedule_starts_at: string;
|
|
5095
|
-
schedule_ends_at: string;
|
|
5096
|
-
created_at: string;
|
|
5097
|
-
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
5098
|
-
errors?: any;
|
|
5099
|
-
automatic_heating_enabled?: boolean | undefined;
|
|
5100
|
-
automatic_cooling_enabled?: boolean | undefined;
|
|
5101
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5102
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5103
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5104
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5105
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5106
|
-
manual_override_allowed?: boolean | undefined;
|
|
5107
|
-
}>;
|
|
5108
|
-
};
|
|
5109
|
-
};
|
|
5110
|
-
'/thermostats/climate_setting_schedules/update': {
|
|
5111
|
-
route: '/thermostats/climate_setting_schedules/update';
|
|
5112
|
-
method: 'PATCH' | 'POST' | 'PUT';
|
|
5113
|
-
queryParams: {};
|
|
5114
|
-
jsonBody: {
|
|
5115
|
-
climate_setting_schedule_id: string;
|
|
5116
|
-
schedule_type?: 'time_bound';
|
|
5117
|
-
name?: string | undefined;
|
|
5118
|
-
schedule_starts_at?: string | undefined;
|
|
5119
|
-
schedule_ends_at?: string | undefined;
|
|
5120
|
-
automatic_heating_enabled?: boolean | undefined;
|
|
5121
|
-
automatic_cooling_enabled?: boolean | undefined;
|
|
5122
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5123
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5124
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5125
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5126
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5127
|
-
manual_override_allowed?: boolean | undefined;
|
|
5128
|
-
};
|
|
5129
|
-
commonParams: {};
|
|
5130
|
-
formData: {};
|
|
5131
|
-
jsonResponse: {
|
|
5132
|
-
climate_setting_schedule: {
|
|
5133
|
-
climate_setting_schedule_id: string;
|
|
5134
|
-
schedule_type: 'time_bound';
|
|
5135
|
-
device_id: string;
|
|
5136
|
-
name?: string | undefined;
|
|
5137
|
-
schedule_starts_at: string;
|
|
5138
|
-
schedule_ends_at: string;
|
|
5139
|
-
created_at: string;
|
|
5140
|
-
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
5141
|
-
errors?: any;
|
|
5142
|
-
automatic_heating_enabled?: boolean | undefined;
|
|
5143
|
-
automatic_cooling_enabled?: boolean | undefined;
|
|
5144
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5145
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5146
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5147
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5148
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5149
|
-
manual_override_allowed?: boolean | undefined;
|
|
5150
|
-
};
|
|
5151
|
-
};
|
|
5152
|
-
};
|
|
5153
|
-
'/thermostats/cool': {
|
|
5154
|
-
route: '/thermostats/cool';
|
|
5155
|
-
method: 'POST';
|
|
5156
|
-
queryParams: {};
|
|
5157
|
-
jsonBody: {
|
|
5158
|
-
device_id: string;
|
|
5159
|
-
cooling_set_point_celsius?: number | undefined;
|
|
5160
|
-
cooling_set_point_fahrenheit?: number | undefined;
|
|
5161
|
-
sync?: boolean;
|
|
5162
|
-
};
|
|
5163
|
-
commonParams: {};
|
|
5164
|
-
formData: {};
|
|
5165
|
-
jsonResponse: {};
|
|
5166
|
-
};
|
|
5167
|
-
'/thermostats/get': {
|
|
5168
|
-
route: '/thermostats/get';
|
|
5078
|
+
'/phones/list': {
|
|
5079
|
+
route: '/phones/list';
|
|
5169
5080
|
method: 'GET' | 'POST';
|
|
5170
5081
|
queryParams: {};
|
|
5171
5082
|
jsonBody: {};
|
|
5172
5083
|
commonParams: {
|
|
5173
|
-
|
|
5174
|
-
name?: string | undefined;
|
|
5084
|
+
owner_user_identity_id?: string | undefined;
|
|
5175
5085
|
};
|
|
5176
5086
|
formData: {};
|
|
5177
5087
|
jsonResponse: {
|
|
5178
|
-
|
|
5088
|
+
phones: Array<{
|
|
5179
5089
|
/** Unique identifier for the device. */
|
|
5180
5090
|
device_id: string;
|
|
5181
|
-
|
|
5182
|
-
device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat') | ('ios_phone' | 'android_phone');
|
|
5091
|
+
device_type: 'android_phone' | 'ios_phone';
|
|
5183
5092
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
5184
5093
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
5185
5094
|
/** Properties of the device. */
|
|
5186
|
-
properties: ({
|
|
5095
|
+
properties: (({
|
|
5187
5096
|
/** Indicates whether the device is online. */
|
|
5188
5097
|
online: boolean;
|
|
5189
5098
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -5591,7 +5500,15 @@ export interface Routes {
|
|
|
5591
5500
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
5592
5501
|
max_cooling_set_point_celsius?: number | undefined;
|
|
5593
5502
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
5594
|
-
}))
|
|
5503
|
+
}))) & {
|
|
5504
|
+
assa_abloy_credential_service_metadata?: ({
|
|
5505
|
+
has_active_endpoint: boolean;
|
|
5506
|
+
endpoints: Array<{
|
|
5507
|
+
endpoint_id: string;
|
|
5508
|
+
is_active: boolean;
|
|
5509
|
+
}>;
|
|
5510
|
+
} | undefined) | undefined;
|
|
5511
|
+
};
|
|
5595
5512
|
/** Location information for the device. */
|
|
5596
5513
|
location: {
|
|
5597
5514
|
/** Name of the device location. */
|
|
@@ -5599,8 +5516,6 @@ export interface Routes {
|
|
|
5599
5516
|
/** Time zone of the device location. */
|
|
5600
5517
|
timezone?: string | undefined;
|
|
5601
5518
|
} | null;
|
|
5602
|
-
/** Unique identifier for the account associated with the device. */
|
|
5603
|
-
connected_account_id: string;
|
|
5604
5519
|
/** Unique identifier for the Seam workspace associated with the device. */
|
|
5605
5520
|
workspace_id: string;
|
|
5606
5521
|
/** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
@@ -5617,34 +5532,1160 @@ export interface Routes {
|
|
|
5617
5532
|
created_at: string;
|
|
5618
5533
|
/** Indicates whether Seam manages the device. */
|
|
5619
5534
|
is_managed: true;
|
|
5620
|
-
|
|
5621
|
-
|
|
5622
|
-
|
|
5623
|
-
|
|
5624
|
-
|
|
5625
|
-
|
|
5626
|
-
|
|
5627
|
-
|
|
5628
|
-
device_id: string;
|
|
5629
|
-
heating_set_point_celsius?: number | undefined;
|
|
5630
|
-
heating_set_point_fahrenheit?: number | undefined;
|
|
5631
|
-
sync?: boolean;
|
|
5535
|
+
assa_abloy_credential_service_metadata?: {
|
|
5536
|
+
has_active_endpoint: boolean;
|
|
5537
|
+
endpoints: Array<{
|
|
5538
|
+
endpoint_id: string;
|
|
5539
|
+
is_active: boolean;
|
|
5540
|
+
}>;
|
|
5541
|
+
} | undefined;
|
|
5542
|
+
}>;
|
|
5632
5543
|
};
|
|
5633
|
-
commonParams: {};
|
|
5634
|
-
formData: {};
|
|
5635
|
-
jsonResponse: {};
|
|
5636
5544
|
};
|
|
5637
|
-
'/
|
|
5638
|
-
route: '/
|
|
5639
|
-
method: 'POST';
|
|
5545
|
+
'/phones/simulate/create_sandbox_phone': {
|
|
5546
|
+
route: '/phones/simulate/create_sandbox_phone';
|
|
5547
|
+
method: 'GET' | 'POST';
|
|
5640
5548
|
queryParams: {};
|
|
5641
5549
|
jsonBody: {
|
|
5642
|
-
|
|
5643
|
-
|
|
5644
|
-
|
|
5645
|
-
|
|
5646
|
-
|
|
5647
|
-
|
|
5550
|
+
assa_abloy_credential_service_acs_system_id: string;
|
|
5551
|
+
custom_sdk_installation_id?: string | undefined;
|
|
5552
|
+
user_identity_id: string;
|
|
5553
|
+
phone_metadata?: {
|
|
5554
|
+
ble_capability?: boolean;
|
|
5555
|
+
hce_capability?: boolean;
|
|
5556
|
+
nfc_capability?: boolean;
|
|
5557
|
+
application_version?: string;
|
|
5558
|
+
seos_applet_version?: string;
|
|
5559
|
+
device_manufacturer?: string;
|
|
5560
|
+
device_model?: string;
|
|
5561
|
+
os_version?: string;
|
|
5562
|
+
operating_system?: 'android' | 'ios';
|
|
5563
|
+
};
|
|
5564
|
+
};
|
|
5565
|
+
commonParams: {};
|
|
5566
|
+
formData: {};
|
|
5567
|
+
jsonResponse: {
|
|
5568
|
+
phone: {
|
|
5569
|
+
/** Unique identifier for the device. */
|
|
5570
|
+
device_id: string;
|
|
5571
|
+
device_type: 'android_phone' | 'ios_phone';
|
|
5572
|
+
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
5573
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
5574
|
+
/** Properties of the device. */
|
|
5575
|
+
properties: (({
|
|
5576
|
+
/** Indicates whether the device is online. */
|
|
5577
|
+
online: boolean;
|
|
5578
|
+
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
5579
|
+
name: string;
|
|
5580
|
+
model: {
|
|
5581
|
+
/** Display name of the device model. */
|
|
5582
|
+
display_name: string;
|
|
5583
|
+
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
5584
|
+
manufacturer_display_name: string;
|
|
5585
|
+
/** Indicates whether the device supports offline access codes. */
|
|
5586
|
+
offline_access_codes_supported?: boolean | undefined;
|
|
5587
|
+
/** Indicates whether the device supports online access codes. */
|
|
5588
|
+
online_access_codes_supported?: boolean | undefined;
|
|
5589
|
+
/** Indicates whether the device supports an accessory keypad. */
|
|
5590
|
+
accessory_keypad_supported?: boolean | undefined;
|
|
5591
|
+
};
|
|
5592
|
+
/** Indicates whether the device has direct power. */
|
|
5593
|
+
has_direct_power?: boolean | undefined;
|
|
5594
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
5595
|
+
battery_level?: number | undefined;
|
|
5596
|
+
/** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
|
|
5597
|
+
battery?: {
|
|
5598
|
+
level: number;
|
|
5599
|
+
status: 'critical' | 'low' | 'good' | 'full';
|
|
5600
|
+
} | undefined;
|
|
5601
|
+
/** Manufacturer of the device. */
|
|
5602
|
+
manufacturer?: string | undefined;
|
|
5603
|
+
/** Image URL for the device. */
|
|
5604
|
+
image_url?: string | undefined;
|
|
5605
|
+
/** Alt text for the device image. */
|
|
5606
|
+
image_alt_text?: string | undefined;
|
|
5607
|
+
/** Serial number of the device. */
|
|
5608
|
+
serial_number?: string | undefined;
|
|
5609
|
+
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
5610
|
+
online_access_codes_enabled?: boolean | undefined;
|
|
5611
|
+
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
5612
|
+
offline_access_codes_enabled?: boolean | undefined;
|
|
5613
|
+
/** Deprecated. Use model.accessory_keypad_supported. */
|
|
5614
|
+
supports_accessory_keypad?: boolean | undefined;
|
|
5615
|
+
/** Deprecated. Use offline_access_codes_enabled. */
|
|
5616
|
+
supports_offline_access_codes?: boolean | undefined;
|
|
5617
|
+
} & {
|
|
5618
|
+
august_metadata?: {
|
|
5619
|
+
lock_id: string;
|
|
5620
|
+
lock_name: string;
|
|
5621
|
+
house_name: string;
|
|
5622
|
+
has_keypad: boolean;
|
|
5623
|
+
keypad_battery_level?: string | undefined;
|
|
5624
|
+
model?: string | undefined;
|
|
5625
|
+
house_id?: string | undefined;
|
|
5626
|
+
} | undefined;
|
|
5627
|
+
avigilon_alta_metadata?: {
|
|
5628
|
+
entry_name: string;
|
|
5629
|
+
org_name: string;
|
|
5630
|
+
zone_id: number;
|
|
5631
|
+
zone_name: string;
|
|
5632
|
+
site_id: number;
|
|
5633
|
+
site_name: string;
|
|
5634
|
+
} | undefined;
|
|
5635
|
+
schlage_metadata?: {
|
|
5636
|
+
device_id: string;
|
|
5637
|
+
device_name: string;
|
|
5638
|
+
access_code_length: number;
|
|
5639
|
+
model?: string | undefined;
|
|
5640
|
+
} | undefined;
|
|
5641
|
+
smartthings_metadata?: {
|
|
5642
|
+
device_id: string;
|
|
5643
|
+
device_name: string;
|
|
5644
|
+
model?: string | undefined;
|
|
5645
|
+
location_id?: string | undefined;
|
|
5646
|
+
} | undefined;
|
|
5647
|
+
lockly_metadata?: {
|
|
5648
|
+
device_id: string;
|
|
5649
|
+
device_name: string;
|
|
5650
|
+
model?: string | undefined;
|
|
5651
|
+
} | undefined;
|
|
5652
|
+
nuki_metadata?: {
|
|
5653
|
+
device_id: string;
|
|
5654
|
+
device_name: string;
|
|
5655
|
+
keypad_battery_critical?: boolean | undefined;
|
|
5656
|
+
} | undefined;
|
|
5657
|
+
kwikset_metadata?: {
|
|
5658
|
+
device_id: string;
|
|
5659
|
+
device_name: string;
|
|
5660
|
+
model_number: string;
|
|
5661
|
+
} | undefined;
|
|
5662
|
+
salto_metadata?: {
|
|
5663
|
+
lock_id: string;
|
|
5664
|
+
customer_reference: string;
|
|
5665
|
+
lock_type: string;
|
|
5666
|
+
battery_level: string;
|
|
5667
|
+
locked_state: string;
|
|
5668
|
+
model?: string | undefined;
|
|
5669
|
+
} | undefined;
|
|
5670
|
+
genie_metadata?: {
|
|
5671
|
+
device_name: string;
|
|
5672
|
+
door_name: string;
|
|
5673
|
+
} | undefined;
|
|
5674
|
+
brivo_metadata?: {
|
|
5675
|
+
device_name: string;
|
|
5676
|
+
} | undefined;
|
|
5677
|
+
igloo_metadata?: {
|
|
5678
|
+
device_id: string;
|
|
5679
|
+
bridge_id: string;
|
|
5680
|
+
model?: string | undefined;
|
|
5681
|
+
} | undefined;
|
|
5682
|
+
noiseaware_metadata?: {
|
|
5683
|
+
device_model: 'indoor' | 'outdoor';
|
|
5684
|
+
noise_level_nrs: number;
|
|
5685
|
+
noise_level_decibel: number;
|
|
5686
|
+
device_name: string;
|
|
5687
|
+
device_id: string;
|
|
5688
|
+
} | undefined;
|
|
5689
|
+
minut_metadata?: {
|
|
5690
|
+
device_id: string;
|
|
5691
|
+
device_name: string;
|
|
5692
|
+
latest_sensor_values: {
|
|
5693
|
+
temperature: {
|
|
5694
|
+
time: string;
|
|
5695
|
+
value: number;
|
|
5696
|
+
};
|
|
5697
|
+
sound: {
|
|
5698
|
+
time: string;
|
|
5699
|
+
value: number;
|
|
5700
|
+
};
|
|
5701
|
+
humidity: {
|
|
5702
|
+
time: string;
|
|
5703
|
+
value: number;
|
|
5704
|
+
};
|
|
5705
|
+
pressure: {
|
|
5706
|
+
time: string;
|
|
5707
|
+
value: number;
|
|
5708
|
+
};
|
|
5709
|
+
accelerometer_z: {
|
|
5710
|
+
time: string;
|
|
5711
|
+
value: number;
|
|
5712
|
+
};
|
|
5713
|
+
};
|
|
5714
|
+
} | undefined;
|
|
5715
|
+
four_suites_metadata?: {
|
|
5716
|
+
device_id: number;
|
|
5717
|
+
device_name: string;
|
|
5718
|
+
reclose_delay_in_seconds: number;
|
|
5719
|
+
} | undefined;
|
|
5720
|
+
two_n_metadata?: {
|
|
5721
|
+
device_id: number;
|
|
5722
|
+
device_name: string;
|
|
5723
|
+
} | undefined;
|
|
5724
|
+
controlbyweb_metadata?: {
|
|
5725
|
+
device_id: string;
|
|
5726
|
+
device_name: string;
|
|
5727
|
+
relay_name: string | null;
|
|
5728
|
+
} | undefined;
|
|
5729
|
+
ttlock_metadata?: {
|
|
5730
|
+
lock_id: number;
|
|
5731
|
+
lock_alias: string;
|
|
5732
|
+
} | undefined;
|
|
5733
|
+
seam_bridge_metadata?: {
|
|
5734
|
+
unlock_method?: ('bridge' | 'doorking') | undefined;
|
|
5735
|
+
device_num: number;
|
|
5736
|
+
name: string;
|
|
5737
|
+
} | undefined;
|
|
5738
|
+
igloohome_metadata?: {
|
|
5739
|
+
device_id: string;
|
|
5740
|
+
device_name: string;
|
|
5741
|
+
bridge_id?: string | undefined;
|
|
5742
|
+
bridge_name?: string | undefined;
|
|
5743
|
+
} | undefined;
|
|
5744
|
+
nest_metadata?: {
|
|
5745
|
+
nest_device_id: string;
|
|
5746
|
+
device_name: string;
|
|
5747
|
+
custom_name: string;
|
|
5748
|
+
} | undefined;
|
|
5749
|
+
ecobee_metadata?: {
|
|
5750
|
+
ecobee_device_id: string;
|
|
5751
|
+
device_name: string;
|
|
5752
|
+
} | undefined;
|
|
5753
|
+
hubitat_metadata?: {
|
|
5754
|
+
device_id: string;
|
|
5755
|
+
device_name: string;
|
|
5756
|
+
device_label: string;
|
|
5757
|
+
} | undefined;
|
|
5758
|
+
dormakaba_oracode_metadata?: {
|
|
5759
|
+
door_id: number;
|
|
5760
|
+
door_name: string;
|
|
5761
|
+
device_id?: number | undefined;
|
|
5762
|
+
site_id: number;
|
|
5763
|
+
site_name: string;
|
|
5764
|
+
iana_timezone?: string | undefined;
|
|
5765
|
+
predefined_time_slots?: Array<{
|
|
5766
|
+
name: string;
|
|
5767
|
+
prefix: number;
|
|
5768
|
+
check_in_time: string;
|
|
5769
|
+
check_out_time: string;
|
|
5770
|
+
is_24_hour: boolean;
|
|
5771
|
+
is_biweekly_mode: boolean;
|
|
5772
|
+
is_one_shot: boolean;
|
|
5773
|
+
is_master: boolean;
|
|
5774
|
+
ext_dormakaba_oracode_user_level_prefix: number;
|
|
5775
|
+
dormakaba_oracode_user_level_id: string;
|
|
5776
|
+
}> | undefined;
|
|
5777
|
+
} | undefined;
|
|
5778
|
+
wyze_metadata?: {
|
|
5779
|
+
device_id: string;
|
|
5780
|
+
device_name: string;
|
|
5781
|
+
product_name: string;
|
|
5782
|
+
product_type: string;
|
|
5783
|
+
product_model: string;
|
|
5784
|
+
device_info_model: string;
|
|
5785
|
+
} | undefined;
|
|
5786
|
+
}) & ({
|
|
5787
|
+
code_constraints?: (Array<{
|
|
5788
|
+
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
|
|
5789
|
+
} | {
|
|
5790
|
+
constraint_type: 'name_length';
|
|
5791
|
+
min_length?: number | undefined;
|
|
5792
|
+
max_length?: number | undefined;
|
|
5793
|
+
}> | undefined) | undefined;
|
|
5794
|
+
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
5795
|
+
max_active_codes_supported?: (number | undefined) | undefined;
|
|
5796
|
+
supports_backup_access_code_pool?: (boolean | undefined) | undefined;
|
|
5797
|
+
has_native_entry_events?: (boolean | undefined) | undefined;
|
|
5798
|
+
locked?: (boolean | undefined) | undefined;
|
|
5799
|
+
keypad_battery?: ({
|
|
5800
|
+
level: number;
|
|
5801
|
+
} | undefined) | undefined;
|
|
5802
|
+
door_open?: (boolean | undefined) | undefined;
|
|
5803
|
+
} & ({
|
|
5804
|
+
temperature_fahrenheit?: number | undefined;
|
|
5805
|
+
temperature_celsius?: number | undefined;
|
|
5806
|
+
relative_humidity?: number | undefined;
|
|
5807
|
+
can_enable_automatic_heating?: boolean | undefined;
|
|
5808
|
+
can_enable_automatic_cooling?: boolean | undefined;
|
|
5809
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
5810
|
+
is_heating_available?: true | undefined;
|
|
5811
|
+
is_cooling_available?: true | undefined;
|
|
5812
|
+
is_heating?: boolean | undefined;
|
|
5813
|
+
is_cooling?: boolean | undefined;
|
|
5814
|
+
is_fan_running?: boolean | undefined;
|
|
5815
|
+
fan_mode_setting?: ('auto' | 'on') | undefined;
|
|
5816
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
5817
|
+
current_climate_setting?: {
|
|
5818
|
+
automatic_heating_enabled: boolean;
|
|
5819
|
+
automatic_cooling_enabled: boolean;
|
|
5820
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
5821
|
+
cooling_set_point_celsius?: number | undefined;
|
|
5822
|
+
heating_set_point_celsius?: number | undefined;
|
|
5823
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
5824
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
5825
|
+
manual_override_allowed: boolean;
|
|
5826
|
+
} | undefined;
|
|
5827
|
+
default_climate_setting?: ({
|
|
5828
|
+
automatic_heating_enabled: boolean;
|
|
5829
|
+
automatic_cooling_enabled: boolean;
|
|
5830
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
5831
|
+
cooling_set_point_celsius?: number | undefined;
|
|
5832
|
+
heating_set_point_celsius?: number | undefined;
|
|
5833
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
5834
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
5835
|
+
manual_override_allowed: boolean;
|
|
5836
|
+
} | undefined) | undefined;
|
|
5837
|
+
is_climate_setting_schedule_active?: boolean | undefined;
|
|
5838
|
+
active_climate_setting_schedule?: ({
|
|
5839
|
+
climate_setting_schedule_id: string;
|
|
5840
|
+
schedule_type: 'time_bound';
|
|
5841
|
+
device_id: string;
|
|
5842
|
+
name?: string | undefined;
|
|
5843
|
+
schedule_starts_at: string;
|
|
5844
|
+
schedule_ends_at: string;
|
|
5845
|
+
created_at: string;
|
|
5846
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
5847
|
+
errors?: any;
|
|
5848
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
5849
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
5850
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5851
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5852
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5853
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5854
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5855
|
+
manual_override_allowed?: boolean | undefined;
|
|
5856
|
+
} | undefined) | undefined;
|
|
5857
|
+
min_cooling_set_point_celsius?: number | undefined;
|
|
5858
|
+
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
5859
|
+
max_cooling_set_point_celsius?: number | undefined;
|
|
5860
|
+
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
5861
|
+
min_heating_set_point_celsius?: number | undefined;
|
|
5862
|
+
min_heating_set_point_fahrenheit?: number | undefined;
|
|
5863
|
+
max_heating_set_point_celsius?: number | undefined;
|
|
5864
|
+
max_heating_set_point_fahrenheit?: number | undefined;
|
|
5865
|
+
min_heating_cooling_delta_celsius?: number | undefined;
|
|
5866
|
+
min_heating_cooling_delta_fahrenheit?: number | undefined;
|
|
5867
|
+
} | {
|
|
5868
|
+
temperature_fahrenheit?: number | undefined;
|
|
5869
|
+
temperature_celsius?: number | undefined;
|
|
5870
|
+
relative_humidity?: number | undefined;
|
|
5871
|
+
can_enable_automatic_heating?: boolean | undefined;
|
|
5872
|
+
can_enable_automatic_cooling?: boolean | undefined;
|
|
5873
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
5874
|
+
is_heating_available?: true | undefined;
|
|
5875
|
+
is_cooling_available?: false | undefined;
|
|
5876
|
+
is_heating?: boolean | undefined;
|
|
5877
|
+
is_cooling?: boolean | undefined;
|
|
5878
|
+
is_fan_running?: boolean | undefined;
|
|
5879
|
+
fan_mode_setting?: ('auto' | 'on') | undefined;
|
|
5880
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
5881
|
+
current_climate_setting?: {
|
|
5882
|
+
automatic_heating_enabled: boolean;
|
|
5883
|
+
automatic_cooling_enabled: boolean;
|
|
5884
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
5885
|
+
cooling_set_point_celsius?: number | undefined;
|
|
5886
|
+
heating_set_point_celsius?: number | undefined;
|
|
5887
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
5888
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
5889
|
+
manual_override_allowed: boolean;
|
|
5890
|
+
} | undefined;
|
|
5891
|
+
default_climate_setting?: ({
|
|
5892
|
+
automatic_heating_enabled: boolean;
|
|
5893
|
+
automatic_cooling_enabled: boolean;
|
|
5894
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
5895
|
+
cooling_set_point_celsius?: number | undefined;
|
|
5896
|
+
heating_set_point_celsius?: number | undefined;
|
|
5897
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
5898
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
5899
|
+
manual_override_allowed: boolean;
|
|
5900
|
+
} | undefined) | undefined;
|
|
5901
|
+
is_climate_setting_schedule_active?: boolean | undefined;
|
|
5902
|
+
active_climate_setting_schedule?: ({
|
|
5903
|
+
climate_setting_schedule_id: string;
|
|
5904
|
+
schedule_type: 'time_bound';
|
|
5905
|
+
device_id: string;
|
|
5906
|
+
name?: string | undefined;
|
|
5907
|
+
schedule_starts_at: string;
|
|
5908
|
+
schedule_ends_at: string;
|
|
5909
|
+
created_at: string;
|
|
5910
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
5911
|
+
errors?: any;
|
|
5912
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
5913
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
5914
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5915
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5916
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5917
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5918
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5919
|
+
manual_override_allowed?: boolean | undefined;
|
|
5920
|
+
} | undefined) | undefined;
|
|
5921
|
+
min_heating_set_point_celsius?: number | undefined;
|
|
5922
|
+
min_heating_set_point_fahrenheit?: number | undefined;
|
|
5923
|
+
max_heating_set_point_celsius?: number | undefined;
|
|
5924
|
+
max_heating_set_point_fahrenheit?: number | undefined;
|
|
5925
|
+
} | {
|
|
5926
|
+
temperature_fahrenheit?: number | undefined;
|
|
5927
|
+
temperature_celsius?: number | undefined;
|
|
5928
|
+
relative_humidity?: number | undefined;
|
|
5929
|
+
can_enable_automatic_heating?: boolean | undefined;
|
|
5930
|
+
can_enable_automatic_cooling?: boolean | undefined;
|
|
5931
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
5932
|
+
is_heating_available?: false | undefined;
|
|
5933
|
+
is_cooling_available?: true | undefined;
|
|
5934
|
+
is_heating?: boolean | undefined;
|
|
5935
|
+
is_cooling?: boolean | undefined;
|
|
5936
|
+
is_fan_running?: boolean | undefined;
|
|
5937
|
+
fan_mode_setting?: ('auto' | 'on') | undefined;
|
|
5938
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
5939
|
+
current_climate_setting?: {
|
|
5940
|
+
automatic_heating_enabled: boolean;
|
|
5941
|
+
automatic_cooling_enabled: boolean;
|
|
5942
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
5943
|
+
cooling_set_point_celsius?: number | undefined;
|
|
5944
|
+
heating_set_point_celsius?: number | undefined;
|
|
5945
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
5946
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
5947
|
+
manual_override_allowed: boolean;
|
|
5948
|
+
} | undefined;
|
|
5949
|
+
default_climate_setting?: ({
|
|
5950
|
+
automatic_heating_enabled: boolean;
|
|
5951
|
+
automatic_cooling_enabled: boolean;
|
|
5952
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
5953
|
+
cooling_set_point_celsius?: number | undefined;
|
|
5954
|
+
heating_set_point_celsius?: number | undefined;
|
|
5955
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
5956
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
5957
|
+
manual_override_allowed: boolean;
|
|
5958
|
+
} | undefined) | undefined;
|
|
5959
|
+
is_climate_setting_schedule_active?: boolean | undefined;
|
|
5960
|
+
active_climate_setting_schedule?: ({
|
|
5961
|
+
climate_setting_schedule_id: string;
|
|
5962
|
+
schedule_type: 'time_bound';
|
|
5963
|
+
device_id: string;
|
|
5964
|
+
name?: string | undefined;
|
|
5965
|
+
schedule_starts_at: string;
|
|
5966
|
+
schedule_ends_at: string;
|
|
5967
|
+
created_at: string;
|
|
5968
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
5969
|
+
errors?: any;
|
|
5970
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
5971
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
5972
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
5973
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
5974
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
5975
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5976
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
5977
|
+
manual_override_allowed?: boolean | undefined;
|
|
5978
|
+
} | undefined) | undefined;
|
|
5979
|
+
min_cooling_set_point_celsius?: number | undefined;
|
|
5980
|
+
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
5981
|
+
max_cooling_set_point_celsius?: number | undefined;
|
|
5982
|
+
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
5983
|
+
}))) & {
|
|
5984
|
+
assa_abloy_credential_service_metadata?: ({
|
|
5985
|
+
has_active_endpoint: boolean;
|
|
5986
|
+
endpoints: Array<{
|
|
5987
|
+
endpoint_id: string;
|
|
5988
|
+
is_active: boolean;
|
|
5989
|
+
}>;
|
|
5990
|
+
} | undefined) | undefined;
|
|
5991
|
+
};
|
|
5992
|
+
/** Location information for the device. */
|
|
5993
|
+
location: {
|
|
5994
|
+
/** Name of the device location. */
|
|
5995
|
+
location_name?: string | undefined;
|
|
5996
|
+
/** Time zone of the device location. */
|
|
5997
|
+
timezone?: string | undefined;
|
|
5998
|
+
} | null;
|
|
5999
|
+
/** Unique identifier for the Seam workspace associated with the device. */
|
|
6000
|
+
workspace_id: string;
|
|
6001
|
+
/** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
6002
|
+
errors: Array<{
|
|
6003
|
+
error_code: string;
|
|
6004
|
+
message: string;
|
|
6005
|
+
}>;
|
|
6006
|
+
/** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
|
|
6007
|
+
warnings: Array<{
|
|
6008
|
+
warning_code: string;
|
|
6009
|
+
message: string;
|
|
6010
|
+
}>;
|
|
6011
|
+
/** Date and time at which the device object was created. */
|
|
6012
|
+
created_at: string;
|
|
6013
|
+
/** Indicates whether Seam manages the device. */
|
|
6014
|
+
is_managed: true;
|
|
6015
|
+
assa_abloy_credential_service_metadata?: {
|
|
6016
|
+
has_active_endpoint: boolean;
|
|
6017
|
+
endpoints: Array<{
|
|
6018
|
+
endpoint_id: string;
|
|
6019
|
+
is_active: boolean;
|
|
6020
|
+
}>;
|
|
6021
|
+
} | undefined;
|
|
6022
|
+
};
|
|
6023
|
+
};
|
|
6024
|
+
};
|
|
6025
|
+
'/thermostats/climate_setting_schedules/create': {
|
|
6026
|
+
route: '/thermostats/climate_setting_schedules/create';
|
|
6027
|
+
method: 'POST';
|
|
6028
|
+
queryParams: {};
|
|
6029
|
+
jsonBody: {
|
|
6030
|
+
schedule_type?: 'time_bound';
|
|
6031
|
+
device_id: string;
|
|
6032
|
+
name?: string | undefined;
|
|
6033
|
+
schedule_starts_at: string;
|
|
6034
|
+
schedule_ends_at: string;
|
|
6035
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6036
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6037
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6038
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6039
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6040
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6041
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6042
|
+
manual_override_allowed?: boolean | undefined;
|
|
6043
|
+
};
|
|
6044
|
+
commonParams: {};
|
|
6045
|
+
formData: {};
|
|
6046
|
+
jsonResponse: {
|
|
6047
|
+
climate_setting_schedule: {
|
|
6048
|
+
climate_setting_schedule_id: string;
|
|
6049
|
+
schedule_type: 'time_bound';
|
|
6050
|
+
device_id: string;
|
|
6051
|
+
name?: string | undefined;
|
|
6052
|
+
schedule_starts_at: string;
|
|
6053
|
+
schedule_ends_at: string;
|
|
6054
|
+
created_at: string;
|
|
6055
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
6056
|
+
errors?: any;
|
|
6057
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6058
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6059
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6060
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6061
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6062
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6063
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6064
|
+
manual_override_allowed?: boolean | undefined;
|
|
6065
|
+
};
|
|
6066
|
+
};
|
|
6067
|
+
};
|
|
6068
|
+
'/thermostats/climate_setting_schedules/delete': {
|
|
6069
|
+
route: '/thermostats/climate_setting_schedules/delete';
|
|
6070
|
+
method: 'DELETE' | 'POST' | 'PUT';
|
|
6071
|
+
queryParams: {};
|
|
6072
|
+
jsonBody: {};
|
|
6073
|
+
commonParams: {
|
|
6074
|
+
climate_setting_schedule_id: string;
|
|
6075
|
+
};
|
|
6076
|
+
formData: {};
|
|
6077
|
+
jsonResponse: {};
|
|
6078
|
+
};
|
|
6079
|
+
'/thermostats/climate_setting_schedules/get': {
|
|
6080
|
+
route: '/thermostats/climate_setting_schedules/get';
|
|
6081
|
+
method: 'GET' | 'POST';
|
|
6082
|
+
queryParams: {};
|
|
6083
|
+
jsonBody: {};
|
|
6084
|
+
commonParams: {
|
|
6085
|
+
climate_setting_schedule_id?: string | undefined;
|
|
6086
|
+
device_id?: string | undefined;
|
|
6087
|
+
};
|
|
6088
|
+
formData: {};
|
|
6089
|
+
jsonResponse: {
|
|
6090
|
+
climate_setting_schedule: {
|
|
6091
|
+
climate_setting_schedule_id: string;
|
|
6092
|
+
schedule_type: 'time_bound';
|
|
6093
|
+
device_id: string;
|
|
6094
|
+
name?: string | undefined;
|
|
6095
|
+
schedule_starts_at: string;
|
|
6096
|
+
schedule_ends_at: string;
|
|
6097
|
+
created_at: string;
|
|
6098
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
6099
|
+
errors?: any;
|
|
6100
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6101
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6102
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6103
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6104
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6105
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6106
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6107
|
+
manual_override_allowed?: boolean | undefined;
|
|
6108
|
+
};
|
|
6109
|
+
};
|
|
6110
|
+
};
|
|
6111
|
+
'/thermostats/climate_setting_schedules/list': {
|
|
6112
|
+
route: '/thermostats/climate_setting_schedules/list';
|
|
6113
|
+
method: 'GET' | 'POST';
|
|
6114
|
+
queryParams: {};
|
|
6115
|
+
jsonBody: {};
|
|
6116
|
+
commonParams: {
|
|
6117
|
+
device_id: string;
|
|
6118
|
+
user_identifier_key?: string | undefined;
|
|
6119
|
+
};
|
|
6120
|
+
formData: {};
|
|
6121
|
+
jsonResponse: {
|
|
6122
|
+
climate_setting_schedules: Array<{
|
|
6123
|
+
climate_setting_schedule_id: string;
|
|
6124
|
+
schedule_type: 'time_bound';
|
|
6125
|
+
device_id: string;
|
|
6126
|
+
name?: string | undefined;
|
|
6127
|
+
schedule_starts_at: string;
|
|
6128
|
+
schedule_ends_at: string;
|
|
6129
|
+
created_at: string;
|
|
6130
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
6131
|
+
errors?: any;
|
|
6132
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6133
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6134
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6135
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6136
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6137
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6138
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6139
|
+
manual_override_allowed?: boolean | undefined;
|
|
6140
|
+
}>;
|
|
6141
|
+
};
|
|
6142
|
+
};
|
|
6143
|
+
'/thermostats/climate_setting_schedules/update': {
|
|
6144
|
+
route: '/thermostats/climate_setting_schedules/update';
|
|
6145
|
+
method: 'PATCH' | 'POST' | 'PUT';
|
|
6146
|
+
queryParams: {};
|
|
6147
|
+
jsonBody: {
|
|
6148
|
+
climate_setting_schedule_id: string;
|
|
6149
|
+
schedule_type?: 'time_bound';
|
|
6150
|
+
name?: string | undefined;
|
|
6151
|
+
schedule_starts_at?: string | undefined;
|
|
6152
|
+
schedule_ends_at?: string | undefined;
|
|
6153
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6154
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6155
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6156
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6157
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6158
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6159
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6160
|
+
manual_override_allowed?: boolean | undefined;
|
|
6161
|
+
};
|
|
6162
|
+
commonParams: {};
|
|
6163
|
+
formData: {};
|
|
6164
|
+
jsonResponse: {
|
|
6165
|
+
climate_setting_schedule: {
|
|
6166
|
+
climate_setting_schedule_id: string;
|
|
6167
|
+
schedule_type: 'time_bound';
|
|
6168
|
+
device_id: string;
|
|
6169
|
+
name?: string | undefined;
|
|
6170
|
+
schedule_starts_at: string;
|
|
6171
|
+
schedule_ends_at: string;
|
|
6172
|
+
created_at: string;
|
|
6173
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
6174
|
+
errors?: any;
|
|
6175
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6176
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6177
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6178
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6179
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6180
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6181
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6182
|
+
manual_override_allowed?: boolean | undefined;
|
|
6183
|
+
};
|
|
6184
|
+
};
|
|
6185
|
+
};
|
|
6186
|
+
'/thermostats/cool': {
|
|
6187
|
+
route: '/thermostats/cool';
|
|
6188
|
+
method: 'POST';
|
|
6189
|
+
queryParams: {};
|
|
6190
|
+
jsonBody: {
|
|
6191
|
+
device_id: string;
|
|
6192
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6193
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6194
|
+
sync?: boolean;
|
|
6195
|
+
};
|
|
6196
|
+
commonParams: {};
|
|
6197
|
+
formData: {};
|
|
6198
|
+
jsonResponse: {};
|
|
6199
|
+
};
|
|
6200
|
+
'/thermostats/get': {
|
|
6201
|
+
route: '/thermostats/get';
|
|
6202
|
+
method: 'GET' | 'POST';
|
|
6203
|
+
queryParams: {};
|
|
6204
|
+
jsonBody: {};
|
|
6205
|
+
commonParams: {
|
|
6206
|
+
device_id?: string | undefined;
|
|
6207
|
+
name?: string | undefined;
|
|
6208
|
+
};
|
|
6209
|
+
formData: {};
|
|
6210
|
+
jsonResponse: {
|
|
6211
|
+
thermostat: {
|
|
6212
|
+
/** Unique identifier for the device. */
|
|
6213
|
+
device_id: string;
|
|
6214
|
+
/** Type of the device. */
|
|
6215
|
+
device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'seam_relay' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'hubitat_lock' | 'four_suites_door' | 'dormakaba_oracode_door') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat') | ('ios_phone' | 'android_phone');
|
|
6216
|
+
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
6217
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
6218
|
+
/** Properties of the device. */
|
|
6219
|
+
properties: (({
|
|
6220
|
+
/** Indicates whether the device is online. */
|
|
6221
|
+
online: boolean;
|
|
6222
|
+
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
6223
|
+
name: string;
|
|
6224
|
+
model: {
|
|
6225
|
+
/** Display name of the device model. */
|
|
6226
|
+
display_name: string;
|
|
6227
|
+
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
6228
|
+
manufacturer_display_name: string;
|
|
6229
|
+
/** Indicates whether the device supports offline access codes. */
|
|
6230
|
+
offline_access_codes_supported?: boolean | undefined;
|
|
6231
|
+
/** Indicates whether the device supports online access codes. */
|
|
6232
|
+
online_access_codes_supported?: boolean | undefined;
|
|
6233
|
+
/** Indicates whether the device supports an accessory keypad. */
|
|
6234
|
+
accessory_keypad_supported?: boolean | undefined;
|
|
6235
|
+
};
|
|
6236
|
+
/** Indicates whether the device has direct power. */
|
|
6237
|
+
has_direct_power?: boolean | undefined;
|
|
6238
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
6239
|
+
battery_level?: number | undefined;
|
|
6240
|
+
/** Represents the current status of the battery charge level. Values are "critical," which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; "low," which signifies that the battery is under the preferred threshold and should be charged soon; "good," which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and "full," which represents a battery that is fully charged, providing the maximum duration of usage. */
|
|
6241
|
+
battery?: {
|
|
6242
|
+
level: number;
|
|
6243
|
+
status: 'critical' | 'low' | 'good' | 'full';
|
|
6244
|
+
} | undefined;
|
|
6245
|
+
/** Manufacturer of the device. */
|
|
6246
|
+
manufacturer?: string | undefined;
|
|
6247
|
+
/** Image URL for the device. */
|
|
6248
|
+
image_url?: string | undefined;
|
|
6249
|
+
/** Alt text for the device image. */
|
|
6250
|
+
image_alt_text?: string | undefined;
|
|
6251
|
+
/** Serial number of the device. */
|
|
6252
|
+
serial_number?: string | undefined;
|
|
6253
|
+
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
6254
|
+
online_access_codes_enabled?: boolean | undefined;
|
|
6255
|
+
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
6256
|
+
offline_access_codes_enabled?: boolean | undefined;
|
|
6257
|
+
/** Deprecated. Use model.accessory_keypad_supported. */
|
|
6258
|
+
supports_accessory_keypad?: boolean | undefined;
|
|
6259
|
+
/** Deprecated. Use offline_access_codes_enabled. */
|
|
6260
|
+
supports_offline_access_codes?: boolean | undefined;
|
|
6261
|
+
} & {
|
|
6262
|
+
august_metadata?: {
|
|
6263
|
+
lock_id: string;
|
|
6264
|
+
lock_name: string;
|
|
6265
|
+
house_name: string;
|
|
6266
|
+
has_keypad: boolean;
|
|
6267
|
+
keypad_battery_level?: string | undefined;
|
|
6268
|
+
model?: string | undefined;
|
|
6269
|
+
house_id?: string | undefined;
|
|
6270
|
+
} | undefined;
|
|
6271
|
+
avigilon_alta_metadata?: {
|
|
6272
|
+
entry_name: string;
|
|
6273
|
+
org_name: string;
|
|
6274
|
+
zone_id: number;
|
|
6275
|
+
zone_name: string;
|
|
6276
|
+
site_id: number;
|
|
6277
|
+
site_name: string;
|
|
6278
|
+
} | undefined;
|
|
6279
|
+
schlage_metadata?: {
|
|
6280
|
+
device_id: string;
|
|
6281
|
+
device_name: string;
|
|
6282
|
+
access_code_length: number;
|
|
6283
|
+
model?: string | undefined;
|
|
6284
|
+
} | undefined;
|
|
6285
|
+
smartthings_metadata?: {
|
|
6286
|
+
device_id: string;
|
|
6287
|
+
device_name: string;
|
|
6288
|
+
model?: string | undefined;
|
|
6289
|
+
location_id?: string | undefined;
|
|
6290
|
+
} | undefined;
|
|
6291
|
+
lockly_metadata?: {
|
|
6292
|
+
device_id: string;
|
|
6293
|
+
device_name: string;
|
|
6294
|
+
model?: string | undefined;
|
|
6295
|
+
} | undefined;
|
|
6296
|
+
nuki_metadata?: {
|
|
6297
|
+
device_id: string;
|
|
6298
|
+
device_name: string;
|
|
6299
|
+
keypad_battery_critical?: boolean | undefined;
|
|
6300
|
+
} | undefined;
|
|
6301
|
+
kwikset_metadata?: {
|
|
6302
|
+
device_id: string;
|
|
6303
|
+
device_name: string;
|
|
6304
|
+
model_number: string;
|
|
6305
|
+
} | undefined;
|
|
6306
|
+
salto_metadata?: {
|
|
6307
|
+
lock_id: string;
|
|
6308
|
+
customer_reference: string;
|
|
6309
|
+
lock_type: string;
|
|
6310
|
+
battery_level: string;
|
|
6311
|
+
locked_state: string;
|
|
6312
|
+
model?: string | undefined;
|
|
6313
|
+
} | undefined;
|
|
6314
|
+
genie_metadata?: {
|
|
6315
|
+
device_name: string;
|
|
6316
|
+
door_name: string;
|
|
6317
|
+
} | undefined;
|
|
6318
|
+
brivo_metadata?: {
|
|
6319
|
+
device_name: string;
|
|
6320
|
+
} | undefined;
|
|
6321
|
+
igloo_metadata?: {
|
|
6322
|
+
device_id: string;
|
|
6323
|
+
bridge_id: string;
|
|
6324
|
+
model?: string | undefined;
|
|
6325
|
+
} | undefined;
|
|
6326
|
+
noiseaware_metadata?: {
|
|
6327
|
+
device_model: 'indoor' | 'outdoor';
|
|
6328
|
+
noise_level_nrs: number;
|
|
6329
|
+
noise_level_decibel: number;
|
|
6330
|
+
device_name: string;
|
|
6331
|
+
device_id: string;
|
|
6332
|
+
} | undefined;
|
|
6333
|
+
minut_metadata?: {
|
|
6334
|
+
device_id: string;
|
|
6335
|
+
device_name: string;
|
|
6336
|
+
latest_sensor_values: {
|
|
6337
|
+
temperature: {
|
|
6338
|
+
time: string;
|
|
6339
|
+
value: number;
|
|
6340
|
+
};
|
|
6341
|
+
sound: {
|
|
6342
|
+
time: string;
|
|
6343
|
+
value: number;
|
|
6344
|
+
};
|
|
6345
|
+
humidity: {
|
|
6346
|
+
time: string;
|
|
6347
|
+
value: number;
|
|
6348
|
+
};
|
|
6349
|
+
pressure: {
|
|
6350
|
+
time: string;
|
|
6351
|
+
value: number;
|
|
6352
|
+
};
|
|
6353
|
+
accelerometer_z: {
|
|
6354
|
+
time: string;
|
|
6355
|
+
value: number;
|
|
6356
|
+
};
|
|
6357
|
+
};
|
|
6358
|
+
} | undefined;
|
|
6359
|
+
four_suites_metadata?: {
|
|
6360
|
+
device_id: number;
|
|
6361
|
+
device_name: string;
|
|
6362
|
+
reclose_delay_in_seconds: number;
|
|
6363
|
+
} | undefined;
|
|
6364
|
+
two_n_metadata?: {
|
|
6365
|
+
device_id: number;
|
|
6366
|
+
device_name: string;
|
|
6367
|
+
} | undefined;
|
|
6368
|
+
controlbyweb_metadata?: {
|
|
6369
|
+
device_id: string;
|
|
6370
|
+
device_name: string;
|
|
6371
|
+
relay_name: string | null;
|
|
6372
|
+
} | undefined;
|
|
6373
|
+
ttlock_metadata?: {
|
|
6374
|
+
lock_id: number;
|
|
6375
|
+
lock_alias: string;
|
|
6376
|
+
} | undefined;
|
|
6377
|
+
seam_bridge_metadata?: {
|
|
6378
|
+
unlock_method?: ('bridge' | 'doorking') | undefined;
|
|
6379
|
+
device_num: number;
|
|
6380
|
+
name: string;
|
|
6381
|
+
} | undefined;
|
|
6382
|
+
igloohome_metadata?: {
|
|
6383
|
+
device_id: string;
|
|
6384
|
+
device_name: string;
|
|
6385
|
+
bridge_id?: string | undefined;
|
|
6386
|
+
bridge_name?: string | undefined;
|
|
6387
|
+
} | undefined;
|
|
6388
|
+
nest_metadata?: {
|
|
6389
|
+
nest_device_id: string;
|
|
6390
|
+
device_name: string;
|
|
6391
|
+
custom_name: string;
|
|
6392
|
+
} | undefined;
|
|
6393
|
+
ecobee_metadata?: {
|
|
6394
|
+
ecobee_device_id: string;
|
|
6395
|
+
device_name: string;
|
|
6396
|
+
} | undefined;
|
|
6397
|
+
hubitat_metadata?: {
|
|
6398
|
+
device_id: string;
|
|
6399
|
+
device_name: string;
|
|
6400
|
+
device_label: string;
|
|
6401
|
+
} | undefined;
|
|
6402
|
+
dormakaba_oracode_metadata?: {
|
|
6403
|
+
door_id: number;
|
|
6404
|
+
door_name: string;
|
|
6405
|
+
device_id?: number | undefined;
|
|
6406
|
+
site_id: number;
|
|
6407
|
+
site_name: string;
|
|
6408
|
+
iana_timezone?: string | undefined;
|
|
6409
|
+
predefined_time_slots?: Array<{
|
|
6410
|
+
name: string;
|
|
6411
|
+
prefix: number;
|
|
6412
|
+
check_in_time: string;
|
|
6413
|
+
check_out_time: string;
|
|
6414
|
+
is_24_hour: boolean;
|
|
6415
|
+
is_biweekly_mode: boolean;
|
|
6416
|
+
is_one_shot: boolean;
|
|
6417
|
+
is_master: boolean;
|
|
6418
|
+
ext_dormakaba_oracode_user_level_prefix: number;
|
|
6419
|
+
dormakaba_oracode_user_level_id: string;
|
|
6420
|
+
}> | undefined;
|
|
6421
|
+
} | undefined;
|
|
6422
|
+
wyze_metadata?: {
|
|
6423
|
+
device_id: string;
|
|
6424
|
+
device_name: string;
|
|
6425
|
+
product_name: string;
|
|
6426
|
+
product_type: string;
|
|
6427
|
+
product_model: string;
|
|
6428
|
+
device_info_model: string;
|
|
6429
|
+
} | undefined;
|
|
6430
|
+
}) & ({
|
|
6431
|
+
code_constraints?: (Array<{
|
|
6432
|
+
constraint_type: 'no_zeros' | 'cannot_start_with_12' | 'no_triple_consecutive_ints' | 'cannot_specify_pin_code' | 'pin_code_matches_existing_set' | 'start_date_in_future';
|
|
6433
|
+
} | {
|
|
6434
|
+
constraint_type: 'name_length';
|
|
6435
|
+
min_length?: number | undefined;
|
|
6436
|
+
max_length?: number | undefined;
|
|
6437
|
+
}> | undefined) | undefined;
|
|
6438
|
+
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
6439
|
+
max_active_codes_supported?: (number | undefined) | undefined;
|
|
6440
|
+
supports_backup_access_code_pool?: (boolean | undefined) | undefined;
|
|
6441
|
+
has_native_entry_events?: (boolean | undefined) | undefined;
|
|
6442
|
+
locked?: (boolean | undefined) | undefined;
|
|
6443
|
+
keypad_battery?: ({
|
|
6444
|
+
level: number;
|
|
6445
|
+
} | undefined) | undefined;
|
|
6446
|
+
door_open?: (boolean | undefined) | undefined;
|
|
6447
|
+
} & ({
|
|
6448
|
+
temperature_fahrenheit?: number | undefined;
|
|
6449
|
+
temperature_celsius?: number | undefined;
|
|
6450
|
+
relative_humidity?: number | undefined;
|
|
6451
|
+
can_enable_automatic_heating?: boolean | undefined;
|
|
6452
|
+
can_enable_automatic_cooling?: boolean | undefined;
|
|
6453
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
6454
|
+
is_heating_available?: true | undefined;
|
|
6455
|
+
is_cooling_available?: true | undefined;
|
|
6456
|
+
is_heating?: boolean | undefined;
|
|
6457
|
+
is_cooling?: boolean | undefined;
|
|
6458
|
+
is_fan_running?: boolean | undefined;
|
|
6459
|
+
fan_mode_setting?: ('auto' | 'on') | undefined;
|
|
6460
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
6461
|
+
current_climate_setting?: {
|
|
6462
|
+
automatic_heating_enabled: boolean;
|
|
6463
|
+
automatic_cooling_enabled: boolean;
|
|
6464
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
6465
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6466
|
+
heating_set_point_celsius?: number | undefined;
|
|
6467
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6468
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6469
|
+
manual_override_allowed: boolean;
|
|
6470
|
+
} | undefined;
|
|
6471
|
+
default_climate_setting?: ({
|
|
6472
|
+
automatic_heating_enabled: boolean;
|
|
6473
|
+
automatic_cooling_enabled: boolean;
|
|
6474
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
6475
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6476
|
+
heating_set_point_celsius?: number | undefined;
|
|
6477
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6478
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6479
|
+
manual_override_allowed: boolean;
|
|
6480
|
+
} | undefined) | undefined;
|
|
6481
|
+
is_climate_setting_schedule_active?: boolean | undefined;
|
|
6482
|
+
active_climate_setting_schedule?: ({
|
|
6483
|
+
climate_setting_schedule_id: string;
|
|
6484
|
+
schedule_type: 'time_bound';
|
|
6485
|
+
device_id: string;
|
|
6486
|
+
name?: string | undefined;
|
|
6487
|
+
schedule_starts_at: string;
|
|
6488
|
+
schedule_ends_at: string;
|
|
6489
|
+
created_at: string;
|
|
6490
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
6491
|
+
errors?: any;
|
|
6492
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6493
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6494
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6495
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6496
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6497
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6498
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6499
|
+
manual_override_allowed?: boolean | undefined;
|
|
6500
|
+
} | undefined) | undefined;
|
|
6501
|
+
min_cooling_set_point_celsius?: number | undefined;
|
|
6502
|
+
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
6503
|
+
max_cooling_set_point_celsius?: number | undefined;
|
|
6504
|
+
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
6505
|
+
min_heating_set_point_celsius?: number | undefined;
|
|
6506
|
+
min_heating_set_point_fahrenheit?: number | undefined;
|
|
6507
|
+
max_heating_set_point_celsius?: number | undefined;
|
|
6508
|
+
max_heating_set_point_fahrenheit?: number | undefined;
|
|
6509
|
+
min_heating_cooling_delta_celsius?: number | undefined;
|
|
6510
|
+
min_heating_cooling_delta_fahrenheit?: number | undefined;
|
|
6511
|
+
} | {
|
|
6512
|
+
temperature_fahrenheit?: number | undefined;
|
|
6513
|
+
temperature_celsius?: number | undefined;
|
|
6514
|
+
relative_humidity?: number | undefined;
|
|
6515
|
+
can_enable_automatic_heating?: boolean | undefined;
|
|
6516
|
+
can_enable_automatic_cooling?: boolean | undefined;
|
|
6517
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
6518
|
+
is_heating_available?: true | undefined;
|
|
6519
|
+
is_cooling_available?: false | undefined;
|
|
6520
|
+
is_heating?: boolean | undefined;
|
|
6521
|
+
is_cooling?: boolean | undefined;
|
|
6522
|
+
is_fan_running?: boolean | undefined;
|
|
6523
|
+
fan_mode_setting?: ('auto' | 'on') | undefined;
|
|
6524
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
6525
|
+
current_climate_setting?: {
|
|
6526
|
+
automatic_heating_enabled: boolean;
|
|
6527
|
+
automatic_cooling_enabled: boolean;
|
|
6528
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
6529
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6530
|
+
heating_set_point_celsius?: number | undefined;
|
|
6531
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6532
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6533
|
+
manual_override_allowed: boolean;
|
|
6534
|
+
} | undefined;
|
|
6535
|
+
default_climate_setting?: ({
|
|
6536
|
+
automatic_heating_enabled: boolean;
|
|
6537
|
+
automatic_cooling_enabled: boolean;
|
|
6538
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
6539
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6540
|
+
heating_set_point_celsius?: number | undefined;
|
|
6541
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6542
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6543
|
+
manual_override_allowed: boolean;
|
|
6544
|
+
} | undefined) | undefined;
|
|
6545
|
+
is_climate_setting_schedule_active?: boolean | undefined;
|
|
6546
|
+
active_climate_setting_schedule?: ({
|
|
6547
|
+
climate_setting_schedule_id: string;
|
|
6548
|
+
schedule_type: 'time_bound';
|
|
6549
|
+
device_id: string;
|
|
6550
|
+
name?: string | undefined;
|
|
6551
|
+
schedule_starts_at: string;
|
|
6552
|
+
schedule_ends_at: string;
|
|
6553
|
+
created_at: string;
|
|
6554
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
6555
|
+
errors?: any;
|
|
6556
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6557
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6558
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6559
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6560
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6561
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6562
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6563
|
+
manual_override_allowed?: boolean | undefined;
|
|
6564
|
+
} | undefined) | undefined;
|
|
6565
|
+
min_heating_set_point_celsius?: number | undefined;
|
|
6566
|
+
min_heating_set_point_fahrenheit?: number | undefined;
|
|
6567
|
+
max_heating_set_point_celsius?: number | undefined;
|
|
6568
|
+
max_heating_set_point_fahrenheit?: number | undefined;
|
|
6569
|
+
} | {
|
|
6570
|
+
temperature_fahrenheit?: number | undefined;
|
|
6571
|
+
temperature_celsius?: number | undefined;
|
|
6572
|
+
relative_humidity?: number | undefined;
|
|
6573
|
+
can_enable_automatic_heating?: boolean | undefined;
|
|
6574
|
+
can_enable_automatic_cooling?: boolean | undefined;
|
|
6575
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
6576
|
+
is_heating_available?: false | undefined;
|
|
6577
|
+
is_cooling_available?: true | undefined;
|
|
6578
|
+
is_heating?: boolean | undefined;
|
|
6579
|
+
is_cooling?: boolean | undefined;
|
|
6580
|
+
is_fan_running?: boolean | undefined;
|
|
6581
|
+
fan_mode_setting?: ('auto' | 'on') | undefined;
|
|
6582
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
6583
|
+
current_climate_setting?: {
|
|
6584
|
+
automatic_heating_enabled: boolean;
|
|
6585
|
+
automatic_cooling_enabled: boolean;
|
|
6586
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
6587
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6588
|
+
heating_set_point_celsius?: number | undefined;
|
|
6589
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6590
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6591
|
+
manual_override_allowed: boolean;
|
|
6592
|
+
} | undefined;
|
|
6593
|
+
default_climate_setting?: ({
|
|
6594
|
+
automatic_heating_enabled: boolean;
|
|
6595
|
+
automatic_cooling_enabled: boolean;
|
|
6596
|
+
hvac_mode_setting: 'off' | 'heat' | 'cool' | 'heat_cool';
|
|
6597
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6598
|
+
heating_set_point_celsius?: number | undefined;
|
|
6599
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6600
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6601
|
+
manual_override_allowed: boolean;
|
|
6602
|
+
} | undefined) | undefined;
|
|
6603
|
+
is_climate_setting_schedule_active?: boolean | undefined;
|
|
6604
|
+
active_climate_setting_schedule?: ({
|
|
6605
|
+
climate_setting_schedule_id: string;
|
|
6606
|
+
schedule_type: 'time_bound';
|
|
6607
|
+
device_id: string;
|
|
6608
|
+
name?: string | undefined;
|
|
6609
|
+
schedule_starts_at: string;
|
|
6610
|
+
schedule_ends_at: string;
|
|
6611
|
+
created_at: string;
|
|
6612
|
+
/** Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues. */
|
|
6613
|
+
errors?: any;
|
|
6614
|
+
automatic_heating_enabled?: boolean | undefined;
|
|
6615
|
+
automatic_cooling_enabled?: boolean | undefined;
|
|
6616
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
6617
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
6618
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
6619
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6620
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
6621
|
+
manual_override_allowed?: boolean | undefined;
|
|
6622
|
+
} | undefined) | undefined;
|
|
6623
|
+
min_cooling_set_point_celsius?: number | undefined;
|
|
6624
|
+
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
6625
|
+
max_cooling_set_point_celsius?: number | undefined;
|
|
6626
|
+
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
6627
|
+
}))) & {
|
|
6628
|
+
assa_abloy_credential_service_metadata?: ({
|
|
6629
|
+
has_active_endpoint: boolean;
|
|
6630
|
+
endpoints: Array<{
|
|
6631
|
+
endpoint_id: string;
|
|
6632
|
+
is_active: boolean;
|
|
6633
|
+
}>;
|
|
6634
|
+
} | undefined) | undefined;
|
|
6635
|
+
};
|
|
6636
|
+
/** Location information for the device. */
|
|
6637
|
+
location: {
|
|
6638
|
+
/** Name of the device location. */
|
|
6639
|
+
location_name?: string | undefined;
|
|
6640
|
+
/** Time zone of the device location. */
|
|
6641
|
+
timezone?: string | undefined;
|
|
6642
|
+
} | null;
|
|
6643
|
+
/** Unique identifier for the account associated with the device. */
|
|
6644
|
+
connected_account_id: string;
|
|
6645
|
+
/** Unique identifier for the Seam workspace associated with the device. */
|
|
6646
|
+
workspace_id: string;
|
|
6647
|
+
/** Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it. */
|
|
6648
|
+
errors: Array<{
|
|
6649
|
+
error_code: string;
|
|
6650
|
+
message: string;
|
|
6651
|
+
}>;
|
|
6652
|
+
/** Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it. */
|
|
6653
|
+
warnings: Array<{
|
|
6654
|
+
warning_code: string;
|
|
6655
|
+
message: string;
|
|
6656
|
+
}>;
|
|
6657
|
+
/** Date and time at which the device object was created. */
|
|
6658
|
+
created_at: string;
|
|
6659
|
+
/** Indicates whether Seam manages the device. */
|
|
6660
|
+
is_managed: true;
|
|
6661
|
+
};
|
|
6662
|
+
};
|
|
6663
|
+
};
|
|
6664
|
+
'/thermostats/heat': {
|
|
6665
|
+
route: '/thermostats/heat';
|
|
6666
|
+
method: 'POST';
|
|
6667
|
+
queryParams: {};
|
|
6668
|
+
jsonBody: {
|
|
6669
|
+
device_id: string;
|
|
6670
|
+
heating_set_point_celsius?: number | undefined;
|
|
6671
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6672
|
+
sync?: boolean;
|
|
6673
|
+
};
|
|
6674
|
+
commonParams: {};
|
|
6675
|
+
formData: {};
|
|
6676
|
+
jsonResponse: {};
|
|
6677
|
+
};
|
|
6678
|
+
'/thermostats/heat_cool': {
|
|
6679
|
+
route: '/thermostats/heat_cool';
|
|
6680
|
+
method: 'POST';
|
|
6681
|
+
queryParams: {};
|
|
6682
|
+
jsonBody: {
|
|
6683
|
+
device_id: string;
|
|
6684
|
+
heating_set_point_celsius?: number | undefined;
|
|
6685
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
6686
|
+
cooling_set_point_celsius?: number | undefined;
|
|
6687
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
6688
|
+
sync?: boolean;
|
|
5648
6689
|
};
|
|
5649
6690
|
commonParams: {};
|
|
5650
6691
|
formData: {};
|
|
@@ -5678,7 +6719,7 @@ export interface Routes {
|
|
|
5678
6719
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
5679
6720
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
5680
6721
|
/** Properties of the device. */
|
|
5681
|
-
properties: ({
|
|
6722
|
+
properties: (({
|
|
5682
6723
|
/** Indicates whether the device is online. */
|
|
5683
6724
|
online: boolean;
|
|
5684
6725
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -6086,7 +7127,15 @@ export interface Routes {
|
|
|
6086
7127
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
6087
7128
|
max_cooling_set_point_celsius?: number | undefined;
|
|
6088
7129
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
6089
|
-
}))
|
|
7130
|
+
}))) & {
|
|
7131
|
+
assa_abloy_credential_service_metadata?: ({
|
|
7132
|
+
has_active_endpoint: boolean;
|
|
7133
|
+
endpoints: Array<{
|
|
7134
|
+
endpoint_id: string;
|
|
7135
|
+
is_active: boolean;
|
|
7136
|
+
}>;
|
|
7137
|
+
} | undefined) | undefined;
|
|
7138
|
+
};
|
|
6090
7139
|
/** Location information for the device. */
|
|
6091
7140
|
location: {
|
|
6092
7141
|
/** Name of the device location. */
|
|
@@ -6198,6 +7247,25 @@ export interface Routes {
|
|
|
6198
7247
|
};
|
|
6199
7248
|
};
|
|
6200
7249
|
};
|
|
7250
|
+
'/user_identities/enrollment_automations/get': {
|
|
7251
|
+
route: '/user_identities/enrollment_automations/get';
|
|
7252
|
+
method: 'GET' | 'POST';
|
|
7253
|
+
queryParams: {};
|
|
7254
|
+
jsonBody: {};
|
|
7255
|
+
commonParams: {
|
|
7256
|
+
enrollment_automation_id: string;
|
|
7257
|
+
};
|
|
7258
|
+
formData: {};
|
|
7259
|
+
jsonResponse: {
|
|
7260
|
+
enrollment_automation: {
|
|
7261
|
+
credential_manager_acs_system_id: string;
|
|
7262
|
+
user_identity_id: string;
|
|
7263
|
+
created_at: string;
|
|
7264
|
+
workspace_id: string;
|
|
7265
|
+
enrollment_automation_id: string;
|
|
7266
|
+
};
|
|
7267
|
+
};
|
|
7268
|
+
};
|
|
6201
7269
|
'/user_identities/enrollment_automations/launch': {
|
|
6202
7270
|
route: '/user_identities/enrollment_automations/launch';
|
|
6203
7271
|
method: 'POST';
|
|
@@ -6222,6 +7290,25 @@ export interface Routes {
|
|
|
6222
7290
|
};
|
|
6223
7291
|
};
|
|
6224
7292
|
};
|
|
7293
|
+
'/user_identities/enrollment_automations/list': {
|
|
7294
|
+
route: '/user_identities/enrollment_automations/list';
|
|
7295
|
+
method: 'GET' | 'POST';
|
|
7296
|
+
queryParams: {};
|
|
7297
|
+
jsonBody: {};
|
|
7298
|
+
commonParams: {
|
|
7299
|
+
user_identity_id: string;
|
|
7300
|
+
};
|
|
7301
|
+
formData: {};
|
|
7302
|
+
jsonResponse: {
|
|
7303
|
+
enrollment_automations: Array<{
|
|
7304
|
+
credential_manager_acs_system_id: string;
|
|
7305
|
+
user_identity_id: string;
|
|
7306
|
+
created_at: string;
|
|
7307
|
+
workspace_id: string;
|
|
7308
|
+
enrollment_automation_id: string;
|
|
7309
|
+
}>;
|
|
7310
|
+
};
|
|
7311
|
+
};
|
|
6225
7312
|
'/user_identities/get': {
|
|
6226
7313
|
route: '/user_identities/get';
|
|
6227
7314
|
method: 'GET' | 'POST';
|
|
@@ -6294,7 +7381,7 @@ export interface Routes {
|
|
|
6294
7381
|
/** Collection of capabilities that the device supports when connected to Seam. Values are "access_code," which indicates that the device can manage and utilize digital PIN codes for secure access; "lock," which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; "noise_detection," which indicates that the device supports monitoring and responding to ambient noise levels; "thermostat," which indicates that the device can regulate and adjust indoor temperatures; and "battery," which indicates that the device can manage battery life and health. */
|
|
6295
7382
|
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
6296
7383
|
/** Properties of the device. */
|
|
6297
|
-
properties: ({
|
|
7384
|
+
properties: (({
|
|
6298
7385
|
/** Indicates whether the device is online. */
|
|
6299
7386
|
online: boolean;
|
|
6300
7387
|
/** Name of the device. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
@@ -6702,7 +7789,15 @@ export interface Routes {
|
|
|
6702
7789
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
6703
7790
|
max_cooling_set_point_celsius?: number | undefined;
|
|
6704
7791
|
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
6705
|
-
}))
|
|
7792
|
+
}))) & {
|
|
7793
|
+
assa_abloy_credential_service_metadata?: ({
|
|
7794
|
+
has_active_endpoint: boolean;
|
|
7795
|
+
endpoints: Array<{
|
|
7796
|
+
endpoint_id: string;
|
|
7797
|
+
is_active: boolean;
|
|
7798
|
+
}>;
|
|
7799
|
+
} | undefined) | undefined;
|
|
7800
|
+
};
|
|
6706
7801
|
/** Location information for the device. */
|
|
6707
7802
|
location: {
|
|
6708
7803
|
/** Name of the device location. */
|