@seamapi/types 1.292.1 → 1.293.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 +148 -24
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +160 -518
- package/lib/seam/connect/models/acs/metadata/{assa_abloy_vostio.js → assa-abloy-vostio.js} +1 -1
- package/lib/seam/connect/models/acs/metadata/{assa_abloy_vostio.js.map → assa-abloy-vostio.js.map} +1 -1
- package/lib/seam/connect/models/acs/metadata/{dormakaba_community.js → dormakaba-community.js} +1 -1
- package/lib/seam/connect/models/acs/metadata/{dormakaba_community.js.map → dormakaba-community.js.map} +1 -1
- package/lib/seam/connect/models/acs/metadata/index.d.ts +2 -2
- package/lib/seam/connect/models/acs/metadata/index.js +2 -2
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +5 -0
- package/lib/seam/connect/models/devices/capability-properties/thermostat.d.ts +5 -0
- package/lib/seam/connect/models/devices/device.d.ts +7 -0
- package/lib/seam/connect/models/devices/phone.d.ts +5 -0
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +5 -0
- package/lib/seam/connect/models/thermostats/thermostat-schedule.d.ts +3 -0
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js +8 -0
- package/lib/seam/connect/models/thermostats/thermostat-schedule.js.map +1 -1
- package/lib/seam/connect/openapi.d.ts +86 -9
- package/lib/seam/connect/openapi.js +102 -18
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +268 -719
- package/lib/seam/connect/schemas.d.ts +1 -1
- package/lib/seam/connect/schemas.js +1 -1
- package/lib/seam/connect/schemas.js.map +1 -1
- package/package.json +1 -1
- package/src/lib/seam/connect/models/acs/metadata/index.ts +2 -2
- package/src/lib/seam/connect/models/thermostats/thermostat-schedule.ts +10 -0
- package/src/lib/seam/connect/openapi.ts +114 -18
- package/src/lib/seam/connect/route-types.ts +271 -905
- package/src/lib/seam/connect/schemas.ts +1 -0
- /package/lib/seam/connect/models/acs/metadata/{assa_abloy_vostio.d.ts → assa-abloy-vostio.d.ts} +0 -0
- /package/lib/seam/connect/models/acs/metadata/{dormakaba_community.d.ts → dormakaba-community.d.ts} +0 -0
- /package/src/lib/seam/connect/models/acs/metadata/{assa_abloy_vostio.ts → assa-abloy-vostio.ts} +0 -0
- /package/src/lib/seam/connect/models/acs/metadata/{dormakaba_community.ts → dormakaba-community.ts} +0 -0
package/dist/connect.d.cts
CHANGED
|
@@ -6335,6 +6335,7 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
6335
6335
|
climate_preset_key: z.ZodString;
|
|
6336
6336
|
max_override_period_minutes: z.ZodNumber;
|
|
6337
6337
|
starts_at: z.ZodString;
|
|
6338
|
+
unstable_is_override_allowed: z.ZodOptional<z.ZodBoolean>;
|
|
6338
6339
|
ends_at: z.ZodString;
|
|
6339
6340
|
created_at: z.ZodString;
|
|
6340
6341
|
errors: z.ZodAny;
|
|
@@ -6348,6 +6349,7 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
6348
6349
|
ends_at: string;
|
|
6349
6350
|
errors?: any;
|
|
6350
6351
|
name?: string | undefined;
|
|
6352
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
6351
6353
|
}, {
|
|
6352
6354
|
created_at: string;
|
|
6353
6355
|
climate_preset_key: string;
|
|
@@ -6358,6 +6360,7 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
6358
6360
|
ends_at: string;
|
|
6359
6361
|
errors?: any;
|
|
6360
6362
|
name?: string | undefined;
|
|
6363
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
6361
6364
|
}>>>>;
|
|
6362
6365
|
min_cooling_set_point_celsius: z.ZodOptional<z.ZodNumber>;
|
|
6363
6366
|
min_cooling_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
|
|
@@ -6449,6 +6452,7 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
6449
6452
|
ends_at: string;
|
|
6450
6453
|
errors?: any;
|
|
6451
6454
|
name?: string | undefined;
|
|
6455
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
6452
6456
|
} | null | undefined;
|
|
6453
6457
|
min_cooling_set_point_celsius?: number | undefined;
|
|
6454
6458
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
@@ -6530,6 +6534,7 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
6530
6534
|
ends_at: string;
|
|
6531
6535
|
errors?: any;
|
|
6532
6536
|
name?: string | undefined;
|
|
6537
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
6533
6538
|
} | null | undefined;
|
|
6534
6539
|
min_cooling_set_point_celsius?: number | undefined;
|
|
6535
6540
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
@@ -6985,6 +6990,7 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
6985
6990
|
ends_at: string;
|
|
6986
6991
|
errors?: any;
|
|
6987
6992
|
name?: string | undefined;
|
|
6993
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
6988
6994
|
} | null | undefined;
|
|
6989
6995
|
min_cooling_set_point_celsius?: number | undefined;
|
|
6990
6996
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
@@ -7392,6 +7398,7 @@ declare const device: z.ZodObject<z.objectUtil.extendShape<{
|
|
|
7392
7398
|
ends_at: string;
|
|
7393
7399
|
errors?: any;
|
|
7394
7400
|
name?: string | undefined;
|
|
7401
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
7395
7402
|
} | null | undefined;
|
|
7396
7403
|
min_cooling_set_point_celsius?: number | undefined;
|
|
7397
7404
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
@@ -9103,6 +9110,7 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
|
|
|
9103
9110
|
climate_preset_key: z.ZodString;
|
|
9104
9111
|
max_override_period_minutes: z.ZodNumber;
|
|
9105
9112
|
starts_at: z.ZodString;
|
|
9113
|
+
unstable_is_override_allowed: z.ZodOptional<z.ZodBoolean>;
|
|
9106
9114
|
ends_at: z.ZodString;
|
|
9107
9115
|
created_at: z.ZodString;
|
|
9108
9116
|
errors: z.ZodAny;
|
|
@@ -9116,6 +9124,7 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
|
|
|
9116
9124
|
ends_at: string;
|
|
9117
9125
|
errors?: any;
|
|
9118
9126
|
name?: string | undefined;
|
|
9127
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
9119
9128
|
}, {
|
|
9120
9129
|
created_at: string;
|
|
9121
9130
|
climate_preset_key: string;
|
|
@@ -9126,6 +9135,7 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
|
|
|
9126
9135
|
ends_at: string;
|
|
9127
9136
|
errors?: any;
|
|
9128
9137
|
name?: string | undefined;
|
|
9138
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
9129
9139
|
}>>>>;
|
|
9130
9140
|
min_cooling_set_point_celsius: z.ZodOptional<z.ZodNumber>;
|
|
9131
9141
|
min_cooling_set_point_fahrenheit: z.ZodOptional<z.ZodNumber>;
|
|
@@ -9217,6 +9227,7 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
|
|
|
9217
9227
|
ends_at: string;
|
|
9218
9228
|
errors?: any;
|
|
9219
9229
|
name?: string | undefined;
|
|
9230
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
9220
9231
|
} | null | undefined;
|
|
9221
9232
|
min_cooling_set_point_celsius?: number | undefined;
|
|
9222
9233
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
@@ -9298,6 +9309,7 @@ declare const unmanaged_device: z.ZodObject<z.objectUtil.extendShape<z.objectUti
|
|
|
9298
9309
|
ends_at: string;
|
|
9299
9310
|
errors?: any;
|
|
9300
9311
|
name?: string | undefined;
|
|
9312
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
9301
9313
|
} | null | undefined;
|
|
9302
9314
|
min_cooling_set_point_celsius?: number | undefined;
|
|
9303
9315
|
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
@@ -11720,6 +11732,7 @@ declare const thermostat_schedule: z.ZodObject<{
|
|
|
11720
11732
|
climate_preset_key: z.ZodString;
|
|
11721
11733
|
max_override_period_minutes: z.ZodNumber;
|
|
11722
11734
|
starts_at: z.ZodString;
|
|
11735
|
+
unstable_is_override_allowed: z.ZodOptional<z.ZodBoolean>;
|
|
11723
11736
|
ends_at: z.ZodString;
|
|
11724
11737
|
created_at: z.ZodString;
|
|
11725
11738
|
errors: z.ZodAny;
|
|
@@ -11733,6 +11746,7 @@ declare const thermostat_schedule: z.ZodObject<{
|
|
|
11733
11746
|
ends_at: string;
|
|
11734
11747
|
errors?: any;
|
|
11735
11748
|
name?: string | undefined;
|
|
11749
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
11736
11750
|
}, {
|
|
11737
11751
|
created_at: string;
|
|
11738
11752
|
climate_preset_key: string;
|
|
@@ -11743,6 +11757,7 @@ declare const thermostat_schedule: z.ZodObject<{
|
|
|
11743
11757
|
ends_at: string;
|
|
11744
11758
|
errors?: any;
|
|
11745
11759
|
name?: string | undefined;
|
|
11760
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
11746
11761
|
}>;
|
|
11747
11762
|
type ThermostatSchedule = z.infer<typeof thermostat_schedule>;
|
|
11748
11763
|
|
|
@@ -11818,6 +11833,7 @@ type Workspace = z.infer<typeof workspace>;
|
|
|
11818
11833
|
declare const schemas_access_code: typeof access_code;
|
|
11819
11834
|
declare const schemas_acs_access_group: typeof acs_access_group;
|
|
11820
11835
|
declare const schemas_acs_credential: typeof acs_credential;
|
|
11836
|
+
declare const schemas_acs_encoder: typeof acs_encoder;
|
|
11821
11837
|
declare const schemas_acs_entrance: typeof acs_entrance;
|
|
11822
11838
|
declare const schemas_acs_system: typeof acs_system;
|
|
11823
11839
|
declare const schemas_acs_user: typeof acs_user;
|
|
@@ -11843,7 +11859,7 @@ declare const schemas_user_identity: typeof user_identity;
|
|
|
11843
11859
|
declare const schemas_webhook: typeof webhook;
|
|
11844
11860
|
declare const schemas_workspace: typeof workspace;
|
|
11845
11861
|
declare namespace schemas {
|
|
11846
|
-
export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_device as device, schemas_device_provider as device_provider, schemas_noise_threshold as noise_threshold, schemas_seam_event as seam_event, schemas_thermostat_schedule as thermostat_schedule, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
|
|
11862
|
+
export { schemas_access_code as access_code, schemas_acs_access_group as acs_access_group, schemas_acs_credential as acs_credential, schemas_acs_encoder as acs_encoder, schemas_acs_entrance as acs_entrance, schemas_acs_system as acs_system, schemas_acs_user as acs_user, schemas_action_attempt as action_attempt, schemas_client_session as client_session, schemas_common_failed_action_attempt as common_failed_action_attempt, schemas_common_pending_action_attempt as common_pending_action_attempt, schemas_common_succeeded_action_attempt as common_succeeded_action_attempt, schemas_connect_webview as connect_webview, schemas_connected_account as connected_account, schemas_custom_metadata as custom_metadata, schemas_device as device, schemas_device_provider as device_provider, schemas_noise_threshold as noise_threshold, schemas_seam_event as seam_event, schemas_thermostat_schedule as thermostat_schedule, schemas_unmanaged_access_code as unmanaged_access_code, schemas_unmanaged_acs_access_group as unmanaged_acs_access_group, schemas_unmanaged_acs_credential as unmanaged_acs_credential, schemas_unmanaged_acs_user as unmanaged_acs_user, schemas_unmanaged_device as unmanaged_device, schemas_user_identity as user_identity, schemas_webhook as webhook, schemas_workspace as workspace };
|
|
11847
11863
|
}
|
|
11848
11864
|
|
|
11849
11865
|
declare const _default: {
|
|
@@ -15151,6 +15167,11 @@ declare const _default: {
|
|
|
15151
15167
|
format: string;
|
|
15152
15168
|
type: string;
|
|
15153
15169
|
};
|
|
15170
|
+
unstable_is_override_allowed: {
|
|
15171
|
+
description: string;
|
|
15172
|
+
type: string;
|
|
15173
|
+
'x-undocumented': string;
|
|
15174
|
+
};
|
|
15154
15175
|
};
|
|
15155
15176
|
required: string[];
|
|
15156
15177
|
type: string;
|
|
@@ -15974,6 +15995,11 @@ declare const _default: {
|
|
|
15974
15995
|
format: string;
|
|
15975
15996
|
type: string;
|
|
15976
15997
|
};
|
|
15998
|
+
unstable_is_override_allowed: {
|
|
15999
|
+
description: string;
|
|
16000
|
+
type: string;
|
|
16001
|
+
'x-undocumented': string;
|
|
16002
|
+
};
|
|
15977
16003
|
};
|
|
15978
16004
|
required: string[];
|
|
15979
16005
|
type: string;
|
|
@@ -20970,7 +20996,7 @@ declare const _default: {
|
|
|
20970
20996
|
format: string;
|
|
20971
20997
|
type: string;
|
|
20972
20998
|
};
|
|
20973
|
-
|
|
20999
|
+
acs_encoder_id: {
|
|
20974
21000
|
description: string;
|
|
20975
21001
|
format: string;
|
|
20976
21002
|
type: string;
|
|
@@ -21040,14 +21066,14 @@ declare const _default: {
|
|
|
21040
21066
|
schema: {
|
|
21041
21067
|
oneOf: ({
|
|
21042
21068
|
properties: {
|
|
21043
|
-
|
|
21069
|
+
acs_encoder_ids: {
|
|
21044
21070
|
items: {
|
|
21045
21071
|
format: string;
|
|
21046
21072
|
type: string;
|
|
21047
21073
|
};
|
|
21048
21074
|
type: string;
|
|
21049
21075
|
};
|
|
21050
|
-
|
|
21076
|
+
acs_system_ids: {
|
|
21051
21077
|
items: {
|
|
21052
21078
|
format: string;
|
|
21053
21079
|
type: string;
|
|
@@ -21064,7 +21090,7 @@ declare const _default: {
|
|
|
21064
21090
|
type: string;
|
|
21065
21091
|
} | {
|
|
21066
21092
|
properties: {
|
|
21067
|
-
|
|
21093
|
+
acs_encoder_ids: {
|
|
21068
21094
|
items: {
|
|
21069
21095
|
format: string;
|
|
21070
21096
|
type: string;
|
|
@@ -21094,7 +21120,7 @@ declare const _default: {
|
|
|
21094
21120
|
format: string;
|
|
21095
21121
|
type: string;
|
|
21096
21122
|
};
|
|
21097
|
-
|
|
21123
|
+
acs_encoder_ids?: never;
|
|
21098
21124
|
};
|
|
21099
21125
|
required: string[];
|
|
21100
21126
|
type: string;
|
|
@@ -21109,9 +21135,66 @@ declare const _default: {
|
|
|
21109
21135
|
'application/json': {
|
|
21110
21136
|
schema: {
|
|
21111
21137
|
properties: {
|
|
21112
|
-
|
|
21138
|
+
acs_encoders: {
|
|
21113
21139
|
items: {
|
|
21114
|
-
|
|
21140
|
+
properties: {
|
|
21141
|
+
acs_encoder_id: {
|
|
21142
|
+
description: string;
|
|
21143
|
+
format: string;
|
|
21144
|
+
type: string;
|
|
21145
|
+
};
|
|
21146
|
+
acs_system_id: {
|
|
21147
|
+
description: string;
|
|
21148
|
+
format: string;
|
|
21149
|
+
type: string;
|
|
21150
|
+
};
|
|
21151
|
+
created_at: {
|
|
21152
|
+
description: string;
|
|
21153
|
+
format: string;
|
|
21154
|
+
type: string;
|
|
21155
|
+
};
|
|
21156
|
+
display_name: {
|
|
21157
|
+
description: string;
|
|
21158
|
+
type: string;
|
|
21159
|
+
};
|
|
21160
|
+
errors: {
|
|
21161
|
+
description: string;
|
|
21162
|
+
items: {
|
|
21163
|
+
description: string;
|
|
21164
|
+
properties: {
|
|
21165
|
+
_event_id: {
|
|
21166
|
+
description: string;
|
|
21167
|
+
format: string;
|
|
21168
|
+
type: string;
|
|
21169
|
+
};
|
|
21170
|
+
created_at: {
|
|
21171
|
+
description: string;
|
|
21172
|
+
format: string;
|
|
21173
|
+
type: string;
|
|
21174
|
+
};
|
|
21175
|
+
error_code: {
|
|
21176
|
+
description: string;
|
|
21177
|
+
enum: string[];
|
|
21178
|
+
type: string;
|
|
21179
|
+
};
|
|
21180
|
+
message: {
|
|
21181
|
+
description: string;
|
|
21182
|
+
type: string;
|
|
21183
|
+
};
|
|
21184
|
+
};
|
|
21185
|
+
required: string[];
|
|
21186
|
+
type: string;
|
|
21187
|
+
};
|
|
21188
|
+
type: string;
|
|
21189
|
+
};
|
|
21190
|
+
workspace_id: {
|
|
21191
|
+
description: string;
|
|
21192
|
+
format: string;
|
|
21193
|
+
type: string;
|
|
21194
|
+
};
|
|
21195
|
+
};
|
|
21196
|
+
required: string[];
|
|
21197
|
+
type: string;
|
|
21115
21198
|
};
|
|
21116
21199
|
type: string;
|
|
21117
21200
|
};
|
|
@@ -21163,12 +21246,12 @@ declare const _default: {
|
|
|
21163
21246
|
'application/json': {
|
|
21164
21247
|
schema: {
|
|
21165
21248
|
properties: {
|
|
21166
|
-
|
|
21249
|
+
acs_encoder_id: {
|
|
21167
21250
|
description: string;
|
|
21168
21251
|
format: string;
|
|
21169
21252
|
type: string;
|
|
21170
21253
|
};
|
|
21171
|
-
|
|
21254
|
+
acs_system_id: {
|
|
21172
21255
|
description: string;
|
|
21173
21256
|
format: string;
|
|
21174
21257
|
type: string;
|
|
@@ -28706,6 +28789,10 @@ declare const _default: {
|
|
|
28706
28789
|
description: string;
|
|
28707
28790
|
type: string;
|
|
28708
28791
|
};
|
|
28792
|
+
is_override_allowed: {
|
|
28793
|
+
default: boolean;
|
|
28794
|
+
type: string;
|
|
28795
|
+
};
|
|
28709
28796
|
max_override_period_minutes: {
|
|
28710
28797
|
default: number;
|
|
28711
28798
|
description: string;
|
|
@@ -29038,6 +29125,9 @@ declare const _default: {
|
|
|
29038
29125
|
description: string;
|
|
29039
29126
|
type: string;
|
|
29040
29127
|
};
|
|
29128
|
+
is_override_allowed: {
|
|
29129
|
+
type: string;
|
|
29130
|
+
};
|
|
29041
29131
|
max_override_period_minutes: {
|
|
29042
29132
|
description: string;
|
|
29043
29133
|
minimum: number;
|
|
@@ -29130,6 +29220,9 @@ declare const _default: {
|
|
|
29130
29220
|
description: string;
|
|
29131
29221
|
type: string;
|
|
29132
29222
|
};
|
|
29223
|
+
is_override_allowed: {
|
|
29224
|
+
type: string;
|
|
29225
|
+
};
|
|
29133
29226
|
max_override_period_minutes: {
|
|
29134
29227
|
description: string;
|
|
29135
29228
|
minimum: number;
|
|
@@ -36713,8 +36806,8 @@ interface Routes {
|
|
|
36713
36806
|
queryParams: {};
|
|
36714
36807
|
jsonBody: {};
|
|
36715
36808
|
commonParams: {
|
|
36716
|
-
/** ID of the
|
|
36717
|
-
|
|
36809
|
+
/** ID of the acs_encoder to use for the encoding. */
|
|
36810
|
+
acs_encoder_id: string;
|
|
36718
36811
|
/** ID of the acs_credential to encode on a physical card. */
|
|
36719
36812
|
acs_credential_id: string;
|
|
36720
36813
|
};
|
|
@@ -37449,10 +37542,10 @@ interface Routes {
|
|
|
37449
37542
|
jsonBody: {};
|
|
37450
37543
|
commonParams: {
|
|
37451
37544
|
acs_system_ids: string[];
|
|
37452
|
-
|
|
37545
|
+
acs_encoder_ids: string[];
|
|
37453
37546
|
limit?: number;
|
|
37454
37547
|
} | {
|
|
37455
|
-
|
|
37548
|
+
acs_encoder_ids: string[];
|
|
37456
37549
|
limit?: number;
|
|
37457
37550
|
} | {
|
|
37458
37551
|
acs_system_ids: string[];
|
|
@@ -37460,513 +37553,28 @@ interface Routes {
|
|
|
37460
37553
|
};
|
|
37461
37554
|
formData: {};
|
|
37462
37555
|
jsonResponse: {
|
|
37463
|
-
|
|
37464
|
-
/**
|
|
37465
|
-
|
|
37466
|
-
/**
|
|
37467
|
-
|
|
37468
|
-
/**
|
|
37469
|
-
nickname?: string | undefined;
|
|
37470
|
-
/** Display name of the device, defaults to nickname (if it is set) or properties.appearance.name otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
37471
|
-
display_name: string;
|
|
37472
|
-
/** 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. */
|
|
37473
|
-
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
37474
|
-
/** Properties of the device. */
|
|
37475
|
-
properties: (({
|
|
37476
|
-
/** Indicates whether the device is online. */
|
|
37477
|
-
online: boolean;
|
|
37478
|
-
/** Name of the device.
|
|
37479
|
-
* @deprecated use device.display_name instead */
|
|
37480
|
-
name: string;
|
|
37481
|
-
/** Represents the accessory keypad state. */
|
|
37482
|
-
accessory_keypad?: {
|
|
37483
|
-
/** Indicates if the accessory_keypad is connected to the device. */
|
|
37484
|
-
is_connected: boolean;
|
|
37485
|
-
/** Indicates if the keypad battery properties. */
|
|
37486
|
-
battery?: {
|
|
37487
|
-
level: number;
|
|
37488
|
-
} | undefined;
|
|
37489
|
-
} | undefined;
|
|
37490
|
-
appearance: {
|
|
37491
|
-
/** Name of the device as seen from the provider API and application, not settable through Seam. */
|
|
37492
|
-
name: string;
|
|
37493
|
-
};
|
|
37494
|
-
model: {
|
|
37495
|
-
/** Indicates whether the device can connect a accessory keypad. */
|
|
37496
|
-
can_connect_accessory_keypad?: boolean | undefined;
|
|
37497
|
-
/** Display name of the device model. */
|
|
37498
|
-
display_name: string;
|
|
37499
|
-
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
37500
|
-
manufacturer_display_name: string;
|
|
37501
|
-
/** Indicates whether the device has a built in accessory keypad. */
|
|
37502
|
-
has_built_in_keypad?: boolean | undefined;
|
|
37503
|
-
/** Indicates whether the device supports offline access codes. */
|
|
37504
|
-
offline_access_codes_supported?: boolean | undefined;
|
|
37505
|
-
/** Indicates whether the device supports online access codes. */
|
|
37506
|
-
online_access_codes_supported?: boolean | undefined;
|
|
37507
|
-
/**
|
|
37508
|
-
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
37509
|
-
accessory_keypad_supported?: boolean | undefined;
|
|
37510
|
-
};
|
|
37511
|
-
/** Indicates whether the device has direct power. */
|
|
37512
|
-
has_direct_power?: boolean | undefined;
|
|
37513
|
-
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
37514
|
-
battery_level?: number | undefined;
|
|
37515
|
-
/** 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. */
|
|
37516
|
-
battery?: {
|
|
37517
|
-
level: number;
|
|
37518
|
-
status: 'critical' | 'low' | 'good' | 'full';
|
|
37519
|
-
} | undefined;
|
|
37520
|
-
/** Manufacturer of the device. */
|
|
37521
|
-
manufacturer?: string | undefined;
|
|
37522
|
-
/** Image URL for the device. */
|
|
37523
|
-
image_url?: string | undefined;
|
|
37524
|
-
/** Alt text for the device image. */
|
|
37525
|
-
image_alt_text?: string | undefined;
|
|
37526
|
-
/** Serial number of the device. */
|
|
37527
|
-
serial_number?: string | undefined;
|
|
37528
|
-
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
37529
|
-
online_access_codes_enabled?: boolean | undefined;
|
|
37530
|
-
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
37531
|
-
offline_access_codes_enabled?: boolean | undefined;
|
|
37532
|
-
/**
|
|
37533
|
-
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
37534
|
-
supports_accessory_keypad?: boolean | undefined;
|
|
37535
|
-
/**
|
|
37536
|
-
* @deprecated use offline_access_codes_enabled */
|
|
37537
|
-
supports_offline_access_codes?: boolean | undefined;
|
|
37538
|
-
/** Indicates current noise level in decibels, if the device supports noise detection. */
|
|
37539
|
-
noise_level_decibels?: number | undefined;
|
|
37540
|
-
/** Array of noise threshold IDs that are currently triggering. */
|
|
37541
|
-
currently_triggering_noise_threshold_ids?: string[] | undefined;
|
|
37542
|
-
} & {
|
|
37543
|
-
assa_abloy_credential_service_metadata?: ({
|
|
37544
|
-
has_active_endpoint: boolean;
|
|
37545
|
-
endpoints: Array<{
|
|
37546
|
-
endpoint_id: string;
|
|
37547
|
-
is_active: boolean;
|
|
37548
|
-
}>;
|
|
37549
|
-
} | undefined) | undefined;
|
|
37550
|
-
}) & {
|
|
37551
|
-
august_metadata?: {
|
|
37552
|
-
lock_id: string;
|
|
37553
|
-
lock_name: string;
|
|
37554
|
-
house_name: string;
|
|
37555
|
-
has_keypad: boolean;
|
|
37556
|
-
keypad_battery_level?: string | undefined;
|
|
37557
|
-
model?: string | undefined;
|
|
37558
|
-
house_id?: string | undefined;
|
|
37559
|
-
} | undefined;
|
|
37560
|
-
avigilon_alta_metadata?: {
|
|
37561
|
-
entry_name: string;
|
|
37562
|
-
org_name: string;
|
|
37563
|
-
zone_id: number;
|
|
37564
|
-
zone_name: string;
|
|
37565
|
-
site_id: number;
|
|
37566
|
-
site_name: string;
|
|
37567
|
-
entry_relays_total_count: number;
|
|
37568
|
-
} | undefined;
|
|
37569
|
-
schlage_metadata?: {
|
|
37570
|
-
device_id: string;
|
|
37571
|
-
device_name: string;
|
|
37572
|
-
access_code_length: number | null;
|
|
37573
|
-
model?: string | undefined;
|
|
37574
|
-
} | undefined;
|
|
37575
|
-
smartthings_metadata?: {
|
|
37576
|
-
device_id: string;
|
|
37577
|
-
device_name: string;
|
|
37578
|
-
model?: string | undefined;
|
|
37579
|
-
location_id?: string | undefined;
|
|
37580
|
-
} | undefined;
|
|
37581
|
-
lockly_metadata?: {
|
|
37582
|
-
device_id: string;
|
|
37583
|
-
device_name: string;
|
|
37584
|
-
model?: string | undefined;
|
|
37585
|
-
} | undefined;
|
|
37586
|
-
nuki_metadata?: {
|
|
37587
|
-
device_id: string;
|
|
37588
|
-
device_name: string;
|
|
37589
|
-
keypad_battery_critical?: boolean | undefined;
|
|
37590
|
-
keypad_paired?: boolean | undefined;
|
|
37591
|
-
keypad_2_paired?: boolean | undefined;
|
|
37592
|
-
} | undefined;
|
|
37593
|
-
kwikset_metadata?: {
|
|
37594
|
-
device_id: string;
|
|
37595
|
-
device_name: string;
|
|
37596
|
-
model_number: string;
|
|
37597
|
-
} | undefined;
|
|
37598
|
-
/**
|
|
37599
|
-
---
|
|
37600
|
-
deprecated: Use `salto_ks_metadata ` instead.
|
|
37601
|
-
*/
|
|
37602
|
-
salto_metadata?: {
|
|
37603
|
-
lock_id: string;
|
|
37604
|
-
customer_reference: string;
|
|
37605
|
-
lock_type: string;
|
|
37606
|
-
battery_level: string;
|
|
37607
|
-
locked_state: string;
|
|
37608
|
-
model?: string | undefined;
|
|
37609
|
-
} | undefined;
|
|
37610
|
-
salto_ks_metadata?: {
|
|
37611
|
-
lock_id: string;
|
|
37612
|
-
customer_reference: string;
|
|
37613
|
-
lock_type: string;
|
|
37614
|
-
battery_level: string;
|
|
37615
|
-
locked_state: string;
|
|
37616
|
-
model?: string | undefined;
|
|
37617
|
-
} | undefined;
|
|
37618
|
-
genie_metadata?: {
|
|
37619
|
-
device_name: string;
|
|
37620
|
-
door_name: string;
|
|
37621
|
-
} | undefined;
|
|
37622
|
-
brivo_metadata?: {
|
|
37623
|
-
device_name: string;
|
|
37624
|
-
} | undefined;
|
|
37625
|
-
igloo_metadata?: {
|
|
37626
|
-
device_id: string;
|
|
37627
|
-
bridge_id: string;
|
|
37628
|
-
model?: string | undefined;
|
|
37629
|
-
} | undefined;
|
|
37630
|
-
noiseaware_metadata?: {
|
|
37631
|
-
device_model: 'indoor' | 'outdoor';
|
|
37632
|
-
noise_level_nrs: number;
|
|
37633
|
-
noise_level_decibel: number;
|
|
37634
|
-
device_name: string;
|
|
37635
|
-
device_id: string;
|
|
37636
|
-
} | undefined;
|
|
37637
|
-
minut_metadata?: {
|
|
37638
|
-
device_id: string;
|
|
37639
|
-
device_name: string;
|
|
37640
|
-
latest_sensor_values: {
|
|
37641
|
-
temperature: {
|
|
37642
|
-
time: string;
|
|
37643
|
-
value: number;
|
|
37644
|
-
};
|
|
37645
|
-
sound: {
|
|
37646
|
-
time: string;
|
|
37647
|
-
value: number;
|
|
37648
|
-
};
|
|
37649
|
-
humidity: {
|
|
37650
|
-
time: string;
|
|
37651
|
-
value: number;
|
|
37652
|
-
};
|
|
37653
|
-
pressure: {
|
|
37654
|
-
time: string;
|
|
37655
|
-
value: number;
|
|
37656
|
-
};
|
|
37657
|
-
accelerometer_z: {
|
|
37658
|
-
time: string;
|
|
37659
|
-
value: number;
|
|
37660
|
-
};
|
|
37661
|
-
};
|
|
37662
|
-
} | undefined;
|
|
37663
|
-
four_suites_metadata?: {
|
|
37664
|
-
device_id: number;
|
|
37665
|
-
device_name: string;
|
|
37666
|
-
reclose_delay_in_seconds: number;
|
|
37667
|
-
} | undefined;
|
|
37668
|
-
two_n_metadata?: {
|
|
37669
|
-
device_id: number;
|
|
37670
|
-
device_name: string;
|
|
37671
|
-
} | undefined;
|
|
37672
|
-
controlbyweb_metadata?: {
|
|
37673
|
-
device_id: string;
|
|
37674
|
-
device_name: string;
|
|
37675
|
-
relay_name: string | null;
|
|
37676
|
-
} | undefined;
|
|
37677
|
-
ttlock_metadata?: {
|
|
37678
|
-
lock_id: number;
|
|
37679
|
-
lock_alias: string;
|
|
37680
|
-
feature_value: string;
|
|
37681
|
-
features: {
|
|
37682
|
-
passcode: boolean;
|
|
37683
|
-
passcode_management: boolean;
|
|
37684
|
-
unlock_via_gateway: boolean;
|
|
37685
|
-
lock_command: boolean;
|
|
37686
|
-
incomplete_keyboard_passcode: boolean;
|
|
37687
|
-
};
|
|
37688
|
-
has_gateway?: boolean | undefined;
|
|
37689
|
-
wireless_keypads?: Array<{
|
|
37690
|
-
wireless_keypad_id: number;
|
|
37691
|
-
wireless_keypad_name: string;
|
|
37692
|
-
}> | undefined;
|
|
37693
|
-
} | undefined;
|
|
37694
|
-
seam_bridge_metadata?: {
|
|
37695
|
-
unlock_method?: ('bridge' | 'doorking') | undefined;
|
|
37696
|
-
device_num: number;
|
|
37697
|
-
name: string;
|
|
37698
|
-
} | undefined;
|
|
37699
|
-
igloohome_metadata?: {
|
|
37700
|
-
device_id: string;
|
|
37701
|
-
device_name: string;
|
|
37702
|
-
bridge_id?: string | undefined;
|
|
37703
|
-
bridge_name?: string | undefined;
|
|
37704
|
-
keypad_id?: string | undefined;
|
|
37705
|
-
} | undefined;
|
|
37706
|
-
nest_metadata?: {
|
|
37707
|
-
nest_device_id: string;
|
|
37708
|
-
device_name: string;
|
|
37709
|
-
custom_name: string;
|
|
37710
|
-
display_name?: string | undefined;
|
|
37711
|
-
} | undefined;
|
|
37712
|
-
ecobee_metadata?: {
|
|
37713
|
-
ecobee_device_id: string;
|
|
37714
|
-
device_name: string;
|
|
37715
|
-
} | undefined;
|
|
37716
|
-
honeywell_resideo_metadata?: {
|
|
37717
|
-
honeywell_resideo_device_id: string;
|
|
37718
|
-
device_name: string;
|
|
37719
|
-
} | undefined;
|
|
37720
|
-
hubitat_metadata?: {
|
|
37721
|
-
device_id: string;
|
|
37722
|
-
device_name: string;
|
|
37723
|
-
device_label: string;
|
|
37724
|
-
} | undefined;
|
|
37725
|
-
dormakaba_oracode_metadata?: {
|
|
37726
|
-
door_id?: number | undefined;
|
|
37727
|
-
door_name: string;
|
|
37728
|
-
device_id?: (number | string) | undefined;
|
|
37729
|
-
door_is_wireless: boolean;
|
|
37730
|
-
/** @DEPRECATED */
|
|
37731
|
-
site_id: number | null;
|
|
37732
|
-
site_name: string;
|
|
37733
|
-
iana_timezone?: string | undefined;
|
|
37734
|
-
predefined_time_slots?: Array<{
|
|
37735
|
-
name: string;
|
|
37736
|
-
prefix: number;
|
|
37737
|
-
check_in_time: string;
|
|
37738
|
-
check_out_time: string;
|
|
37739
|
-
is_24_hour: boolean;
|
|
37740
|
-
is_biweekly_mode: boolean;
|
|
37741
|
-
is_one_shot: boolean;
|
|
37742
|
-
is_master: boolean;
|
|
37743
|
-
ext_dormakaba_oracode_user_level_prefix: number;
|
|
37744
|
-
dormakaba_oracode_user_level_id: string;
|
|
37745
|
-
}> | undefined;
|
|
37746
|
-
} | undefined;
|
|
37747
|
-
wyze_metadata?: {
|
|
37748
|
-
device_id: string;
|
|
37749
|
-
device_name: string;
|
|
37750
|
-
product_name: string;
|
|
37751
|
-
product_type: string;
|
|
37752
|
-
product_model: string;
|
|
37753
|
-
device_info_model: string;
|
|
37754
|
-
keypad_uuid?: string | undefined;
|
|
37755
|
-
locker_status_hardlock?: number | undefined;
|
|
37756
|
-
} | undefined;
|
|
37757
|
-
tedee_metadata?: {
|
|
37758
|
-
device_id: number;
|
|
37759
|
-
serial_number: string;
|
|
37760
|
-
device_name: string;
|
|
37761
|
-
device_model: string;
|
|
37762
|
-
bridge_id: number;
|
|
37763
|
-
bridge_name: string;
|
|
37764
|
-
keypad_id?: number | undefined;
|
|
37765
|
-
} | undefined;
|
|
37766
|
-
visionline_metadata?: {
|
|
37767
|
-
encoder_id: string;
|
|
37768
|
-
} | undefined;
|
|
37769
|
-
akiles_metadata?: {
|
|
37770
|
-
gadget_name: string;
|
|
37771
|
-
gadget_id: string;
|
|
37772
|
-
product_name: string;
|
|
37773
|
-
_member_group_id?: string | undefined;
|
|
37774
|
-
} | undefined;
|
|
37775
|
-
assa_abloy_vostio_metadata?: {
|
|
37776
|
-
encoder_name: string;
|
|
37777
|
-
} | undefined;
|
|
37778
|
-
}) & ({
|
|
37779
|
-
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
37780
|
-
code_constraints?: (Array<{
|
|
37781
|
-
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' | 'no_ascending_or_descending_sequence' | 'at_least_three_unique_digits' | 'cannot_contain_089' | 'cannot_contain_0789';
|
|
37782
|
-
} | {
|
|
37783
|
-
constraint_type: 'name_length' | 'name_must_be_unique';
|
|
37784
|
-
min_length?: number | undefined;
|
|
37785
|
-
max_length?: number | undefined;
|
|
37786
|
-
}> | undefined) | undefined;
|
|
37787
|
-
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
37788
|
-
max_active_codes_supported?: (number | undefined) | undefined;
|
|
37789
|
-
supports_backup_access_code_pool?: (boolean | undefined) | undefined;
|
|
37790
|
-
has_native_entry_events?: (boolean | undefined) | undefined;
|
|
37791
|
-
locked?: (boolean | undefined) | undefined;
|
|
37792
|
-
keypad_battery?: ({
|
|
37793
|
-
level: number;
|
|
37794
|
-
} | undefined) | undefined;
|
|
37795
|
-
door_open?: (boolean | undefined) | undefined;
|
|
37796
|
-
} & {
|
|
37797
|
-
temperature_fahrenheit?: number | undefined;
|
|
37798
|
-
temperature_celsius?: number | undefined;
|
|
37799
|
-
relative_humidity?: number | undefined;
|
|
37800
|
-
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
37801
|
-
available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
|
|
37802
|
-
is_heating?: boolean | undefined;
|
|
37803
|
-
is_cooling?: boolean | undefined;
|
|
37804
|
-
is_fan_running?: boolean | undefined;
|
|
37805
|
-
/**
|
|
37806
|
-
* @deprecated use current_climate_setting.fan_mode_setting instead. */
|
|
37807
|
-
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
37808
|
-
is_temporary_manual_override_active?: boolean | undefined;
|
|
37809
|
-
current_climate_setting?: {
|
|
37810
|
-
/** Unique key to identify the climate preset. */
|
|
37811
|
-
climate_preset_key?: string | undefined;
|
|
37812
|
-
/** Indicates whether this climate preset key can be edited. */
|
|
37813
|
-
can_edit?: boolean | undefined;
|
|
37814
|
-
/** Indicates whether this climate preset key can be deleted. */
|
|
37815
|
-
can_delete?: boolean | undefined;
|
|
37816
|
-
/** User-friendly name to identify the climate preset. */
|
|
37817
|
-
name?: ((string | null) | undefined) | undefined;
|
|
37818
|
-
/** Display name for the climate preset. */
|
|
37819
|
-
display_name?: string | undefined;
|
|
37820
|
-
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
37821
|
-
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
37822
|
-
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
|
|
37823
|
-
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
37824
|
-
/** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
37825
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
37826
|
-
/** Temperature to which the thermostat should heat (in °C). */
|
|
37827
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
37828
|
-
/** Temperature to which the thermostat should cool (in °F). */
|
|
37829
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
37830
|
-
/** Temperature to which the thermostat should heat (in °F). */
|
|
37831
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
37832
|
-
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
37833
|
-
manual_override_allowed?: boolean | undefined;
|
|
37834
|
-
} | undefined;
|
|
37835
|
-
/**
|
|
37836
|
-
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
37837
|
-
default_climate_setting?: {
|
|
37838
|
-
/** Unique key to identify the climate preset. */
|
|
37839
|
-
climate_preset_key?: string | undefined;
|
|
37840
|
-
/** Indicates whether this climate preset key can be edited. */
|
|
37841
|
-
can_edit?: boolean | undefined;
|
|
37842
|
-
/** Indicates whether this climate preset key can be deleted. */
|
|
37843
|
-
can_delete?: boolean | undefined;
|
|
37844
|
-
/** User-friendly name to identify the climate preset. */
|
|
37845
|
-
name?: ((string | null) | undefined) | undefined;
|
|
37846
|
-
/** Display name for the climate preset. */
|
|
37847
|
-
display_name?: string | undefined;
|
|
37848
|
-
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
37849
|
-
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
37850
|
-
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
|
|
37851
|
-
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
37852
|
-
/** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
37853
|
-
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
37854
|
-
/** Temperature to which the thermostat should heat (in °C). */
|
|
37855
|
-
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
37856
|
-
/** Temperature to which the thermostat should cool (in °F). */
|
|
37857
|
-
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
37858
|
-
/** Temperature to which the thermostat should heat (in °F). */
|
|
37859
|
-
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
37860
|
-
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
37861
|
-
manual_override_allowed?: boolean | undefined;
|
|
37862
|
-
} | undefined;
|
|
37863
|
-
available_climate_presets?: Array<{
|
|
37864
|
-
/** Unique key to identify the climate preset. */
|
|
37865
|
-
climate_preset_key: string;
|
|
37866
|
-
/** Indicates whether this climate preset key can be edited. */
|
|
37867
|
-
can_edit: boolean;
|
|
37868
|
-
/** Indicates whether this climate preset key can be deleted. */
|
|
37869
|
-
can_delete: boolean;
|
|
37870
|
-
/** User-friendly name to identify the climate preset. */
|
|
37871
|
-
name?: (string | null) | undefined;
|
|
37872
|
-
/** Display name for the climate preset. */
|
|
37873
|
-
display_name: string;
|
|
37874
|
-
/** Desired fan mode setting, such as `on`, `auto`, or `circulate`. */
|
|
37875
|
-
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
37876
|
-
/** Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
|
|
37877
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
37878
|
-
/** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
37879
|
-
cooling_set_point_celsius?: number | undefined;
|
|
37880
|
-
/** Temperature to which the thermostat should heat (in °C). */
|
|
37881
|
-
heating_set_point_celsius?: number | undefined;
|
|
37882
|
-
/** Temperature to which the thermostat should cool (in °F). */
|
|
37883
|
-
cooling_set_point_fahrenheit?: number | undefined;
|
|
37884
|
-
/** Temperature to which the thermostat should heat (in °F). */
|
|
37885
|
-
heating_set_point_fahrenheit?: number | undefined;
|
|
37886
|
-
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
37887
|
-
manual_override_allowed: boolean;
|
|
37888
|
-
}> | undefined;
|
|
37889
|
-
fallback_climate_preset_key?: (string | null) | undefined;
|
|
37890
|
-
/** Represents a [thermostat schedule](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules) that activates a configured [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) on a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) at a specified starting time and deactivates the climate preset at a specified ending time. */
|
|
37891
|
-
active_thermostat_schedule?: ({
|
|
37892
|
-
/** ID of the thermostat schedule. */
|
|
37893
|
-
thermostat_schedule_id: string;
|
|
37894
|
-
/** ID of the desired thermostat device. */
|
|
37895
|
-
device_id: string;
|
|
37896
|
-
/** User-friendly name to identify the thermostat schedule. */
|
|
37897
|
-
name?: string | undefined;
|
|
37898
|
-
/** Key of the [climate preset](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-climate-presets) to use for the thermostat schedule. */
|
|
37899
|
-
climate_preset_key: string;
|
|
37900
|
-
/** Number of minutes for which a person at the thermostat can change the thermostat's settings after the activation of the scheduled climate preset. See also [Specifying Manual Override Permissions](https://docs.seam.co/latest/capability-guides/thermostats/creating-and-managing-thermostat-schedules#specifying-manual-override-permissions). */
|
|
37901
|
-
max_override_period_minutes: number;
|
|
37902
|
-
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
37903
|
-
starts_at: string;
|
|
37904
|
-
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
37905
|
-
ends_at: string;
|
|
37906
|
-
/** Date and time at which the thermostat schedule was created. */
|
|
37907
|
-
created_at: string;
|
|
37908
|
-
/** Array of errors associated with the thermostat schedule. 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. */
|
|
37909
|
-
errors?: any;
|
|
37910
|
-
} | null) | undefined;
|
|
37911
|
-
min_cooling_set_point_celsius?: number | undefined;
|
|
37912
|
-
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
37913
|
-
max_cooling_set_point_celsius?: number | undefined;
|
|
37914
|
-
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
37915
|
-
min_heating_set_point_celsius?: number | undefined;
|
|
37916
|
-
min_heating_set_point_fahrenheit?: number | undefined;
|
|
37917
|
-
max_heating_set_point_celsius?: number | undefined;
|
|
37918
|
-
max_heating_set_point_fahrenheit?: number | undefined;
|
|
37919
|
-
min_heating_cooling_delta_celsius?: number | undefined;
|
|
37920
|
-
min_heating_cooling_delta_fahrenheit?: number | undefined;
|
|
37921
|
-
temperature_threshold?: ({
|
|
37922
|
-
lower_limit_celsius: number | null;
|
|
37923
|
-
lower_limit_fahrenheit: number | null;
|
|
37924
|
-
upper_limit_celsius: number | null;
|
|
37925
|
-
upper_limit_fahrenheit: number | null;
|
|
37926
|
-
} | undefined) | undefined;
|
|
37927
|
-
});
|
|
37928
|
-
/** Location information for the device. */
|
|
37929
|
-
location: {
|
|
37930
|
-
/** Name of the device location. */
|
|
37931
|
-
location_name?: string | undefined;
|
|
37932
|
-
/** Time zone of the device location. */
|
|
37933
|
-
timezone?: string | undefined;
|
|
37934
|
-
} | null;
|
|
37935
|
-
/** Unique identifier for the account associated with the device. */
|
|
37936
|
-
connected_account_id: string;
|
|
37937
|
-
/** Unique identifier for the Seam workspace associated with the device. */
|
|
37556
|
+
acs_encoders: Array<{
|
|
37557
|
+
/** ID of the `acs_encoder`. */
|
|
37558
|
+
acs_encoder_id: string;
|
|
37559
|
+
/** ID of the access control system that contains the `acs_encoder`. */
|
|
37560
|
+
acs_system_id: string;
|
|
37561
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the `acs_system`. */
|
|
37938
37562
|
workspace_id: string;
|
|
37939
|
-
/**
|
|
37563
|
+
/** Errors associated with the `acs_encoder`. */
|
|
37940
37564
|
errors: Array<{
|
|
37565
|
+
/** Date and time at which Seam created the error. */
|
|
37566
|
+
created_at: string;
|
|
37567
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
37941
37568
|
message: string;
|
|
37942
|
-
|
|
37943
|
-
error_code:
|
|
37944
|
-
|
|
37945
|
-
|
|
37946
|
-
is_connected_account_error: true;
|
|
37947
|
-
error_code: string;
|
|
37948
|
-
}>;
|
|
37949
|
-
/** 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. */
|
|
37950
|
-
warnings: Array<{
|
|
37951
|
-
message: string;
|
|
37952
|
-
warning_code: string;
|
|
37569
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
37570
|
+
error_code: 'acs_encoder_removed';
|
|
37571
|
+
/** ID of the event that was created when the `acs_encoder` was removed. */
|
|
37572
|
+
_event_id: string;
|
|
37953
37573
|
}>;
|
|
37954
|
-
/** Date and time at which the
|
|
37574
|
+
/** Date and time at which the `acs_encoder` was created. */
|
|
37955
37575
|
created_at: string;
|
|
37956
|
-
/**
|
|
37957
|
-
|
|
37958
|
-
custom_metadata: Record<string, string | boolean>;
|
|
37959
|
-
can_remotely_unlock?: boolean | undefined;
|
|
37960
|
-
can_remotely_lock?: boolean | undefined;
|
|
37961
|
-
can_program_offline_access_codes?: boolean | undefined;
|
|
37962
|
-
can_program_online_access_codes?: boolean | undefined;
|
|
37963
|
-
can_hvac_heat?: boolean | undefined;
|
|
37964
|
-
can_hvac_cool?: boolean | undefined;
|
|
37965
|
-
can_hvac_heat_cool?: boolean | undefined;
|
|
37966
|
-
can_turn_off_hvac?: boolean | undefined;
|
|
37967
|
-
can_simulate_removal?: boolean | undefined;
|
|
37968
|
-
can_simulate_connection?: boolean | undefined;
|
|
37969
|
-
can_simulate_disconnection?: boolean | undefined;
|
|
37576
|
+
/** Display name for the `acs_encoder`. */
|
|
37577
|
+
display_name: string;
|
|
37970
37578
|
}>;
|
|
37971
37579
|
};
|
|
37972
37580
|
};
|
|
@@ -37978,8 +37586,8 @@ interface Routes {
|
|
|
37978
37586
|
commonParams: {
|
|
37979
37587
|
/** ID of the acs_system the encoder belongs to. */
|
|
37980
37588
|
acs_system_id: string;
|
|
37981
|
-
/** ID of the
|
|
37982
|
-
|
|
37589
|
+
/** ID of the acs_encoder to use for the scan. */
|
|
37590
|
+
acs_encoder_id: string;
|
|
37983
37591
|
};
|
|
37984
37592
|
formData: {};
|
|
37985
37593
|
jsonResponse: {
|
|
@@ -42286,6 +41894,8 @@ interface Routes {
|
|
|
42286
41894
|
max_override_period_minutes: number;
|
|
42287
41895
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
42288
41896
|
starts_at: string;
|
|
41897
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
41898
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
42289
41899
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
42290
41900
|
ends_at: string;
|
|
42291
41901
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -42831,6 +42441,8 @@ interface Routes {
|
|
|
42831
42441
|
max_override_period_minutes: number;
|
|
42832
42442
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
42833
42443
|
starts_at: string;
|
|
42444
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
42445
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
42834
42446
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
42835
42447
|
ends_at: string;
|
|
42836
42448
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -43779,6 +43391,8 @@ interface Routes {
|
|
|
43779
43391
|
max_override_period_minutes: number;
|
|
43780
43392
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
43781
43393
|
starts_at: string;
|
|
43394
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
43395
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
43782
43396
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
43783
43397
|
ends_at: string;
|
|
43784
43398
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -44287,6 +43901,8 @@ interface Routes {
|
|
|
44287
43901
|
max_override_period_minutes: number;
|
|
44288
43902
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
44289
43903
|
starts_at: string;
|
|
43904
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
43905
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
44290
43906
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
44291
43907
|
ends_at: string;
|
|
44292
43908
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -44832,6 +44448,8 @@ interface Routes {
|
|
|
44832
44448
|
max_override_period_minutes: number;
|
|
44833
44449
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
44834
44450
|
starts_at: string;
|
|
44451
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
44452
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
44835
44453
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
44836
44454
|
ends_at: string;
|
|
44837
44455
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -45340,6 +44958,8 @@ interface Routes {
|
|
|
45340
44958
|
max_override_period_minutes: number;
|
|
45341
44959
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
45342
44960
|
starts_at: string;
|
|
44961
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
44962
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
45343
44963
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
45344
44964
|
ends_at: string;
|
|
45345
44965
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -47385,6 +47005,8 @@ interface Routes {
|
|
|
47385
47005
|
max_override_period_minutes: number;
|
|
47386
47006
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
47387
47007
|
starts_at: string;
|
|
47008
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
47009
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
47388
47010
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
47389
47011
|
ends_at: string;
|
|
47390
47012
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -47893,6 +47515,8 @@ interface Routes {
|
|
|
47893
47515
|
max_override_period_minutes: number;
|
|
47894
47516
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
47895
47517
|
starts_at: string;
|
|
47518
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
47519
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
47896
47520
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
47897
47521
|
ends_at: string;
|
|
47898
47522
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -52379,6 +52003,8 @@ interface Routes {
|
|
|
52379
52003
|
max_override_period_minutes: number;
|
|
52380
52004
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
52381
52005
|
starts_at: string;
|
|
52006
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
52007
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
52382
52008
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
52383
52009
|
ends_at: string;
|
|
52384
52010
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -54406,6 +54032,8 @@ interface Routes {
|
|
|
54406
54032
|
max_override_period_minutes: number;
|
|
54407
54033
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
54408
54034
|
starts_at: string;
|
|
54035
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
54036
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
54409
54037
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
54410
54038
|
ends_at: string;
|
|
54411
54039
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -54914,6 +54542,8 @@ interface Routes {
|
|
|
54914
54542
|
max_override_period_minutes: number;
|
|
54915
54543
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
54916
54544
|
starts_at: string;
|
|
54545
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
54546
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
54917
54547
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
54918
54548
|
ends_at: string;
|
|
54919
54549
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -55735,6 +55365,7 @@ interface Routes {
|
|
|
55735
55365
|
starts_at: string;
|
|
55736
55366
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55737
55367
|
ends_at: string;
|
|
55368
|
+
is_override_allowed?: boolean | undefined;
|
|
55738
55369
|
};
|
|
55739
55370
|
commonParams: {};
|
|
55740
55371
|
formData: {};
|
|
@@ -55753,6 +55384,8 @@ interface Routes {
|
|
|
55753
55384
|
max_override_period_minutes: number;
|
|
55754
55385
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55755
55386
|
starts_at: string;
|
|
55387
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
55388
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
55756
55389
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55757
55390
|
ends_at: string;
|
|
55758
55391
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -55799,6 +55432,8 @@ interface Routes {
|
|
|
55799
55432
|
max_override_period_minutes: number;
|
|
55800
55433
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55801
55434
|
starts_at: string;
|
|
55435
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
55436
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
55802
55437
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55803
55438
|
ends_at: string;
|
|
55804
55439
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -55834,6 +55469,8 @@ interface Routes {
|
|
|
55834
55469
|
max_override_period_minutes: number;
|
|
55835
55470
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55836
55471
|
starts_at: string;
|
|
55472
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
55473
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
55837
55474
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55838
55475
|
ends_at: string;
|
|
55839
55476
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -55860,6 +55497,7 @@ interface Routes {
|
|
|
55860
55497
|
starts_at?: string | undefined;
|
|
55861
55498
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
55862
55499
|
ends_at?: string | undefined;
|
|
55500
|
+
is_override_allowed?: boolean | undefined;
|
|
55863
55501
|
};
|
|
55864
55502
|
commonParams: {};
|
|
55865
55503
|
formData: {};
|
|
@@ -57298,6 +56936,8 @@ interface Routes {
|
|
|
57298
56936
|
max_override_period_minutes: number;
|
|
57299
56937
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
57300
56938
|
starts_at: string;
|
|
56939
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
56940
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
57301
56941
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
57302
56942
|
ends_at: string;
|
|
57303
56943
|
/** Date and time at which the thermostat schedule was created. */
|
|
@@ -57808,6 +57448,8 @@ interface Routes {
|
|
|
57808
57448
|
max_override_period_minutes: number;
|
|
57809
57449
|
/** Date and time at which the thermostat schedule starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
57810
57450
|
starts_at: string;
|
|
57451
|
+
/** Indicates whether a person at the thermostat can change the thermostat's settings. */
|
|
57452
|
+
unstable_is_override_allowed?: boolean | undefined;
|
|
57811
57453
|
/** Date and time at which the thermostat schedule ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
57812
57454
|
ends_at: string;
|
|
57813
57455
|
/** Date and time at which the thermostat schedule was created. */
|