@seamapi/types 1.1080.0 → 1.1082.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/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.js +31 -0
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.js.map +1 -0
- package/lib/seam/connect/models/devices/device-metadata.d.ts +33 -0
- package/lib/seam/connect/models/devices/device-metadata.js +23 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +5 -1
- package/lib/seam/connect/models/devices/device-provider.js +2 -1
- package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
- package/lib/seam/connect/models/devices/device-type.d.ts +2 -1
- package/lib/seam/connect/models/devices/device-type.js +1 -0
- package/lib/seam/connect/models/devices/device-type.js.map +1 -1
- package/lib/seam/connect/models/devices/device.d.ts +56 -3
- package/lib/seam/connect/models/devices/device.js +3 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +40 -3
- package/lib/seam/connect/openapi.js +220 -6
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3417 -152
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
- package/src/lib/seam/connect/models/action-attempts/activate-weekly-program.ts +46 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +24 -0
- package/src/lib/seam/connect/models/devices/device-provider.ts +2 -1
- package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
- package/src/lib/seam/connect/models/devices/device.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +233 -6
- package/src/lib/seam/connect/route-types.ts +3790 -24
|
@@ -1438,6 +1438,41 @@ export type Routes = {
|
|
|
1438
1438
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
1439
1439
|
message: string;
|
|
1440
1440
|
};
|
|
1441
|
+
} | {
|
|
1442
|
+
/** ID of the action attempt. */
|
|
1443
|
+
action_attempt_id: string;
|
|
1444
|
+
status: 'pending';
|
|
1445
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
1446
|
+
result: null;
|
|
1447
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
1448
|
+
error: null;
|
|
1449
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
1450
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
1451
|
+
} | {
|
|
1452
|
+
/** ID of the action attempt. */
|
|
1453
|
+
action_attempt_id: string;
|
|
1454
|
+
status: 'success';
|
|
1455
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
1456
|
+
error: null;
|
|
1457
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
1458
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
1459
|
+
/** Result of the action. */
|
|
1460
|
+
result: {};
|
|
1461
|
+
} | {
|
|
1462
|
+
/** ID of the action attempt. */
|
|
1463
|
+
action_attempt_id: string;
|
|
1464
|
+
status: 'error';
|
|
1465
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
1466
|
+
result: null;
|
|
1467
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
1468
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
1469
|
+
/** Error associated with the action. */
|
|
1470
|
+
error: {
|
|
1471
|
+
/** Type of the error. */
|
|
1472
|
+
type: string;
|
|
1473
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
1474
|
+
message: string;
|
|
1475
|
+
};
|
|
1441
1476
|
} | {
|
|
1442
1477
|
/** ID of the action attempt. */
|
|
1443
1478
|
action_attempt_id: string;
|
|
@@ -4288,6 +4323,41 @@ export type Routes = {
|
|
|
4288
4323
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
4289
4324
|
message: string;
|
|
4290
4325
|
};
|
|
4326
|
+
} | {
|
|
4327
|
+
/** ID of the action attempt. */
|
|
4328
|
+
action_attempt_id: string;
|
|
4329
|
+
status: 'pending';
|
|
4330
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
4331
|
+
result: null;
|
|
4332
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
4333
|
+
error: null;
|
|
4334
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
4335
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
4336
|
+
} | {
|
|
4337
|
+
/** ID of the action attempt. */
|
|
4338
|
+
action_attempt_id: string;
|
|
4339
|
+
status: 'success';
|
|
4340
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
4341
|
+
error: null;
|
|
4342
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
4343
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
4344
|
+
/** Result of the action. */
|
|
4345
|
+
result: {};
|
|
4346
|
+
} | {
|
|
4347
|
+
/** ID of the action attempt. */
|
|
4348
|
+
action_attempt_id: string;
|
|
4349
|
+
status: 'error';
|
|
4350
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
4351
|
+
result: null;
|
|
4352
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
4353
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
4354
|
+
/** Error associated with the action. */
|
|
4355
|
+
error: {
|
|
4356
|
+
/** Type of the error. */
|
|
4357
|
+
type: string;
|
|
4358
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
4359
|
+
message: string;
|
|
4360
|
+
};
|
|
4291
4361
|
} | {
|
|
4292
4362
|
/** ID of the action attempt. */
|
|
4293
4363
|
action_attempt_id: string;
|
|
@@ -8715,6 +8785,41 @@ export type Routes = {
|
|
|
8715
8785
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
8716
8786
|
message: string;
|
|
8717
8787
|
};
|
|
8788
|
+
} | {
|
|
8789
|
+
/** ID of the action attempt. */
|
|
8790
|
+
action_attempt_id: string;
|
|
8791
|
+
status: 'pending';
|
|
8792
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
8793
|
+
result: null;
|
|
8794
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
8795
|
+
error: null;
|
|
8796
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
8797
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
8798
|
+
} | {
|
|
8799
|
+
/** ID of the action attempt. */
|
|
8800
|
+
action_attempt_id: string;
|
|
8801
|
+
status: 'success';
|
|
8802
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
8803
|
+
error: null;
|
|
8804
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
8805
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
8806
|
+
/** Result of the action. */
|
|
8807
|
+
result: {};
|
|
8808
|
+
} | {
|
|
8809
|
+
/** ID of the action attempt. */
|
|
8810
|
+
action_attempt_id: string;
|
|
8811
|
+
status: 'error';
|
|
8812
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
8813
|
+
result: null;
|
|
8814
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
8815
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
8816
|
+
/** Error associated with the action. */
|
|
8817
|
+
error: {
|
|
8818
|
+
/** Type of the error. */
|
|
8819
|
+
type: string;
|
|
8820
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
8821
|
+
message: string;
|
|
8822
|
+
};
|
|
8718
8823
|
} | {
|
|
8719
8824
|
/** ID of the action attempt. */
|
|
8720
8825
|
action_attempt_id: string;
|
|
@@ -11430,6 +11535,41 @@ export type Routes = {
|
|
|
11430
11535
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11431
11536
|
message: string;
|
|
11432
11537
|
};
|
|
11538
|
+
} | {
|
|
11539
|
+
/** ID of the action attempt. */
|
|
11540
|
+
action_attempt_id: string;
|
|
11541
|
+
status: 'pending';
|
|
11542
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
11543
|
+
result: null;
|
|
11544
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
11545
|
+
error: null;
|
|
11546
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
11547
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
11548
|
+
} | {
|
|
11549
|
+
/** ID of the action attempt. */
|
|
11550
|
+
action_attempt_id: string;
|
|
11551
|
+
status: 'success';
|
|
11552
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
11553
|
+
error: null;
|
|
11554
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
11555
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
11556
|
+
/** Result of the action. */
|
|
11557
|
+
result: {};
|
|
11558
|
+
} | {
|
|
11559
|
+
/** ID of the action attempt. */
|
|
11560
|
+
action_attempt_id: string;
|
|
11561
|
+
status: 'error';
|
|
11562
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
11563
|
+
result: null;
|
|
11564
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
11565
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
11566
|
+
/** Error associated with the action. */
|
|
11567
|
+
error: {
|
|
11568
|
+
/** Type of the error. */
|
|
11569
|
+
type: string;
|
|
11570
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11571
|
+
message: string;
|
|
11572
|
+
};
|
|
11433
11573
|
} | {
|
|
11434
11574
|
/** ID of the action attempt. */
|
|
11435
11575
|
action_attempt_id: string;
|
|
@@ -12391,7 +12531,7 @@ export type Routes = {
|
|
|
12391
12531
|
/** ID of the device. */
|
|
12392
12532
|
device_id: string;
|
|
12393
12533
|
/** Type of the device. */
|
|
12394
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
12534
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
12395
12535
|
/** IDs of the spaces the device is in. */
|
|
12396
12536
|
space_ids: string[];
|
|
12397
12537
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -13055,6 +13195,19 @@ export type Routes = {
|
|
|
13055
13195
|
/** Hardware version reported by the camera. */
|
|
13056
13196
|
hardware_version?: (string | undefined) | undefined;
|
|
13057
13197
|
} | undefined) | undefined;
|
|
13198
|
+
/** Metadata for an Arlo camera. */
|
|
13199
|
+
arlo_metadata?: ({
|
|
13200
|
+
/** Device ID reported by Arlo. */
|
|
13201
|
+
device_id?: (string | undefined) | undefined;
|
|
13202
|
+
/** Device name reported by Arlo. */
|
|
13203
|
+
device_name?: (string | undefined) | undefined;
|
|
13204
|
+
/** Model ID reported by Arlo. */
|
|
13205
|
+
model_id?: (string | undefined) | undefined;
|
|
13206
|
+
/** Hardware version reported by Arlo. */
|
|
13207
|
+
hardware_version?: (string | undefined) | undefined;
|
|
13208
|
+
/** Firmware version reported by Arlo. */
|
|
13209
|
+
firmware_version?: (string | undefined) | undefined;
|
|
13210
|
+
} | undefined) | undefined;
|
|
13058
13211
|
/** Metadata for a Ring device. */
|
|
13059
13212
|
ring_metadata?: {
|
|
13060
13213
|
/** Device ID for a Ring device. */
|
|
@@ -13879,6 +14032,8 @@ export type Routes = {
|
|
|
13879
14032
|
can_hvac_heat_cool?: boolean | undefined;
|
|
13880
14033
|
/** Indicates whether the thermostat can be turned off. */
|
|
13881
14034
|
can_turn_off_hvac?: boolean | undefined;
|
|
14035
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
14036
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
13882
14037
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
13883
14038
|
can_simulate_removal?: boolean | undefined;
|
|
13884
14039
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -17076,6 +17231,41 @@ export type Routes = {
|
|
|
17076
17231
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
17077
17232
|
message: string;
|
|
17078
17233
|
};
|
|
17234
|
+
} | {
|
|
17235
|
+
/** ID of the action attempt. */
|
|
17236
|
+
action_attempt_id: string;
|
|
17237
|
+
status: 'pending';
|
|
17238
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
17239
|
+
result: null;
|
|
17240
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
17241
|
+
error: null;
|
|
17242
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
17243
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
17244
|
+
} | {
|
|
17245
|
+
/** ID of the action attempt. */
|
|
17246
|
+
action_attempt_id: string;
|
|
17247
|
+
status: 'success';
|
|
17248
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
17249
|
+
error: null;
|
|
17250
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
17251
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
17252
|
+
/** Result of the action. */
|
|
17253
|
+
result: {};
|
|
17254
|
+
} | {
|
|
17255
|
+
/** ID of the action attempt. */
|
|
17256
|
+
action_attempt_id: string;
|
|
17257
|
+
status: 'error';
|
|
17258
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
17259
|
+
result: null;
|
|
17260
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
17261
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
17262
|
+
/** Error associated with the action. */
|
|
17263
|
+
error: {
|
|
17264
|
+
/** Type of the error. */
|
|
17265
|
+
type: string;
|
|
17266
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
17267
|
+
message: string;
|
|
17268
|
+
};
|
|
17079
17269
|
} | {
|
|
17080
17270
|
/** ID of the action attempt. */
|
|
17081
17271
|
action_attempt_id: string;
|
|
@@ -18907,6 +19097,41 @@ export type Routes = {
|
|
|
18907
19097
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
18908
19098
|
message: string;
|
|
18909
19099
|
};
|
|
19100
|
+
} | {
|
|
19101
|
+
/** ID of the action attempt. */
|
|
19102
|
+
action_attempt_id: string;
|
|
19103
|
+
status: 'pending';
|
|
19104
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
19105
|
+
result: null;
|
|
19106
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
19107
|
+
error: null;
|
|
19108
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
19109
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
19110
|
+
} | {
|
|
19111
|
+
/** ID of the action attempt. */
|
|
19112
|
+
action_attempt_id: string;
|
|
19113
|
+
status: 'success';
|
|
19114
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
19115
|
+
error: null;
|
|
19116
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
19117
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
19118
|
+
/** Result of the action. */
|
|
19119
|
+
result: {};
|
|
19120
|
+
} | {
|
|
19121
|
+
/** ID of the action attempt. */
|
|
19122
|
+
action_attempt_id: string;
|
|
19123
|
+
status: 'error';
|
|
19124
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
19125
|
+
result: null;
|
|
19126
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
19127
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
19128
|
+
/** Error associated with the action. */
|
|
19129
|
+
error: {
|
|
19130
|
+
/** Type of the error. */
|
|
19131
|
+
type: string;
|
|
19132
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
19133
|
+
message: string;
|
|
19134
|
+
};
|
|
18910
19135
|
} | {
|
|
18911
19136
|
/** ID of the action attempt. */
|
|
18912
19137
|
action_attempt_id: string;
|
|
@@ -19538,7 +19763,7 @@ export type Routes = {
|
|
|
19538
19763
|
/** ID of the device. */
|
|
19539
19764
|
device_id: string;
|
|
19540
19765
|
/** Type of the device. */
|
|
19541
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
19766
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
19542
19767
|
/** IDs of the spaces the device is in. */
|
|
19543
19768
|
space_ids: string[];
|
|
19544
19769
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -20202,6 +20427,19 @@ export type Routes = {
|
|
|
20202
20427
|
/** Hardware version reported by the camera. */
|
|
20203
20428
|
hardware_version?: (string | undefined) | undefined;
|
|
20204
20429
|
} | undefined) | undefined;
|
|
20430
|
+
/** Metadata for an Arlo camera. */
|
|
20431
|
+
arlo_metadata?: ({
|
|
20432
|
+
/** Device ID reported by Arlo. */
|
|
20433
|
+
device_id?: (string | undefined) | undefined;
|
|
20434
|
+
/** Device name reported by Arlo. */
|
|
20435
|
+
device_name?: (string | undefined) | undefined;
|
|
20436
|
+
/** Model ID reported by Arlo. */
|
|
20437
|
+
model_id?: (string | undefined) | undefined;
|
|
20438
|
+
/** Hardware version reported by Arlo. */
|
|
20439
|
+
hardware_version?: (string | undefined) | undefined;
|
|
20440
|
+
/** Firmware version reported by Arlo. */
|
|
20441
|
+
firmware_version?: (string | undefined) | undefined;
|
|
20442
|
+
} | undefined) | undefined;
|
|
20205
20443
|
/** Metadata for a Ring device. */
|
|
20206
20444
|
ring_metadata?: {
|
|
20207
20445
|
/** Device ID for a Ring device. */
|
|
@@ -21026,6 +21264,8 @@ export type Routes = {
|
|
|
21026
21264
|
can_hvac_heat_cool?: boolean | undefined;
|
|
21027
21265
|
/** Indicates whether the thermostat can be turned off. */
|
|
21028
21266
|
can_turn_off_hvac?: boolean | undefined;
|
|
21267
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
21268
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
21029
21269
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
21030
21270
|
can_simulate_removal?: boolean | undefined;
|
|
21031
21271
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -23378,6 +23618,41 @@ export type Routes = {
|
|
|
23378
23618
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23379
23619
|
message: string;
|
|
23380
23620
|
};
|
|
23621
|
+
} | {
|
|
23622
|
+
/** ID of the action attempt. */
|
|
23623
|
+
action_attempt_id: string;
|
|
23624
|
+
status: 'pending';
|
|
23625
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
23626
|
+
result: null;
|
|
23627
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
23628
|
+
error: null;
|
|
23629
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
23630
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
23631
|
+
} | {
|
|
23632
|
+
/** ID of the action attempt. */
|
|
23633
|
+
action_attempt_id: string;
|
|
23634
|
+
status: 'success';
|
|
23635
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
23636
|
+
error: null;
|
|
23637
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
23638
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
23639
|
+
/** Result of the action. */
|
|
23640
|
+
result: {};
|
|
23641
|
+
} | {
|
|
23642
|
+
/** ID of the action attempt. */
|
|
23643
|
+
action_attempt_id: string;
|
|
23644
|
+
status: 'error';
|
|
23645
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
23646
|
+
result: null;
|
|
23647
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
23648
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
23649
|
+
/** Error associated with the action. */
|
|
23650
|
+
error: {
|
|
23651
|
+
/** Type of the error. */
|
|
23652
|
+
type: string;
|
|
23653
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
23654
|
+
message: string;
|
|
23655
|
+
};
|
|
23381
23656
|
} | {
|
|
23382
23657
|
/** ID of the action attempt. */
|
|
23383
23658
|
action_attempt_id: string;
|
|
@@ -28698,6 +28973,41 @@ export type Routes = {
|
|
|
28698
28973
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
28699
28974
|
message: string;
|
|
28700
28975
|
};
|
|
28976
|
+
} | {
|
|
28977
|
+
/** ID of the action attempt. */
|
|
28978
|
+
action_attempt_id: string;
|
|
28979
|
+
status: 'pending';
|
|
28980
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28981
|
+
result: null;
|
|
28982
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28983
|
+
error: null;
|
|
28984
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
28985
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
28986
|
+
} | {
|
|
28987
|
+
/** ID of the action attempt. */
|
|
28988
|
+
action_attempt_id: string;
|
|
28989
|
+
status: 'success';
|
|
28990
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28991
|
+
error: null;
|
|
28992
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
28993
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
28994
|
+
/** Result of the action. */
|
|
28995
|
+
result: {};
|
|
28996
|
+
} | {
|
|
28997
|
+
/** ID of the action attempt. */
|
|
28998
|
+
action_attempt_id: string;
|
|
28999
|
+
status: 'error';
|
|
29000
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
29001
|
+
result: null;
|
|
29002
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
29003
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
29004
|
+
/** Error associated with the action. */
|
|
29005
|
+
error: {
|
|
29006
|
+
/** Type of the error. */
|
|
29007
|
+
type: string;
|
|
29008
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
29009
|
+
message: string;
|
|
29010
|
+
};
|
|
28701
29011
|
} | {
|
|
28702
29012
|
/** ID of the action attempt. */
|
|
28703
29013
|
action_attempt_id: string;
|
|
@@ -30618,6 +30928,41 @@ export type Routes = {
|
|
|
30618
30928
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
30619
30929
|
message: string;
|
|
30620
30930
|
};
|
|
30931
|
+
} | {
|
|
30932
|
+
/** ID of the action attempt. */
|
|
30933
|
+
action_attempt_id: string;
|
|
30934
|
+
status: 'pending';
|
|
30935
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
30936
|
+
result: null;
|
|
30937
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
30938
|
+
error: null;
|
|
30939
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
30940
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
30941
|
+
} | {
|
|
30942
|
+
/** ID of the action attempt. */
|
|
30943
|
+
action_attempt_id: string;
|
|
30944
|
+
status: 'success';
|
|
30945
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
30946
|
+
error: null;
|
|
30947
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
30948
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
30949
|
+
/** Result of the action. */
|
|
30950
|
+
result: {};
|
|
30951
|
+
} | {
|
|
30952
|
+
/** ID of the action attempt. */
|
|
30953
|
+
action_attempt_id: string;
|
|
30954
|
+
status: 'error';
|
|
30955
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
30956
|
+
result: null;
|
|
30957
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
30958
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
30959
|
+
/** Error associated with the action. */
|
|
30960
|
+
error: {
|
|
30961
|
+
/** Type of the error. */
|
|
30962
|
+
type: string;
|
|
30963
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
30964
|
+
message: string;
|
|
30965
|
+
};
|
|
30621
30966
|
} | {
|
|
30622
30967
|
/** ID of the action attempt. */
|
|
30623
30968
|
action_attempt_id: string;
|
|
@@ -32437,6 +32782,41 @@ export type Routes = {
|
|
|
32437
32782
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
32438
32783
|
message: string;
|
|
32439
32784
|
};
|
|
32785
|
+
} | {
|
|
32786
|
+
/** ID of the action attempt. */
|
|
32787
|
+
action_attempt_id: string;
|
|
32788
|
+
status: 'pending';
|
|
32789
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
32790
|
+
result: null;
|
|
32791
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
32792
|
+
error: null;
|
|
32793
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
32794
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
32795
|
+
} | {
|
|
32796
|
+
/** ID of the action attempt. */
|
|
32797
|
+
action_attempt_id: string;
|
|
32798
|
+
status: 'success';
|
|
32799
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
32800
|
+
error: null;
|
|
32801
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
32802
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
32803
|
+
/** Result of the action. */
|
|
32804
|
+
result: {};
|
|
32805
|
+
} | {
|
|
32806
|
+
/** ID of the action attempt. */
|
|
32807
|
+
action_attempt_id: string;
|
|
32808
|
+
status: 'error';
|
|
32809
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
32810
|
+
result: null;
|
|
32811
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
32812
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
32813
|
+
/** Error associated with the action. */
|
|
32814
|
+
error: {
|
|
32815
|
+
/** Type of the error. */
|
|
32816
|
+
type: string;
|
|
32817
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
32818
|
+
message: string;
|
|
32819
|
+
};
|
|
32440
32820
|
} | {
|
|
32441
32821
|
/** ID of the action attempt. */
|
|
32442
32822
|
action_attempt_id: string;
|
|
@@ -34987,6 +35367,41 @@ export type Routes = {
|
|
|
34987
35367
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
34988
35368
|
message: string;
|
|
34989
35369
|
};
|
|
35370
|
+
} | {
|
|
35371
|
+
/** ID of the action attempt. */
|
|
35372
|
+
action_attempt_id: string;
|
|
35373
|
+
status: 'pending';
|
|
35374
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
35375
|
+
result: null;
|
|
35376
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
35377
|
+
error: null;
|
|
35378
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
35379
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
35380
|
+
} | {
|
|
35381
|
+
/** ID of the action attempt. */
|
|
35382
|
+
action_attempt_id: string;
|
|
35383
|
+
status: 'success';
|
|
35384
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
35385
|
+
error: null;
|
|
35386
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
35387
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
35388
|
+
/** Result of the action. */
|
|
35389
|
+
result: {};
|
|
35390
|
+
} | {
|
|
35391
|
+
/** ID of the action attempt. */
|
|
35392
|
+
action_attempt_id: string;
|
|
35393
|
+
status: 'error';
|
|
35394
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
35395
|
+
result: null;
|
|
35396
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
35397
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
35398
|
+
/** Error associated with the action. */
|
|
35399
|
+
error: {
|
|
35400
|
+
/** Type of the error. */
|
|
35401
|
+
type: string;
|
|
35402
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
35403
|
+
message: string;
|
|
35404
|
+
};
|
|
34990
35405
|
} | {
|
|
34991
35406
|
/** ID of the action attempt. */
|
|
34992
35407
|
action_attempt_id: string;
|
|
@@ -39156,6 +39571,41 @@ export type Routes = {
|
|
|
39156
39571
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
39157
39572
|
message: string;
|
|
39158
39573
|
};
|
|
39574
|
+
} | {
|
|
39575
|
+
/** ID of the action attempt. */
|
|
39576
|
+
action_attempt_id: string;
|
|
39577
|
+
status: 'pending';
|
|
39578
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
39579
|
+
result: null;
|
|
39580
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
39581
|
+
error: null;
|
|
39582
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
39583
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
39584
|
+
} | {
|
|
39585
|
+
/** ID of the action attempt. */
|
|
39586
|
+
action_attempt_id: string;
|
|
39587
|
+
status: 'success';
|
|
39588
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
39589
|
+
error: null;
|
|
39590
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
39591
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
39592
|
+
/** Result of the action. */
|
|
39593
|
+
result: {};
|
|
39594
|
+
} | {
|
|
39595
|
+
/** ID of the action attempt. */
|
|
39596
|
+
action_attempt_id: string;
|
|
39597
|
+
status: 'error';
|
|
39598
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
39599
|
+
result: null;
|
|
39600
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
39601
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
39602
|
+
/** Error associated with the action. */
|
|
39603
|
+
error: {
|
|
39604
|
+
/** Type of the error. */
|
|
39605
|
+
type: string;
|
|
39606
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
39607
|
+
message: string;
|
|
39608
|
+
};
|
|
39159
39609
|
} | {
|
|
39160
39610
|
/** ID of the action attempt. */
|
|
39161
39611
|
action_attempt_id: string;
|
|
@@ -40967,6 +41417,41 @@ export type Routes = {
|
|
|
40967
41417
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
40968
41418
|
message: string;
|
|
40969
41419
|
};
|
|
41420
|
+
} | {
|
|
41421
|
+
/** ID of the action attempt. */
|
|
41422
|
+
action_attempt_id: string;
|
|
41423
|
+
status: 'pending';
|
|
41424
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
41425
|
+
result: null;
|
|
41426
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
41427
|
+
error: null;
|
|
41428
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
41429
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
41430
|
+
} | {
|
|
41431
|
+
/** ID of the action attempt. */
|
|
41432
|
+
action_attempt_id: string;
|
|
41433
|
+
status: 'success';
|
|
41434
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
41435
|
+
error: null;
|
|
41436
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
41437
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
41438
|
+
/** Result of the action. */
|
|
41439
|
+
result: {};
|
|
41440
|
+
} | {
|
|
41441
|
+
/** ID of the action attempt. */
|
|
41442
|
+
action_attempt_id: string;
|
|
41443
|
+
status: 'error';
|
|
41444
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
41445
|
+
result: null;
|
|
41446
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
41447
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
41448
|
+
/** Error associated with the action. */
|
|
41449
|
+
error: {
|
|
41450
|
+
/** Type of the error. */
|
|
41451
|
+
type: string;
|
|
41452
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
41453
|
+
message: string;
|
|
41454
|
+
};
|
|
40970
41455
|
} | {
|
|
40971
41456
|
/** ID of the action attempt. */
|
|
40972
41457
|
action_attempt_id: string;
|
|
@@ -41807,7 +42292,7 @@ export type Routes = {
|
|
|
41807
42292
|
/** Associate the Connect Webview, the connected account, and all resources under the connected account with a customer. If the connected account already exists, it will be associated with the customer. If the connected account already exists, but is already associated with a customer, the Connect Webview will show an error. */
|
|
41808
42293
|
customer_key?: string | undefined;
|
|
41809
42294
|
/** Accepted device provider keys as an alternative to `provider_category`. Use this parameter to specify accepted providers explicitly. See [Customize the Brands to Display in Your Connect Webviews](https://www.seam.co/docs/core-concepts/connect-webviews/customizing-connect-webviews#customize-the-brands-to-display-in-your-connect-webviews). To list all provider keys, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with no filters. */
|
|
41810
|
-
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
|
|
42295
|
+
accepted_providers?: ('hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara' | 'yale_access' | 'hid_cm' | 'google_nest' | 'slack')[] | undefined;
|
|
41811
42296
|
/** Specifies the category of providers that you want to include. To list all providers within a category, use [`/devices/list_device_providers`](https://www.seam.co/docs/api/devices/list_device_providers) with the desired `provider_category` filter. */
|
|
41812
42297
|
provider_category?: ('stable' | 'consumer_smartlocks' | 'beta' | 'thermostats' | 'noise_sensors' | 'access_control_systems' | 'cameras' | 'connectors' | 'internal_beta') | undefined;
|
|
41813
42298
|
/** Custom metadata that you want to associate with the Connect Webview. Supports up to 50 JSON key:value pairs, with key names up to 40 characters long that cannot contain a period (.). [Adding custom metadata to a Connect Webview](https://www.seam.co/docs/core-concepts/connect-webviews/attaching-custom-data-to-the-connect-webview) enables you to store custom information, like customer details or internal IDs from your application. The custom metadata is then transferred to any [connected accounts](https://www.seam.co/docs/core-concepts/connected-accounts) that were connected using the Connect Webview, making it easy to find and filter these resources in your [workspace](https://www.seam.co/docs/core-concepts/workspaces). You can also [filter Connect Webviews by custom metadata](https://www.seam.co/docs/core-concepts/connect-webviews/filtering-connect-webviews-by-custom-metadata). Set a key to `null` or to an empty string to remove that key from the custom metadata. */
|
|
@@ -43639,7 +44124,7 @@ export type Routes = {
|
|
|
43639
44124
|
/** ID of the device. */
|
|
43640
44125
|
device_id: string;
|
|
43641
44126
|
/** Type of the device. */
|
|
43642
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
44127
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
43643
44128
|
/** IDs of the spaces the device is in. */
|
|
43644
44129
|
space_ids: string[];
|
|
43645
44130
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -44303,6 +44788,19 @@ export type Routes = {
|
|
|
44303
44788
|
/** Hardware version reported by the camera. */
|
|
44304
44789
|
hardware_version?: (string | undefined) | undefined;
|
|
44305
44790
|
} | undefined) | undefined;
|
|
44791
|
+
/** Metadata for an Arlo camera. */
|
|
44792
|
+
arlo_metadata?: ({
|
|
44793
|
+
/** Device ID reported by Arlo. */
|
|
44794
|
+
device_id?: (string | undefined) | undefined;
|
|
44795
|
+
/** Device name reported by Arlo. */
|
|
44796
|
+
device_name?: (string | undefined) | undefined;
|
|
44797
|
+
/** Model ID reported by Arlo. */
|
|
44798
|
+
model_id?: (string | undefined) | undefined;
|
|
44799
|
+
/** Hardware version reported by Arlo. */
|
|
44800
|
+
hardware_version?: (string | undefined) | undefined;
|
|
44801
|
+
/** Firmware version reported by Arlo. */
|
|
44802
|
+
firmware_version?: (string | undefined) | undefined;
|
|
44803
|
+
} | undefined) | undefined;
|
|
44306
44804
|
/** Metadata for a Ring device. */
|
|
44307
44805
|
ring_metadata?: {
|
|
44308
44806
|
/** Device ID for a Ring device. */
|
|
@@ -45127,6 +45625,8 @@ export type Routes = {
|
|
|
45127
45625
|
can_hvac_heat_cool?: boolean | undefined;
|
|
45128
45626
|
/** Indicates whether the thermostat can be turned off. */
|
|
45129
45627
|
can_turn_off_hvac?: boolean | undefined;
|
|
45628
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
45629
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
45130
45630
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
45131
45631
|
can_simulate_removal?: boolean | undefined;
|
|
45132
45632
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -45170,11 +45670,11 @@ export type Routes = {
|
|
|
45170
45670
|
/** ID of the Connect Webview for which you want to list devices. */
|
|
45171
45671
|
connect_webview_id?: string | undefined;
|
|
45172
45672
|
/** Device type for which you want to list devices. */
|
|
45173
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera')) | undefined;
|
|
45673
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera')) | undefined;
|
|
45174
45674
|
/** Array of device types for which you want to list devices. */
|
|
45175
|
-
device_types?: (('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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera'))[] | undefined;
|
|
45675
|
+
device_types?: (('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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera'))[] | undefined;
|
|
45176
45676
|
/** Manufacturer for which you want to list devices. */
|
|
45177
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
|
|
45677
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
|
|
45178
45678
|
/** Array of device IDs for which you want to list devices. */
|
|
45179
45679
|
device_ids?: string[] | undefined;
|
|
45180
45680
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -45190,9 +45690,9 @@ export type Routes = {
|
|
|
45190
45690
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
45191
45691
|
page_cursor?: (string | undefined) | null;
|
|
45192
45692
|
/** */
|
|
45193
|
-
include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
45693
|
+
include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
45194
45694
|
/** */
|
|
45195
|
-
exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
45695
|
+
exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
45196
45696
|
/**
|
|
45197
45697
|
* @deprecated Use `space_id`.*/
|
|
45198
45698
|
unstable_location_id?: (string | null) | undefined;
|
|
@@ -45207,7 +45707,7 @@ export type Routes = {
|
|
|
45207
45707
|
/** ID of the device. */
|
|
45208
45708
|
device_id: string;
|
|
45209
45709
|
/** Type of the device. */
|
|
45210
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
45710
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
45211
45711
|
/** IDs of the spaces the device is in. */
|
|
45212
45712
|
space_ids: string[];
|
|
45213
45713
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -45871,6 +46371,19 @@ export type Routes = {
|
|
|
45871
46371
|
/** Hardware version reported by the camera. */
|
|
45872
46372
|
hardware_version?: (string | undefined) | undefined;
|
|
45873
46373
|
} | undefined) | undefined;
|
|
46374
|
+
/** Metadata for an Arlo camera. */
|
|
46375
|
+
arlo_metadata?: ({
|
|
46376
|
+
/** Device ID reported by Arlo. */
|
|
46377
|
+
device_id?: (string | undefined) | undefined;
|
|
46378
|
+
/** Device name reported by Arlo. */
|
|
46379
|
+
device_name?: (string | undefined) | undefined;
|
|
46380
|
+
/** Model ID reported by Arlo. */
|
|
46381
|
+
model_id?: (string | undefined) | undefined;
|
|
46382
|
+
/** Hardware version reported by Arlo. */
|
|
46383
|
+
hardware_version?: (string | undefined) | undefined;
|
|
46384
|
+
/** Firmware version reported by Arlo. */
|
|
46385
|
+
firmware_version?: (string | undefined) | undefined;
|
|
46386
|
+
} | undefined) | undefined;
|
|
45874
46387
|
/** Metadata for a Ring device. */
|
|
45875
46388
|
ring_metadata?: {
|
|
45876
46389
|
/** Device ID for a Ring device. */
|
|
@@ -46695,6 +47208,8 @@ export type Routes = {
|
|
|
46695
47208
|
can_hvac_heat_cool?: boolean | undefined;
|
|
46696
47209
|
/** Indicates whether the thermostat can be turned off. */
|
|
46697
47210
|
can_turn_off_hvac?: boolean | undefined;
|
|
47211
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
47212
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
46698
47213
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
46699
47214
|
can_simulate_removal?: boolean | undefined;
|
|
46700
47215
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -46745,7 +47260,7 @@ export type Routes = {
|
|
|
46745
47260
|
jsonResponse: {
|
|
46746
47261
|
device_providers: {
|
|
46747
47262
|
/** Name of the device provider. */
|
|
46748
|
-
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
|
|
47263
|
+
device_provider_name: 'hotek' | 'dormakaba_community' | 'legic_connect' | 'akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'schlage' | 'smartthings' | 'yale' | 'genie' | 'doorking' | 'salto' | 'salto_ks' | 'salto_ks_accept' | 'lockly' | 'ttlock' | 'linear' | 'noiseaware' | 'nuki' | 'igloo' | 'kwikset' | 'minut' | 'my_2n' | 'controlbyweb' | 'nest' | 'igloohome' | 'ecobee' | 'four_suites' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'pti' | 'wyze' | 'seam_passport' | 'visionline' | 'assa_abloy_credential_service' | 'tedee' | 'honeywell_resideo' | 'first_alert' | 'latch' | 'akiles' | 'assa_abloy_vostio' | 'assa_abloy_vostio_credential_service' | 'tado' | 'salto_space' | 'sensi' | 'keynest' | 'korelock' | 'keyincode' | 'dormakaba_ambiance' | 'ultraloq' | 'yacan' | 'dusaw' | 'sifely' | 'thirty_three_lock' | 'ring' | 'tapo' | 'arlo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'aqara';
|
|
46749
47264
|
/** Display name for the device provider. */
|
|
46750
47265
|
display_name: string;
|
|
46751
47266
|
/** Image URL for the device provider. */
|
|
@@ -46768,6 +47283,8 @@ export type Routes = {
|
|
|
46768
47283
|
can_hvac_heat_cool?: boolean | undefined;
|
|
46769
47284
|
/** Indicates whether the thermostat can be turned off. */
|
|
46770
47285
|
can_turn_off_hvac?: boolean | undefined;
|
|
47286
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
47287
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
46771
47288
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
46772
47289
|
can_simulate_removal?: boolean | undefined;
|
|
46773
47290
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -46923,7 +47440,7 @@ export type Routes = {
|
|
|
46923
47440
|
/** ID of the device. */
|
|
46924
47441
|
device_id: string;
|
|
46925
47442
|
/** Type of the device. */
|
|
46926
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
47443
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
46927
47444
|
/** Unique identifier for the account associated with the device. */
|
|
46928
47445
|
connected_account_id: string;
|
|
46929
47446
|
/** Location information for the device. */
|
|
@@ -47383,6 +47900,8 @@ export type Routes = {
|
|
|
47383
47900
|
can_hvac_heat_cool?: boolean | undefined;
|
|
47384
47901
|
/** Indicates whether the thermostat can be turned off. */
|
|
47385
47902
|
can_turn_off_hvac?: boolean | undefined;
|
|
47903
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
47904
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
47386
47905
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
47387
47906
|
can_simulate_removal?: boolean | undefined;
|
|
47388
47907
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -47426,11 +47945,11 @@ export type Routes = {
|
|
|
47426
47945
|
/** ID of the Connect Webview for which you want to list devices. */
|
|
47427
47946
|
connect_webview_id?: string | undefined;
|
|
47428
47947
|
/** Device type for which you want to list devices. */
|
|
47429
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera')) | undefined;
|
|
47948
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera')) | undefined;
|
|
47430
47949
|
/** Array of device types for which you want to list devices. */
|
|
47431
|
-
device_types?: (('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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera'))[] | undefined;
|
|
47950
|
+
device_types?: (('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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera'))[] | undefined;
|
|
47432
47951
|
/** Manufacturer for which you want to list devices. */
|
|
47433
|
-
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
|
|
47952
|
+
manufacturer?: ('akuvox' | 'august' | 'avigilon_alta' | 'brivo' | 'butterflymx' | 'doorking' | 'four_suites' | 'genie' | 'igloo' | 'keywe' | 'kwikset' | 'linear' | 'nuki' | 'philia' | 'salto' | 'samsung' | 'schlage' | 'seam' | 'unknown' | 'wyze' | 'yale' | 'two_n' | 'ttlock' | 'igloohome' | 'controlbyweb' | 'tedee' | 'keyincode' | 'akiles' | 'aqara' | 'ecobee' | 'eufy' | 'dormakaba_oracode' | 'dormakaba_oracode_iho' | 'honeywell_resideo' | 'keynest' | 'korelock' | 'lockly' | 'minut' | 'nest' | 'noiseaware' | 'sensi' | 'smartthings' | 'tado' | 'ultraloq' | 'ring' | 'tapo' | 'arlo' | 'ical' | 'lodgify' | 'hostaway' | 'guesty' | 'acuity_scheduling' | 'omnitec' | 'kisi' | 'slack' | 'yacan') | undefined;
|
|
47434
47953
|
/** Array of device IDs for which you want to list devices. */
|
|
47435
47954
|
device_ids?: string[] | undefined;
|
|
47436
47955
|
/** Timestamp by which to limit returned devices. Returns devices created before this timestamp. */
|
|
@@ -47438,9 +47957,9 @@ export type Routes = {
|
|
|
47438
47957
|
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
47439
47958
|
page_cursor?: (string | undefined) | null;
|
|
47440
47959
|
/** */
|
|
47441
|
-
include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
47960
|
+
include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
47442
47961
|
/** */
|
|
47443
|
-
exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
47962
|
+
exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_activate_weekly_program' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
|
|
47444
47963
|
/** String for which to search. Filters returned devices to include all records that satisfy a partial match using `device_id` (full or partial UUID prefix, minimum 4 characters), `connected_account_id`, `display_name`, `custom_metadata` or `location.location_name`. */
|
|
47445
47964
|
search?: string | undefined;
|
|
47446
47965
|
/** Numerical limit on the number of devices to return. */
|
|
@@ -47452,7 +47971,7 @@ export type Routes = {
|
|
|
47452
47971
|
/** ID of the device. */
|
|
47453
47972
|
device_id: string;
|
|
47454
47973
|
/** Type of the device. */
|
|
47455
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
47974
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
47456
47975
|
/** Unique identifier for the account associated with the device. */
|
|
47457
47976
|
connected_account_id: string;
|
|
47458
47977
|
/** Location information for the device. */
|
|
@@ -47912,6 +48431,8 @@ export type Routes = {
|
|
|
47912
48431
|
can_hvac_heat_cool?: boolean | undefined;
|
|
47913
48432
|
/** Indicates whether the thermostat can be turned off. */
|
|
47914
48433
|
can_turn_off_hvac?: boolean | undefined;
|
|
48434
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
48435
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
47915
48436
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
47916
48437
|
can_simulate_removal?: boolean | undefined;
|
|
47917
48438
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -56714,6 +57235,41 @@ export type Routes = {
|
|
|
56714
57235
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
56715
57236
|
message: string;
|
|
56716
57237
|
};
|
|
57238
|
+
} | {
|
|
57239
|
+
/** ID of the action attempt. */
|
|
57240
|
+
action_attempt_id: string;
|
|
57241
|
+
status: 'pending';
|
|
57242
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
57243
|
+
result: null;
|
|
57244
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
57245
|
+
error: null;
|
|
57246
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
57247
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
57248
|
+
} | {
|
|
57249
|
+
/** ID of the action attempt. */
|
|
57250
|
+
action_attempt_id: string;
|
|
57251
|
+
status: 'success';
|
|
57252
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
57253
|
+
error: null;
|
|
57254
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
57255
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
57256
|
+
/** Result of the action. */
|
|
57257
|
+
result: {};
|
|
57258
|
+
} | {
|
|
57259
|
+
/** ID of the action attempt. */
|
|
57260
|
+
action_attempt_id: string;
|
|
57261
|
+
status: 'error';
|
|
57262
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
57263
|
+
result: null;
|
|
57264
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
57265
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
57266
|
+
/** Error associated with the action. */
|
|
57267
|
+
error: {
|
|
57268
|
+
/** Type of the error. */
|
|
57269
|
+
type: string;
|
|
57270
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
57271
|
+
message: string;
|
|
57272
|
+
};
|
|
56717
57273
|
} | {
|
|
56718
57274
|
/** ID of the action attempt. */
|
|
56719
57275
|
action_attempt_id: string;
|
|
@@ -57141,7 +57697,7 @@ export type Routes = {
|
|
|
57141
57697
|
/** ID of the device. */
|
|
57142
57698
|
device_id: string;
|
|
57143
57699
|
/** Type of the device. */
|
|
57144
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
57700
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
57145
57701
|
/** IDs of the spaces the device is in. */
|
|
57146
57702
|
space_ids: string[];
|
|
57147
57703
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -57805,6 +58361,19 @@ export type Routes = {
|
|
|
57805
58361
|
/** Hardware version reported by the camera. */
|
|
57806
58362
|
hardware_version?: (string | undefined) | undefined;
|
|
57807
58363
|
} | undefined) | undefined;
|
|
58364
|
+
/** Metadata for an Arlo camera. */
|
|
58365
|
+
arlo_metadata?: ({
|
|
58366
|
+
/** Device ID reported by Arlo. */
|
|
58367
|
+
device_id?: (string | undefined) | undefined;
|
|
58368
|
+
/** Device name reported by Arlo. */
|
|
58369
|
+
device_name?: (string | undefined) | undefined;
|
|
58370
|
+
/** Model ID reported by Arlo. */
|
|
58371
|
+
model_id?: (string | undefined) | undefined;
|
|
58372
|
+
/** Hardware version reported by Arlo. */
|
|
58373
|
+
hardware_version?: (string | undefined) | undefined;
|
|
58374
|
+
/** Firmware version reported by Arlo. */
|
|
58375
|
+
firmware_version?: (string | undefined) | undefined;
|
|
58376
|
+
} | undefined) | undefined;
|
|
57808
58377
|
/** Metadata for a Ring device. */
|
|
57809
58378
|
ring_metadata?: {
|
|
57810
58379
|
/** Device ID for a Ring device. */
|
|
@@ -58629,6 +59198,8 @@ export type Routes = {
|
|
|
58629
59198
|
can_hvac_heat_cool?: boolean | undefined;
|
|
58630
59199
|
/** Indicates whether the thermostat can be turned off. */
|
|
58631
59200
|
can_turn_off_hvac?: boolean | undefined;
|
|
59201
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
59202
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
58632
59203
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
58633
59204
|
can_simulate_removal?: boolean | undefined;
|
|
58634
59205
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -58659,7 +59230,7 @@ export type Routes = {
|
|
|
58659
59230
|
/** ID of the device. */
|
|
58660
59231
|
device_id: string;
|
|
58661
59232
|
/** Type of the device. */
|
|
58662
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
59233
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
58663
59234
|
/** IDs of the spaces the device is in. */
|
|
58664
59235
|
space_ids: string[];
|
|
58665
59236
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -59323,6 +59894,19 @@ export type Routes = {
|
|
|
59323
59894
|
/** Hardware version reported by the camera. */
|
|
59324
59895
|
hardware_version?: (string | undefined) | undefined;
|
|
59325
59896
|
} | undefined) | undefined;
|
|
59897
|
+
/** Metadata for an Arlo camera. */
|
|
59898
|
+
arlo_metadata?: ({
|
|
59899
|
+
/** Device ID reported by Arlo. */
|
|
59900
|
+
device_id?: (string | undefined) | undefined;
|
|
59901
|
+
/** Device name reported by Arlo. */
|
|
59902
|
+
device_name?: (string | undefined) | undefined;
|
|
59903
|
+
/** Model ID reported by Arlo. */
|
|
59904
|
+
model_id?: (string | undefined) | undefined;
|
|
59905
|
+
/** Hardware version reported by Arlo. */
|
|
59906
|
+
hardware_version?: (string | undefined) | undefined;
|
|
59907
|
+
/** Firmware version reported by Arlo. */
|
|
59908
|
+
firmware_version?: (string | undefined) | undefined;
|
|
59909
|
+
} | undefined) | undefined;
|
|
59326
59910
|
/** Metadata for a Ring device. */
|
|
59327
59911
|
ring_metadata?: {
|
|
59328
59912
|
/** Device ID for a Ring device. */
|
|
@@ -60147,6 +60731,8 @@ export type Routes = {
|
|
|
60147
60731
|
can_hvac_heat_cool?: boolean | undefined;
|
|
60148
60732
|
/** Indicates whether the thermostat can be turned off. */
|
|
60149
60733
|
can_turn_off_hvac?: boolean | undefined;
|
|
60734
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
60735
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
60150
60736
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
60151
60737
|
can_simulate_removal?: boolean | undefined;
|
|
60152
60738
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -60200,7 +60786,7 @@ export type Routes = {
|
|
|
60200
60786
|
/** ID of the device. */
|
|
60201
60787
|
device_id: string;
|
|
60202
60788
|
/** Type of the device. */
|
|
60203
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
60789
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
60204
60790
|
/** IDs of the spaces the device is in. */
|
|
60205
60791
|
space_ids: string[];
|
|
60206
60792
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -60864,6 +61450,19 @@ export type Routes = {
|
|
|
60864
61450
|
/** Hardware version reported by the camera. */
|
|
60865
61451
|
hardware_version?: (string | undefined) | undefined;
|
|
60866
61452
|
} | undefined) | undefined;
|
|
61453
|
+
/** Metadata for an Arlo camera. */
|
|
61454
|
+
arlo_metadata?: ({
|
|
61455
|
+
/** Device ID reported by Arlo. */
|
|
61456
|
+
device_id?: (string | undefined) | undefined;
|
|
61457
|
+
/** Device name reported by Arlo. */
|
|
61458
|
+
device_name?: (string | undefined) | undefined;
|
|
61459
|
+
/** Model ID reported by Arlo. */
|
|
61460
|
+
model_id?: (string | undefined) | undefined;
|
|
61461
|
+
/** Hardware version reported by Arlo. */
|
|
61462
|
+
hardware_version?: (string | undefined) | undefined;
|
|
61463
|
+
/** Firmware version reported by Arlo. */
|
|
61464
|
+
firmware_version?: (string | undefined) | undefined;
|
|
61465
|
+
} | undefined) | undefined;
|
|
60867
61466
|
/** Metadata for a Ring device. */
|
|
60868
61467
|
ring_metadata?: {
|
|
60869
61468
|
/** Device ID for a Ring device. */
|
|
@@ -61688,6 +62287,8 @@ export type Routes = {
|
|
|
61688
62287
|
can_hvac_heat_cool?: boolean | undefined;
|
|
61689
62288
|
/** Indicates whether the thermostat can be turned off. */
|
|
61690
62289
|
can_turn_off_hvac?: boolean | undefined;
|
|
62290
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
62291
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
61691
62292
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
61692
62293
|
can_simulate_removal?: boolean | undefined;
|
|
61693
62294
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -61717,7 +62318,7 @@ export type Routes = {
|
|
|
61717
62318
|
/** ID of the device. */
|
|
61718
62319
|
device_id: string;
|
|
61719
62320
|
/** Type of the device. */
|
|
61720
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
62321
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
61721
62322
|
/** IDs of the spaces the device is in. */
|
|
61722
62323
|
space_ids: string[];
|
|
61723
62324
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -62381,6 +62982,19 @@ export type Routes = {
|
|
|
62381
62982
|
/** Hardware version reported by the camera. */
|
|
62382
62983
|
hardware_version?: (string | undefined) | undefined;
|
|
62383
62984
|
} | undefined) | undefined;
|
|
62985
|
+
/** Metadata for an Arlo camera. */
|
|
62986
|
+
arlo_metadata?: ({
|
|
62987
|
+
/** Device ID reported by Arlo. */
|
|
62988
|
+
device_id?: (string | undefined) | undefined;
|
|
62989
|
+
/** Device name reported by Arlo. */
|
|
62990
|
+
device_name?: (string | undefined) | undefined;
|
|
62991
|
+
/** Model ID reported by Arlo. */
|
|
62992
|
+
model_id?: (string | undefined) | undefined;
|
|
62993
|
+
/** Hardware version reported by Arlo. */
|
|
62994
|
+
hardware_version?: (string | undefined) | undefined;
|
|
62995
|
+
/** Firmware version reported by Arlo. */
|
|
62996
|
+
firmware_version?: (string | undefined) | undefined;
|
|
62997
|
+
} | undefined) | undefined;
|
|
62384
62998
|
/** Metadata for a Ring device. */
|
|
62385
62999
|
ring_metadata?: {
|
|
62386
63000
|
/** Device ID for a Ring device. */
|
|
@@ -63205,6 +63819,8 @@ export type Routes = {
|
|
|
63205
63819
|
can_hvac_heat_cool?: boolean | undefined;
|
|
63206
63820
|
/** Indicates whether the thermostat can be turned off. */
|
|
63207
63821
|
can_turn_off_hvac?: boolean | undefined;
|
|
63822
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
63823
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
63208
63824
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
63209
63825
|
can_simulate_removal?: boolean | undefined;
|
|
63210
63826
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -64636,6 +65252,41 @@ export type Routes = {
|
|
|
64636
65252
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
64637
65253
|
message: string;
|
|
64638
65254
|
};
|
|
65255
|
+
} | {
|
|
65256
|
+
/** ID of the action attempt. */
|
|
65257
|
+
action_attempt_id: string;
|
|
65258
|
+
status: 'pending';
|
|
65259
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
65260
|
+
result: null;
|
|
65261
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
65262
|
+
error: null;
|
|
65263
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
65264
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
65265
|
+
} | {
|
|
65266
|
+
/** ID of the action attempt. */
|
|
65267
|
+
action_attempt_id: string;
|
|
65268
|
+
status: 'success';
|
|
65269
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
65270
|
+
error: null;
|
|
65271
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
65272
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
65273
|
+
/** Result of the action. */
|
|
65274
|
+
result: {};
|
|
65275
|
+
} | {
|
|
65276
|
+
/** ID of the action attempt. */
|
|
65277
|
+
action_attempt_id: string;
|
|
65278
|
+
status: 'error';
|
|
65279
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
65280
|
+
result: null;
|
|
65281
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
65282
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
65283
|
+
/** Error associated with the action. */
|
|
65284
|
+
error: {
|
|
65285
|
+
/** Type of the error. */
|
|
65286
|
+
type: string;
|
|
65287
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
65288
|
+
message: string;
|
|
65289
|
+
};
|
|
64639
65290
|
} | {
|
|
64640
65291
|
/** ID of the action attempt. */
|
|
64641
65292
|
action_attempt_id: string;
|
|
@@ -66448,6 +67099,41 @@ export type Routes = {
|
|
|
66448
67099
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
66449
67100
|
message: string;
|
|
66450
67101
|
};
|
|
67102
|
+
} | {
|
|
67103
|
+
/** ID of the action attempt. */
|
|
67104
|
+
action_attempt_id: string;
|
|
67105
|
+
status: 'pending';
|
|
67106
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
67107
|
+
result: null;
|
|
67108
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
67109
|
+
error: null;
|
|
67110
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
67111
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
67112
|
+
} | {
|
|
67113
|
+
/** ID of the action attempt. */
|
|
67114
|
+
action_attempt_id: string;
|
|
67115
|
+
status: 'success';
|
|
67116
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
67117
|
+
error: null;
|
|
67118
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
67119
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
67120
|
+
/** Result of the action. */
|
|
67121
|
+
result: {};
|
|
67122
|
+
} | {
|
|
67123
|
+
/** ID of the action attempt. */
|
|
67124
|
+
action_attempt_id: string;
|
|
67125
|
+
status: 'error';
|
|
67126
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
67127
|
+
result: null;
|
|
67128
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
67129
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
67130
|
+
/** Error associated with the action. */
|
|
67131
|
+
error: {
|
|
67132
|
+
/** Type of the error. */
|
|
67133
|
+
type: string;
|
|
67134
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
67135
|
+
message: string;
|
|
67136
|
+
};
|
|
66451
67137
|
} | {
|
|
66452
67138
|
/** ID of the action attempt. */
|
|
66453
67139
|
action_attempt_id: string;
|
|
@@ -68258,6 +68944,41 @@ export type Routes = {
|
|
|
68258
68944
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
68259
68945
|
message: string;
|
|
68260
68946
|
};
|
|
68947
|
+
} | {
|
|
68948
|
+
/** ID of the action attempt. */
|
|
68949
|
+
action_attempt_id: string;
|
|
68950
|
+
status: 'pending';
|
|
68951
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
68952
|
+
result: null;
|
|
68953
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
68954
|
+
error: null;
|
|
68955
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
68956
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
68957
|
+
} | {
|
|
68958
|
+
/** ID of the action attempt. */
|
|
68959
|
+
action_attempt_id: string;
|
|
68960
|
+
status: 'success';
|
|
68961
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
68962
|
+
error: null;
|
|
68963
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
68964
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
68965
|
+
/** Result of the action. */
|
|
68966
|
+
result: {};
|
|
68967
|
+
} | {
|
|
68968
|
+
/** ID of the action attempt. */
|
|
68969
|
+
action_attempt_id: string;
|
|
68970
|
+
status: 'error';
|
|
68971
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
68972
|
+
result: null;
|
|
68973
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
68974
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
68975
|
+
/** Error associated with the action. */
|
|
68976
|
+
error: {
|
|
68977
|
+
/** Type of the error. */
|
|
68978
|
+
type: string;
|
|
68979
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
68980
|
+
message: string;
|
|
68981
|
+
};
|
|
68261
68982
|
} | {
|
|
68262
68983
|
/** ID of the action attempt. */
|
|
68263
68984
|
action_attempt_id: string;
|
|
@@ -70070,6 +70791,41 @@ export type Routes = {
|
|
|
70070
70791
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
70071
70792
|
message: string;
|
|
70072
70793
|
};
|
|
70794
|
+
} | {
|
|
70795
|
+
/** ID of the action attempt. */
|
|
70796
|
+
action_attempt_id: string;
|
|
70797
|
+
status: 'pending';
|
|
70798
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
70799
|
+
result: null;
|
|
70800
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
70801
|
+
error: null;
|
|
70802
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
70803
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
70804
|
+
} | {
|
|
70805
|
+
/** ID of the action attempt. */
|
|
70806
|
+
action_attempt_id: string;
|
|
70807
|
+
status: 'success';
|
|
70808
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
70809
|
+
error: null;
|
|
70810
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
70811
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
70812
|
+
/** Result of the action. */
|
|
70813
|
+
result: {};
|
|
70814
|
+
} | {
|
|
70815
|
+
/** ID of the action attempt. */
|
|
70816
|
+
action_attempt_id: string;
|
|
70817
|
+
status: 'error';
|
|
70818
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
70819
|
+
result: null;
|
|
70820
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
70821
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
70822
|
+
/** Error associated with the action. */
|
|
70823
|
+
error: {
|
|
70824
|
+
/** Type of the error. */
|
|
70825
|
+
type: string;
|
|
70826
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
70827
|
+
message: string;
|
|
70828
|
+
};
|
|
70073
70829
|
} | {
|
|
70074
70830
|
/** ID of the action attempt. */
|
|
70075
70831
|
action_attempt_id: string;
|
|
@@ -70504,7 +71260,7 @@ export type Routes = {
|
|
|
70504
71260
|
/** ID of the device. */
|
|
70505
71261
|
device_id: string;
|
|
70506
71262
|
/** Type of the device. */
|
|
70507
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
71263
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
70508
71264
|
/** IDs of the spaces the device is in. */
|
|
70509
71265
|
space_ids: string[];
|
|
70510
71266
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -71168,6 +71924,19 @@ export type Routes = {
|
|
|
71168
71924
|
/** Hardware version reported by the camera. */
|
|
71169
71925
|
hardware_version?: (string | undefined) | undefined;
|
|
71170
71926
|
} | undefined) | undefined;
|
|
71927
|
+
/** Metadata for an Arlo camera. */
|
|
71928
|
+
arlo_metadata?: ({
|
|
71929
|
+
/** Device ID reported by Arlo. */
|
|
71930
|
+
device_id?: (string | undefined) | undefined;
|
|
71931
|
+
/** Device name reported by Arlo. */
|
|
71932
|
+
device_name?: (string | undefined) | undefined;
|
|
71933
|
+
/** Model ID reported by Arlo. */
|
|
71934
|
+
model_id?: (string | undefined) | undefined;
|
|
71935
|
+
/** Hardware version reported by Arlo. */
|
|
71936
|
+
hardware_version?: (string | undefined) | undefined;
|
|
71937
|
+
/** Firmware version reported by Arlo. */
|
|
71938
|
+
firmware_version?: (string | undefined) | undefined;
|
|
71939
|
+
} | undefined) | undefined;
|
|
71171
71940
|
/** Metadata for a Ring device. */
|
|
71172
71941
|
ring_metadata?: {
|
|
71173
71942
|
/** Device ID for a Ring device. */
|
|
@@ -71992,6 +72761,8 @@ export type Routes = {
|
|
|
71992
72761
|
can_hvac_heat_cool?: boolean | undefined;
|
|
71993
72762
|
/** Indicates whether the thermostat can be turned off. */
|
|
71994
72763
|
can_turn_off_hvac?: boolean | undefined;
|
|
72764
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
72765
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
71995
72766
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
71996
72767
|
can_simulate_removal?: boolean | undefined;
|
|
71997
72768
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -72021,7 +72792,7 @@ export type Routes = {
|
|
|
72021
72792
|
/** ID of the device. */
|
|
72022
72793
|
device_id: string;
|
|
72023
72794
|
/** Type of the device. */
|
|
72024
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
72795
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
72025
72796
|
/** IDs of the spaces the device is in. */
|
|
72026
72797
|
space_ids: string[];
|
|
72027
72798
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -72685,6 +73456,19 @@ export type Routes = {
|
|
|
72685
73456
|
/** Hardware version reported by the camera. */
|
|
72686
73457
|
hardware_version?: (string | undefined) | undefined;
|
|
72687
73458
|
} | undefined) | undefined;
|
|
73459
|
+
/** Metadata for an Arlo camera. */
|
|
73460
|
+
arlo_metadata?: ({
|
|
73461
|
+
/** Device ID reported by Arlo. */
|
|
73462
|
+
device_id?: (string | undefined) | undefined;
|
|
73463
|
+
/** Device name reported by Arlo. */
|
|
73464
|
+
device_name?: (string | undefined) | undefined;
|
|
73465
|
+
/** Model ID reported by Arlo. */
|
|
73466
|
+
model_id?: (string | undefined) | undefined;
|
|
73467
|
+
/** Hardware version reported by Arlo. */
|
|
73468
|
+
hardware_version?: (string | undefined) | undefined;
|
|
73469
|
+
/** Firmware version reported by Arlo. */
|
|
73470
|
+
firmware_version?: (string | undefined) | undefined;
|
|
73471
|
+
} | undefined) | undefined;
|
|
72688
73472
|
/** Metadata for a Ring device. */
|
|
72689
73473
|
ring_metadata?: {
|
|
72690
73474
|
/** Device ID for a Ring device. */
|
|
@@ -73509,6 +74293,8 @@ export type Routes = {
|
|
|
73509
74293
|
can_hvac_heat_cool?: boolean | undefined;
|
|
73510
74294
|
/** Indicates whether the thermostat can be turned off. */
|
|
73511
74295
|
can_turn_off_hvac?: boolean | undefined;
|
|
74296
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
74297
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
73512
74298
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
73513
74299
|
can_simulate_removal?: boolean | undefined;
|
|
73514
74300
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -74950,6 +75736,41 @@ export type Routes = {
|
|
|
74950
75736
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
74951
75737
|
message: string;
|
|
74952
75738
|
};
|
|
75739
|
+
} | {
|
|
75740
|
+
/** ID of the action attempt. */
|
|
75741
|
+
action_attempt_id: string;
|
|
75742
|
+
status: 'pending';
|
|
75743
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
75744
|
+
result: null;
|
|
75745
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
75746
|
+
error: null;
|
|
75747
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
75748
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
75749
|
+
} | {
|
|
75750
|
+
/** ID of the action attempt. */
|
|
75751
|
+
action_attempt_id: string;
|
|
75752
|
+
status: 'success';
|
|
75753
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
75754
|
+
error: null;
|
|
75755
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
75756
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
75757
|
+
/** Result of the action. */
|
|
75758
|
+
result: {};
|
|
75759
|
+
} | {
|
|
75760
|
+
/** ID of the action attempt. */
|
|
75761
|
+
action_attempt_id: string;
|
|
75762
|
+
status: 'error';
|
|
75763
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
75764
|
+
result: null;
|
|
75765
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
75766
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
75767
|
+
/** Error associated with the action. */
|
|
75768
|
+
error: {
|
|
75769
|
+
/** Type of the error. */
|
|
75770
|
+
type: string;
|
|
75771
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
75772
|
+
message: string;
|
|
75773
|
+
};
|
|
74953
75774
|
} | {
|
|
74954
75775
|
/** ID of the action attempt. */
|
|
74955
75776
|
action_attempt_id: string;
|
|
@@ -76781,6 +77602,41 @@ export type Routes = {
|
|
|
76781
77602
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
76782
77603
|
message: string;
|
|
76783
77604
|
};
|
|
77605
|
+
} | {
|
|
77606
|
+
/** ID of the action attempt. */
|
|
77607
|
+
action_attempt_id: string;
|
|
77608
|
+
status: 'pending';
|
|
77609
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
77610
|
+
result: null;
|
|
77611
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
77612
|
+
error: null;
|
|
77613
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
77614
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
77615
|
+
} | {
|
|
77616
|
+
/** ID of the action attempt. */
|
|
77617
|
+
action_attempt_id: string;
|
|
77618
|
+
status: 'success';
|
|
77619
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
77620
|
+
error: null;
|
|
77621
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
77622
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
77623
|
+
/** Result of the action. */
|
|
77624
|
+
result: {};
|
|
77625
|
+
} | {
|
|
77626
|
+
/** ID of the action attempt. */
|
|
77627
|
+
action_attempt_id: string;
|
|
77628
|
+
status: 'error';
|
|
77629
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
77630
|
+
result: null;
|
|
77631
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
77632
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
77633
|
+
/** Error associated with the action. */
|
|
77634
|
+
error: {
|
|
77635
|
+
/** Type of the error. */
|
|
77636
|
+
type: string;
|
|
77637
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
77638
|
+
message: string;
|
|
77639
|
+
};
|
|
76784
77640
|
} | {
|
|
76785
77641
|
/** ID of the action attempt. */
|
|
76786
77642
|
action_attempt_id: string;
|
|
@@ -78668,6 +79524,41 @@ export type Routes = {
|
|
|
78668
79524
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
78669
79525
|
message: string;
|
|
78670
79526
|
};
|
|
79527
|
+
} | {
|
|
79528
|
+
/** ID of the action attempt. */
|
|
79529
|
+
action_attempt_id: string;
|
|
79530
|
+
status: 'pending';
|
|
79531
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
79532
|
+
result: null;
|
|
79533
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
79534
|
+
error: null;
|
|
79535
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
79536
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
79537
|
+
} | {
|
|
79538
|
+
/** ID of the action attempt. */
|
|
79539
|
+
action_attempt_id: string;
|
|
79540
|
+
status: 'success';
|
|
79541
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
79542
|
+
error: null;
|
|
79543
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
79544
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
79545
|
+
/** Result of the action. */
|
|
79546
|
+
result: {};
|
|
79547
|
+
} | {
|
|
79548
|
+
/** ID of the action attempt. */
|
|
79549
|
+
action_attempt_id: string;
|
|
79550
|
+
status: 'error';
|
|
79551
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
79552
|
+
result: null;
|
|
79553
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
79554
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
79555
|
+
/** Error associated with the action. */
|
|
79556
|
+
error: {
|
|
79557
|
+
/** Type of the error. */
|
|
79558
|
+
type: string;
|
|
79559
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
79560
|
+
message: string;
|
|
79561
|
+
};
|
|
78671
79562
|
} | {
|
|
78672
79563
|
/** ID of the action attempt. */
|
|
78673
79564
|
action_attempt_id: string;
|
|
@@ -82338,6 +83229,41 @@ export type Routes = {
|
|
|
82338
83229
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
82339
83230
|
message: string;
|
|
82340
83231
|
};
|
|
83232
|
+
} | {
|
|
83233
|
+
/** ID of the action attempt. */
|
|
83234
|
+
action_attempt_id: string;
|
|
83235
|
+
status: 'pending';
|
|
83236
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
83237
|
+
result: null;
|
|
83238
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
83239
|
+
error: null;
|
|
83240
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
83241
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
83242
|
+
} | {
|
|
83243
|
+
/** ID of the action attempt. */
|
|
83244
|
+
action_attempt_id: string;
|
|
83245
|
+
status: 'success';
|
|
83246
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
83247
|
+
error: null;
|
|
83248
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
83249
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
83250
|
+
/** Result of the action. */
|
|
83251
|
+
result: {};
|
|
83252
|
+
} | {
|
|
83253
|
+
/** ID of the action attempt. */
|
|
83254
|
+
action_attempt_id: string;
|
|
83255
|
+
status: 'error';
|
|
83256
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
83257
|
+
result: null;
|
|
83258
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
83259
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
83260
|
+
/** Error associated with the action. */
|
|
83261
|
+
error: {
|
|
83262
|
+
/** Type of the error. */
|
|
83263
|
+
type: string;
|
|
83264
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
83265
|
+
message: string;
|
|
83266
|
+
};
|
|
82341
83267
|
} | {
|
|
82342
83268
|
/** ID of the action attempt. */
|
|
82343
83269
|
action_attempt_id: string;
|
|
@@ -93107,7 +94033,7 @@ export type Routes = {
|
|
|
93107
94033
|
/** ID of the device. */
|
|
93108
94034
|
device_id: string;
|
|
93109
94035
|
/** Type of the device. */
|
|
93110
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
94036
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
93111
94037
|
/** IDs of the spaces the device is in. */
|
|
93112
94038
|
space_ids: string[];
|
|
93113
94039
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -93771,6 +94697,19 @@ export type Routes = {
|
|
|
93771
94697
|
/** Hardware version reported by the camera. */
|
|
93772
94698
|
hardware_version?: (string | undefined) | undefined;
|
|
93773
94699
|
} | undefined) | undefined;
|
|
94700
|
+
/** Metadata for an Arlo camera. */
|
|
94701
|
+
arlo_metadata?: ({
|
|
94702
|
+
/** Device ID reported by Arlo. */
|
|
94703
|
+
device_id?: (string | undefined) | undefined;
|
|
94704
|
+
/** Device name reported by Arlo. */
|
|
94705
|
+
device_name?: (string | undefined) | undefined;
|
|
94706
|
+
/** Model ID reported by Arlo. */
|
|
94707
|
+
model_id?: (string | undefined) | undefined;
|
|
94708
|
+
/** Hardware version reported by Arlo. */
|
|
94709
|
+
hardware_version?: (string | undefined) | undefined;
|
|
94710
|
+
/** Firmware version reported by Arlo. */
|
|
94711
|
+
firmware_version?: (string | undefined) | undefined;
|
|
94712
|
+
} | undefined) | undefined;
|
|
93774
94713
|
/** Metadata for a Ring device. */
|
|
93775
94714
|
ring_metadata?: {
|
|
93776
94715
|
/** Device ID for a Ring device. */
|
|
@@ -94595,6 +95534,8 @@ export type Routes = {
|
|
|
94595
95534
|
can_hvac_heat_cool?: boolean | undefined;
|
|
94596
95535
|
/** Indicates whether the thermostat can be turned off. */
|
|
94597
95536
|
can_turn_off_hvac?: boolean | undefined;
|
|
95537
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
95538
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
94598
95539
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
94599
95540
|
can_simulate_removal?: boolean | undefined;
|
|
94600
95541
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -96913,6 +97854,41 @@ export type Routes = {
|
|
|
96913
97854
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
96914
97855
|
message: string;
|
|
96915
97856
|
};
|
|
97857
|
+
} | {
|
|
97858
|
+
/** ID of the action attempt. */
|
|
97859
|
+
action_attempt_id: string;
|
|
97860
|
+
status: 'pending';
|
|
97861
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97862
|
+
result: null;
|
|
97863
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
97864
|
+
error: null;
|
|
97865
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
97866
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
97867
|
+
} | {
|
|
97868
|
+
/** ID of the action attempt. */
|
|
97869
|
+
action_attempt_id: string;
|
|
97870
|
+
status: 'success';
|
|
97871
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97872
|
+
error: null;
|
|
97873
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
97874
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
97875
|
+
/** Result of the action. */
|
|
97876
|
+
result: {};
|
|
97877
|
+
} | {
|
|
97878
|
+
/** ID of the action attempt. */
|
|
97879
|
+
action_attempt_id: string;
|
|
97880
|
+
status: 'error';
|
|
97881
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97882
|
+
result: null;
|
|
97883
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
97884
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
97885
|
+
/** Error associated with the action. */
|
|
97886
|
+
error: {
|
|
97887
|
+
/** Type of the error. */
|
|
97888
|
+
type: string;
|
|
97889
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97890
|
+
message: string;
|
|
97891
|
+
};
|
|
96916
97892
|
} | {
|
|
96917
97893
|
/** ID of the action attempt. */
|
|
96918
97894
|
action_attempt_id: string;
|
|
@@ -97322,17 +98298,13 @@ export type Routes = {
|
|
|
97322
98298
|
};
|
|
97323
98299
|
maxDuration: undefined;
|
|
97324
98300
|
};
|
|
97325
|
-
'/thermostats/
|
|
97326
|
-
route: '/thermostats/
|
|
98301
|
+
'/thermostats/activate_weekly_program': {
|
|
98302
|
+
route: '/thermostats/activate_weekly_program';
|
|
97327
98303
|
method: 'POST';
|
|
97328
98304
|
queryParams: {};
|
|
97329
98305
|
jsonBody: {
|
|
97330
|
-
/** ID of the thermostat device that you want to
|
|
98306
|
+
/** ID of the thermostat device that you want to return to its weekly program. */
|
|
97331
98307
|
device_id: string;
|
|
97332
|
-
/** [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
|
|
97333
|
-
cooling_set_point_celsius?: number | undefined;
|
|
97334
|
-
/** [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
|
|
97335
|
-
cooling_set_point_fahrenheit?: number | undefined;
|
|
97336
98308
|
/** */
|
|
97337
98309
|
sync?: boolean;
|
|
97338
98310
|
};
|
|
@@ -98729,6 +99701,41 @@ export type Routes = {
|
|
|
98729
99701
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
98730
99702
|
message: string;
|
|
98731
99703
|
};
|
|
99704
|
+
} | {
|
|
99705
|
+
/** ID of the action attempt. */
|
|
99706
|
+
action_attempt_id: string;
|
|
99707
|
+
status: 'pending';
|
|
99708
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
99709
|
+
result: null;
|
|
99710
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
99711
|
+
error: null;
|
|
99712
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
99713
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
99714
|
+
} | {
|
|
99715
|
+
/** ID of the action attempt. */
|
|
99716
|
+
action_attempt_id: string;
|
|
99717
|
+
status: 'success';
|
|
99718
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
99719
|
+
error: null;
|
|
99720
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
99721
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
99722
|
+
/** Result of the action. */
|
|
99723
|
+
result: {};
|
|
99724
|
+
} | {
|
|
99725
|
+
/** ID of the action attempt. */
|
|
99726
|
+
action_attempt_id: string;
|
|
99727
|
+
status: 'error';
|
|
99728
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
99729
|
+
result: null;
|
|
99730
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
99731
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
99732
|
+
/** Error associated with the action. */
|
|
99733
|
+
error: {
|
|
99734
|
+
/** Type of the error. */
|
|
99735
|
+
type: string;
|
|
99736
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
99737
|
+
message: string;
|
|
99738
|
+
};
|
|
98732
99739
|
} | {
|
|
98733
99740
|
/** ID of the action attempt. */
|
|
98734
99741
|
action_attempt_id: string;
|
|
@@ -99138,125 +100145,19 @@ export type Routes = {
|
|
|
99138
100145
|
};
|
|
99139
100146
|
maxDuration: undefined;
|
|
99140
100147
|
};
|
|
99141
|
-
'/thermostats/
|
|
99142
|
-
route: '/thermostats/
|
|
100148
|
+
'/thermostats/cool': {
|
|
100149
|
+
route: '/thermostats/cool';
|
|
99143
100150
|
method: 'POST';
|
|
99144
100151
|
queryParams: {};
|
|
99145
100152
|
jsonBody: {
|
|
99146
|
-
/** ID of the thermostat device
|
|
100153
|
+
/** ID of the thermostat device that you want to set to cool mode. */
|
|
99147
100154
|
device_id: string;
|
|
99148
|
-
/**
|
|
99149
|
-
* @deprecated Use 'thermostat_schedule.is_override_allowed'*/
|
|
99150
|
-
manual_override_allowed?: boolean;
|
|
99151
|
-
/** Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
|
|
99152
|
-
climate_preset_key: string;
|
|
99153
|
-
/** User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
|
|
99154
|
-
name?: (string | null) | undefined;
|
|
99155
|
-
/**
|
|
99156
|
-
The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
99157
|
-
*/
|
|
99158
|
-
climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
|
|
99159
|
-
/** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
|
|
99160
|
-
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
99161
|
-
/** Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
|
|
99162
|
-
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool' | 'eco') | undefined;
|
|
99163
|
-
/** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
100155
|
+
/** [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
|
|
99164
100156
|
cooling_set_point_celsius?: number | undefined;
|
|
99165
|
-
/**
|
|
99166
|
-
heating_set_point_celsius?: number | undefined;
|
|
99167
|
-
/** Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
100157
|
+
/** [Cooling set point](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F that you want to set for the thermostat. You must set one of the `cooling_set_point` parameters. */
|
|
99168
100158
|
cooling_set_point_fahrenheit?: number | undefined;
|
|
99169
|
-
/**
|
|
99170
|
-
|
|
99171
|
-
/**
|
|
99172
|
-
Metadata specific to the Ecobee climate, if applicable.
|
|
99173
|
-
*/
|
|
99174
|
-
ecobee_metadata?: {
|
|
99175
|
-
/** Reference to the Ecobee climate, if applicable. */
|
|
99176
|
-
climate_ref?: (string | undefined) | undefined;
|
|
99177
|
-
/** Indicates if the climate preset is optimized by Ecobee. */
|
|
99178
|
-
is_optimized?: (boolean | undefined) | undefined;
|
|
99179
|
-
/** Indicates whether the climate preset is owned by the user or the system. */
|
|
99180
|
-
owner?: (('user' | 'system') | undefined) | undefined;
|
|
99181
|
-
} | undefined;
|
|
99182
|
-
};
|
|
99183
|
-
commonParams: {};
|
|
99184
|
-
formData: {};
|
|
99185
|
-
jsonResponse: {};
|
|
99186
|
-
maxDuration: undefined;
|
|
99187
|
-
};
|
|
99188
|
-
'/thermostats/daily_programs/create': {
|
|
99189
|
-
route: '/thermostats/daily_programs/create';
|
|
99190
|
-
method: 'POST';
|
|
99191
|
-
queryParams: {};
|
|
99192
|
-
jsonBody: {
|
|
99193
|
-
/** ID of the thermostat device for which you want to create a daily program. */
|
|
99194
|
-
device_id: string;
|
|
99195
|
-
/** Name of the thermostat daily program. */
|
|
99196
|
-
name: string;
|
|
99197
|
-
/** Array of thermostat daily program periods. */
|
|
99198
|
-
periods: {
|
|
99199
|
-
/** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
99200
|
-
starts_at_time: string;
|
|
99201
|
-
/** Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
|
|
99202
|
-
climate_preset_key: string;
|
|
99203
|
-
}[];
|
|
99204
|
-
};
|
|
99205
|
-
commonParams: {};
|
|
99206
|
-
formData: {};
|
|
99207
|
-
jsonResponse: {
|
|
99208
|
-
/** Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time. */
|
|
99209
|
-
thermostat_daily_program: {
|
|
99210
|
-
/** ID of the thermostat daily program. */
|
|
99211
|
-
thermostat_daily_program_id: string;
|
|
99212
|
-
/** ID of the thermostat device on which the thermostat daily program is configured. */
|
|
99213
|
-
device_id: string;
|
|
99214
|
-
/** User-friendly name to identify the thermostat daily program. */
|
|
99215
|
-
name: string | null;
|
|
99216
|
-
/** Array of thermostat daily program periods. */
|
|
99217
|
-
periods: {
|
|
99218
|
-
/** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
99219
|
-
starts_at_time: string;
|
|
99220
|
-
/** Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
|
|
99221
|
-
climate_preset_key: string;
|
|
99222
|
-
}[];
|
|
99223
|
-
/** ID of the workspace that contains the thermostat daily program. */
|
|
99224
|
-
workspace_id: string;
|
|
99225
|
-
/** Date and time at which the thermostat daily program was created. */
|
|
99226
|
-
created_at: string;
|
|
99227
|
-
};
|
|
99228
|
-
};
|
|
99229
|
-
maxDuration: undefined;
|
|
99230
|
-
};
|
|
99231
|
-
'/thermostats/daily_programs/delete': {
|
|
99232
|
-
route: '/thermostats/daily_programs/delete';
|
|
99233
|
-
method: 'DELETE' | 'POST';
|
|
99234
|
-
queryParams: {};
|
|
99235
|
-
jsonBody: {};
|
|
99236
|
-
commonParams: {
|
|
99237
|
-
/** ID of the thermostat daily program that you want to delete. */
|
|
99238
|
-
thermostat_daily_program_id: string;
|
|
99239
|
-
};
|
|
99240
|
-
formData: {};
|
|
99241
|
-
jsonResponse: {};
|
|
99242
|
-
maxDuration: undefined;
|
|
99243
|
-
};
|
|
99244
|
-
'/thermostats/daily_programs/update': {
|
|
99245
|
-
route: '/thermostats/daily_programs/update';
|
|
99246
|
-
method: 'PATCH' | 'POST';
|
|
99247
|
-
queryParams: {};
|
|
99248
|
-
jsonBody: {
|
|
99249
|
-
/** ID of the thermostat daily program that you want to update. */
|
|
99250
|
-
thermostat_daily_program_id: string;
|
|
99251
|
-
/** Name of the thermostat daily program that you want to update. */
|
|
99252
|
-
name: string;
|
|
99253
|
-
/** Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. */
|
|
99254
|
-
periods: {
|
|
99255
|
-
/** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
99256
|
-
starts_at_time: string;
|
|
99257
|
-
/** Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
|
|
99258
|
-
climate_preset_key: string;
|
|
99259
|
-
}[];
|
|
100159
|
+
/** */
|
|
100160
|
+
sync?: boolean;
|
|
99260
100161
|
};
|
|
99261
100162
|
commonParams: {};
|
|
99262
100163
|
formData: {};
|
|
@@ -100651,6 +101552,1998 @@ export type Routes = {
|
|
|
100651
101552
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100652
101553
|
message: string;
|
|
100653
101554
|
};
|
|
101555
|
+
} | {
|
|
101556
|
+
/** ID of the action attempt. */
|
|
101557
|
+
action_attempt_id: string;
|
|
101558
|
+
status: 'pending';
|
|
101559
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101560
|
+
result: null;
|
|
101561
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101562
|
+
error: null;
|
|
101563
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
101564
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
101565
|
+
} | {
|
|
101566
|
+
/** ID of the action attempt. */
|
|
101567
|
+
action_attempt_id: string;
|
|
101568
|
+
status: 'success';
|
|
101569
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101570
|
+
error: null;
|
|
101571
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
101572
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
101573
|
+
/** Result of the action. */
|
|
101574
|
+
result: {};
|
|
101575
|
+
} | {
|
|
101576
|
+
/** ID of the action attempt. */
|
|
101577
|
+
action_attempt_id: string;
|
|
101578
|
+
status: 'error';
|
|
101579
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101580
|
+
result: null;
|
|
101581
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
101582
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
101583
|
+
/** Error associated with the action. */
|
|
101584
|
+
error: {
|
|
101585
|
+
/** Type of the error. */
|
|
101586
|
+
type: string;
|
|
101587
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101588
|
+
message: string;
|
|
101589
|
+
};
|
|
101590
|
+
} | {
|
|
101591
|
+
/** ID of the action attempt. */
|
|
101592
|
+
action_attempt_id: string;
|
|
101593
|
+
status: 'pending';
|
|
101594
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101595
|
+
result: null;
|
|
101596
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101597
|
+
error: null;
|
|
101598
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
101599
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
101600
|
+
} | {
|
|
101601
|
+
/** ID of the action attempt. */
|
|
101602
|
+
action_attempt_id: string;
|
|
101603
|
+
status: 'success';
|
|
101604
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101605
|
+
error: null;
|
|
101606
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
101607
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
101608
|
+
/** Result of the action. */
|
|
101609
|
+
result: {};
|
|
101610
|
+
} | {
|
|
101611
|
+
/** ID of the action attempt. */
|
|
101612
|
+
action_attempt_id: string;
|
|
101613
|
+
status: 'error';
|
|
101614
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101615
|
+
result: null;
|
|
101616
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
101617
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
|
|
101618
|
+
/** Error associated with the action. */
|
|
101619
|
+
error: {
|
|
101620
|
+
/** Type of the error. */
|
|
101621
|
+
type: string;
|
|
101622
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101623
|
+
message: string;
|
|
101624
|
+
};
|
|
101625
|
+
} | {
|
|
101626
|
+
/** ID of the action attempt. */
|
|
101627
|
+
action_attempt_id: string;
|
|
101628
|
+
status: 'pending';
|
|
101629
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101630
|
+
result: null;
|
|
101631
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101632
|
+
error: null;
|
|
101633
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
101634
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
101635
|
+
} | {
|
|
101636
|
+
/** ID of the action attempt. */
|
|
101637
|
+
action_attempt_id: string;
|
|
101638
|
+
status: 'success';
|
|
101639
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101640
|
+
error: null;
|
|
101641
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
101642
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
101643
|
+
/** Result of the action. */
|
|
101644
|
+
result: {};
|
|
101645
|
+
} | {
|
|
101646
|
+
/** ID of the action attempt. */
|
|
101647
|
+
action_attempt_id: string;
|
|
101648
|
+
status: 'error';
|
|
101649
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101650
|
+
result: null;
|
|
101651
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
101652
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
|
|
101653
|
+
/** Error associated with the action. */
|
|
101654
|
+
error: {
|
|
101655
|
+
/** Type of the error. */
|
|
101656
|
+
type: string;
|
|
101657
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101658
|
+
message: string;
|
|
101659
|
+
};
|
|
101660
|
+
} | {
|
|
101661
|
+
/** ID of the action attempt. */
|
|
101662
|
+
action_attempt_id: string;
|
|
101663
|
+
status: 'pending';
|
|
101664
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101665
|
+
result: null;
|
|
101666
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101667
|
+
error: null;
|
|
101668
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
101669
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
101670
|
+
} | {
|
|
101671
|
+
/** ID of the action attempt. */
|
|
101672
|
+
action_attempt_id: string;
|
|
101673
|
+
status: 'success';
|
|
101674
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101675
|
+
error: null;
|
|
101676
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
101677
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
101678
|
+
/** Result of the action. */
|
|
101679
|
+
result: {};
|
|
101680
|
+
} | {
|
|
101681
|
+
/** ID of the action attempt. */
|
|
101682
|
+
action_attempt_id: string;
|
|
101683
|
+
status: 'error';
|
|
101684
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101685
|
+
result: null;
|
|
101686
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
101687
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS';
|
|
101688
|
+
/** Error associated with the action. */
|
|
101689
|
+
error: {
|
|
101690
|
+
/** Type of the error. */
|
|
101691
|
+
type: string;
|
|
101692
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101693
|
+
message: string;
|
|
101694
|
+
};
|
|
101695
|
+
} | {
|
|
101696
|
+
/** ID of the action attempt. */
|
|
101697
|
+
action_attempt_id: string;
|
|
101698
|
+
status: 'pending';
|
|
101699
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101700
|
+
result: null;
|
|
101701
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101702
|
+
error: null;
|
|
101703
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
101704
|
+
action_type: 'CONFIGURE_AUTO_LOCK';
|
|
101705
|
+
} | {
|
|
101706
|
+
/** ID of the action attempt. */
|
|
101707
|
+
action_attempt_id: string;
|
|
101708
|
+
status: 'success';
|
|
101709
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101710
|
+
error: null;
|
|
101711
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
101712
|
+
action_type: 'CONFIGURE_AUTO_LOCK';
|
|
101713
|
+
/** Result of the action. */
|
|
101714
|
+
result: {};
|
|
101715
|
+
} | {
|
|
101716
|
+
/** ID of the action attempt. */
|
|
101717
|
+
action_attempt_id: string;
|
|
101718
|
+
status: 'error';
|
|
101719
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101720
|
+
result: null;
|
|
101721
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
101722
|
+
action_type: 'CONFIGURE_AUTO_LOCK';
|
|
101723
|
+
/** Error associated with the action. */
|
|
101724
|
+
error: {
|
|
101725
|
+
/** Type of the error. */
|
|
101726
|
+
type: string;
|
|
101727
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101728
|
+
message: string;
|
|
101729
|
+
};
|
|
101730
|
+
} | {
|
|
101731
|
+
/** ID of the action attempt. */
|
|
101732
|
+
action_attempt_id: string;
|
|
101733
|
+
status: 'pending';
|
|
101734
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101735
|
+
result: null;
|
|
101736
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101737
|
+
error: null;
|
|
101738
|
+
/** Syncing access codes is pending. */
|
|
101739
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
101740
|
+
} | {
|
|
101741
|
+
/** ID of the action attempt. */
|
|
101742
|
+
action_attempt_id: string;
|
|
101743
|
+
status: 'success';
|
|
101744
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101745
|
+
error: null;
|
|
101746
|
+
/** Syncing access codes succeeded. */
|
|
101747
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
101748
|
+
/** Result of the action. */
|
|
101749
|
+
result: {};
|
|
101750
|
+
} | {
|
|
101751
|
+
/** ID of the action attempt. */
|
|
101752
|
+
action_attempt_id: string;
|
|
101753
|
+
status: 'error';
|
|
101754
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101755
|
+
result: null;
|
|
101756
|
+
/** Syncing access codes failed. */
|
|
101757
|
+
action_type: 'SYNC_ACCESS_CODES';
|
|
101758
|
+
/** Error associated with the action. */
|
|
101759
|
+
error: {
|
|
101760
|
+
/** Type of the error. */
|
|
101761
|
+
type: string;
|
|
101762
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101763
|
+
message: string;
|
|
101764
|
+
};
|
|
101765
|
+
} | {
|
|
101766
|
+
/** ID of the action attempt. */
|
|
101767
|
+
action_attempt_id: string;
|
|
101768
|
+
status: 'pending';
|
|
101769
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101770
|
+
result: null;
|
|
101771
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101772
|
+
error: null;
|
|
101773
|
+
/** Creating an access code is pending. */
|
|
101774
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
101775
|
+
} | {
|
|
101776
|
+
/** ID of the action attempt. */
|
|
101777
|
+
action_attempt_id: string;
|
|
101778
|
+
status: 'success';
|
|
101779
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101780
|
+
error: null;
|
|
101781
|
+
/** Creating an access code succeeded. */
|
|
101782
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
101783
|
+
/** Result of the action. */
|
|
101784
|
+
result: {
|
|
101785
|
+
/** Created access code. */
|
|
101786
|
+
access_code: {
|
|
101787
|
+
[x: string]: any;
|
|
101788
|
+
};
|
|
101789
|
+
};
|
|
101790
|
+
} | {
|
|
101791
|
+
/** ID of the action attempt. */
|
|
101792
|
+
action_attempt_id: string;
|
|
101793
|
+
status: 'error';
|
|
101794
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101795
|
+
result: null;
|
|
101796
|
+
/** Creating an access code failed. */
|
|
101797
|
+
action_type: 'CREATE_ACCESS_CODE';
|
|
101798
|
+
/** Error associated with the action. */
|
|
101799
|
+
error: {
|
|
101800
|
+
/** Type of the error. */
|
|
101801
|
+
type: string;
|
|
101802
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101803
|
+
message: string;
|
|
101804
|
+
};
|
|
101805
|
+
} | {
|
|
101806
|
+
/** ID of the action attempt. */
|
|
101807
|
+
action_attempt_id: string;
|
|
101808
|
+
status: 'pending';
|
|
101809
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101810
|
+
result: null;
|
|
101811
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101812
|
+
error: null;
|
|
101813
|
+
/** Deleting an access code is pending. */
|
|
101814
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
101815
|
+
} | {
|
|
101816
|
+
/** ID of the action attempt. */
|
|
101817
|
+
action_attempt_id: string;
|
|
101818
|
+
status: 'success';
|
|
101819
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101820
|
+
error: null;
|
|
101821
|
+
/** Deleting an access code succeeded. */
|
|
101822
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
101823
|
+
/** Result of the action. */
|
|
101824
|
+
result: {};
|
|
101825
|
+
} | {
|
|
101826
|
+
/** ID of the action attempt. */
|
|
101827
|
+
action_attempt_id: string;
|
|
101828
|
+
status: 'error';
|
|
101829
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101830
|
+
result: null;
|
|
101831
|
+
/** Deleting an access code failed. */
|
|
101832
|
+
action_type: 'DELETE_ACCESS_CODE';
|
|
101833
|
+
/** Error associated with the action. */
|
|
101834
|
+
error: {
|
|
101835
|
+
/** Type of the error. */
|
|
101836
|
+
type: string;
|
|
101837
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101838
|
+
message: string;
|
|
101839
|
+
};
|
|
101840
|
+
} | {
|
|
101841
|
+
/** ID of the action attempt. */
|
|
101842
|
+
action_attempt_id: string;
|
|
101843
|
+
status: 'pending';
|
|
101844
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101845
|
+
result: null;
|
|
101846
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101847
|
+
error: null;
|
|
101848
|
+
/** Updating an access code is pending. */
|
|
101849
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
101850
|
+
} | {
|
|
101851
|
+
/** ID of the action attempt. */
|
|
101852
|
+
action_attempt_id: string;
|
|
101853
|
+
status: 'success';
|
|
101854
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101855
|
+
error: null;
|
|
101856
|
+
/** Updating an access code succeeded. */
|
|
101857
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
101858
|
+
/** Result of the action. */
|
|
101859
|
+
result: {
|
|
101860
|
+
/** Updated access code. */
|
|
101861
|
+
access_code?: {
|
|
101862
|
+
[x: string]: any;
|
|
101863
|
+
} | undefined;
|
|
101864
|
+
};
|
|
101865
|
+
} | {
|
|
101866
|
+
/** ID of the action attempt. */
|
|
101867
|
+
action_attempt_id: string;
|
|
101868
|
+
status: 'error';
|
|
101869
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101870
|
+
result: null;
|
|
101871
|
+
/** Updating an access code failed. */
|
|
101872
|
+
action_type: 'UPDATE_ACCESS_CODE';
|
|
101873
|
+
/** Error associated with the action. */
|
|
101874
|
+
error: {
|
|
101875
|
+
/** Type of the error. */
|
|
101876
|
+
type: string;
|
|
101877
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101878
|
+
message: string;
|
|
101879
|
+
};
|
|
101880
|
+
} | {
|
|
101881
|
+
/** ID of the action attempt. */
|
|
101882
|
+
action_attempt_id: string;
|
|
101883
|
+
status: 'pending';
|
|
101884
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101885
|
+
result: null;
|
|
101886
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101887
|
+
error: null;
|
|
101888
|
+
/** Creating a noise threshold is pending. */
|
|
101889
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
101890
|
+
} | {
|
|
101891
|
+
/** ID of the action attempt. */
|
|
101892
|
+
action_attempt_id: string;
|
|
101893
|
+
status: 'success';
|
|
101894
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101895
|
+
error: null;
|
|
101896
|
+
/** Creating a noise threshold succeeded. */
|
|
101897
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
101898
|
+
/** Result of the action. */
|
|
101899
|
+
result: {
|
|
101900
|
+
/** Created noise threshold. */
|
|
101901
|
+
noise_threshold: {
|
|
101902
|
+
[x: string]: any;
|
|
101903
|
+
};
|
|
101904
|
+
};
|
|
101905
|
+
} | {
|
|
101906
|
+
/** ID of the action attempt. */
|
|
101907
|
+
action_attempt_id: string;
|
|
101908
|
+
status: 'error';
|
|
101909
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101910
|
+
result: null;
|
|
101911
|
+
/** Creating a noise threshold failed. */
|
|
101912
|
+
action_type: 'CREATE_NOISE_THRESHOLD';
|
|
101913
|
+
/** Error associated with the action. */
|
|
101914
|
+
error: {
|
|
101915
|
+
/** Type of the error. */
|
|
101916
|
+
type: string;
|
|
101917
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101918
|
+
message: string;
|
|
101919
|
+
};
|
|
101920
|
+
} | {
|
|
101921
|
+
/** ID of the action attempt. */
|
|
101922
|
+
action_attempt_id: string;
|
|
101923
|
+
status: 'pending';
|
|
101924
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101925
|
+
result: null;
|
|
101926
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101927
|
+
error: null;
|
|
101928
|
+
/** Deleting a noise threshold is pending. */
|
|
101929
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
101930
|
+
} | {
|
|
101931
|
+
/** ID of the action attempt. */
|
|
101932
|
+
action_attempt_id: string;
|
|
101933
|
+
status: 'success';
|
|
101934
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101935
|
+
error: null;
|
|
101936
|
+
/** Deleting a noise threshold succeeded. */
|
|
101937
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
101938
|
+
/** Result of the action. */
|
|
101939
|
+
result: {};
|
|
101940
|
+
} | {
|
|
101941
|
+
/** ID of the action attempt. */
|
|
101942
|
+
action_attempt_id: string;
|
|
101943
|
+
status: 'error';
|
|
101944
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101945
|
+
result: null;
|
|
101946
|
+
/** Deleting a noise threshold failed. */
|
|
101947
|
+
action_type: 'DELETE_NOISE_THRESHOLD';
|
|
101948
|
+
/** Error associated with the action. */
|
|
101949
|
+
error: {
|
|
101950
|
+
/** Type of the error. */
|
|
101951
|
+
type: string;
|
|
101952
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101953
|
+
message: string;
|
|
101954
|
+
};
|
|
101955
|
+
} | {
|
|
101956
|
+
/** ID of the action attempt. */
|
|
101957
|
+
action_attempt_id: string;
|
|
101958
|
+
status: 'pending';
|
|
101959
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
101960
|
+
result: null;
|
|
101961
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
101962
|
+
error: null;
|
|
101963
|
+
/** Updating a noise threshold is pending. */
|
|
101964
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
101965
|
+
} | {
|
|
101966
|
+
/** ID of the action attempt. */
|
|
101967
|
+
action_attempt_id: string;
|
|
101968
|
+
status: 'success';
|
|
101969
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
101970
|
+
error: null;
|
|
101971
|
+
/** Updating a noise threshold succeeded. */
|
|
101972
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
101973
|
+
/** Result of the action. */
|
|
101974
|
+
result: {
|
|
101975
|
+
/** Updated noise threshold. */
|
|
101976
|
+
noise_threshold: {
|
|
101977
|
+
[x: string]: any;
|
|
101978
|
+
};
|
|
101979
|
+
};
|
|
101980
|
+
} | {
|
|
101981
|
+
/** ID of the action attempt. */
|
|
101982
|
+
action_attempt_id: string;
|
|
101983
|
+
status: 'error';
|
|
101984
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
101985
|
+
result: null;
|
|
101986
|
+
/** Updating a noise threshold failed. */
|
|
101987
|
+
action_type: 'UPDATE_NOISE_THRESHOLD';
|
|
101988
|
+
/** Error associated with the action. */
|
|
101989
|
+
error: {
|
|
101990
|
+
/** Type of the error. */
|
|
101991
|
+
type: string;
|
|
101992
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
101993
|
+
message: string;
|
|
101994
|
+
};
|
|
101995
|
+
};
|
|
101996
|
+
};
|
|
101997
|
+
maxDuration: undefined;
|
|
101998
|
+
};
|
|
101999
|
+
'/thermostats/create_climate_preset': {
|
|
102000
|
+
route: '/thermostats/create_climate_preset';
|
|
102001
|
+
method: 'POST';
|
|
102002
|
+
queryParams: {};
|
|
102003
|
+
jsonBody: {
|
|
102004
|
+
/** ID of the thermostat device for which you want create a climate preset. */
|
|
102005
|
+
device_id: string;
|
|
102006
|
+
/** Indicates whether a person at the thermostat or using the API can change the thermostat's settings.
|
|
102007
|
+
* @deprecated Use 'thermostat_schedule.is_override_allowed'*/
|
|
102008
|
+
manual_override_allowed?: boolean;
|
|
102009
|
+
/** Unique key to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
|
|
102010
|
+
climate_preset_key: string;
|
|
102011
|
+
/** User-friendly name to identify the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets). */
|
|
102012
|
+
name?: (string | null) | undefined;
|
|
102013
|
+
/**
|
|
102014
|
+
The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
|
|
102015
|
+
*/
|
|
102016
|
+
climate_preset_mode?: ('home' | 'away' | 'wake' | 'sleep' | 'occupied' | 'unoccupied') | undefined;
|
|
102017
|
+
/** Desired [fan mode setting](https://www.seam.co/docs/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`. */
|
|
102018
|
+
fan_mode_setting?: ('auto' | 'on' | 'circulate') | undefined;
|
|
102019
|
+
/** Desired [HVAC mode](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) setting, such as `heat`, `cool`, `heat_cool`, or `off`. */
|
|
102020
|
+
hvac_mode_setting?: ('off' | 'heat' | 'cool' | 'heat_cool' | 'eco') | undefined;
|
|
102021
|
+
/** Temperature to which the thermostat should cool (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
102022
|
+
cooling_set_point_celsius?: number | undefined;
|
|
102023
|
+
/** Temperature to which the thermostat should heat (in °C). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
102024
|
+
heating_set_point_celsius?: number | undefined;
|
|
102025
|
+
/** Temperature to which the thermostat should cool (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
102026
|
+
cooling_set_point_fahrenheit?: number | undefined;
|
|
102027
|
+
/** Temperature to which the thermostat should heat (in °F). See also [Set Points](https://www.seam.co/docs/capability-guides/thermostats/understanding-thermostat-concepts/set-points). */
|
|
102028
|
+
heating_set_point_fahrenheit?: number | undefined;
|
|
102029
|
+
/**
|
|
102030
|
+
Metadata specific to the Ecobee climate, if applicable.
|
|
102031
|
+
*/
|
|
102032
|
+
ecobee_metadata?: {
|
|
102033
|
+
/** Reference to the Ecobee climate, if applicable. */
|
|
102034
|
+
climate_ref?: (string | undefined) | undefined;
|
|
102035
|
+
/** Indicates if the climate preset is optimized by Ecobee. */
|
|
102036
|
+
is_optimized?: (boolean | undefined) | undefined;
|
|
102037
|
+
/** Indicates whether the climate preset is owned by the user or the system. */
|
|
102038
|
+
owner?: (('user' | 'system') | undefined) | undefined;
|
|
102039
|
+
} | undefined;
|
|
102040
|
+
};
|
|
102041
|
+
commonParams: {};
|
|
102042
|
+
formData: {};
|
|
102043
|
+
jsonResponse: {};
|
|
102044
|
+
maxDuration: undefined;
|
|
102045
|
+
};
|
|
102046
|
+
'/thermostats/daily_programs/create': {
|
|
102047
|
+
route: '/thermostats/daily_programs/create';
|
|
102048
|
+
method: 'POST';
|
|
102049
|
+
queryParams: {};
|
|
102050
|
+
jsonBody: {
|
|
102051
|
+
/** ID of the thermostat device for which you want to create a daily program. */
|
|
102052
|
+
device_id: string;
|
|
102053
|
+
/** Name of the thermostat daily program. */
|
|
102054
|
+
name: string;
|
|
102055
|
+
/** Array of thermostat daily program periods. */
|
|
102056
|
+
periods: {
|
|
102057
|
+
/** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
102058
|
+
starts_at_time: string;
|
|
102059
|
+
/** Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
|
|
102060
|
+
climate_preset_key: string;
|
|
102061
|
+
}[];
|
|
102062
|
+
};
|
|
102063
|
+
commonParams: {};
|
|
102064
|
+
formData: {};
|
|
102065
|
+
jsonResponse: {
|
|
102066
|
+
/** Represents a thermostat daily program, consisting of a set of periods, each of which has a starting time and the key that identifies the climate preset to apply at the starting time. */
|
|
102067
|
+
thermostat_daily_program: {
|
|
102068
|
+
/** ID of the thermostat daily program. */
|
|
102069
|
+
thermostat_daily_program_id: string;
|
|
102070
|
+
/** ID of the thermostat device on which the thermostat daily program is configured. */
|
|
102071
|
+
device_id: string;
|
|
102072
|
+
/** User-friendly name to identify the thermostat daily program. */
|
|
102073
|
+
name: string | null;
|
|
102074
|
+
/** Array of thermostat daily program periods. */
|
|
102075
|
+
periods: {
|
|
102076
|
+
/** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
102077
|
+
starts_at_time: string;
|
|
102078
|
+
/** Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
|
|
102079
|
+
climate_preset_key: string;
|
|
102080
|
+
}[];
|
|
102081
|
+
/** ID of the workspace that contains the thermostat daily program. */
|
|
102082
|
+
workspace_id: string;
|
|
102083
|
+
/** Date and time at which the thermostat daily program was created. */
|
|
102084
|
+
created_at: string;
|
|
102085
|
+
};
|
|
102086
|
+
};
|
|
102087
|
+
maxDuration: undefined;
|
|
102088
|
+
};
|
|
102089
|
+
'/thermostats/daily_programs/delete': {
|
|
102090
|
+
route: '/thermostats/daily_programs/delete';
|
|
102091
|
+
method: 'DELETE' | 'POST';
|
|
102092
|
+
queryParams: {};
|
|
102093
|
+
jsonBody: {};
|
|
102094
|
+
commonParams: {
|
|
102095
|
+
/** ID of the thermostat daily program that you want to delete. */
|
|
102096
|
+
thermostat_daily_program_id: string;
|
|
102097
|
+
};
|
|
102098
|
+
formData: {};
|
|
102099
|
+
jsonResponse: {};
|
|
102100
|
+
maxDuration: undefined;
|
|
102101
|
+
};
|
|
102102
|
+
'/thermostats/daily_programs/update': {
|
|
102103
|
+
route: '/thermostats/daily_programs/update';
|
|
102104
|
+
method: 'PATCH' | 'POST';
|
|
102105
|
+
queryParams: {};
|
|
102106
|
+
jsonBody: {
|
|
102107
|
+
/** ID of the thermostat daily program that you want to update. */
|
|
102108
|
+
thermostat_daily_program_id: string;
|
|
102109
|
+
/** Name of the thermostat daily program that you want to update. */
|
|
102110
|
+
name: string;
|
|
102111
|
+
/** Array of thermostat daily program periods. The periods that you specify overwrite any existing periods for the daily program. */
|
|
102112
|
+
periods: {
|
|
102113
|
+
/** Time at which the thermostat daily program period starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
102114
|
+
starts_at_time: string;
|
|
102115
|
+
/** Key of the [climate preset](https://www.seam.co/docs/capability-guides/thermostats/creating-and-managing-climate-presets) to activate at the `starts_at_time`. */
|
|
102116
|
+
climate_preset_key: string;
|
|
102117
|
+
}[];
|
|
102118
|
+
};
|
|
102119
|
+
commonParams: {};
|
|
102120
|
+
formData: {};
|
|
102121
|
+
jsonResponse: {
|
|
102122
|
+
/** Represents an action attempt that enables you to keep track of the progress of your action that affects a physical device or system.actions against a device. Action attempts are useful because the physical world is intrinsically asynchronous.
|
|
102123
|
+
|
|
102124
|
+
When you request for a device to perform an action, the Seam API immediately returns an action attempt object. In the background, the Seam API performs the action.
|
|
102125
|
+
|
|
102126
|
+
See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts). */
|
|
102127
|
+
action_attempt: {
|
|
102128
|
+
/** ID of the action attempt. */
|
|
102129
|
+
action_attempt_id: string;
|
|
102130
|
+
status: 'pending';
|
|
102131
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
102132
|
+
result: null;
|
|
102133
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
102134
|
+
error: null;
|
|
102135
|
+
/** Action attempt to track the status of locking a door. */
|
|
102136
|
+
action_type: 'LOCK_DOOR';
|
|
102137
|
+
} | {
|
|
102138
|
+
/** ID of the action attempt. */
|
|
102139
|
+
action_attempt_id: string;
|
|
102140
|
+
status: 'success';
|
|
102141
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
102142
|
+
error: null;
|
|
102143
|
+
/** Action attempt to track the status of locking a door. */
|
|
102144
|
+
action_type: 'LOCK_DOOR';
|
|
102145
|
+
/** Result of the action. */
|
|
102146
|
+
result: {
|
|
102147
|
+
/** Indicates whether the device confirmed that the lock action occurred. */
|
|
102148
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
102149
|
+
};
|
|
102150
|
+
} | {
|
|
102151
|
+
/** ID of the action attempt. */
|
|
102152
|
+
action_attempt_id: string;
|
|
102153
|
+
status: 'error';
|
|
102154
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
102155
|
+
result: null;
|
|
102156
|
+
/** Action attempt to track the status of locking a door. */
|
|
102157
|
+
action_type: 'LOCK_DOOR';
|
|
102158
|
+
/** Error associated with the action. */
|
|
102159
|
+
error: {
|
|
102160
|
+
/** Type of the error. */
|
|
102161
|
+
type: string;
|
|
102162
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102163
|
+
message: string;
|
|
102164
|
+
};
|
|
102165
|
+
} | {
|
|
102166
|
+
/** ID of the action attempt. */
|
|
102167
|
+
action_attempt_id: string;
|
|
102168
|
+
status: 'pending';
|
|
102169
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
102170
|
+
result: null;
|
|
102171
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
102172
|
+
error: null;
|
|
102173
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
102174
|
+
action_type: 'UNLOCK_DOOR';
|
|
102175
|
+
} | {
|
|
102176
|
+
/** ID of the action attempt. */
|
|
102177
|
+
action_attempt_id: string;
|
|
102178
|
+
status: 'success';
|
|
102179
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
102180
|
+
error: null;
|
|
102181
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
102182
|
+
action_type: 'UNLOCK_DOOR';
|
|
102183
|
+
/** Result of the action. */
|
|
102184
|
+
result: {
|
|
102185
|
+
/** Indicates whether the device confirmed that the unlock action occurred. */
|
|
102186
|
+
was_confirmed_by_device?: boolean | undefined;
|
|
102187
|
+
};
|
|
102188
|
+
} | {
|
|
102189
|
+
/** ID of the action attempt. */
|
|
102190
|
+
action_attempt_id: string;
|
|
102191
|
+
status: 'error';
|
|
102192
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
102193
|
+
result: null;
|
|
102194
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
102195
|
+
action_type: 'UNLOCK_DOOR';
|
|
102196
|
+
/** Error associated with the action. */
|
|
102197
|
+
error: {
|
|
102198
|
+
/** Type of the error. */
|
|
102199
|
+
type: string;
|
|
102200
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102201
|
+
message: string;
|
|
102202
|
+
};
|
|
102203
|
+
} | {
|
|
102204
|
+
/** ID of the action attempt. */
|
|
102205
|
+
action_attempt_id: string;
|
|
102206
|
+
status: 'pending';
|
|
102207
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
102208
|
+
result: null;
|
|
102209
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
102210
|
+
error: null;
|
|
102211
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
102212
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
102213
|
+
} | {
|
|
102214
|
+
/** ID of the action attempt. */
|
|
102215
|
+
action_attempt_id: string;
|
|
102216
|
+
status: 'success';
|
|
102217
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
102218
|
+
error: null;
|
|
102219
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
102220
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
102221
|
+
/** Result of scanning a card. If the attempt was successful, includes a snapshot of credential data read from the physical encoder, the corresponding data stored on Seam and the access system, and any associated warnings. */
|
|
102222
|
+
result: {
|
|
102223
|
+
/** Snapshot of credential data read from the physical encoder. */
|
|
102224
|
+
acs_credential_on_encoder: {
|
|
102225
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
102226
|
+
created_at: string | null;
|
|
102227
|
+
/** Indicates whether the credential has been issued (encoded onto a card). */
|
|
102228
|
+
is_issued: boolean | null;
|
|
102229
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */
|
|
102230
|
+
starts_at: string | null;
|
|
102231
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */
|
|
102232
|
+
ends_at: string | null;
|
|
102233
|
+
/** A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102234
|
+
card_number: string | null;
|
|
102235
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102236
|
+
visionline_metadata?: {
|
|
102237
|
+
/** Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102238
|
+
card_id?: (string | undefined) | undefined;
|
|
102239
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */
|
|
102240
|
+
cancelled?: (boolean | undefined) | undefined;
|
|
102241
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded. */
|
|
102242
|
+
discarded?: (boolean | undefined) | undefined;
|
|
102243
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */
|
|
102244
|
+
expired?: (boolean | undefined) | undefined;
|
|
102245
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */
|
|
102246
|
+
overwritten?: (boolean | undefined) | undefined;
|
|
102247
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */
|
|
102248
|
+
overridden?: (boolean | undefined) | undefined;
|
|
102249
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */
|
|
102250
|
+
pending_auto_update?: (boolean | undefined) | undefined;
|
|
102251
|
+
/** Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102252
|
+
card_format?: (('TLCode' | 'rfid48') | undefined) | undefined;
|
|
102253
|
+
/** Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102254
|
+
card_holder?: (string | undefined) | undefined;
|
|
102255
|
+
/** Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102256
|
+
number_of_issued_cards?: (number | undefined) | undefined;
|
|
102257
|
+
/** IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102258
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102259
|
+
/** IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102260
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102261
|
+
} | undefined;
|
|
102262
|
+
} | null;
|
|
102263
|
+
/** Corresponding credential data as stored on Seam and the access system. */
|
|
102264
|
+
acs_credential_on_seam: ({
|
|
102265
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102266
|
+
acs_credential_id: string;
|
|
102267
|
+
/** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102268
|
+
acs_user_id?: string | undefined;
|
|
102269
|
+
/** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102270
|
+
user_identity_id?: string | undefined;
|
|
102271
|
+
/** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102272
|
+
connected_account_id: string;
|
|
102273
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
102274
|
+
acs_credential_pool_id?: string | undefined;
|
|
102275
|
+
/** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102276
|
+
acs_system_id: string;
|
|
102277
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102278
|
+
parent_acs_credential_id?: string | undefined;
|
|
102279
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102280
|
+
display_name: string;
|
|
102281
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102282
|
+
code?: (string | undefined) | null;
|
|
102283
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
102284
|
+
is_one_time_use?: boolean | undefined;
|
|
102285
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102286
|
+
card_number?: (string | undefined) | null;
|
|
102287
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
102288
|
+
is_issued?: boolean | undefined;
|
|
102289
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
102290
|
+
issued_at?: (string | undefined) | null;
|
|
102291
|
+
/** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
102292
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
102293
|
+
/** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
102294
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
|
|
102295
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102296
|
+
external_type_display_name?: string | undefined;
|
|
102297
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
102298
|
+
created_at: string;
|
|
102299
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102300
|
+
workspace_id: string;
|
|
102301
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
102302
|
+
starts_at?: string | undefined;
|
|
102303
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
102304
|
+
ends_at?: string | undefined;
|
|
102305
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102306
|
+
errors: {
|
|
102307
|
+
error_code: string;
|
|
102308
|
+
message: string;
|
|
102309
|
+
/** Date and time at which Seam created the error. */
|
|
102310
|
+
created_at: string;
|
|
102311
|
+
}[];
|
|
102312
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102313
|
+
warnings: ({
|
|
102314
|
+
/** Date and time at which Seam created the warning. */
|
|
102315
|
+
created_at: string;
|
|
102316
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102317
|
+
message: string;
|
|
102318
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102319
|
+
warning_code: 'waiting_to_be_issued';
|
|
102320
|
+
} | {
|
|
102321
|
+
/** Date and time at which Seam created the warning. */
|
|
102322
|
+
created_at: string;
|
|
102323
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102324
|
+
message: string;
|
|
102325
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102326
|
+
warning_code: 'schedule_externally_modified';
|
|
102327
|
+
} | {
|
|
102328
|
+
/** Date and time at which Seam created the warning. */
|
|
102329
|
+
created_at: string;
|
|
102330
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102331
|
+
message: string;
|
|
102332
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102333
|
+
warning_code: 'schedule_modified';
|
|
102334
|
+
} | {
|
|
102335
|
+
/** Date and time at which Seam created the warning. */
|
|
102336
|
+
created_at: string;
|
|
102337
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102338
|
+
message: string;
|
|
102339
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102340
|
+
warning_code: 'being_deleted';
|
|
102341
|
+
} | {
|
|
102342
|
+
/** Date and time at which Seam created the warning. */
|
|
102343
|
+
created_at: string;
|
|
102344
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102345
|
+
message: string;
|
|
102346
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102347
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
102348
|
+
} | {
|
|
102349
|
+
/** Date and time at which Seam created the warning. */
|
|
102350
|
+
created_at: string;
|
|
102351
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102352
|
+
message: string;
|
|
102353
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102354
|
+
warning_code: 'needs_to_be_reissued';
|
|
102355
|
+
} | {
|
|
102356
|
+
/** Date and time at which Seam created the warning. */
|
|
102357
|
+
created_at: string;
|
|
102358
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102359
|
+
message: string;
|
|
102360
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102361
|
+
warning_code: 'requested_code_unavailable';
|
|
102362
|
+
/** The originally requested PIN code that could not be used. */
|
|
102363
|
+
original_code: string;
|
|
102364
|
+
/** The PIN code that was assigned instead. */
|
|
102365
|
+
new_code: string;
|
|
102366
|
+
})[];
|
|
102367
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
102368
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
102369
|
+
/** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
102370
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
102371
|
+
/** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
102372
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
102373
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102374
|
+
visionline_metadata?: {
|
|
102375
|
+
/** Card function type in the Visionline access system. */
|
|
102376
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
102377
|
+
/** IDs of the credentials to which you want to join. */
|
|
102378
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
102379
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
102380
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102381
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
102382
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102383
|
+
/** Indicates whether the credential is valid. */
|
|
102384
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
102385
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102386
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102387
|
+
/** ID of the card in the Visionline access system. */
|
|
102388
|
+
card_id?: (string | undefined) | undefined;
|
|
102389
|
+
/** ID of the credential in the Visionline access system. */
|
|
102390
|
+
credential_id?: (string | undefined) | undefined;
|
|
102391
|
+
} | undefined;
|
|
102392
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102393
|
+
assa_abloy_vostio_metadata?: {
|
|
102394
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102395
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102396
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
102397
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102398
|
+
/** Key ID in the Vostio access system. */
|
|
102399
|
+
key_id?: (string | undefined) | undefined;
|
|
102400
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
102401
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
102402
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
102403
|
+
door_names?: (string[] | undefined) | undefined;
|
|
102404
|
+
/** Endpoint ID in the Vostio access system. */
|
|
102405
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
102406
|
+
} | undefined;
|
|
102407
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102408
|
+
akiles_metadata?: {
|
|
102409
|
+
/** ID of the Akiles member PIN. */
|
|
102410
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
102411
|
+
} | undefined;
|
|
102412
|
+
/** Indicates whether Seam manages the credential. */
|
|
102413
|
+
is_managed: true;
|
|
102414
|
+
} | {
|
|
102415
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102416
|
+
acs_credential_id: string;
|
|
102417
|
+
/** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102418
|
+
acs_user_id?: string | undefined;
|
|
102419
|
+
/** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102420
|
+
user_identity_id?: string | undefined;
|
|
102421
|
+
/** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102422
|
+
connected_account_id: string;
|
|
102423
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
102424
|
+
acs_credential_pool_id?: string | undefined;
|
|
102425
|
+
/** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102426
|
+
acs_system_id: string;
|
|
102427
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102428
|
+
parent_acs_credential_id?: string | undefined;
|
|
102429
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102430
|
+
display_name: string;
|
|
102431
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102432
|
+
code?: (string | undefined) | null;
|
|
102433
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
102434
|
+
is_one_time_use?: boolean | undefined;
|
|
102435
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102436
|
+
card_number?: (string | undefined) | null;
|
|
102437
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
102438
|
+
is_issued?: boolean | undefined;
|
|
102439
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
102440
|
+
issued_at?: (string | undefined) | null;
|
|
102441
|
+
/** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
102442
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
102443
|
+
/** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
102444
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
|
|
102445
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102446
|
+
external_type_display_name?: string | undefined;
|
|
102447
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
102448
|
+
created_at: string;
|
|
102449
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102450
|
+
workspace_id: string;
|
|
102451
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
102452
|
+
starts_at?: string | undefined;
|
|
102453
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
102454
|
+
ends_at?: string | undefined;
|
|
102455
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102456
|
+
errors: {
|
|
102457
|
+
error_code: string;
|
|
102458
|
+
message: string;
|
|
102459
|
+
/** Date and time at which Seam created the error. */
|
|
102460
|
+
created_at: string;
|
|
102461
|
+
}[];
|
|
102462
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102463
|
+
warnings: ({
|
|
102464
|
+
/** Date and time at which Seam created the warning. */
|
|
102465
|
+
created_at: string;
|
|
102466
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102467
|
+
message: string;
|
|
102468
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102469
|
+
warning_code: 'waiting_to_be_issued';
|
|
102470
|
+
} | {
|
|
102471
|
+
/** Date and time at which Seam created the warning. */
|
|
102472
|
+
created_at: string;
|
|
102473
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102474
|
+
message: string;
|
|
102475
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102476
|
+
warning_code: 'schedule_externally_modified';
|
|
102477
|
+
} | {
|
|
102478
|
+
/** Date and time at which Seam created the warning. */
|
|
102479
|
+
created_at: string;
|
|
102480
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102481
|
+
message: string;
|
|
102482
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102483
|
+
warning_code: 'schedule_modified';
|
|
102484
|
+
} | {
|
|
102485
|
+
/** Date and time at which Seam created the warning. */
|
|
102486
|
+
created_at: string;
|
|
102487
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102488
|
+
message: string;
|
|
102489
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102490
|
+
warning_code: 'being_deleted';
|
|
102491
|
+
} | {
|
|
102492
|
+
/** Date and time at which Seam created the warning. */
|
|
102493
|
+
created_at: string;
|
|
102494
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102495
|
+
message: string;
|
|
102496
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102497
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
102498
|
+
} | {
|
|
102499
|
+
/** Date and time at which Seam created the warning. */
|
|
102500
|
+
created_at: string;
|
|
102501
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102502
|
+
message: string;
|
|
102503
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102504
|
+
warning_code: 'needs_to_be_reissued';
|
|
102505
|
+
} | {
|
|
102506
|
+
/** Date and time at which Seam created the warning. */
|
|
102507
|
+
created_at: string;
|
|
102508
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102509
|
+
message: string;
|
|
102510
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102511
|
+
warning_code: 'requested_code_unavailable';
|
|
102512
|
+
/** The originally requested PIN code that could not be used. */
|
|
102513
|
+
original_code: string;
|
|
102514
|
+
/** The PIN code that was assigned instead. */
|
|
102515
|
+
new_code: string;
|
|
102516
|
+
})[];
|
|
102517
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
102518
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
102519
|
+
/** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
102520
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
102521
|
+
/** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
102522
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
102523
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102524
|
+
visionline_metadata?: {
|
|
102525
|
+
/** Card function type in the Visionline access system. */
|
|
102526
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
102527
|
+
/** IDs of the credentials to which you want to join. */
|
|
102528
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
102529
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
102530
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102531
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
102532
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102533
|
+
/** Indicates whether the credential is valid. */
|
|
102534
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
102535
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102536
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102537
|
+
/** ID of the card in the Visionline access system. */
|
|
102538
|
+
card_id?: (string | undefined) | undefined;
|
|
102539
|
+
/** ID of the credential in the Visionline access system. */
|
|
102540
|
+
credential_id?: (string | undefined) | undefined;
|
|
102541
|
+
} | undefined;
|
|
102542
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102543
|
+
assa_abloy_vostio_metadata?: {
|
|
102544
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102545
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102546
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
102547
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102548
|
+
/** Key ID in the Vostio access system. */
|
|
102549
|
+
key_id?: (string | undefined) | undefined;
|
|
102550
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
102551
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
102552
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
102553
|
+
door_names?: (string[] | undefined) | undefined;
|
|
102554
|
+
/** Endpoint ID in the Vostio access system. */
|
|
102555
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
102556
|
+
} | undefined;
|
|
102557
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102558
|
+
akiles_metadata?: {
|
|
102559
|
+
/** ID of the Akiles member PIN. */
|
|
102560
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
102561
|
+
} | undefined;
|
|
102562
|
+
is_managed: false;
|
|
102563
|
+
}) | null;
|
|
102564
|
+
/** Warnings related to scanning the credential, such as mismatches between the credential data currently encoded on the card and the corresponding data stored on Seam and the access system. */
|
|
102565
|
+
warnings: {
|
|
102566
|
+
/** Indicates a warning related to scanning a credential. */
|
|
102567
|
+
warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
|
|
102568
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102569
|
+
warning_message: string;
|
|
102570
|
+
}[];
|
|
102571
|
+
};
|
|
102572
|
+
} | {
|
|
102573
|
+
/** ID of the action attempt. */
|
|
102574
|
+
action_attempt_id: string;
|
|
102575
|
+
status: 'error';
|
|
102576
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
102577
|
+
result: null;
|
|
102578
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
102579
|
+
action_type: 'SCAN_CREDENTIAL';
|
|
102580
|
+
error: {
|
|
102581
|
+
/** Type of the error associated with the action attempt. */
|
|
102582
|
+
type: 'uncategorized_error';
|
|
102583
|
+
/** Message for the error associated with the action attempt. */
|
|
102584
|
+
message: string;
|
|
102585
|
+
} | {
|
|
102586
|
+
/** Type of the error associated with the action attempt. */
|
|
102587
|
+
type: 'action_attempt_expired';
|
|
102588
|
+
/** Message for the error associated with the action attempt. */
|
|
102589
|
+
message: string;
|
|
102590
|
+
} | {
|
|
102591
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
102592
|
+
type: 'no_credential_on_encoder';
|
|
102593
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102594
|
+
message: string;
|
|
102595
|
+
} | {
|
|
102596
|
+
/** Error type to indicate that the encoder is not online. */
|
|
102597
|
+
type: 'encoder_not_online';
|
|
102598
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102599
|
+
message: string;
|
|
102600
|
+
} | {
|
|
102601
|
+
/** Error type to indicate that communication with the encoder timed out. */
|
|
102602
|
+
type: 'encoder_communication_timeout';
|
|
102603
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102604
|
+
message: string;
|
|
102605
|
+
} | {
|
|
102606
|
+
/** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
|
|
102607
|
+
type: 'bridge_disconnected';
|
|
102608
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102609
|
+
message: string;
|
|
102610
|
+
};
|
|
102611
|
+
} | {
|
|
102612
|
+
/** ID of the action attempt. */
|
|
102613
|
+
action_attempt_id: string;
|
|
102614
|
+
status: 'pending';
|
|
102615
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
102616
|
+
result: null;
|
|
102617
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
102618
|
+
error: null;
|
|
102619
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
102620
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
102621
|
+
} | {
|
|
102622
|
+
/** ID of the action attempt. */
|
|
102623
|
+
action_attempt_id: string;
|
|
102624
|
+
status: 'success';
|
|
102625
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
102626
|
+
error: null;
|
|
102627
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
102628
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
102629
|
+
/** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
|
|
102630
|
+
result: {
|
|
102631
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102632
|
+
acs_credential_id: string;
|
|
102633
|
+
/** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102634
|
+
acs_user_id?: string | undefined;
|
|
102635
|
+
/** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102636
|
+
user_identity_id?: string | undefined;
|
|
102637
|
+
/** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102638
|
+
connected_account_id: string;
|
|
102639
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
102640
|
+
acs_credential_pool_id?: string | undefined;
|
|
102641
|
+
/** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102642
|
+
acs_system_id: string;
|
|
102643
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102644
|
+
parent_acs_credential_id?: string | undefined;
|
|
102645
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102646
|
+
display_name: string;
|
|
102647
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102648
|
+
code?: (string | undefined) | null;
|
|
102649
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
102650
|
+
is_one_time_use?: boolean | undefined;
|
|
102651
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102652
|
+
card_number?: (string | undefined) | null;
|
|
102653
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
102654
|
+
is_issued?: boolean | undefined;
|
|
102655
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
102656
|
+
issued_at?: (string | undefined) | null;
|
|
102657
|
+
/** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
102658
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
102659
|
+
/** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
102660
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
|
|
102661
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102662
|
+
external_type_display_name?: string | undefined;
|
|
102663
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
102664
|
+
created_at: string;
|
|
102665
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102666
|
+
workspace_id: string;
|
|
102667
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
102668
|
+
starts_at?: string | undefined;
|
|
102669
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
102670
|
+
ends_at?: string | undefined;
|
|
102671
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102672
|
+
errors: {
|
|
102673
|
+
error_code: string;
|
|
102674
|
+
message: string;
|
|
102675
|
+
/** Date and time at which Seam created the error. */
|
|
102676
|
+
created_at: string;
|
|
102677
|
+
}[];
|
|
102678
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102679
|
+
warnings: ({
|
|
102680
|
+
/** Date and time at which Seam created the warning. */
|
|
102681
|
+
created_at: string;
|
|
102682
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102683
|
+
message: string;
|
|
102684
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102685
|
+
warning_code: 'waiting_to_be_issued';
|
|
102686
|
+
} | {
|
|
102687
|
+
/** Date and time at which Seam created the warning. */
|
|
102688
|
+
created_at: string;
|
|
102689
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102690
|
+
message: string;
|
|
102691
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102692
|
+
warning_code: 'schedule_externally_modified';
|
|
102693
|
+
} | {
|
|
102694
|
+
/** Date and time at which Seam created the warning. */
|
|
102695
|
+
created_at: string;
|
|
102696
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102697
|
+
message: string;
|
|
102698
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102699
|
+
warning_code: 'schedule_modified';
|
|
102700
|
+
} | {
|
|
102701
|
+
/** Date and time at which Seam created the warning. */
|
|
102702
|
+
created_at: string;
|
|
102703
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102704
|
+
message: string;
|
|
102705
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102706
|
+
warning_code: 'being_deleted';
|
|
102707
|
+
} | {
|
|
102708
|
+
/** Date and time at which Seam created the warning. */
|
|
102709
|
+
created_at: string;
|
|
102710
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102711
|
+
message: string;
|
|
102712
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102713
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
102714
|
+
} | {
|
|
102715
|
+
/** Date and time at which Seam created the warning. */
|
|
102716
|
+
created_at: string;
|
|
102717
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102718
|
+
message: string;
|
|
102719
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102720
|
+
warning_code: 'needs_to_be_reissued';
|
|
102721
|
+
} | {
|
|
102722
|
+
/** Date and time at which Seam created the warning. */
|
|
102723
|
+
created_at: string;
|
|
102724
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102725
|
+
message: string;
|
|
102726
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102727
|
+
warning_code: 'requested_code_unavailable';
|
|
102728
|
+
/** The originally requested PIN code that could not be used. */
|
|
102729
|
+
original_code: string;
|
|
102730
|
+
/** The PIN code that was assigned instead. */
|
|
102731
|
+
new_code: string;
|
|
102732
|
+
})[];
|
|
102733
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
102734
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
102735
|
+
/** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
102736
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
102737
|
+
/** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
102738
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
102739
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102740
|
+
visionline_metadata?: {
|
|
102741
|
+
/** Card function type in the Visionline access system. */
|
|
102742
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
102743
|
+
/** IDs of the credentials to which you want to join. */
|
|
102744
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
102745
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
102746
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102747
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
102748
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102749
|
+
/** Indicates whether the credential is valid. */
|
|
102750
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
102751
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102752
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102753
|
+
/** ID of the card in the Visionline access system. */
|
|
102754
|
+
card_id?: (string | undefined) | undefined;
|
|
102755
|
+
/** ID of the credential in the Visionline access system. */
|
|
102756
|
+
credential_id?: (string | undefined) | undefined;
|
|
102757
|
+
} | undefined;
|
|
102758
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102759
|
+
assa_abloy_vostio_metadata?: {
|
|
102760
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102761
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102762
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
102763
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102764
|
+
/** Key ID in the Vostio access system. */
|
|
102765
|
+
key_id?: (string | undefined) | undefined;
|
|
102766
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
102767
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
102768
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
102769
|
+
door_names?: (string[] | undefined) | undefined;
|
|
102770
|
+
/** Endpoint ID in the Vostio access system. */
|
|
102771
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
102772
|
+
} | undefined;
|
|
102773
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102774
|
+
akiles_metadata?: {
|
|
102775
|
+
/** ID of the Akiles member PIN. */
|
|
102776
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
102777
|
+
} | undefined;
|
|
102778
|
+
/** Indicates whether Seam manages the credential. */
|
|
102779
|
+
is_managed: true;
|
|
102780
|
+
} | {
|
|
102781
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102782
|
+
acs_credential_id: string;
|
|
102783
|
+
/** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102784
|
+
acs_user_id?: string | undefined;
|
|
102785
|
+
/** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102786
|
+
user_identity_id?: string | undefined;
|
|
102787
|
+
/** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
102788
|
+
connected_account_id: string;
|
|
102789
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
102790
|
+
acs_credential_pool_id?: string | undefined;
|
|
102791
|
+
/** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102792
|
+
acs_system_id: string;
|
|
102793
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102794
|
+
parent_acs_credential_id?: string | undefined;
|
|
102795
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102796
|
+
display_name: string;
|
|
102797
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102798
|
+
code?: (string | undefined) | null;
|
|
102799
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
102800
|
+
is_one_time_use?: boolean | undefined;
|
|
102801
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102802
|
+
card_number?: (string | undefined) | null;
|
|
102803
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
102804
|
+
is_issued?: boolean | undefined;
|
|
102805
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
102806
|
+
issued_at?: (string | undefined) | null;
|
|
102807
|
+
/** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
102808
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
102809
|
+
/** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
102810
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
|
|
102811
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
102812
|
+
external_type_display_name?: string | undefined;
|
|
102813
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
102814
|
+
created_at: string;
|
|
102815
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102816
|
+
workspace_id: string;
|
|
102817
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
102818
|
+
starts_at?: string | undefined;
|
|
102819
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
102820
|
+
ends_at?: string | undefined;
|
|
102821
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102822
|
+
errors: {
|
|
102823
|
+
error_code: string;
|
|
102824
|
+
message: string;
|
|
102825
|
+
/** Date and time at which Seam created the error. */
|
|
102826
|
+
created_at: string;
|
|
102827
|
+
}[];
|
|
102828
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102829
|
+
warnings: ({
|
|
102830
|
+
/** Date and time at which Seam created the warning. */
|
|
102831
|
+
created_at: string;
|
|
102832
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102833
|
+
message: string;
|
|
102834
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102835
|
+
warning_code: 'waiting_to_be_issued';
|
|
102836
|
+
} | {
|
|
102837
|
+
/** Date and time at which Seam created the warning. */
|
|
102838
|
+
created_at: string;
|
|
102839
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102840
|
+
message: string;
|
|
102841
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102842
|
+
warning_code: 'schedule_externally_modified';
|
|
102843
|
+
} | {
|
|
102844
|
+
/** Date and time at which Seam created the warning. */
|
|
102845
|
+
created_at: string;
|
|
102846
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102847
|
+
message: string;
|
|
102848
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102849
|
+
warning_code: 'schedule_modified';
|
|
102850
|
+
} | {
|
|
102851
|
+
/** Date and time at which Seam created the warning. */
|
|
102852
|
+
created_at: string;
|
|
102853
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102854
|
+
message: string;
|
|
102855
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102856
|
+
warning_code: 'being_deleted';
|
|
102857
|
+
} | {
|
|
102858
|
+
/** Date and time at which Seam created the warning. */
|
|
102859
|
+
created_at: string;
|
|
102860
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102861
|
+
message: string;
|
|
102862
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102863
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
102864
|
+
} | {
|
|
102865
|
+
/** Date and time at which Seam created the warning. */
|
|
102866
|
+
created_at: string;
|
|
102867
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102868
|
+
message: string;
|
|
102869
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102870
|
+
warning_code: 'needs_to_be_reissued';
|
|
102871
|
+
} | {
|
|
102872
|
+
/** Date and time at which Seam created the warning. */
|
|
102873
|
+
created_at: string;
|
|
102874
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
102875
|
+
message: string;
|
|
102876
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
102877
|
+
warning_code: 'requested_code_unavailable';
|
|
102878
|
+
/** The originally requested PIN code that could not be used. */
|
|
102879
|
+
original_code: string;
|
|
102880
|
+
/** The PIN code that was assigned instead. */
|
|
102881
|
+
new_code: string;
|
|
102882
|
+
})[];
|
|
102883
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
102884
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
102885
|
+
/** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
102886
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
102887
|
+
/** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
102888
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
102889
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102890
|
+
visionline_metadata?: {
|
|
102891
|
+
/** Card function type in the Visionline access system. */
|
|
102892
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
102893
|
+
/** IDs of the credentials to which you want to join. */
|
|
102894
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
102895
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
102896
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102897
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
102898
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102899
|
+
/** Indicates whether the credential is valid. */
|
|
102900
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
102901
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102902
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102903
|
+
/** ID of the card in the Visionline access system. */
|
|
102904
|
+
card_id?: (string | undefined) | undefined;
|
|
102905
|
+
/** ID of the credential in the Visionline access system. */
|
|
102906
|
+
credential_id?: (string | undefined) | undefined;
|
|
102907
|
+
} | undefined;
|
|
102908
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102909
|
+
assa_abloy_vostio_metadata?: {
|
|
102910
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
102911
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
102912
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
102913
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
102914
|
+
/** Key ID in the Vostio access system. */
|
|
102915
|
+
key_id?: (string | undefined) | undefined;
|
|
102916
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
102917
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
102918
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
102919
|
+
door_names?: (string[] | undefined) | undefined;
|
|
102920
|
+
/** Endpoint ID in the Vostio access system. */
|
|
102921
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
102922
|
+
} | undefined;
|
|
102923
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
102924
|
+
akiles_metadata?: {
|
|
102925
|
+
/** ID of the Akiles member PIN. */
|
|
102926
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
102927
|
+
} | undefined;
|
|
102928
|
+
is_managed: false;
|
|
102929
|
+
};
|
|
102930
|
+
} | {
|
|
102931
|
+
/** ID of the action attempt. */
|
|
102932
|
+
action_attempt_id: string;
|
|
102933
|
+
status: 'error';
|
|
102934
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
102935
|
+
result: null;
|
|
102936
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
102937
|
+
action_type: 'ENCODE_CREDENTIAL';
|
|
102938
|
+
error: {
|
|
102939
|
+
/** Type of the error associated with the action attempt. */
|
|
102940
|
+
type: 'uncategorized_error';
|
|
102941
|
+
/** Message for the error associated with the action attempt. */
|
|
102942
|
+
message: string;
|
|
102943
|
+
} | {
|
|
102944
|
+
/** Type of the error associated with the action attempt. */
|
|
102945
|
+
type: 'action_attempt_expired';
|
|
102946
|
+
/** Message for the error associated with the action attempt. */
|
|
102947
|
+
message: string;
|
|
102948
|
+
} | {
|
|
102949
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
102950
|
+
type: 'no_credential_on_encoder';
|
|
102951
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102952
|
+
message: string;
|
|
102953
|
+
} | {
|
|
102954
|
+
/** Error type to indicate an incompatible card format. */
|
|
102955
|
+
type: 'incompatible_card_format';
|
|
102956
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102957
|
+
message: string;
|
|
102958
|
+
} | {
|
|
102959
|
+
/** Error type to indicate that the affected credential cannot be reissued. */
|
|
102960
|
+
type: 'credential_cannot_be_reissued';
|
|
102961
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102962
|
+
message: string;
|
|
102963
|
+
} | {
|
|
102964
|
+
/** Error type to indicate that the encoder is not online. */
|
|
102965
|
+
type: 'encoder_not_online';
|
|
102966
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102967
|
+
message: string;
|
|
102968
|
+
} | {
|
|
102969
|
+
/** Error type to indicate that communication with the encoder timed out. */
|
|
102970
|
+
type: 'encoder_communication_timeout';
|
|
102971
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102972
|
+
message: string;
|
|
102973
|
+
} | {
|
|
102974
|
+
/** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
|
|
102975
|
+
type: 'bridge_disconnected';
|
|
102976
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102977
|
+
message: string;
|
|
102978
|
+
} | {
|
|
102979
|
+
/** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
|
|
102980
|
+
type: 'encoding_interrupted';
|
|
102981
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102982
|
+
message: string;
|
|
102983
|
+
} | {
|
|
102984
|
+
/** Error type to indicate that the credential was deleted and can no longer be encoded. */
|
|
102985
|
+
type: 'credential_deleted';
|
|
102986
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
102987
|
+
message: string;
|
|
102988
|
+
};
|
|
102989
|
+
} | {
|
|
102990
|
+
/** ID of the action attempt. */
|
|
102991
|
+
action_attempt_id: string;
|
|
102992
|
+
status: 'pending';
|
|
102993
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
102994
|
+
result: null;
|
|
102995
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
102996
|
+
error: null;
|
|
102997
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
102998
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
|
|
102999
|
+
} | {
|
|
103000
|
+
/** ID of the action attempt. */
|
|
103001
|
+
action_attempt_id: string;
|
|
103002
|
+
status: 'success';
|
|
103003
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103004
|
+
error: null;
|
|
103005
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
103006
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
|
|
103007
|
+
/** Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. */
|
|
103008
|
+
result: {
|
|
103009
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103010
|
+
acs_credential_id: string;
|
|
103011
|
+
/** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
103012
|
+
acs_user_id?: string | undefined;
|
|
103013
|
+
/** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
103014
|
+
user_identity_id?: string | undefined;
|
|
103015
|
+
/** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
|
|
103016
|
+
connected_account_id: string;
|
|
103017
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
103018
|
+
acs_credential_pool_id?: string | undefined;
|
|
103019
|
+
/** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103020
|
+
acs_system_id: string;
|
|
103021
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103022
|
+
parent_acs_credential_id?: string | undefined;
|
|
103023
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
103024
|
+
display_name: string;
|
|
103025
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103026
|
+
code?: (string | undefined) | null;
|
|
103027
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
103028
|
+
is_one_time_use?: boolean | undefined;
|
|
103029
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103030
|
+
card_number?: (string | undefined) | null;
|
|
103031
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
103032
|
+
is_issued?: boolean | undefined;
|
|
103033
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
103034
|
+
issued_at?: (string | undefined) | null;
|
|
103035
|
+
/** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
103036
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
103037
|
+
/** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
103038
|
+
external_type?: ('pti_card' | 'brivo_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card' | 'salto_ks_tag' | 'avigilon_alta_credential' | 'kisi_credential' | 'akiles_credential') | undefined;
|
|
103039
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
103040
|
+
external_type_display_name?: string | undefined;
|
|
103041
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
103042
|
+
created_at: string;
|
|
103043
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103044
|
+
workspace_id: string;
|
|
103045
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
103046
|
+
starts_at?: string | undefined;
|
|
103047
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
|
|
103048
|
+
ends_at?: string | undefined;
|
|
103049
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103050
|
+
errors: {
|
|
103051
|
+
error_code: string;
|
|
103052
|
+
message: string;
|
|
103053
|
+
/** Date and time at which Seam created the error. */
|
|
103054
|
+
created_at: string;
|
|
103055
|
+
}[];
|
|
103056
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103057
|
+
warnings: ({
|
|
103058
|
+
/** Date and time at which Seam created the warning. */
|
|
103059
|
+
created_at: string;
|
|
103060
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103061
|
+
message: string;
|
|
103062
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103063
|
+
warning_code: 'waiting_to_be_issued';
|
|
103064
|
+
} | {
|
|
103065
|
+
/** Date and time at which Seam created the warning. */
|
|
103066
|
+
created_at: string;
|
|
103067
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103068
|
+
message: string;
|
|
103069
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103070
|
+
warning_code: 'schedule_externally_modified';
|
|
103071
|
+
} | {
|
|
103072
|
+
/** Date and time at which Seam created the warning. */
|
|
103073
|
+
created_at: string;
|
|
103074
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103075
|
+
message: string;
|
|
103076
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103077
|
+
warning_code: 'schedule_modified';
|
|
103078
|
+
} | {
|
|
103079
|
+
/** Date and time at which Seam created the warning. */
|
|
103080
|
+
created_at: string;
|
|
103081
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103082
|
+
message: string;
|
|
103083
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103084
|
+
warning_code: 'being_deleted';
|
|
103085
|
+
} | {
|
|
103086
|
+
/** Date and time at which Seam created the warning. */
|
|
103087
|
+
created_at: string;
|
|
103088
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103089
|
+
message: string;
|
|
103090
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103091
|
+
warning_code: 'unknown_issue_with_acs_credential';
|
|
103092
|
+
} | {
|
|
103093
|
+
/** Date and time at which Seam created the warning. */
|
|
103094
|
+
created_at: string;
|
|
103095
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103096
|
+
message: string;
|
|
103097
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103098
|
+
warning_code: 'needs_to_be_reissued';
|
|
103099
|
+
} | {
|
|
103100
|
+
/** Date and time at which Seam created the warning. */
|
|
103101
|
+
created_at: string;
|
|
103102
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103103
|
+
message: string;
|
|
103104
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103105
|
+
warning_code: 'requested_code_unavailable';
|
|
103106
|
+
/** The originally requested PIN code that could not be used. */
|
|
103107
|
+
original_code: string;
|
|
103108
|
+
/** The PIN code that was assigned instead. */
|
|
103109
|
+
new_code: string;
|
|
103110
|
+
})[];
|
|
103111
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
103112
|
+
is_multi_phone_sync_credential?: boolean | undefined;
|
|
103113
|
+
/** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
103114
|
+
is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
|
|
103115
|
+
/** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
103116
|
+
latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
|
|
103117
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103118
|
+
visionline_metadata?: {
|
|
103119
|
+
/** Card function type in the Visionline access system. */
|
|
103120
|
+
card_function_type?: (('guest' | 'staff') | undefined) | undefined;
|
|
103121
|
+
/** IDs of the credentials to which you want to join. */
|
|
103122
|
+
joiner_acs_credential_ids?: (string[] | undefined) | undefined;
|
|
103123
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
103124
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
103125
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
103126
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
103127
|
+
/** Indicates whether the credential is valid. */
|
|
103128
|
+
is_valid?: (boolean | undefined) | undefined;
|
|
103129
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
103130
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
103131
|
+
/** ID of the card in the Visionline access system. */
|
|
103132
|
+
card_id?: (string | undefined) | undefined;
|
|
103133
|
+
/** ID of the credential in the Visionline access system. */
|
|
103134
|
+
credential_id?: (string | undefined) | undefined;
|
|
103135
|
+
} | undefined;
|
|
103136
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103137
|
+
assa_abloy_vostio_metadata?: {
|
|
103138
|
+
/** Indicates whether the credential should auto-join. For an auto-join credential, Seam automatically issues an override card if there are no other cards and a joiner card if there are existing cards on the doors. */
|
|
103139
|
+
auto_join?: (boolean | undefined) | undefined;
|
|
103140
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
103141
|
+
override_guest_acs_entrance_ids?: (string[] | undefined) | undefined;
|
|
103142
|
+
/** Key ID in the Vostio access system. */
|
|
103143
|
+
key_id?: (string | undefined) | undefined;
|
|
103144
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
103145
|
+
key_issuing_request_id?: (string | undefined) | undefined;
|
|
103146
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
103147
|
+
door_names?: (string[] | undefined) | undefined;
|
|
103148
|
+
/** Endpoint ID in the Vostio access system. */
|
|
103149
|
+
endpoint_id?: (string | undefined) | undefined;
|
|
103150
|
+
} | undefined;
|
|
103151
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
103152
|
+
akiles_metadata?: {
|
|
103153
|
+
/** ID of the Akiles member PIN. */
|
|
103154
|
+
member_pin_id?: (string | undefined) | undefined;
|
|
103155
|
+
} | undefined;
|
|
103156
|
+
/** Indicates whether Seam manages the credential. */
|
|
103157
|
+
is_managed: true;
|
|
103158
|
+
};
|
|
103159
|
+
} | {
|
|
103160
|
+
/** ID of the action attempt. */
|
|
103161
|
+
action_attempt_id: string;
|
|
103162
|
+
status: 'error';
|
|
103163
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103164
|
+
result: null;
|
|
103165
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
103166
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL';
|
|
103167
|
+
error: {
|
|
103168
|
+
/** Type of the error associated with the action attempt. */
|
|
103169
|
+
type: 'uncategorized_error';
|
|
103170
|
+
/** Message for the error associated with the action attempt. */
|
|
103171
|
+
message: string;
|
|
103172
|
+
} | {
|
|
103173
|
+
/** Type of the error associated with the action attempt. */
|
|
103174
|
+
type: 'action_attempt_expired';
|
|
103175
|
+
/** Message for the error associated with the action attempt. */
|
|
103176
|
+
message: string;
|
|
103177
|
+
} | {
|
|
103178
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
103179
|
+
type: 'no_credential_on_encoder';
|
|
103180
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103181
|
+
message: string;
|
|
103182
|
+
};
|
|
103183
|
+
} | {
|
|
103184
|
+
/** ID of the action attempt. */
|
|
103185
|
+
action_attempt_id: string;
|
|
103186
|
+
status: 'pending';
|
|
103187
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
103188
|
+
result: null;
|
|
103189
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
103190
|
+
error: null;
|
|
103191
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
103192
|
+
action_type: 'ASSIGN_CREDENTIAL';
|
|
103193
|
+
} | {
|
|
103194
|
+
/** ID of the action attempt. */
|
|
103195
|
+
action_attempt_id: string;
|
|
103196
|
+
status: 'success';
|
|
103197
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103198
|
+
error: null;
|
|
103199
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
103200
|
+
action_type: 'ASSIGN_CREDENTIAL';
|
|
103201
|
+
/** Result of assigning a credential. If successful, includes the updated access method with the assigned credential. */
|
|
103202
|
+
result: {
|
|
103203
|
+
/** ID of the Seam workspace associated with the access method. */
|
|
103204
|
+
workspace_id: string;
|
|
103205
|
+
/** ID of the access method. */
|
|
103206
|
+
access_method_id: string;
|
|
103207
|
+
/** Display name of the access method. */
|
|
103208
|
+
display_name: string;
|
|
103209
|
+
/** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
103210
|
+
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key';
|
|
103211
|
+
/** Date and time at which the access method was created. */
|
|
103212
|
+
created_at: string;
|
|
103213
|
+
/** Date and time at which the access method was issued. */
|
|
103214
|
+
issued_at: string | null;
|
|
103215
|
+
/** Indicates whether the access method has been issued. */
|
|
103216
|
+
is_issued: boolean;
|
|
103217
|
+
/** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
|
|
103218
|
+
display_status: string;
|
|
103219
|
+
/** URL of the Instant Key for mobile key access methods. */
|
|
103220
|
+
instant_key_url?: string | undefined;
|
|
103221
|
+
/** Token of the client session associated with the access method. */
|
|
103222
|
+
client_session_token?: string | undefined;
|
|
103223
|
+
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
103224
|
+
is_encoding_required?: boolean | undefined;
|
|
103225
|
+
/** Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued. */
|
|
103226
|
+
is_ready_for_encoding?: boolean | undefined;
|
|
103227
|
+
/** Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment. */
|
|
103228
|
+
is_assignment_required?: boolean | undefined;
|
|
103229
|
+
/** Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment. */
|
|
103230
|
+
is_ready_for_assignment?: boolean | undefined;
|
|
103231
|
+
/** The actual PIN code for code access methods. */
|
|
103232
|
+
code?: (string | null) | undefined;
|
|
103233
|
+
/** Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
|
|
103234
|
+
warnings: ({
|
|
103235
|
+
/** Date and time at which Seam created the warning. */
|
|
103236
|
+
created_at: string;
|
|
103237
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103238
|
+
message: string;
|
|
103239
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103240
|
+
warning_code: 'being_deleted';
|
|
103241
|
+
} | {
|
|
103242
|
+
/** Date and time at which Seam created the warning. */
|
|
103243
|
+
created_at: string;
|
|
103244
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103245
|
+
message: string;
|
|
103246
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103247
|
+
warning_code: 'updating_access_times';
|
|
103248
|
+
} | {
|
|
103249
|
+
/** Date and time at which Seam created the warning. */
|
|
103250
|
+
created_at: string;
|
|
103251
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103252
|
+
message: string;
|
|
103253
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103254
|
+
warning_code: 'pulled_backup_access_code';
|
|
103255
|
+
/** ID of the original access method from which this backup access method was split, if applicable. */
|
|
103256
|
+
original_access_method_id?: string | undefined;
|
|
103257
|
+
} | {
|
|
103258
|
+
/** Date and time at which Seam created the warning. */
|
|
103259
|
+
created_at: string;
|
|
103260
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103261
|
+
message: string;
|
|
103262
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103263
|
+
warning_code: 'delay_in_issuing';
|
|
103264
|
+
} | {
|
|
103265
|
+
/** Date and time at which Seam created the warning. */
|
|
103266
|
+
created_at: string;
|
|
103267
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103268
|
+
message: string;
|
|
103269
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103270
|
+
warning_code: 'user_identity_missing_email_address';
|
|
103271
|
+
} | {
|
|
103272
|
+
/** Date and time at which Seam created the warning. */
|
|
103273
|
+
created_at: string;
|
|
103274
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
103275
|
+
message: string;
|
|
103276
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
103277
|
+
warning_code: 'user_identity_missing_phone_number';
|
|
103278
|
+
})[];
|
|
103279
|
+
/** Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
|
|
103280
|
+
errors: {
|
|
103281
|
+
/** Date and time at which Seam created the error. */
|
|
103282
|
+
created_at: string;
|
|
103283
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103284
|
+
message: string;
|
|
103285
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
103286
|
+
error_code: 'failed_to_issue';
|
|
103287
|
+
}[];
|
|
103288
|
+
/** Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. */
|
|
103289
|
+
pending_mutations: ({
|
|
103290
|
+
/** Date and time at which the mutation was created. */
|
|
103291
|
+
created_at: string;
|
|
103292
|
+
/** Detailed description of the mutation. */
|
|
103293
|
+
message: string;
|
|
103294
|
+
/** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
|
|
103295
|
+
mutation_code: 'provisioning_access';
|
|
103296
|
+
/** Previous device configuration. */
|
|
103297
|
+
from: {
|
|
103298
|
+
/** Previous device IDs where access was provisioned. */
|
|
103299
|
+
device_ids: string[];
|
|
103300
|
+
};
|
|
103301
|
+
/** New device configuration. */
|
|
103302
|
+
to: {
|
|
103303
|
+
/** New device IDs where access is being provisioned. */
|
|
103304
|
+
device_ids: string[];
|
|
103305
|
+
};
|
|
103306
|
+
} | {
|
|
103307
|
+
/** Date and time at which the mutation was created. */
|
|
103308
|
+
created_at: string;
|
|
103309
|
+
/** Detailed description of the mutation. */
|
|
103310
|
+
message: string;
|
|
103311
|
+
/** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
|
|
103312
|
+
mutation_code: 'revoking_access';
|
|
103313
|
+
/** Previous device configuration. */
|
|
103314
|
+
from: {
|
|
103315
|
+
/** Previous device IDs where access existed. */
|
|
103316
|
+
device_ids: string[];
|
|
103317
|
+
};
|
|
103318
|
+
/** New device configuration. */
|
|
103319
|
+
to: {
|
|
103320
|
+
/** New device IDs where access should remain. */
|
|
103321
|
+
device_ids: string[];
|
|
103322
|
+
};
|
|
103323
|
+
} | {
|
|
103324
|
+
/** Date and time at which the mutation was created. */
|
|
103325
|
+
created_at: string;
|
|
103326
|
+
/** Detailed description of the mutation. */
|
|
103327
|
+
message: string;
|
|
103328
|
+
/** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
|
|
103329
|
+
mutation_code: 'updating_access_times';
|
|
103330
|
+
/** Previous access time configuration. */
|
|
103331
|
+
from: {
|
|
103332
|
+
/** Previous start time for access. */
|
|
103333
|
+
starts_at: string | null;
|
|
103334
|
+
/** Previous end time for access. */
|
|
103335
|
+
ends_at: string | null;
|
|
103336
|
+
};
|
|
103337
|
+
/** New access time configuration. */
|
|
103338
|
+
to: {
|
|
103339
|
+
/** New start time for access. */
|
|
103340
|
+
starts_at: string | null;
|
|
103341
|
+
/** New end time for access. */
|
|
103342
|
+
ends_at: string | null;
|
|
103343
|
+
};
|
|
103344
|
+
})[];
|
|
103345
|
+
/** ID of the customization profile associated with the access method. */
|
|
103346
|
+
customization_profile_id?: string | undefined;
|
|
103347
|
+
};
|
|
103348
|
+
} | {
|
|
103349
|
+
/** ID of the action attempt. */
|
|
103350
|
+
action_attempt_id: string;
|
|
103351
|
+
status: 'error';
|
|
103352
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103353
|
+
result: null;
|
|
103354
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
103355
|
+
action_type: 'ASSIGN_CREDENTIAL';
|
|
103356
|
+
error: {
|
|
103357
|
+
/** Type of the error associated with the action attempt. */
|
|
103358
|
+
type: 'uncategorized_error';
|
|
103359
|
+
/** Message for the error associated with the action attempt. */
|
|
103360
|
+
message: string;
|
|
103361
|
+
} | {
|
|
103362
|
+
/** Type of the error associated with the action attempt. */
|
|
103363
|
+
type: 'action_attempt_expired';
|
|
103364
|
+
/** Message for the error associated with the action attempt. */
|
|
103365
|
+
message: string;
|
|
103366
|
+
} | {
|
|
103367
|
+
/** Error type to indicate that no matching credential was found. */
|
|
103368
|
+
type: 'credential_not_found';
|
|
103369
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103370
|
+
message: string;
|
|
103371
|
+
};
|
|
103372
|
+
} | {
|
|
103373
|
+
/** ID of the action attempt. */
|
|
103374
|
+
action_attempt_id: string;
|
|
103375
|
+
status: 'pending';
|
|
103376
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
103377
|
+
result: null;
|
|
103378
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
103379
|
+
error: null;
|
|
103380
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
103381
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
103382
|
+
} | {
|
|
103383
|
+
/** ID of the action attempt. */
|
|
103384
|
+
action_attempt_id: string;
|
|
103385
|
+
status: 'success';
|
|
103386
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103387
|
+
error: null;
|
|
103388
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
103389
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
103390
|
+
/** Result of the action. */
|
|
103391
|
+
result: {};
|
|
103392
|
+
} | {
|
|
103393
|
+
/** ID of the action attempt. */
|
|
103394
|
+
action_attempt_id: string;
|
|
103395
|
+
status: 'error';
|
|
103396
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103397
|
+
result: null;
|
|
103398
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
103399
|
+
action_type: 'RESET_SANDBOX_WORKSPACE';
|
|
103400
|
+
/** Error associated with the action. */
|
|
103401
|
+
error: {
|
|
103402
|
+
/** Type of the error. */
|
|
103403
|
+
type: string;
|
|
103404
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103405
|
+
message: string;
|
|
103406
|
+
};
|
|
103407
|
+
} | {
|
|
103408
|
+
/** ID of the action attempt. */
|
|
103409
|
+
action_attempt_id: string;
|
|
103410
|
+
status: 'pending';
|
|
103411
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
103412
|
+
result: null;
|
|
103413
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
103414
|
+
error: null;
|
|
103415
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
103416
|
+
action_type: 'SET_FAN_MODE';
|
|
103417
|
+
} | {
|
|
103418
|
+
/** ID of the action attempt. */
|
|
103419
|
+
action_attempt_id: string;
|
|
103420
|
+
status: 'success';
|
|
103421
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103422
|
+
error: null;
|
|
103423
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
103424
|
+
action_type: 'SET_FAN_MODE';
|
|
103425
|
+
/** Result of the action. */
|
|
103426
|
+
result: {};
|
|
103427
|
+
} | {
|
|
103428
|
+
/** ID of the action attempt. */
|
|
103429
|
+
action_attempt_id: string;
|
|
103430
|
+
status: 'error';
|
|
103431
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103432
|
+
result: null;
|
|
103433
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
103434
|
+
action_type: 'SET_FAN_MODE';
|
|
103435
|
+
/** Error associated with the action. */
|
|
103436
|
+
error: {
|
|
103437
|
+
/** Type of the error. */
|
|
103438
|
+
type: string;
|
|
103439
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103440
|
+
message: string;
|
|
103441
|
+
};
|
|
103442
|
+
} | {
|
|
103443
|
+
/** ID of the action attempt. */
|
|
103444
|
+
action_attempt_id: string;
|
|
103445
|
+
status: 'pending';
|
|
103446
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
103447
|
+
result: null;
|
|
103448
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
103449
|
+
error: null;
|
|
103450
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
103451
|
+
action_type: 'SET_HVAC_MODE';
|
|
103452
|
+
} | {
|
|
103453
|
+
/** ID of the action attempt. */
|
|
103454
|
+
action_attempt_id: string;
|
|
103455
|
+
status: 'success';
|
|
103456
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103457
|
+
error: null;
|
|
103458
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
103459
|
+
action_type: 'SET_HVAC_MODE';
|
|
103460
|
+
/** Result of the action. */
|
|
103461
|
+
result: {};
|
|
103462
|
+
} | {
|
|
103463
|
+
/** ID of the action attempt. */
|
|
103464
|
+
action_attempt_id: string;
|
|
103465
|
+
status: 'error';
|
|
103466
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103467
|
+
result: null;
|
|
103468
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
103469
|
+
action_type: 'SET_HVAC_MODE';
|
|
103470
|
+
/** Error associated with the action. */
|
|
103471
|
+
error: {
|
|
103472
|
+
/** Type of the error. */
|
|
103473
|
+
type: string;
|
|
103474
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103475
|
+
message: string;
|
|
103476
|
+
};
|
|
103477
|
+
} | {
|
|
103478
|
+
/** ID of the action attempt. */
|
|
103479
|
+
action_attempt_id: string;
|
|
103480
|
+
status: 'pending';
|
|
103481
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
103482
|
+
result: null;
|
|
103483
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
103484
|
+
error: null;
|
|
103485
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
103486
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
103487
|
+
} | {
|
|
103488
|
+
/** ID of the action attempt. */
|
|
103489
|
+
action_attempt_id: string;
|
|
103490
|
+
status: 'success';
|
|
103491
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103492
|
+
error: null;
|
|
103493
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
103494
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
103495
|
+
/** Result of the action. */
|
|
103496
|
+
result: {};
|
|
103497
|
+
} | {
|
|
103498
|
+
/** ID of the action attempt. */
|
|
103499
|
+
action_attempt_id: string;
|
|
103500
|
+
status: 'error';
|
|
103501
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103502
|
+
result: null;
|
|
103503
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
103504
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET';
|
|
103505
|
+
/** Error associated with the action. */
|
|
103506
|
+
error: {
|
|
103507
|
+
/** Type of the error. */
|
|
103508
|
+
type: string;
|
|
103509
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103510
|
+
message: string;
|
|
103511
|
+
};
|
|
103512
|
+
} | {
|
|
103513
|
+
/** ID of the action attempt. */
|
|
103514
|
+
action_attempt_id: string;
|
|
103515
|
+
status: 'pending';
|
|
103516
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
103517
|
+
result: null;
|
|
103518
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
103519
|
+
error: null;
|
|
103520
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
103521
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
103522
|
+
} | {
|
|
103523
|
+
/** ID of the action attempt. */
|
|
103524
|
+
action_attempt_id: string;
|
|
103525
|
+
status: 'success';
|
|
103526
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
103527
|
+
error: null;
|
|
103528
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
103529
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
103530
|
+
/** Result of the action. */
|
|
103531
|
+
result: {};
|
|
103532
|
+
} | {
|
|
103533
|
+
/** ID of the action attempt. */
|
|
103534
|
+
action_attempt_id: string;
|
|
103535
|
+
status: 'error';
|
|
103536
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
103537
|
+
result: null;
|
|
103538
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
103539
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
103540
|
+
/** Error associated with the action. */
|
|
103541
|
+
error: {
|
|
103542
|
+
/** Type of the error. */
|
|
103543
|
+
type: string;
|
|
103544
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
103545
|
+
message: string;
|
|
103546
|
+
};
|
|
100654
103547
|
} | {
|
|
100655
103548
|
/** ID of the action attempt. */
|
|
100656
103549
|
action_attempt_id: string;
|
|
@@ -101093,7 +103986,7 @@ export type Routes = {
|
|
|
101093
103986
|
/** ID of the device. */
|
|
101094
103987
|
device_id: string;
|
|
101095
103988
|
/** Type of the device. */
|
|
101096
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
103989
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
101097
103990
|
/** IDs of the spaces the device is in. */
|
|
101098
103991
|
space_ids: string[];
|
|
101099
103992
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -101757,6 +104650,19 @@ export type Routes = {
|
|
|
101757
104650
|
/** Hardware version reported by the camera. */
|
|
101758
104651
|
hardware_version?: (string | undefined) | undefined;
|
|
101759
104652
|
} | undefined) | undefined;
|
|
104653
|
+
/** Metadata for an Arlo camera. */
|
|
104654
|
+
arlo_metadata?: ({
|
|
104655
|
+
/** Device ID reported by Arlo. */
|
|
104656
|
+
device_id?: (string | undefined) | undefined;
|
|
104657
|
+
/** Device name reported by Arlo. */
|
|
104658
|
+
device_name?: (string | undefined) | undefined;
|
|
104659
|
+
/** Model ID reported by Arlo. */
|
|
104660
|
+
model_id?: (string | undefined) | undefined;
|
|
104661
|
+
/** Hardware version reported by Arlo. */
|
|
104662
|
+
hardware_version?: (string | undefined) | undefined;
|
|
104663
|
+
/** Firmware version reported by Arlo. */
|
|
104664
|
+
firmware_version?: (string | undefined) | undefined;
|
|
104665
|
+
} | undefined) | undefined;
|
|
101760
104666
|
/** Metadata for a Ring device. */
|
|
101761
104667
|
ring_metadata?: {
|
|
101762
104668
|
/** Device ID for a Ring device. */
|
|
@@ -102581,6 +105487,8 @@ export type Routes = {
|
|
|
102581
105487
|
can_hvac_heat_cool?: boolean | undefined;
|
|
102582
105488
|
/** Indicates whether the thermostat can be turned off. */
|
|
102583
105489
|
can_turn_off_hvac?: boolean | undefined;
|
|
105490
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
105491
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
102584
105492
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
102585
105493
|
can_simulate_removal?: boolean | undefined;
|
|
102586
105494
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -104016,6 +106924,41 @@ export type Routes = {
|
|
|
104016
106924
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
104017
106925
|
message: string;
|
|
104018
106926
|
};
|
|
106927
|
+
} | {
|
|
106928
|
+
/** ID of the action attempt. */
|
|
106929
|
+
action_attempt_id: string;
|
|
106930
|
+
status: 'pending';
|
|
106931
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
106932
|
+
result: null;
|
|
106933
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
106934
|
+
error: null;
|
|
106935
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
106936
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
106937
|
+
} | {
|
|
106938
|
+
/** ID of the action attempt. */
|
|
106939
|
+
action_attempt_id: string;
|
|
106940
|
+
status: 'success';
|
|
106941
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
106942
|
+
error: null;
|
|
106943
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
106944
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
106945
|
+
/** Result of the action. */
|
|
106946
|
+
result: {};
|
|
106947
|
+
} | {
|
|
106948
|
+
/** ID of the action attempt. */
|
|
106949
|
+
action_attempt_id: string;
|
|
106950
|
+
status: 'error';
|
|
106951
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
106952
|
+
result: null;
|
|
106953
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
106954
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
106955
|
+
/** Error associated with the action. */
|
|
106956
|
+
error: {
|
|
106957
|
+
/** Type of the error. */
|
|
106958
|
+
type: string;
|
|
106959
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
106960
|
+
message: string;
|
|
106961
|
+
};
|
|
104019
106962
|
} | {
|
|
104020
106963
|
/** ID of the action attempt. */
|
|
104021
106964
|
action_attempt_id: string;
|
|
@@ -105836,6 +108779,41 @@ export type Routes = {
|
|
|
105836
108779
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
105837
108780
|
message: string;
|
|
105838
108781
|
};
|
|
108782
|
+
} | {
|
|
108783
|
+
/** ID of the action attempt. */
|
|
108784
|
+
action_attempt_id: string;
|
|
108785
|
+
status: 'pending';
|
|
108786
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
108787
|
+
result: null;
|
|
108788
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
108789
|
+
error: null;
|
|
108790
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
108791
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
108792
|
+
} | {
|
|
108793
|
+
/** ID of the action attempt. */
|
|
108794
|
+
action_attempt_id: string;
|
|
108795
|
+
status: 'success';
|
|
108796
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
108797
|
+
error: null;
|
|
108798
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
108799
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
108800
|
+
/** Result of the action. */
|
|
108801
|
+
result: {};
|
|
108802
|
+
} | {
|
|
108803
|
+
/** ID of the action attempt. */
|
|
108804
|
+
action_attempt_id: string;
|
|
108805
|
+
status: 'error';
|
|
108806
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
108807
|
+
result: null;
|
|
108808
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
108809
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
108810
|
+
/** Error associated with the action. */
|
|
108811
|
+
error: {
|
|
108812
|
+
/** Type of the error. */
|
|
108813
|
+
type: string;
|
|
108814
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
108815
|
+
message: string;
|
|
108816
|
+
};
|
|
105839
108817
|
} | {
|
|
105840
108818
|
/** ID of the action attempt. */
|
|
105841
108819
|
action_attempt_id: string;
|
|
@@ -106270,7 +109248,7 @@ export type Routes = {
|
|
|
106270
109248
|
/** ID of the device. */
|
|
106271
109249
|
device_id: string;
|
|
106272
109250
|
/** Type of the device. */
|
|
106273
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
109251
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
106274
109252
|
/** IDs of the spaces the device is in. */
|
|
106275
109253
|
space_ids: string[];
|
|
106276
109254
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -106934,6 +109912,19 @@ export type Routes = {
|
|
|
106934
109912
|
/** Hardware version reported by the camera. */
|
|
106935
109913
|
hardware_version?: (string | undefined) | undefined;
|
|
106936
109914
|
} | undefined) | undefined;
|
|
109915
|
+
/** Metadata for an Arlo camera. */
|
|
109916
|
+
arlo_metadata?: ({
|
|
109917
|
+
/** Device ID reported by Arlo. */
|
|
109918
|
+
device_id?: (string | undefined) | undefined;
|
|
109919
|
+
/** Device name reported by Arlo. */
|
|
109920
|
+
device_name?: (string | undefined) | undefined;
|
|
109921
|
+
/** Model ID reported by Arlo. */
|
|
109922
|
+
model_id?: (string | undefined) | undefined;
|
|
109923
|
+
/** Hardware version reported by Arlo. */
|
|
109924
|
+
hardware_version?: (string | undefined) | undefined;
|
|
109925
|
+
/** Firmware version reported by Arlo. */
|
|
109926
|
+
firmware_version?: (string | undefined) | undefined;
|
|
109927
|
+
} | undefined) | undefined;
|
|
106937
109928
|
/** Metadata for a Ring device. */
|
|
106938
109929
|
ring_metadata?: {
|
|
106939
109930
|
/** Device ID for a Ring device. */
|
|
@@ -107758,6 +110749,8 @@ export type Routes = {
|
|
|
107758
110749
|
can_hvac_heat_cool?: boolean | undefined;
|
|
107759
110750
|
/** Indicates whether the thermostat can be turned off. */
|
|
107760
110751
|
can_turn_off_hvac?: boolean | undefined;
|
|
110752
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
110753
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
107761
110754
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
107762
110755
|
can_simulate_removal?: boolean | undefined;
|
|
107763
110756
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -107787,7 +110780,7 @@ export type Routes = {
|
|
|
107787
110780
|
/** ID of the device. */
|
|
107788
110781
|
device_id: string;
|
|
107789
110782
|
/** Type of the device. */
|
|
107790
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
110783
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
107791
110784
|
/** IDs of the spaces the device is in. */
|
|
107792
110785
|
space_ids: string[];
|
|
107793
110786
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -108451,6 +111444,19 @@ export type Routes = {
|
|
|
108451
111444
|
/** Hardware version reported by the camera. */
|
|
108452
111445
|
hardware_version?: (string | undefined) | undefined;
|
|
108453
111446
|
} | undefined) | undefined;
|
|
111447
|
+
/** Metadata for an Arlo camera. */
|
|
111448
|
+
arlo_metadata?: ({
|
|
111449
|
+
/** Device ID reported by Arlo. */
|
|
111450
|
+
device_id?: (string | undefined) | undefined;
|
|
111451
|
+
/** Device name reported by Arlo. */
|
|
111452
|
+
device_name?: (string | undefined) | undefined;
|
|
111453
|
+
/** Model ID reported by Arlo. */
|
|
111454
|
+
model_id?: (string | undefined) | undefined;
|
|
111455
|
+
/** Hardware version reported by Arlo. */
|
|
111456
|
+
hardware_version?: (string | undefined) | undefined;
|
|
111457
|
+
/** Firmware version reported by Arlo. */
|
|
111458
|
+
firmware_version?: (string | undefined) | undefined;
|
|
111459
|
+
} | undefined) | undefined;
|
|
108454
111460
|
/** Metadata for a Ring device. */
|
|
108455
111461
|
ring_metadata?: {
|
|
108456
111462
|
/** Device ID for a Ring device. */
|
|
@@ -109275,6 +112281,8 @@ export type Routes = {
|
|
|
109275
112281
|
can_hvac_heat_cool?: boolean | undefined;
|
|
109276
112282
|
/** Indicates whether the thermostat can be turned off. */
|
|
109277
112283
|
can_turn_off_hvac?: boolean | undefined;
|
|
112284
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
112285
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
109278
112286
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
109279
112287
|
can_simulate_removal?: boolean | undefined;
|
|
109280
112288
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -110706,6 +113714,41 @@ export type Routes = {
|
|
|
110706
113714
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
110707
113715
|
message: string;
|
|
110708
113716
|
};
|
|
113717
|
+
} | {
|
|
113718
|
+
/** ID of the action attempt. */
|
|
113719
|
+
action_attempt_id: string;
|
|
113720
|
+
status: 'pending';
|
|
113721
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
113722
|
+
result: null;
|
|
113723
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
113724
|
+
error: null;
|
|
113725
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
113726
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
113727
|
+
} | {
|
|
113728
|
+
/** ID of the action attempt. */
|
|
113729
|
+
action_attempt_id: string;
|
|
113730
|
+
status: 'success';
|
|
113731
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
113732
|
+
error: null;
|
|
113733
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
113734
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
113735
|
+
/** Result of the action. */
|
|
113736
|
+
result: {};
|
|
113737
|
+
} | {
|
|
113738
|
+
/** ID of the action attempt. */
|
|
113739
|
+
action_attempt_id: string;
|
|
113740
|
+
status: 'error';
|
|
113741
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
113742
|
+
result: null;
|
|
113743
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
113744
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
113745
|
+
/** Error associated with the action. */
|
|
113746
|
+
error: {
|
|
113747
|
+
/** Type of the error. */
|
|
113748
|
+
type: string;
|
|
113749
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
113750
|
+
message: string;
|
|
113751
|
+
};
|
|
110709
113752
|
} | {
|
|
110710
113753
|
/** ID of the action attempt. */
|
|
110711
113754
|
action_attempt_id: string;
|
|
@@ -112727,6 +115770,41 @@ export type Routes = {
|
|
|
112727
115770
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
112728
115771
|
message: string;
|
|
112729
115772
|
};
|
|
115773
|
+
} | {
|
|
115774
|
+
/** ID of the action attempt. */
|
|
115775
|
+
action_attempt_id: string;
|
|
115776
|
+
status: 'pending';
|
|
115777
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
115778
|
+
result: null;
|
|
115779
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
115780
|
+
error: null;
|
|
115781
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
115782
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
115783
|
+
} | {
|
|
115784
|
+
/** ID of the action attempt. */
|
|
115785
|
+
action_attempt_id: string;
|
|
115786
|
+
status: 'success';
|
|
115787
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
115788
|
+
error: null;
|
|
115789
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
115790
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
115791
|
+
/** Result of the action. */
|
|
115792
|
+
result: {};
|
|
115793
|
+
} | {
|
|
115794
|
+
/** ID of the action attempt. */
|
|
115795
|
+
action_attempt_id: string;
|
|
115796
|
+
status: 'error';
|
|
115797
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
115798
|
+
result: null;
|
|
115799
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
115800
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
115801
|
+
/** Error associated with the action. */
|
|
115802
|
+
error: {
|
|
115803
|
+
/** Type of the error. */
|
|
115804
|
+
type: string;
|
|
115805
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
115806
|
+
message: string;
|
|
115807
|
+
};
|
|
112730
115808
|
} | {
|
|
112731
115809
|
/** ID of the action attempt. */
|
|
112732
115810
|
action_attempt_id: string;
|
|
@@ -114570,6 +117648,41 @@ export type Routes = {
|
|
|
114570
117648
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
114571
117649
|
message: string;
|
|
114572
117650
|
};
|
|
117651
|
+
} | {
|
|
117652
|
+
/** ID of the action attempt. */
|
|
117653
|
+
action_attempt_id: string;
|
|
117654
|
+
status: 'pending';
|
|
117655
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117656
|
+
result: null;
|
|
117657
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
117658
|
+
error: null;
|
|
117659
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
117660
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
117661
|
+
} | {
|
|
117662
|
+
/** ID of the action attempt. */
|
|
117663
|
+
action_attempt_id: string;
|
|
117664
|
+
status: 'success';
|
|
117665
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117666
|
+
error: null;
|
|
117667
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
117668
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
117669
|
+
/** Result of the action. */
|
|
117670
|
+
result: {};
|
|
117671
|
+
} | {
|
|
117672
|
+
/** ID of the action attempt. */
|
|
117673
|
+
action_attempt_id: string;
|
|
117674
|
+
status: 'error';
|
|
117675
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117676
|
+
result: null;
|
|
117677
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
117678
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
117679
|
+
/** Error associated with the action. */
|
|
117680
|
+
error: {
|
|
117681
|
+
/** Type of the error. */
|
|
117682
|
+
type: string;
|
|
117683
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117684
|
+
message: string;
|
|
117685
|
+
};
|
|
114573
117686
|
} | {
|
|
114574
117687
|
/** ID of the action attempt. */
|
|
114575
117688
|
action_attempt_id: string;
|
|
@@ -116525,6 +119638,41 @@ export type Routes = {
|
|
|
116525
119638
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116526
119639
|
message: string;
|
|
116527
119640
|
};
|
|
119641
|
+
} | {
|
|
119642
|
+
/** ID of the action attempt. */
|
|
119643
|
+
action_attempt_id: string;
|
|
119644
|
+
status: 'pending';
|
|
119645
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
119646
|
+
result: null;
|
|
119647
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
119648
|
+
error: null;
|
|
119649
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
119650
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
119651
|
+
} | {
|
|
119652
|
+
/** ID of the action attempt. */
|
|
119653
|
+
action_attempt_id: string;
|
|
119654
|
+
status: 'success';
|
|
119655
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
119656
|
+
error: null;
|
|
119657
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
119658
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
119659
|
+
/** Result of the action. */
|
|
119660
|
+
result: {};
|
|
119661
|
+
} | {
|
|
119662
|
+
/** ID of the action attempt. */
|
|
119663
|
+
action_attempt_id: string;
|
|
119664
|
+
status: 'error';
|
|
119665
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
119666
|
+
result: null;
|
|
119667
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
119668
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
119669
|
+
/** Error associated with the action. */
|
|
119670
|
+
error: {
|
|
119671
|
+
/** Type of the error. */
|
|
119672
|
+
type: string;
|
|
119673
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
119674
|
+
message: string;
|
|
119675
|
+
};
|
|
116528
119676
|
} | {
|
|
116529
119677
|
/** ID of the action attempt. */
|
|
116530
119678
|
action_attempt_id: string;
|
|
@@ -117558,7 +120706,7 @@ export type Routes = {
|
|
|
117558
120706
|
/** ID of the device. */
|
|
117559
120707
|
device_id: string;
|
|
117560
120708
|
/** Type of the device. */
|
|
117561
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
120709
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
117562
120710
|
/** IDs of the spaces the device is in. */
|
|
117563
120711
|
space_ids: string[];
|
|
117564
120712
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -118222,6 +121370,19 @@ export type Routes = {
|
|
|
118222
121370
|
/** Hardware version reported by the camera. */
|
|
118223
121371
|
hardware_version?: (string | undefined) | undefined;
|
|
118224
121372
|
} | undefined) | undefined;
|
|
121373
|
+
/** Metadata for an Arlo camera. */
|
|
121374
|
+
arlo_metadata?: ({
|
|
121375
|
+
/** Device ID reported by Arlo. */
|
|
121376
|
+
device_id?: (string | undefined) | undefined;
|
|
121377
|
+
/** Device name reported by Arlo. */
|
|
121378
|
+
device_name?: (string | undefined) | undefined;
|
|
121379
|
+
/** Model ID reported by Arlo. */
|
|
121380
|
+
model_id?: (string | undefined) | undefined;
|
|
121381
|
+
/** Hardware version reported by Arlo. */
|
|
121382
|
+
hardware_version?: (string | undefined) | undefined;
|
|
121383
|
+
/** Firmware version reported by Arlo. */
|
|
121384
|
+
firmware_version?: (string | undefined) | undefined;
|
|
121385
|
+
} | undefined) | undefined;
|
|
118225
121386
|
/** Metadata for a Ring device. */
|
|
118226
121387
|
ring_metadata?: {
|
|
118227
121388
|
/** Device ID for a Ring device. */
|
|
@@ -119046,6 +122207,8 @@ export type Routes = {
|
|
|
119046
122207
|
can_hvac_heat_cool?: boolean | undefined;
|
|
119047
122208
|
/** Indicates whether the thermostat can be turned off. */
|
|
119048
122209
|
can_turn_off_hvac?: boolean | undefined;
|
|
122210
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
122211
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
119049
122212
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
119050
122213
|
can_simulate_removal?: boolean | undefined;
|
|
119051
122214
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -119077,7 +122240,7 @@ export type Routes = {
|
|
|
119077
122240
|
/** ID of the device. */
|
|
119078
122241
|
device_id: string;
|
|
119079
122242
|
/** Type of the device. */
|
|
119080
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
122243
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
119081
122244
|
/** IDs of the spaces the device is in. */
|
|
119082
122245
|
space_ids: string[];
|
|
119083
122246
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -119741,6 +122904,19 @@ export type Routes = {
|
|
|
119741
122904
|
/** Hardware version reported by the camera. */
|
|
119742
122905
|
hardware_version?: (string | undefined) | undefined;
|
|
119743
122906
|
} | undefined) | undefined;
|
|
122907
|
+
/** Metadata for an Arlo camera. */
|
|
122908
|
+
arlo_metadata?: ({
|
|
122909
|
+
/** Device ID reported by Arlo. */
|
|
122910
|
+
device_id?: (string | undefined) | undefined;
|
|
122911
|
+
/** Device name reported by Arlo. */
|
|
122912
|
+
device_name?: (string | undefined) | undefined;
|
|
122913
|
+
/** Model ID reported by Arlo. */
|
|
122914
|
+
model_id?: (string | undefined) | undefined;
|
|
122915
|
+
/** Hardware version reported by Arlo. */
|
|
122916
|
+
hardware_version?: (string | undefined) | undefined;
|
|
122917
|
+
/** Firmware version reported by Arlo. */
|
|
122918
|
+
firmware_version?: (string | undefined) | undefined;
|
|
122919
|
+
} | undefined) | undefined;
|
|
119744
122920
|
/** Metadata for a Ring device. */
|
|
119745
122921
|
ring_metadata?: {
|
|
119746
122922
|
/** Device ID for a Ring device. */
|
|
@@ -120565,6 +123741,8 @@ export type Routes = {
|
|
|
120565
123741
|
can_hvac_heat_cool?: boolean | undefined;
|
|
120566
123742
|
/** Indicates whether the thermostat can be turned off. */
|
|
120567
123743
|
can_turn_off_hvac?: boolean | undefined;
|
|
123744
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
123745
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
120568
123746
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
120569
123747
|
can_simulate_removal?: boolean | undefined;
|
|
120570
123748
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -121933,7 +125111,7 @@ export type Routes = {
|
|
|
121933
125111
|
/** ID of the device. */
|
|
121934
125112
|
device_id: string;
|
|
121935
125113
|
/** Type of the device. */
|
|
121936
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
125114
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
121937
125115
|
/** IDs of the spaces the device is in. */
|
|
121938
125116
|
space_ids: string[];
|
|
121939
125117
|
/** Optional nickname to describe the device, settable through Seam. */
|
|
@@ -122597,6 +125775,19 @@ export type Routes = {
|
|
|
122597
125775
|
/** Hardware version reported by the camera. */
|
|
122598
125776
|
hardware_version?: (string | undefined) | undefined;
|
|
122599
125777
|
} | undefined) | undefined;
|
|
125778
|
+
/** Metadata for an Arlo camera. */
|
|
125779
|
+
arlo_metadata?: ({
|
|
125780
|
+
/** Device ID reported by Arlo. */
|
|
125781
|
+
device_id?: (string | undefined) | undefined;
|
|
125782
|
+
/** Device name reported by Arlo. */
|
|
125783
|
+
device_name?: (string | undefined) | undefined;
|
|
125784
|
+
/** Model ID reported by Arlo. */
|
|
125785
|
+
model_id?: (string | undefined) | undefined;
|
|
125786
|
+
/** Hardware version reported by Arlo. */
|
|
125787
|
+
hardware_version?: (string | undefined) | undefined;
|
|
125788
|
+
/** Firmware version reported by Arlo. */
|
|
125789
|
+
firmware_version?: (string | undefined) | undefined;
|
|
125790
|
+
} | undefined) | undefined;
|
|
122600
125791
|
/** Metadata for a Ring device. */
|
|
122601
125792
|
ring_metadata?: {
|
|
122602
125793
|
/** Device ID for a Ring device. */
|
|
@@ -123421,6 +126612,8 @@ export type Routes = {
|
|
|
123421
126612
|
can_hvac_heat_cool?: boolean | undefined;
|
|
123422
126613
|
/** Indicates whether the thermostat can be turned off. */
|
|
123423
126614
|
can_turn_off_hvac?: boolean | undefined;
|
|
126615
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
126616
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
123424
126617
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
123425
126618
|
can_simulate_removal?: boolean | undefined;
|
|
123426
126619
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -125641,6 +128834,41 @@ export type Routes = {
|
|
|
125641
128834
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
125642
128835
|
message: string;
|
|
125643
128836
|
};
|
|
128837
|
+
} | {
|
|
128838
|
+
/** ID of the action attempt. */
|
|
128839
|
+
action_attempt_id: string;
|
|
128840
|
+
status: 'pending';
|
|
128841
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
128842
|
+
result: null;
|
|
128843
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
128844
|
+
error: null;
|
|
128845
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
128846
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
128847
|
+
} | {
|
|
128848
|
+
/** ID of the action attempt. */
|
|
128849
|
+
action_attempt_id: string;
|
|
128850
|
+
status: 'success';
|
|
128851
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
128852
|
+
error: null;
|
|
128853
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
128854
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
128855
|
+
/** Result of the action. */
|
|
128856
|
+
result: {};
|
|
128857
|
+
} | {
|
|
128858
|
+
/** ID of the action attempt. */
|
|
128859
|
+
action_attempt_id: string;
|
|
128860
|
+
status: 'error';
|
|
128861
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
128862
|
+
result: null;
|
|
128863
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
128864
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
128865
|
+
/** Error associated with the action. */
|
|
128866
|
+
error: {
|
|
128867
|
+
/** Type of the error. */
|
|
128868
|
+
type: string;
|
|
128869
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
128870
|
+
message: string;
|
|
128871
|
+
};
|
|
125644
128872
|
} | {
|
|
125645
128873
|
/** ID of the action attempt. */
|
|
125646
128874
|
action_attempt_id: string;
|
|
@@ -126507,7 +129735,7 @@ export type Routes = {
|
|
|
126507
129735
|
/** ID of the device. */
|
|
126508
129736
|
device_id: string;
|
|
126509
129737
|
/** Type of the device. */
|
|
126510
|
-
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera');
|
|
129738
|
+
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' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'yacan_lock' | 'keyincode_lock' | 'omnitec_lock' | 'kisi_lock' | 'aqara_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | ('ring_camera' | 'tapo_camera' | 'arlo_camera');
|
|
126511
129739
|
/** Unique identifier for the account associated with the device. */
|
|
126512
129740
|
connected_account_id: string;
|
|
126513
129741
|
/** Location information for the device. */
|
|
@@ -126967,6 +130195,8 @@ export type Routes = {
|
|
|
126967
130195
|
can_hvac_heat_cool?: boolean | undefined;
|
|
126968
130196
|
/** Indicates whether the thermostat can be turned off. */
|
|
126969
130197
|
can_turn_off_hvac?: boolean | undefined;
|
|
130198
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
130199
|
+
can_activate_weekly_program?: boolean | undefined;
|
|
126970
130200
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
126971
130201
|
can_simulate_removal?: boolean | undefined;
|
|
126972
130202
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -133950,6 +137180,41 @@ export type Routes = {
|
|
|
133950
137180
|
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
133951
137181
|
message: string;
|
|
133952
137182
|
};
|
|
137183
|
+
} | {
|
|
137184
|
+
/** ID of the action attempt. */
|
|
137185
|
+
action_attempt_id: string;
|
|
137186
|
+
status: 'pending';
|
|
137187
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
137188
|
+
result: null;
|
|
137189
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
137190
|
+
error: null;
|
|
137191
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
137192
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
137193
|
+
} | {
|
|
137194
|
+
/** ID of the action attempt. */
|
|
137195
|
+
action_attempt_id: string;
|
|
137196
|
+
status: 'success';
|
|
137197
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
137198
|
+
error: null;
|
|
137199
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
137200
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
137201
|
+
/** Result of the action. */
|
|
137202
|
+
result: {};
|
|
137203
|
+
} | {
|
|
137204
|
+
/** ID of the action attempt. */
|
|
137205
|
+
action_attempt_id: string;
|
|
137206
|
+
status: 'error';
|
|
137207
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
137208
|
+
result: null;
|
|
137209
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
137210
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM';
|
|
137211
|
+
/** Error associated with the action. */
|
|
137212
|
+
error: {
|
|
137213
|
+
/** Type of the error. */
|
|
137214
|
+
type: string;
|
|
137215
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
137216
|
+
message: string;
|
|
137217
|
+
};
|
|
133953
137218
|
} | {
|
|
133954
137219
|
/** ID of the action attempt. */
|
|
133955
137220
|
action_attempt_id: string;
|