@seamapi/types 1.262.1 → 1.263.1
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 +118 -5
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +646 -0
- package/lib/seam/connect/openapi.d.ts +189 -0
- package/lib/seam/connect/openapi.js +118 -5
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +457 -0
- package/package.json +2 -2
- package/src/lib/seam/connect/openapi.ts +118 -5
- package/src/lib/seam/connect/route-types.ts +631 -0
package/dist/connect.d.cts
CHANGED
|
@@ -15533,6 +15533,189 @@ declare const _default: {
|
|
|
15533
15533
|
'x-response-key': null;
|
|
15534
15534
|
};
|
|
15535
15535
|
};
|
|
15536
|
+
'/access_codes/update_multiple': {
|
|
15537
|
+
patch: {
|
|
15538
|
+
operationId: string;
|
|
15539
|
+
requestBody: {
|
|
15540
|
+
content: {
|
|
15541
|
+
'application/json': {
|
|
15542
|
+
schema: {
|
|
15543
|
+
properties: {
|
|
15544
|
+
allow_external_modification: {
|
|
15545
|
+
type: string;
|
|
15546
|
+
};
|
|
15547
|
+
code: {
|
|
15548
|
+
maxLength: number;
|
|
15549
|
+
minLength: number;
|
|
15550
|
+
pattern: string;
|
|
15551
|
+
type: string;
|
|
15552
|
+
};
|
|
15553
|
+
common_code_key: {
|
|
15554
|
+
type: string;
|
|
15555
|
+
};
|
|
15556
|
+
ends_at: {
|
|
15557
|
+
type: string;
|
|
15558
|
+
};
|
|
15559
|
+
is_external_modification_allowed: {
|
|
15560
|
+
type: string;
|
|
15561
|
+
};
|
|
15562
|
+
name: {
|
|
15563
|
+
type: string;
|
|
15564
|
+
};
|
|
15565
|
+
prefer_native_scheduling: {
|
|
15566
|
+
type: string;
|
|
15567
|
+
};
|
|
15568
|
+
starts_at: {
|
|
15569
|
+
type: string;
|
|
15570
|
+
};
|
|
15571
|
+
};
|
|
15572
|
+
required: string[];
|
|
15573
|
+
type: string;
|
|
15574
|
+
};
|
|
15575
|
+
};
|
|
15576
|
+
};
|
|
15577
|
+
};
|
|
15578
|
+
responses: {
|
|
15579
|
+
200: {
|
|
15580
|
+
content: {
|
|
15581
|
+
'application/json': {
|
|
15582
|
+
schema: {
|
|
15583
|
+
properties: {
|
|
15584
|
+
ok: {
|
|
15585
|
+
type: string;
|
|
15586
|
+
};
|
|
15587
|
+
};
|
|
15588
|
+
required: string[];
|
|
15589
|
+
type: string;
|
|
15590
|
+
};
|
|
15591
|
+
};
|
|
15592
|
+
};
|
|
15593
|
+
description: string;
|
|
15594
|
+
};
|
|
15595
|
+
400: {
|
|
15596
|
+
description: string;
|
|
15597
|
+
};
|
|
15598
|
+
401: {
|
|
15599
|
+
description: string;
|
|
15600
|
+
};
|
|
15601
|
+
};
|
|
15602
|
+
security: ({
|
|
15603
|
+
client_session: never[];
|
|
15604
|
+
pat_with_workspace?: never;
|
|
15605
|
+
console_session?: never;
|
|
15606
|
+
api_key?: never;
|
|
15607
|
+
} | {
|
|
15608
|
+
pat_with_workspace: never[];
|
|
15609
|
+
client_session?: never;
|
|
15610
|
+
console_session?: never;
|
|
15611
|
+
api_key?: never;
|
|
15612
|
+
} | {
|
|
15613
|
+
console_session: never[];
|
|
15614
|
+
client_session?: never;
|
|
15615
|
+
pat_with_workspace?: never;
|
|
15616
|
+
api_key?: never;
|
|
15617
|
+
} | {
|
|
15618
|
+
api_key: never[];
|
|
15619
|
+
client_session?: never;
|
|
15620
|
+
pat_with_workspace?: never;
|
|
15621
|
+
console_session?: never;
|
|
15622
|
+
})[];
|
|
15623
|
+
summary: string;
|
|
15624
|
+
tags: string[];
|
|
15625
|
+
'x-fern-ignore': boolean;
|
|
15626
|
+
};
|
|
15627
|
+
post: {
|
|
15628
|
+
operationId: string;
|
|
15629
|
+
requestBody: {
|
|
15630
|
+
content: {
|
|
15631
|
+
'application/json': {
|
|
15632
|
+
schema: {
|
|
15633
|
+
properties: {
|
|
15634
|
+
allow_external_modification: {
|
|
15635
|
+
type: string;
|
|
15636
|
+
};
|
|
15637
|
+
code: {
|
|
15638
|
+
maxLength: number;
|
|
15639
|
+
minLength: number;
|
|
15640
|
+
pattern: string;
|
|
15641
|
+
type: string;
|
|
15642
|
+
};
|
|
15643
|
+
common_code_key: {
|
|
15644
|
+
type: string;
|
|
15645
|
+
};
|
|
15646
|
+
ends_at: {
|
|
15647
|
+
type: string;
|
|
15648
|
+
};
|
|
15649
|
+
is_external_modification_allowed: {
|
|
15650
|
+
type: string;
|
|
15651
|
+
};
|
|
15652
|
+
name: {
|
|
15653
|
+
type: string;
|
|
15654
|
+
};
|
|
15655
|
+
prefer_native_scheduling: {
|
|
15656
|
+
type: string;
|
|
15657
|
+
};
|
|
15658
|
+
starts_at: {
|
|
15659
|
+
type: string;
|
|
15660
|
+
};
|
|
15661
|
+
};
|
|
15662
|
+
required: string[];
|
|
15663
|
+
type: string;
|
|
15664
|
+
};
|
|
15665
|
+
};
|
|
15666
|
+
};
|
|
15667
|
+
};
|
|
15668
|
+
responses: {
|
|
15669
|
+
200: {
|
|
15670
|
+
content: {
|
|
15671
|
+
'application/json': {
|
|
15672
|
+
schema: {
|
|
15673
|
+
properties: {
|
|
15674
|
+
ok: {
|
|
15675
|
+
type: string;
|
|
15676
|
+
};
|
|
15677
|
+
};
|
|
15678
|
+
required: string[];
|
|
15679
|
+
type: string;
|
|
15680
|
+
};
|
|
15681
|
+
};
|
|
15682
|
+
};
|
|
15683
|
+
description: string;
|
|
15684
|
+
};
|
|
15685
|
+
400: {
|
|
15686
|
+
description: string;
|
|
15687
|
+
};
|
|
15688
|
+
401: {
|
|
15689
|
+
description: string;
|
|
15690
|
+
};
|
|
15691
|
+
};
|
|
15692
|
+
security: ({
|
|
15693
|
+
client_session: never[];
|
|
15694
|
+
pat_with_workspace?: never;
|
|
15695
|
+
console_session?: never;
|
|
15696
|
+
api_key?: never;
|
|
15697
|
+
} | {
|
|
15698
|
+
pat_with_workspace: never[];
|
|
15699
|
+
client_session?: never;
|
|
15700
|
+
console_session?: never;
|
|
15701
|
+
api_key?: never;
|
|
15702
|
+
} | {
|
|
15703
|
+
console_session: never[];
|
|
15704
|
+
client_session?: never;
|
|
15705
|
+
pat_with_workspace?: never;
|
|
15706
|
+
api_key?: never;
|
|
15707
|
+
} | {
|
|
15708
|
+
api_key: never[];
|
|
15709
|
+
client_session?: never;
|
|
15710
|
+
pat_with_workspace?: never;
|
|
15711
|
+
console_session?: never;
|
|
15712
|
+
})[];
|
|
15713
|
+
summary: string;
|
|
15714
|
+
tags: string[];
|
|
15715
|
+
'x-fern-sdk-group-name': string[];
|
|
15716
|
+
'x-fern-sdk-method-name': string;
|
|
15717
|
+
};
|
|
15718
|
+
};
|
|
15536
15719
|
'/acs/access_groups/add_user': {
|
|
15537
15720
|
post: {
|
|
15538
15721
|
operationId: string;
|
|
@@ -25251,6 +25434,12 @@ declare const _default: {
|
|
|
25251
25434
|
'application/json': {
|
|
25252
25435
|
schema: {
|
|
25253
25436
|
properties: {
|
|
25437
|
+
devices: {
|
|
25438
|
+
items: {
|
|
25439
|
+
$ref: string;
|
|
25440
|
+
};
|
|
25441
|
+
type: string;
|
|
25442
|
+
};
|
|
25254
25443
|
ok: {
|
|
25255
25444
|
type: string;
|
|
25256
25445
|
};
|
|
@@ -30908,6 +31097,24 @@ interface Routes {
|
|
|
30908
31097
|
};
|
|
30909
31098
|
};
|
|
30910
31099
|
};
|
|
31100
|
+
'/access_codes/update_multiple': {
|
|
31101
|
+
route: '/access_codes/update_multiple';
|
|
31102
|
+
method: 'POST' | 'PATCH';
|
|
31103
|
+
queryParams: {};
|
|
31104
|
+
jsonBody: {
|
|
31105
|
+
allow_external_modification?: boolean | undefined;
|
|
31106
|
+
is_external_modification_allowed?: boolean | undefined;
|
|
31107
|
+
code?: string | undefined;
|
|
31108
|
+
ends_at?: string | undefined;
|
|
31109
|
+
starts_at?: string | undefined;
|
|
31110
|
+
name?: string | undefined;
|
|
31111
|
+
prefer_native_scheduling?: boolean | undefined;
|
|
31112
|
+
common_code_key: string;
|
|
31113
|
+
};
|
|
31114
|
+
commonParams: {};
|
|
31115
|
+
formData: {};
|
|
31116
|
+
jsonResponse: {};
|
|
31117
|
+
};
|
|
30911
31118
|
'/acs/access_groups/add_user': {
|
|
30912
31119
|
route: '/acs/access_groups/add_user';
|
|
30913
31120
|
method: 'PUT' | 'POST';
|
|
@@ -44973,6 +45180,445 @@ interface Routes {
|
|
|
44973
45180
|
can_simulate_connection?: boolean | undefined;
|
|
44974
45181
|
can_simulate_disconnection?: boolean | undefined;
|
|
44975
45182
|
}>;
|
|
45183
|
+
devices: Array<{
|
|
45184
|
+
/** Unique identifier for the device. */
|
|
45185
|
+
device_id: string;
|
|
45186
|
+
/** Type of the device. */
|
|
45187
|
+
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' | 'tedee_lock' | 'akiles_lock') | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat') | ('ios_phone' | 'android_phone') | 'visionline_encoder';
|
|
45188
|
+
/** Optional nickname to describe the device, settable through Seam */
|
|
45189
|
+
nickname?: string | undefined;
|
|
45190
|
+
/** 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. */
|
|
45191
|
+
display_name: string;
|
|
45192
|
+
/** 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. */
|
|
45193
|
+
capabilities_supported: Array<'access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone'>;
|
|
45194
|
+
/** Properties of the device. */
|
|
45195
|
+
properties: (({
|
|
45196
|
+
/** Indicates whether the device is online. */
|
|
45197
|
+
online: boolean;
|
|
45198
|
+
/** Name of the device.
|
|
45199
|
+
* @deprecated use device.display_name instead */
|
|
45200
|
+
name: string;
|
|
45201
|
+
/** Represents the accessory keypad state. */
|
|
45202
|
+
accessory_keypad?: {
|
|
45203
|
+
/** Indicates if the accessory_keypad is connected to the device. */
|
|
45204
|
+
is_connected: boolean;
|
|
45205
|
+
/** Indicates if the keypad battery properties. */
|
|
45206
|
+
battery?: {
|
|
45207
|
+
level: number;
|
|
45208
|
+
} | undefined;
|
|
45209
|
+
} | undefined;
|
|
45210
|
+
appearance: {
|
|
45211
|
+
/** Name of the device as seen from the provider API and application, not settable through Seam. */
|
|
45212
|
+
name: string;
|
|
45213
|
+
};
|
|
45214
|
+
model: {
|
|
45215
|
+
/** Indicates whether the device can connect a accessory keypad. */
|
|
45216
|
+
can_connect_accessory_keypad?: boolean | undefined;
|
|
45217
|
+
/** Display name of the device model. */
|
|
45218
|
+
display_name: string;
|
|
45219
|
+
/** Display name that corresponds to the manufacturer-specific terminology for the device. */
|
|
45220
|
+
manufacturer_display_name: string;
|
|
45221
|
+
/** Indicates whether the device has a built in accessory keypad. */
|
|
45222
|
+
has_built_in_keypad?: boolean | undefined;
|
|
45223
|
+
/** Indicates whether the device supports offline access codes. */
|
|
45224
|
+
offline_access_codes_supported?: boolean | undefined;
|
|
45225
|
+
/** Indicates whether the device supports online access codes. */
|
|
45226
|
+
online_access_codes_supported?: boolean | undefined;
|
|
45227
|
+
/**
|
|
45228
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
45229
|
+
accessory_keypad_supported?: boolean | undefined;
|
|
45230
|
+
};
|
|
45231
|
+
/** Indicates whether the device has direct power. */
|
|
45232
|
+
has_direct_power?: boolean | undefined;
|
|
45233
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
45234
|
+
battery_level?: number | undefined;
|
|
45235
|
+
/** 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. */
|
|
45236
|
+
battery?: {
|
|
45237
|
+
level: number;
|
|
45238
|
+
status: 'critical' | 'low' | 'good' | 'full';
|
|
45239
|
+
} | undefined;
|
|
45240
|
+
/** Manufacturer of the device. */
|
|
45241
|
+
manufacturer?: string | undefined;
|
|
45242
|
+
/** Image URL for the device. */
|
|
45243
|
+
image_url?: string | undefined;
|
|
45244
|
+
/** Alt text for the device image. */
|
|
45245
|
+
image_alt_text?: string | undefined;
|
|
45246
|
+
/** Serial number of the device. */
|
|
45247
|
+
serial_number?: string | undefined;
|
|
45248
|
+
/** Indicates whether it is currently possible to use online access codes for the device. */
|
|
45249
|
+
online_access_codes_enabled?: boolean | undefined;
|
|
45250
|
+
/** Indicates whether it is currently possible to use offline access codes for the device. */
|
|
45251
|
+
offline_access_codes_enabled?: boolean | undefined;
|
|
45252
|
+
/**
|
|
45253
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad */
|
|
45254
|
+
supports_accessory_keypad?: boolean | undefined;
|
|
45255
|
+
/**
|
|
45256
|
+
* @deprecated use offline_access_codes_enabled */
|
|
45257
|
+
supports_offline_access_codes?: boolean | undefined;
|
|
45258
|
+
/** Indicates current noise level in decibels, if the device supports noise detection. */
|
|
45259
|
+
noise_level_decibels?: number | undefined;
|
|
45260
|
+
/** Array of noise threshold IDs that are currently triggering. */
|
|
45261
|
+
currently_triggering_noise_threshold_ids?: string[] | undefined;
|
|
45262
|
+
} & {
|
|
45263
|
+
assa_abloy_credential_service_metadata?: ({
|
|
45264
|
+
has_active_endpoint: boolean;
|
|
45265
|
+
endpoints: Array<{
|
|
45266
|
+
endpoint_id: string;
|
|
45267
|
+
is_active: boolean;
|
|
45268
|
+
}>;
|
|
45269
|
+
} | undefined) | undefined;
|
|
45270
|
+
}) & {
|
|
45271
|
+
august_metadata?: {
|
|
45272
|
+
lock_id: string;
|
|
45273
|
+
lock_name: string;
|
|
45274
|
+
house_name: string;
|
|
45275
|
+
has_keypad: boolean;
|
|
45276
|
+
keypad_battery_level?: string | undefined;
|
|
45277
|
+
model?: string | undefined;
|
|
45278
|
+
house_id?: string | undefined;
|
|
45279
|
+
} | undefined;
|
|
45280
|
+
avigilon_alta_metadata?: {
|
|
45281
|
+
entry_name: string;
|
|
45282
|
+
org_name: string;
|
|
45283
|
+
zone_id: number;
|
|
45284
|
+
zone_name: string;
|
|
45285
|
+
site_id: number;
|
|
45286
|
+
site_name: string;
|
|
45287
|
+
entry_relays_total_count: number;
|
|
45288
|
+
} | undefined;
|
|
45289
|
+
schlage_metadata?: {
|
|
45290
|
+
device_id: string;
|
|
45291
|
+
device_name: string;
|
|
45292
|
+
access_code_length: number | null;
|
|
45293
|
+
model?: string | undefined;
|
|
45294
|
+
} | undefined;
|
|
45295
|
+
smartthings_metadata?: {
|
|
45296
|
+
device_id: string;
|
|
45297
|
+
device_name: string;
|
|
45298
|
+
model?: string | undefined;
|
|
45299
|
+
location_id?: string | undefined;
|
|
45300
|
+
} | undefined;
|
|
45301
|
+
lockly_metadata?: {
|
|
45302
|
+
device_id: string;
|
|
45303
|
+
device_name: string;
|
|
45304
|
+
model?: string | undefined;
|
|
45305
|
+
} | undefined;
|
|
45306
|
+
nuki_metadata?: {
|
|
45307
|
+
device_id: string;
|
|
45308
|
+
device_name: string;
|
|
45309
|
+
keypad_battery_critical?: boolean | undefined;
|
|
45310
|
+
keypad_paired?: boolean | undefined;
|
|
45311
|
+
keypad_2_paired?: boolean | undefined;
|
|
45312
|
+
} | undefined;
|
|
45313
|
+
kwikset_metadata?: {
|
|
45314
|
+
device_id: string;
|
|
45315
|
+
device_name: string;
|
|
45316
|
+
model_number: string;
|
|
45317
|
+
} | undefined;
|
|
45318
|
+
salto_metadata?: {
|
|
45319
|
+
lock_id: string;
|
|
45320
|
+
customer_reference: string;
|
|
45321
|
+
lock_type: string;
|
|
45322
|
+
battery_level: string;
|
|
45323
|
+
locked_state: string;
|
|
45324
|
+
model?: string | undefined;
|
|
45325
|
+
} | undefined;
|
|
45326
|
+
genie_metadata?: {
|
|
45327
|
+
device_name: string;
|
|
45328
|
+
door_name: string;
|
|
45329
|
+
} | undefined;
|
|
45330
|
+
brivo_metadata?: {
|
|
45331
|
+
device_name: string;
|
|
45332
|
+
} | undefined;
|
|
45333
|
+
igloo_metadata?: {
|
|
45334
|
+
device_id: string;
|
|
45335
|
+
bridge_id: string;
|
|
45336
|
+
model?: string | undefined;
|
|
45337
|
+
} | undefined;
|
|
45338
|
+
noiseaware_metadata?: {
|
|
45339
|
+
device_model: 'indoor' | 'outdoor';
|
|
45340
|
+
noise_level_nrs: number;
|
|
45341
|
+
noise_level_decibel: number;
|
|
45342
|
+
device_name: string;
|
|
45343
|
+
device_id: string;
|
|
45344
|
+
} | undefined;
|
|
45345
|
+
minut_metadata?: {
|
|
45346
|
+
device_id: string;
|
|
45347
|
+
device_name: string;
|
|
45348
|
+
latest_sensor_values: {
|
|
45349
|
+
temperature: {
|
|
45350
|
+
time: string;
|
|
45351
|
+
value: number;
|
|
45352
|
+
};
|
|
45353
|
+
sound: {
|
|
45354
|
+
time: string;
|
|
45355
|
+
value: number;
|
|
45356
|
+
};
|
|
45357
|
+
humidity: {
|
|
45358
|
+
time: string;
|
|
45359
|
+
value: number;
|
|
45360
|
+
};
|
|
45361
|
+
pressure: {
|
|
45362
|
+
time: string;
|
|
45363
|
+
value: number;
|
|
45364
|
+
};
|
|
45365
|
+
accelerometer_z: {
|
|
45366
|
+
time: string;
|
|
45367
|
+
value: number;
|
|
45368
|
+
};
|
|
45369
|
+
};
|
|
45370
|
+
} | undefined;
|
|
45371
|
+
four_suites_metadata?: {
|
|
45372
|
+
device_id: number;
|
|
45373
|
+
device_name: string;
|
|
45374
|
+
reclose_delay_in_seconds: number;
|
|
45375
|
+
} | undefined;
|
|
45376
|
+
two_n_metadata?: {
|
|
45377
|
+
device_id: number;
|
|
45378
|
+
device_name: string;
|
|
45379
|
+
} | undefined;
|
|
45380
|
+
controlbyweb_metadata?: {
|
|
45381
|
+
device_id: string;
|
|
45382
|
+
device_name: string;
|
|
45383
|
+
relay_name: string | null;
|
|
45384
|
+
} | undefined;
|
|
45385
|
+
ttlock_metadata?: {
|
|
45386
|
+
lock_id: number;
|
|
45387
|
+
lock_alias: string;
|
|
45388
|
+
feature_value: string;
|
|
45389
|
+
features: {
|
|
45390
|
+
passcode: boolean;
|
|
45391
|
+
passcode_management: boolean;
|
|
45392
|
+
unlock_via_gateway: boolean;
|
|
45393
|
+
lock_command: boolean;
|
|
45394
|
+
incomplete_keyboard_passcode: boolean;
|
|
45395
|
+
};
|
|
45396
|
+
has_gateway?: boolean | undefined;
|
|
45397
|
+
wireless_keypads?: Array<{
|
|
45398
|
+
wireless_keypad_id: number;
|
|
45399
|
+
wireless_keypad_name: string;
|
|
45400
|
+
}> | undefined;
|
|
45401
|
+
} | undefined;
|
|
45402
|
+
seam_bridge_metadata?: {
|
|
45403
|
+
unlock_method?: ('bridge' | 'doorking') | undefined;
|
|
45404
|
+
device_num: number;
|
|
45405
|
+
name: string;
|
|
45406
|
+
} | undefined;
|
|
45407
|
+
igloohome_metadata?: {
|
|
45408
|
+
device_id: string;
|
|
45409
|
+
device_name: string;
|
|
45410
|
+
bridge_id?: string | undefined;
|
|
45411
|
+
bridge_name?: string | undefined;
|
|
45412
|
+
keypad_id?: string | undefined;
|
|
45413
|
+
} | undefined;
|
|
45414
|
+
nest_metadata?: {
|
|
45415
|
+
nest_device_id: string;
|
|
45416
|
+
device_name: string;
|
|
45417
|
+
custom_name: string;
|
|
45418
|
+
} | undefined;
|
|
45419
|
+
ecobee_metadata?: {
|
|
45420
|
+
ecobee_device_id: string;
|
|
45421
|
+
device_name: string;
|
|
45422
|
+
} | undefined;
|
|
45423
|
+
honeywell_resideo_metadata?: {
|
|
45424
|
+
honeywell_resideo_device_id: string;
|
|
45425
|
+
device_name: string;
|
|
45426
|
+
} | undefined;
|
|
45427
|
+
hubitat_metadata?: {
|
|
45428
|
+
device_id: string;
|
|
45429
|
+
device_name: string;
|
|
45430
|
+
device_label: string;
|
|
45431
|
+
} | undefined;
|
|
45432
|
+
dormakaba_oracode_metadata?: {
|
|
45433
|
+
door_id?: number | undefined;
|
|
45434
|
+
door_name: string;
|
|
45435
|
+
device_id?: (number | string) | undefined;
|
|
45436
|
+
door_is_wireless: boolean;
|
|
45437
|
+
/** @DEPRECATED */
|
|
45438
|
+
site_id: number | null;
|
|
45439
|
+
site_name: string;
|
|
45440
|
+
iana_timezone?: string | undefined;
|
|
45441
|
+
predefined_time_slots?: Array<{
|
|
45442
|
+
name: string;
|
|
45443
|
+
prefix: number;
|
|
45444
|
+
check_in_time: string;
|
|
45445
|
+
check_out_time: string;
|
|
45446
|
+
is_24_hour: boolean;
|
|
45447
|
+
is_biweekly_mode: boolean;
|
|
45448
|
+
is_one_shot: boolean;
|
|
45449
|
+
is_master: boolean;
|
|
45450
|
+
ext_dormakaba_oracode_user_level_prefix: number;
|
|
45451
|
+
dormakaba_oracode_user_level_id: string;
|
|
45452
|
+
}> | undefined;
|
|
45453
|
+
} | undefined;
|
|
45454
|
+
wyze_metadata?: {
|
|
45455
|
+
device_id: string;
|
|
45456
|
+
device_name: string;
|
|
45457
|
+
product_name: string;
|
|
45458
|
+
product_type: string;
|
|
45459
|
+
product_model: string;
|
|
45460
|
+
device_info_model: string;
|
|
45461
|
+
keypad_uuid?: string | undefined;
|
|
45462
|
+
locker_status_hardlock?: number | undefined;
|
|
45463
|
+
} | undefined;
|
|
45464
|
+
tedee_metadata?: {
|
|
45465
|
+
device_id: number;
|
|
45466
|
+
serial_number: string;
|
|
45467
|
+
device_name: string;
|
|
45468
|
+
device_model: string;
|
|
45469
|
+
bridge_id: number;
|
|
45470
|
+
bridge_name: string;
|
|
45471
|
+
keypad_id?: number | undefined;
|
|
45472
|
+
} | undefined;
|
|
45473
|
+
visionline_metadata?: {
|
|
45474
|
+
encoder_id: string;
|
|
45475
|
+
} | undefined;
|
|
45476
|
+
akiles_metadata?: {
|
|
45477
|
+
gadget_name: string;
|
|
45478
|
+
gadget_id: string;
|
|
45479
|
+
} | undefined;
|
|
45480
|
+
}) & ({
|
|
45481
|
+
_experimental_supported_code_from_access_codes_lengths?: (number[] | undefined) | undefined;
|
|
45482
|
+
code_constraints?: (Array<{
|
|
45483
|
+
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';
|
|
45484
|
+
} | {
|
|
45485
|
+
constraint_type: 'name_length' | 'name_must_be_unique';
|
|
45486
|
+
min_length?: number | undefined;
|
|
45487
|
+
max_length?: number | undefined;
|
|
45488
|
+
}> | undefined) | undefined;
|
|
45489
|
+
supported_code_lengths?: (number[] | undefined) | undefined;
|
|
45490
|
+
max_active_codes_supported?: (number | undefined) | undefined;
|
|
45491
|
+
supports_backup_access_code_pool?: (boolean | undefined) | undefined;
|
|
45492
|
+
has_native_entry_events?: (boolean | undefined) | undefined;
|
|
45493
|
+
locked?: (boolean | undefined) | undefined;
|
|
45494
|
+
keypad_battery?: ({
|
|
45495
|
+
level: number;
|
|
45496
|
+
} | undefined) | undefined;
|
|
45497
|
+
door_open?: (boolean | undefined) | undefined;
|
|
45498
|
+
} & {
|
|
45499
|
+
temperature_fahrenheit?: number | undefined;
|
|
45500
|
+
temperature_celsius?: number | undefined;
|
|
45501
|
+
relative_humidity?: number | undefined;
|
|
45502
|
+
available_hvac_mode_settings?: Array<'off' | 'heat' | 'cool' | 'heat_cool'> | undefined;
|
|
45503
|
+
available_fan_mode_settings?: Array<'auto' | 'on' | 'circulate'> | undefined;
|
|
45504
|
+
is_heating?: boolean | undefined;
|
|
45505
|
+
is_cooling?: boolean | undefined;
|
|
45506
|
+
is_fan_running?: boolean | undefined;
|
|
45507
|
+
/**
|
|
45508
|
+
* @deprecated use current_climate_setting.fan_mode_setting instead. */
|
|
45509
|
+
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
45510
|
+
is_temporary_manual_override_active?: boolean | undefined;
|
|
45511
|
+
current_climate_setting?: {
|
|
45512
|
+
climate_preset_key?: string | undefined;
|
|
45513
|
+
can_edit?: boolean | undefined;
|
|
45514
|
+
can_delete?: boolean | undefined;
|
|
45515
|
+
name?: ((string | null) | undefined) | undefined;
|
|
45516
|
+
display_name?: string | undefined;
|
|
45517
|
+
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
45518
|
+
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
45519
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
45520
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
45521
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
45522
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
45523
|
+
manual_override_allowed?: boolean | undefined;
|
|
45524
|
+
} | undefined;
|
|
45525
|
+
/**
|
|
45526
|
+
* @deprecated use fallback_climate_preset_key to specify a fallback climate preset instead. */
|
|
45527
|
+
default_climate_setting?: {
|
|
45528
|
+
climate_preset_key?: string | undefined;
|
|
45529
|
+
can_edit?: boolean | undefined;
|
|
45530
|
+
can_delete?: boolean | undefined;
|
|
45531
|
+
name?: ((string | null) | undefined) | undefined;
|
|
45532
|
+
display_name?: string | undefined;
|
|
45533
|
+
fan_mode_setting?: (('auto' | 'on' | 'circulate') | undefined) | undefined;
|
|
45534
|
+
hvac_mode_setting?: (('off' | 'heat' | 'cool' | 'heat_cool') | undefined) | undefined;
|
|
45535
|
+
cooling_set_point_celsius?: (number | undefined) | undefined;
|
|
45536
|
+
heating_set_point_celsius?: (number | undefined) | undefined;
|
|
45537
|
+
cooling_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
45538
|
+
heating_set_point_fahrenheit?: (number | undefined) | undefined;
|
|
45539
|
+
manual_override_allowed?: boolean | undefined;
|
|
45540
|
+
} | undefined;
|
|
45541
|
+
available_climate_presets?: Array<{
|
|
45542
|
+
climate_preset_key: string;
|
|
45543
|
+
can_edit: boolean;
|
|
45544
|
+
can_delete: boolean;
|
|
45545
|
+
name?: (string | null) | undefined;
|
|
45546
|
+
display_name: string;
|
|
45547
|
+
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
45548
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool') | undefined;
|
|
45549
|
+
cooling_set_point_celsius?: number | undefined;
|
|
45550
|
+
heating_set_point_celsius?: number | undefined;
|
|
45551
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
45552
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
45553
|
+
manual_override_allowed: boolean;
|
|
45554
|
+
}> | undefined;
|
|
45555
|
+
fallback_climate_preset_key?: (string | null) | undefined;
|
|
45556
|
+
active_thermostat_schedule?: ({
|
|
45557
|
+
thermostat_schedule_id: string;
|
|
45558
|
+
device_id: string;
|
|
45559
|
+
name?: string | undefined;
|
|
45560
|
+
climate_preset_key: string;
|
|
45561
|
+
max_override_period_minutes: number;
|
|
45562
|
+
starts_at: string;
|
|
45563
|
+
ends_at: string;
|
|
45564
|
+
created_at: string;
|
|
45565
|
+
/** Collection of errors associated with the thermostat schedule, 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. */
|
|
45566
|
+
errors?: any;
|
|
45567
|
+
} | null) | undefined;
|
|
45568
|
+
min_cooling_set_point_celsius?: number | undefined;
|
|
45569
|
+
min_cooling_set_point_fahrenheit?: number | undefined;
|
|
45570
|
+
max_cooling_set_point_celsius?: number | undefined;
|
|
45571
|
+
max_cooling_set_point_fahrenheit?: number | undefined;
|
|
45572
|
+
min_heating_set_point_celsius?: number | undefined;
|
|
45573
|
+
min_heating_set_point_fahrenheit?: number | undefined;
|
|
45574
|
+
max_heating_set_point_celsius?: number | undefined;
|
|
45575
|
+
max_heating_set_point_fahrenheit?: number | undefined;
|
|
45576
|
+
min_heating_cooling_delta_celsius?: number | undefined;
|
|
45577
|
+
min_heating_cooling_delta_fahrenheit?: number | undefined;
|
|
45578
|
+
});
|
|
45579
|
+
/** Location information for the device. */
|
|
45580
|
+
location: {
|
|
45581
|
+
/** Name of the device location. */
|
|
45582
|
+
location_name?: string | undefined;
|
|
45583
|
+
/** Time zone of the device location. */
|
|
45584
|
+
timezone?: string | undefined;
|
|
45585
|
+
} | null;
|
|
45586
|
+
/** Unique identifier for the account associated with the device. */
|
|
45587
|
+
connected_account_id: string;
|
|
45588
|
+
/** Unique identifier for the Seam workspace associated with the device. */
|
|
45589
|
+
workspace_id: string;
|
|
45590
|
+
/** 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. */
|
|
45591
|
+
errors: Array<{
|
|
45592
|
+
message: string;
|
|
45593
|
+
is_device_error: true;
|
|
45594
|
+
error_code: string;
|
|
45595
|
+
} | {
|
|
45596
|
+
message: string;
|
|
45597
|
+
is_connected_account_error: true;
|
|
45598
|
+
error_code: string;
|
|
45599
|
+
}>;
|
|
45600
|
+
/** 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. */
|
|
45601
|
+
warnings: Array<{
|
|
45602
|
+
message: string;
|
|
45603
|
+
warning_code: string;
|
|
45604
|
+
}>;
|
|
45605
|
+
/** Date and time at which the device object was created. */
|
|
45606
|
+
created_at: string;
|
|
45607
|
+
/** Indicates whether Seam manages the device. */
|
|
45608
|
+
is_managed: true;
|
|
45609
|
+
custom_metadata: Record<string, string | boolean>;
|
|
45610
|
+
can_remotely_unlock?: boolean | undefined;
|
|
45611
|
+
can_remotely_lock?: boolean | undefined;
|
|
45612
|
+
can_program_offline_access_codes?: boolean | undefined;
|
|
45613
|
+
can_program_online_access_codes?: boolean | undefined;
|
|
45614
|
+
can_hvac_heat?: boolean | undefined;
|
|
45615
|
+
can_hvac_cool?: boolean | undefined;
|
|
45616
|
+
can_hvac_heat_cool?: boolean | undefined;
|
|
45617
|
+
can_turn_off_hvac?: boolean | undefined;
|
|
45618
|
+
can_simulate_removal?: boolean | undefined;
|
|
45619
|
+
can_simulate_connection?: boolean | undefined;
|
|
45620
|
+
can_simulate_disconnection?: boolean | undefined;
|
|
45621
|
+
}>;
|
|
44976
45622
|
};
|
|
44977
45623
|
};
|
|
44978
45624
|
'/thermostats/off': {
|