@seamapi/types 1.766.0 → 1.768.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/connect.cjs +410 -130
- package/dist/connect.cjs.map +1 -1
- package/dist/connect.d.cts +2887 -10
- package/dist/index.cjs +410 -130
- package/dist/index.cjs.map +1 -1
- 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/configure-auto-lock.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/configure-auto-lock.js +31 -0
- package/lib/seam/connect/models/action-attempts/configure-auto-lock.js.map +1 -0
- package/lib/seam/connect/models/batch.d.ts +166 -0
- package/lib/seam/connect/models/customer/customer-portal.js +6 -2
- package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
- package/lib/seam/connect/models/customer/user-identity-resources.js +1 -0
- package/lib/seam/connect/models/customer/user-identity-resources.js.map +1 -1
- package/lib/seam/connect/models/devices/capability-properties/index.d.ts +6 -0
- package/lib/seam/connect/models/devices/capability-properties/lock.d.ts +6 -0
- package/lib/seam/connect/models/devices/capability-properties/lock.js +12 -0
- package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
- package/lib/seam/connect/models/devices/device-metadata.d.ts +7 -0
- package/lib/seam/connect/models/devices/device-metadata.js +3 -0
- package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
- package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
- package/lib/seam/connect/models/devices/device.d.ts +25 -0
- package/lib/seam/connect/models/devices/device.js +1 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +17 -0
- package/lib/seam/connect/openapi.d.ts +142 -0
- package/lib/seam/connect/openapi.js +239 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +2758 -306
- 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/configure-auto-lock.ts +46 -0
- package/src/lib/seam/connect/models/customer/customer-portal.ts +6 -4
- package/src/lib/seam/connect/models/customer/user-identity-resources.ts +1 -0
- package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +12 -0
- package/src/lib/seam/connect/models/devices/device-metadata.ts +5 -0
- package/src/lib/seam/connect/models/devices/device.ts +1 -0
- package/src/lib/seam/connect/openapi.ts +264 -0
- package/src/lib/seam/connect/route-types.ts +3085 -330
|
@@ -1234,6 +1234,44 @@ export type Routes = {
|
|
|
1234
1234
|
message: string
|
|
1235
1235
|
}
|
|
1236
1236
|
}
|
|
1237
|
+
| {
|
|
1238
|
+
/** ID of the action attempt. */
|
|
1239
|
+
action_attempt_id: string
|
|
1240
|
+
status: 'pending'
|
|
1241
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
1242
|
+
result: null
|
|
1243
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
1244
|
+
error: null
|
|
1245
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
1246
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
1247
|
+
}
|
|
1248
|
+
| {
|
|
1249
|
+
/** ID of the action attempt. */
|
|
1250
|
+
action_attempt_id: string
|
|
1251
|
+
status: 'success'
|
|
1252
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
1253
|
+
error: null
|
|
1254
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
1255
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
1256
|
+
/** Result of the action. */
|
|
1257
|
+
result: {}
|
|
1258
|
+
}
|
|
1259
|
+
| {
|
|
1260
|
+
/** ID of the action attempt. */
|
|
1261
|
+
action_attempt_id: string
|
|
1262
|
+
status: 'error'
|
|
1263
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
1264
|
+
result: null
|
|
1265
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
1266
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
1267
|
+
/** Error associated with the action. */
|
|
1268
|
+
error: {
|
|
1269
|
+
/** Type of the error. */
|
|
1270
|
+
type: string
|
|
1271
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
1272
|
+
message: string
|
|
1273
|
+
}
|
|
1274
|
+
}
|
|
1237
1275
|
| {
|
|
1238
1276
|
/** ID of the action attempt. */
|
|
1239
1277
|
action_attempt_id: string
|
|
@@ -3892,6 +3930,44 @@ export type Routes = {
|
|
|
3892
3930
|
message: string
|
|
3893
3931
|
}
|
|
3894
3932
|
}
|
|
3933
|
+
| {
|
|
3934
|
+
/** ID of the action attempt. */
|
|
3935
|
+
action_attempt_id: string
|
|
3936
|
+
status: 'pending'
|
|
3937
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
3938
|
+
result: null
|
|
3939
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
3940
|
+
error: null
|
|
3941
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
3942
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
3943
|
+
}
|
|
3944
|
+
| {
|
|
3945
|
+
/** ID of the action attempt. */
|
|
3946
|
+
action_attempt_id: string
|
|
3947
|
+
status: 'success'
|
|
3948
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
3949
|
+
error: null
|
|
3950
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
3951
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
3952
|
+
/** Result of the action. */
|
|
3953
|
+
result: {}
|
|
3954
|
+
}
|
|
3955
|
+
| {
|
|
3956
|
+
/** ID of the action attempt. */
|
|
3957
|
+
action_attempt_id: string
|
|
3958
|
+
status: 'error'
|
|
3959
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
3960
|
+
result: null
|
|
3961
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
3962
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
3963
|
+
/** Error associated with the action. */
|
|
3964
|
+
error: {
|
|
3965
|
+
/** Type of the error. */
|
|
3966
|
+
type: string
|
|
3967
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
3968
|
+
message: string
|
|
3969
|
+
}
|
|
3970
|
+
}
|
|
3895
3971
|
| {
|
|
3896
3972
|
/** ID of the action attempt. */
|
|
3897
3973
|
action_attempt_id: string
|
|
@@ -8454,6 +8530,44 @@ export type Routes = {
|
|
|
8454
8530
|
message: string
|
|
8455
8531
|
}
|
|
8456
8532
|
}
|
|
8533
|
+
| {
|
|
8534
|
+
/** ID of the action attempt. */
|
|
8535
|
+
action_attempt_id: string
|
|
8536
|
+
status: 'pending'
|
|
8537
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
8538
|
+
result: null
|
|
8539
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
8540
|
+
error: null
|
|
8541
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
8542
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
8543
|
+
}
|
|
8544
|
+
| {
|
|
8545
|
+
/** ID of the action attempt. */
|
|
8546
|
+
action_attempt_id: string
|
|
8547
|
+
status: 'success'
|
|
8548
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
8549
|
+
error: null
|
|
8550
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
8551
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
8552
|
+
/** Result of the action. */
|
|
8553
|
+
result: {}
|
|
8554
|
+
}
|
|
8555
|
+
| {
|
|
8556
|
+
/** ID of the action attempt. */
|
|
8557
|
+
action_attempt_id: string
|
|
8558
|
+
status: 'error'
|
|
8559
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
8560
|
+
result: null
|
|
8561
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
8562
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
8563
|
+
/** Error associated with the action. */
|
|
8564
|
+
error: {
|
|
8565
|
+
/** Type of the error. */
|
|
8566
|
+
type: string
|
|
8567
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
8568
|
+
message: string
|
|
8569
|
+
}
|
|
8570
|
+
}
|
|
8457
8571
|
| {
|
|
8458
8572
|
/** ID of the action attempt. */
|
|
8459
8573
|
action_attempt_id: string
|
|
@@ -11148,6 +11262,44 @@ export type Routes = {
|
|
|
11148
11262
|
message: string
|
|
11149
11263
|
}
|
|
11150
11264
|
}
|
|
11265
|
+
| {
|
|
11266
|
+
/** ID of the action attempt. */
|
|
11267
|
+
action_attempt_id: string
|
|
11268
|
+
status: 'pending'
|
|
11269
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
11270
|
+
result: null
|
|
11271
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
11272
|
+
error: null
|
|
11273
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
11274
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
11275
|
+
}
|
|
11276
|
+
| {
|
|
11277
|
+
/** ID of the action attempt. */
|
|
11278
|
+
action_attempt_id: string
|
|
11279
|
+
status: 'success'
|
|
11280
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
11281
|
+
error: null
|
|
11282
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
11283
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
11284
|
+
/** Result of the action. */
|
|
11285
|
+
result: {}
|
|
11286
|
+
}
|
|
11287
|
+
| {
|
|
11288
|
+
/** ID of the action attempt. */
|
|
11289
|
+
action_attempt_id: string
|
|
11290
|
+
status: 'error'
|
|
11291
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
11292
|
+
result: null
|
|
11293
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
11294
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
11295
|
+
/** Error associated with the action. */
|
|
11296
|
+
error: {
|
|
11297
|
+
/** Type of the error. */
|
|
11298
|
+
type: string
|
|
11299
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
11300
|
+
message: string
|
|
11301
|
+
}
|
|
11302
|
+
}
|
|
11151
11303
|
| {
|
|
11152
11304
|
/** ID of the action attempt. */
|
|
11153
11305
|
action_attempt_id: string
|
|
@@ -12434,6 +12586,8 @@ export type Routes = {
|
|
|
12434
12586
|
incomplete_keyboard_passcode: boolean
|
|
12435
12587
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
12436
12588
|
wifi: boolean
|
|
12589
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
12590
|
+
auto_lock_time_config: boolean
|
|
12437
12591
|
}
|
|
12438
12592
|
/** Indicates whether a TTLock device has a gateway. */
|
|
12439
12593
|
has_gateway?: boolean | undefined
|
|
@@ -12794,6 +12948,10 @@ export type Routes = {
|
|
|
12794
12948
|
| undefined
|
|
12795
12949
|
/** Indicates whether the door is open. */
|
|
12796
12950
|
door_open?: (boolean | undefined) | undefined
|
|
12951
|
+
/** Indicates whether automatic locking is enabled. */
|
|
12952
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
12953
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
12954
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
12797
12955
|
} & {
|
|
12798
12956
|
/** Reported temperature in °F. */
|
|
12799
12957
|
temperature_fahrenheit?: number | undefined
|
|
@@ -13617,6 +13775,7 @@ export type Routes = {
|
|
|
13617
13775
|
can_simulate_hub_connection?: boolean | undefined
|
|
13618
13776
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
13619
13777
|
can_simulate_paid_subscription?: boolean | undefined
|
|
13778
|
+
can_configure_auto_lock?: boolean | undefined
|
|
13620
13779
|
}[]
|
|
13621
13780
|
| undefined
|
|
13622
13781
|
acs_entrances?:
|
|
@@ -16499,6 +16658,44 @@ export type Routes = {
|
|
|
16499
16658
|
message: string
|
|
16500
16659
|
}
|
|
16501
16660
|
}
|
|
16661
|
+
| {
|
|
16662
|
+
/** ID of the action attempt. */
|
|
16663
|
+
action_attempt_id: string
|
|
16664
|
+
status: 'pending'
|
|
16665
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
16666
|
+
result: null
|
|
16667
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
16668
|
+
error: null
|
|
16669
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
16670
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
16671
|
+
}
|
|
16672
|
+
| {
|
|
16673
|
+
/** ID of the action attempt. */
|
|
16674
|
+
action_attempt_id: string
|
|
16675
|
+
status: 'success'
|
|
16676
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
16677
|
+
error: null
|
|
16678
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
16679
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
16680
|
+
/** Result of the action. */
|
|
16681
|
+
result: {}
|
|
16682
|
+
}
|
|
16683
|
+
| {
|
|
16684
|
+
/** ID of the action attempt. */
|
|
16685
|
+
action_attempt_id: string
|
|
16686
|
+
status: 'error'
|
|
16687
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
16688
|
+
result: null
|
|
16689
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
16690
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
16691
|
+
/** Error associated with the action. */
|
|
16692
|
+
error: {
|
|
16693
|
+
/** Type of the error. */
|
|
16694
|
+
type: string
|
|
16695
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
16696
|
+
message: string
|
|
16697
|
+
}
|
|
16698
|
+
}
|
|
16502
16699
|
| {
|
|
16503
16700
|
/** ID of the action attempt. */
|
|
16504
16701
|
action_attempt_id: string
|
|
@@ -17450,6 +17647,8 @@ export type Routes = {
|
|
|
17450
17647
|
incomplete_keyboard_passcode: boolean
|
|
17451
17648
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
17452
17649
|
wifi: boolean
|
|
17650
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
17651
|
+
auto_lock_time_config: boolean
|
|
17453
17652
|
}
|
|
17454
17653
|
/** Indicates whether a TTLock device has a gateway. */
|
|
17455
17654
|
has_gateway?: boolean | undefined
|
|
@@ -17810,6 +18009,10 @@ export type Routes = {
|
|
|
17810
18009
|
| undefined
|
|
17811
18010
|
/** Indicates whether the door is open. */
|
|
17812
18011
|
door_open?: (boolean | undefined) | undefined
|
|
18012
|
+
/** Indicates whether automatic locking is enabled. */
|
|
18013
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
18014
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
18015
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
17813
18016
|
} & {
|
|
17814
18017
|
/** Reported temperature in °F. */
|
|
17815
18018
|
temperature_fahrenheit?: number | undefined
|
|
@@ -18633,6 +18836,7 @@ export type Routes = {
|
|
|
18633
18836
|
can_simulate_hub_connection?: boolean | undefined
|
|
18634
18837
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
18635
18838
|
can_simulate_paid_subscription?: boolean | undefined
|
|
18839
|
+
can_configure_auto_lock?: boolean | undefined
|
|
18636
18840
|
}[]
|
|
18637
18841
|
| undefined
|
|
18638
18842
|
acs_entrances?:
|
|
@@ -24201,6 +24405,44 @@ export type Routes = {
|
|
|
24201
24405
|
message: string
|
|
24202
24406
|
}
|
|
24203
24407
|
}
|
|
24408
|
+
| {
|
|
24409
|
+
/** ID of the action attempt. */
|
|
24410
|
+
action_attempt_id: string
|
|
24411
|
+
status: 'pending'
|
|
24412
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
24413
|
+
result: null
|
|
24414
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
24415
|
+
error: null
|
|
24416
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
24417
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
24418
|
+
}
|
|
24419
|
+
| {
|
|
24420
|
+
/** ID of the action attempt. */
|
|
24421
|
+
action_attempt_id: string
|
|
24422
|
+
status: 'success'
|
|
24423
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
24424
|
+
error: null
|
|
24425
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
24426
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
24427
|
+
/** Result of the action. */
|
|
24428
|
+
result: {}
|
|
24429
|
+
}
|
|
24430
|
+
| {
|
|
24431
|
+
/** ID of the action attempt. */
|
|
24432
|
+
action_attempt_id: string
|
|
24433
|
+
status: 'error'
|
|
24434
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
24435
|
+
result: null
|
|
24436
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
24437
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
24438
|
+
/** Error associated with the action. */
|
|
24439
|
+
error: {
|
|
24440
|
+
/** Type of the error. */
|
|
24441
|
+
type: string
|
|
24442
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
24443
|
+
message: string
|
|
24444
|
+
}
|
|
24445
|
+
}
|
|
24204
24446
|
| {
|
|
24205
24447
|
/** ID of the action attempt. */
|
|
24206
24448
|
action_attempt_id: string
|
|
@@ -25791,6 +26033,44 @@ export type Routes = {
|
|
|
25791
26033
|
message: string
|
|
25792
26034
|
}
|
|
25793
26035
|
}
|
|
26036
|
+
| {
|
|
26037
|
+
/** ID of the action attempt. */
|
|
26038
|
+
action_attempt_id: string
|
|
26039
|
+
status: 'pending'
|
|
26040
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
26041
|
+
result: null
|
|
26042
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
26043
|
+
error: null
|
|
26044
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
26045
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
26046
|
+
}
|
|
26047
|
+
| {
|
|
26048
|
+
/** ID of the action attempt. */
|
|
26049
|
+
action_attempt_id: string
|
|
26050
|
+
status: 'success'
|
|
26051
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
26052
|
+
error: null
|
|
26053
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
26054
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
26055
|
+
/** Result of the action. */
|
|
26056
|
+
result: {}
|
|
26057
|
+
}
|
|
26058
|
+
| {
|
|
26059
|
+
/** ID of the action attempt. */
|
|
26060
|
+
action_attempt_id: string
|
|
26061
|
+
status: 'error'
|
|
26062
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
26063
|
+
result: null
|
|
26064
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
26065
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
26066
|
+
/** Error associated with the action. */
|
|
26067
|
+
error: {
|
|
26068
|
+
/** Type of the error. */
|
|
26069
|
+
type: string
|
|
26070
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
26071
|
+
message: string
|
|
26072
|
+
}
|
|
26073
|
+
}
|
|
25794
26074
|
| {
|
|
25795
26075
|
/** ID of the action attempt. */
|
|
25796
26076
|
action_attempt_id: string
|
|
@@ -27935,6 +28215,44 @@ export type Routes = {
|
|
|
27935
28215
|
message: string
|
|
27936
28216
|
}
|
|
27937
28217
|
}
|
|
28218
|
+
| {
|
|
28219
|
+
/** ID of the action attempt. */
|
|
28220
|
+
action_attempt_id: string
|
|
28221
|
+
status: 'pending'
|
|
28222
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
28223
|
+
result: null
|
|
28224
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
28225
|
+
error: null
|
|
28226
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
28227
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
28228
|
+
}
|
|
28229
|
+
| {
|
|
28230
|
+
/** ID of the action attempt. */
|
|
28231
|
+
action_attempt_id: string
|
|
28232
|
+
status: 'success'
|
|
28233
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
28234
|
+
error: null
|
|
28235
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
28236
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
28237
|
+
/** Result of the action. */
|
|
28238
|
+
result: {}
|
|
28239
|
+
}
|
|
28240
|
+
| {
|
|
28241
|
+
/** ID of the action attempt. */
|
|
28242
|
+
action_attempt_id: string
|
|
28243
|
+
status: 'error'
|
|
28244
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
28245
|
+
result: null
|
|
28246
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
28247
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
28248
|
+
/** Error associated with the action. */
|
|
28249
|
+
error: {
|
|
28250
|
+
/** Type of the error. */
|
|
28251
|
+
type: string
|
|
28252
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
28253
|
+
message: string
|
|
28254
|
+
}
|
|
28255
|
+
}
|
|
27938
28256
|
| {
|
|
27939
28257
|
/** ID of the action attempt. */
|
|
27940
28258
|
action_attempt_id: string
|
|
@@ -31819,6 +32137,44 @@ export type Routes = {
|
|
|
31819
32137
|
message: string
|
|
31820
32138
|
}
|
|
31821
32139
|
}
|
|
32140
|
+
| {
|
|
32141
|
+
/** ID of the action attempt. */
|
|
32142
|
+
action_attempt_id: string
|
|
32143
|
+
status: 'pending'
|
|
32144
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
32145
|
+
result: null
|
|
32146
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
32147
|
+
error: null
|
|
32148
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
32149
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
32150
|
+
}
|
|
32151
|
+
| {
|
|
32152
|
+
/** ID of the action attempt. */
|
|
32153
|
+
action_attempt_id: string
|
|
32154
|
+
status: 'success'
|
|
32155
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
32156
|
+
error: null
|
|
32157
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
32158
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
32159
|
+
/** Result of the action. */
|
|
32160
|
+
result: {}
|
|
32161
|
+
}
|
|
32162
|
+
| {
|
|
32163
|
+
/** ID of the action attempt. */
|
|
32164
|
+
action_attempt_id: string
|
|
32165
|
+
status: 'error'
|
|
32166
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
32167
|
+
result: null
|
|
32168
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
32169
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
32170
|
+
/** Error associated with the action. */
|
|
32171
|
+
error: {
|
|
32172
|
+
/** Type of the error. */
|
|
32173
|
+
type: string
|
|
32174
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
32175
|
+
message: string
|
|
32176
|
+
}
|
|
32177
|
+
}
|
|
31822
32178
|
| {
|
|
31823
32179
|
/** ID of the action attempt. */
|
|
31824
32180
|
action_attempt_id: string
|
|
@@ -33298,6 +33654,44 @@ export type Routes = {
|
|
|
33298
33654
|
message: string
|
|
33299
33655
|
}
|
|
33300
33656
|
}
|
|
33657
|
+
| {
|
|
33658
|
+
/** ID of the action attempt. */
|
|
33659
|
+
action_attempt_id: string
|
|
33660
|
+
status: 'pending'
|
|
33661
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
33662
|
+
result: null
|
|
33663
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
33664
|
+
error: null
|
|
33665
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
33666
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
33667
|
+
}
|
|
33668
|
+
| {
|
|
33669
|
+
/** ID of the action attempt. */
|
|
33670
|
+
action_attempt_id: string
|
|
33671
|
+
status: 'success'
|
|
33672
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
33673
|
+
error: null
|
|
33674
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
33675
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
33676
|
+
/** Result of the action. */
|
|
33677
|
+
result: {}
|
|
33678
|
+
}
|
|
33679
|
+
| {
|
|
33680
|
+
/** ID of the action attempt. */
|
|
33681
|
+
action_attempt_id: string
|
|
33682
|
+
status: 'error'
|
|
33683
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
33684
|
+
result: null
|
|
33685
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
33686
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
33687
|
+
/** Error associated with the action. */
|
|
33688
|
+
error: {
|
|
33689
|
+
/** Type of the error. */
|
|
33690
|
+
type: string
|
|
33691
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
33692
|
+
message: string
|
|
33693
|
+
}
|
|
33694
|
+
}
|
|
33301
33695
|
| {
|
|
33302
33696
|
/** ID of the action attempt. */
|
|
33303
33697
|
action_attempt_id: string
|
|
@@ -36322,6 +36716,8 @@ export type Routes = {
|
|
|
36322
36716
|
incomplete_keyboard_passcode: boolean
|
|
36323
36717
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
36324
36718
|
wifi: boolean
|
|
36719
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
36720
|
+
auto_lock_time_config: boolean
|
|
36325
36721
|
}
|
|
36326
36722
|
/** Indicates whether a TTLock device has a gateway. */
|
|
36327
36723
|
has_gateway?: boolean | undefined
|
|
@@ -36678,6 +37074,10 @@ export type Routes = {
|
|
|
36678
37074
|
| undefined
|
|
36679
37075
|
/** Indicates whether the door is open. */
|
|
36680
37076
|
door_open?: (boolean | undefined) | undefined
|
|
37077
|
+
/** Indicates whether automatic locking is enabled. */
|
|
37078
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
37079
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
37080
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
36681
37081
|
} & {
|
|
36682
37082
|
/** Reported temperature in °F. */
|
|
36683
37083
|
temperature_fahrenheit?: number | undefined
|
|
@@ -37481,6 +37881,7 @@ export type Routes = {
|
|
|
37481
37881
|
can_simulate_hub_connection?: boolean | undefined
|
|
37482
37882
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
37483
37883
|
can_simulate_paid_subscription?: boolean | undefined
|
|
37884
|
+
can_configure_auto_lock?: boolean | undefined
|
|
37484
37885
|
}
|
|
37485
37886
|
}
|
|
37486
37887
|
maxDuration: undefined
|
|
@@ -37676,6 +38077,7 @@ export type Routes = {
|
|
|
37676
38077
|
| 'can_simulate_hub_connection'
|
|
37677
38078
|
| 'can_simulate_hub_disconnection'
|
|
37678
38079
|
| 'can_simulate_paid_subscription'
|
|
38080
|
+
| 'can_configure_auto_lock'
|
|
37679
38081
|
)[]
|
|
37680
38082
|
| undefined
|
|
37681
38083
|
/** */
|
|
@@ -37700,6 +38102,7 @@ export type Routes = {
|
|
|
37700
38102
|
| 'can_simulate_hub_connection'
|
|
37701
38103
|
| 'can_simulate_hub_disconnection'
|
|
37702
38104
|
| 'can_simulate_paid_subscription'
|
|
38105
|
+
| 'can_configure_auto_lock'
|
|
37703
38106
|
)[]
|
|
37704
38107
|
| undefined
|
|
37705
38108
|
/**
|
|
@@ -38187,6 +38590,8 @@ export type Routes = {
|
|
|
38187
38590
|
incomplete_keyboard_passcode: boolean
|
|
38188
38591
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
38189
38592
|
wifi: boolean
|
|
38593
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
38594
|
+
auto_lock_time_config: boolean
|
|
38190
38595
|
}
|
|
38191
38596
|
/** Indicates whether a TTLock device has a gateway. */
|
|
38192
38597
|
has_gateway?: boolean | undefined
|
|
@@ -38543,6 +38948,10 @@ export type Routes = {
|
|
|
38543
38948
|
| undefined
|
|
38544
38949
|
/** Indicates whether the door is open. */
|
|
38545
38950
|
door_open?: (boolean | undefined) | undefined
|
|
38951
|
+
/** Indicates whether automatic locking is enabled. */
|
|
38952
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
38953
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
38954
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
38546
38955
|
} & {
|
|
38547
38956
|
/** Reported temperature in °F. */
|
|
38548
38957
|
temperature_fahrenheit?: number | undefined
|
|
@@ -39346,6 +39755,7 @@ export type Routes = {
|
|
|
39346
39755
|
can_simulate_hub_connection?: boolean | undefined
|
|
39347
39756
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
39348
39757
|
can_simulate_paid_subscription?: boolean | undefined
|
|
39758
|
+
can_configure_auto_lock?: boolean | undefined
|
|
39349
39759
|
}[]
|
|
39350
39760
|
/** Information about the current page of results. */
|
|
39351
39761
|
pagination: {
|
|
@@ -39463,6 +39873,7 @@ export type Routes = {
|
|
|
39463
39873
|
can_simulate_hub_connection?: boolean | undefined
|
|
39464
39874
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
39465
39875
|
can_simulate_paid_subscription?: boolean | undefined
|
|
39876
|
+
can_configure_auto_lock?: boolean | undefined
|
|
39466
39877
|
}[]
|
|
39467
39878
|
}
|
|
39468
39879
|
maxDuration: undefined
|
|
@@ -40535,6 +40946,7 @@ export type Routes = {
|
|
|
40535
40946
|
can_simulate_hub_connection?: boolean | undefined
|
|
40536
40947
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
40537
40948
|
can_simulate_paid_subscription?: boolean | undefined
|
|
40949
|
+
can_configure_auto_lock?: boolean | undefined
|
|
40538
40950
|
}
|
|
40539
40951
|
}
|
|
40540
40952
|
maxDuration: undefined
|
|
@@ -40728,6 +41140,7 @@ export type Routes = {
|
|
|
40728
41140
|
| 'can_simulate_hub_connection'
|
|
40729
41141
|
| 'can_simulate_hub_disconnection'
|
|
40730
41142
|
| 'can_simulate_paid_subscription'
|
|
41143
|
+
| 'can_configure_auto_lock'
|
|
40731
41144
|
)[]
|
|
40732
41145
|
| undefined
|
|
40733
41146
|
/** */
|
|
@@ -40752,6 +41165,7 @@ export type Routes = {
|
|
|
40752
41165
|
| 'can_simulate_hub_connection'
|
|
40753
41166
|
| 'can_simulate_hub_disconnection'
|
|
40754
41167
|
| 'can_simulate_paid_subscription'
|
|
41168
|
+
| 'can_configure_auto_lock'
|
|
40755
41169
|
)[]
|
|
40756
41170
|
| undefined
|
|
40757
41171
|
/**
|
|
@@ -41290,6 +41704,7 @@ export type Routes = {
|
|
|
41290
41704
|
can_simulate_hub_connection?: boolean | undefined
|
|
41291
41705
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
41292
41706
|
can_simulate_paid_subscription?: boolean | undefined
|
|
41707
|
+
can_configure_auto_lock?: boolean | undefined
|
|
41293
41708
|
}[]
|
|
41294
41709
|
/** Information about the current page of results. */
|
|
41295
41710
|
pagination: {
|
|
@@ -47988,343 +48403,1863 @@ export type Routes = {
|
|
|
47988
48403
|
}
|
|
47989
48404
|
maxDuration: undefined
|
|
47990
48405
|
}
|
|
47991
|
-
'/locks/
|
|
47992
|
-
route: '/locks/
|
|
47993
|
-
method: '
|
|
48406
|
+
'/locks/configure_auto_lock': {
|
|
48407
|
+
route: '/locks/configure_auto_lock'
|
|
48408
|
+
method: 'POST'
|
|
47994
48409
|
queryParams: {}
|
|
47995
|
-
jsonBody: {
|
|
47996
|
-
|
|
47997
|
-
|
|
47998
|
-
|
|
47999
|
-
|
|
48000
|
-
|
|
48410
|
+
jsonBody: {
|
|
48411
|
+
/** ID of the lock for which you want to configure the auto-lock. */
|
|
48412
|
+
device_id: string
|
|
48413
|
+
/** Whether to enable or disable auto-lock. */
|
|
48414
|
+
auto_lock_enabled: boolean
|
|
48415
|
+
/** Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60. */
|
|
48416
|
+
auto_lock_delay_seconds?: number | undefined
|
|
48001
48417
|
}
|
|
48418
|
+
commonParams: {}
|
|
48002
48419
|
formData: {}
|
|
48003
48420
|
jsonResponse: {
|
|
48004
|
-
/** Represents a
|
|
48005
|
-
|
|
48006
|
-
|
|
48007
|
-
|
|
48008
|
-
|
|
48009
|
-
|
|
48010
|
-
|
|
48011
|
-
|
|
48012
|
-
|
|
48013
|
-
|
|
48014
|
-
|
|
48015
|
-
|
|
48016
|
-
|
|
48017
|
-
|
|
48018
|
-
|
|
48019
|
-
|
|
48020
|
-
|
|
48021
|
-
|
|
48022
|
-
|
|
48023
|
-
|
|
48024
|
-
|
|
48025
|
-
|
|
48026
|
-
|
|
48027
|
-
|
|
48028
|
-
|
|
48029
|
-
|
|
48030
|
-
|
|
48031
|
-
|
|
48032
|
-
|
|
|
48033
|
-
|
|
48034
|
-
|
|
48035
|
-
|
|
48036
|
-
|
|
48037
|
-
|
|
48038
|
-
|
|
48039
|
-
|
|
48040
|
-
|
|
48041
|
-
|
|
48042
|
-
|
|
48043
|
-
|
|
48044
|
-
|
|
48045
|
-
|
|
48046
|
-
|
|
48047
|
-
|
|
48048
|
-
|
|
48049
|
-
|
|
48050
|
-
|
|
48051
|
-
|
|
48052
|
-
|
|
48053
|
-
|
|
48054
|
-
|
|
48055
|
-
|
|
48056
|
-
|
|
48057
|
-
|
|
48058
|
-
|
|
48059
|
-
|
|
48060
|
-
|
|
48061
|
-
|
|
48062
|
-
|
|
48063
|
-
|
|
48064
|
-
|
|
48065
|
-
|
|
48066
|
-
|
|
48067
|
-
|
|
48068
|
-
|
|
48069
|
-
|
|
48070
|
-
|
|
48071
|
-
|
|
48072
|
-
|
|
48073
|
-
|
|
48074
|
-
|
|
48075
|
-
|
|
48076
|
-
|
|
48077
|
-
|
|
48078
|
-
|
|
48079
|
-
|
|
48080
|
-
|
|
48081
|
-
|
|
48082
|
-
|
|
48083
|
-
|
|
48421
|
+
/** 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.
|
|
48422
|
+
|
|
48423
|
+
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.
|
|
48424
|
+
|
|
48425
|
+
See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
|
|
48426
|
+
action_attempt:
|
|
48427
|
+
| {
|
|
48428
|
+
/** ID of the action attempt. */
|
|
48429
|
+
action_attempt_id: string
|
|
48430
|
+
status: 'pending'
|
|
48431
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
48432
|
+
result: null
|
|
48433
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
48434
|
+
error: null
|
|
48435
|
+
/** Action attempt to track the status of locking a door. */
|
|
48436
|
+
action_type: 'LOCK_DOOR'
|
|
48437
|
+
}
|
|
48438
|
+
| {
|
|
48439
|
+
/** ID of the action attempt. */
|
|
48440
|
+
action_attempt_id: string
|
|
48441
|
+
status: 'success'
|
|
48442
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
48443
|
+
error: null
|
|
48444
|
+
/** Action attempt to track the status of locking a door. */
|
|
48445
|
+
action_type: 'LOCK_DOOR'
|
|
48446
|
+
/** Result of the action. */
|
|
48447
|
+
result: {
|
|
48448
|
+
/** Indicates whether the device confirmed that the lock action occurred. */
|
|
48449
|
+
was_confirmed_by_device?: boolean | undefined
|
|
48450
|
+
}
|
|
48451
|
+
}
|
|
48452
|
+
| {
|
|
48453
|
+
/** ID of the action attempt. */
|
|
48454
|
+
action_attempt_id: string
|
|
48455
|
+
status: 'error'
|
|
48456
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
48457
|
+
result: null
|
|
48458
|
+
/** Action attempt to track the status of locking a door. */
|
|
48459
|
+
action_type: 'LOCK_DOOR'
|
|
48460
|
+
/** Error associated with the action. */
|
|
48461
|
+
error: {
|
|
48462
|
+
/** Type of the error. */
|
|
48463
|
+
type: string
|
|
48464
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
48465
|
+
message: string
|
|
48466
|
+
}
|
|
48467
|
+
}
|
|
48468
|
+
| {
|
|
48469
|
+
/** ID of the action attempt. */
|
|
48470
|
+
action_attempt_id: string
|
|
48471
|
+
status: 'pending'
|
|
48472
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
48473
|
+
result: null
|
|
48474
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
48475
|
+
error: null
|
|
48476
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
48477
|
+
action_type: 'UNLOCK_DOOR'
|
|
48478
|
+
}
|
|
48479
|
+
| {
|
|
48480
|
+
/** ID of the action attempt. */
|
|
48481
|
+
action_attempt_id: string
|
|
48482
|
+
status: 'success'
|
|
48483
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
48484
|
+
error: null
|
|
48485
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
48486
|
+
action_type: 'UNLOCK_DOOR'
|
|
48487
|
+
/** Result of the action. */
|
|
48488
|
+
result: {
|
|
48489
|
+
/** Indicates whether the device confirmed that the unlock action occurred. */
|
|
48490
|
+
was_confirmed_by_device?: boolean | undefined
|
|
48491
|
+
}
|
|
48492
|
+
}
|
|
48493
|
+
| {
|
|
48494
|
+
/** ID of the action attempt. */
|
|
48495
|
+
action_attempt_id: string
|
|
48496
|
+
status: 'error'
|
|
48497
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
48498
|
+
result: null
|
|
48499
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
48500
|
+
action_type: 'UNLOCK_DOOR'
|
|
48501
|
+
/** Error associated with the action. */
|
|
48502
|
+
error: {
|
|
48503
|
+
/** Type of the error. */
|
|
48504
|
+
type: string
|
|
48505
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
48506
|
+
message: string
|
|
48507
|
+
}
|
|
48508
|
+
}
|
|
48509
|
+
| {
|
|
48510
|
+
/** ID of the action attempt. */
|
|
48511
|
+
action_attempt_id: string
|
|
48512
|
+
status: 'pending'
|
|
48513
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
48514
|
+
result: null
|
|
48515
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
48516
|
+
error: null
|
|
48517
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
48518
|
+
action_type: 'SCAN_CREDENTIAL'
|
|
48519
|
+
}
|
|
48520
|
+
| {
|
|
48521
|
+
/** ID of the action attempt. */
|
|
48522
|
+
action_attempt_id: string
|
|
48523
|
+
status: 'success'
|
|
48524
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
48525
|
+
error: null
|
|
48526
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
48527
|
+
action_type: 'SCAN_CREDENTIAL'
|
|
48528
|
+
/** 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. */
|
|
48529
|
+
result: {
|
|
48530
|
+
/** Snapshot of credential data read from the physical encoder. */
|
|
48531
|
+
acs_credential_on_encoder: {
|
|
48532
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
48533
|
+
created_at: string | null
|
|
48534
|
+
is_issued: boolean | null
|
|
48535
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
|
|
48536
|
+
starts_at: string | null
|
|
48537
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
|
|
48538
|
+
ends_at: string | null
|
|
48539
|
+
/** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48540
|
+
card_number: string | null
|
|
48541
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48542
|
+
visionline_metadata?:
|
|
48084
48543
|
| {
|
|
48085
|
-
|
|
48544
|
+
/** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48545
|
+
card_id: string
|
|
48546
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
|
|
48547
|
+
cancelled: boolean
|
|
48548
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
|
|
48549
|
+
discarded: boolean
|
|
48550
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
|
|
48551
|
+
expired: boolean
|
|
48552
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
|
|
48553
|
+
overwritten: boolean
|
|
48554
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
|
|
48555
|
+
overridden?: boolean | undefined
|
|
48556
|
+
/** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
|
|
48557
|
+
pending_auto_update: boolean
|
|
48558
|
+
/** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48559
|
+
card_format: 'TLCode' | 'rfid48'
|
|
48560
|
+
/** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48561
|
+
card_holder?: string | undefined
|
|
48562
|
+
/** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48563
|
+
number_of_issued_cards: number
|
|
48564
|
+
/** IDs of the guest [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48565
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
48566
|
+
/** IDs of the common [entrances](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details) for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48567
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
48086
48568
|
}
|
|
48087
48569
|
| undefined
|
|
48088
|
-
}
|
|
48089
|
-
|
|
48090
|
-
|
|
48091
|
-
|
|
48092
|
-
|
|
48093
|
-
|
|
48094
|
-
|
|
48095
|
-
|
|
48096
|
-
|
|
48097
|
-
|
|
48098
|
-
|
|
48099
|
-
|
|
48100
|
-
|
|
48101
|
-
|
|
48102
|
-
|
|
48103
|
-
|
|
48104
|
-
|
|
48105
|
-
|
|
48106
|
-
|
|
48107
|
-
|
|
48108
|
-
|
|
48109
|
-
|
|
48110
|
-
|
|
48111
|
-
|
|
48112
|
-
|
|
48113
|
-
|
|
48114
|
-
|
|
48115
|
-
|
|
48116
|
-
|
|
48117
|
-
|
|
48118
|
-
|
|
48119
|
-
|
|
48120
|
-
|
|
48121
|
-
|
|
48122
|
-
|
|
48123
|
-
|
|
48124
|
-
|
|
48125
|
-
|
|
48126
|
-
|
|
48127
|
-
|
|
48128
|
-
|
|
48129
|
-
|
|
48130
|
-
|
|
48131
|
-
|
|
48132
|
-
|
|
48133
|
-
|
|
48134
|
-
|
|
48135
|
-
|
|
48136
|
-
|
|
48137
|
-
|
|
48138
|
-
|
|
48139
|
-
|
|
48140
|
-
|
|
48141
|
-
|
|
48142
|
-
|
|
48143
|
-
|
|
48144
|
-
|
|
48145
|
-
|
|
48146
|
-
|
|
48147
|
-
|
|
48148
|
-
|
|
48149
|
-
|
|
48150
|
-
|
|
48151
|
-
|
|
48152
|
-
|
|
48153
|
-
|
|
48154
|
-
|
|
48155
|
-
|
|
48156
|
-
|
|
48157
|
-
|
|
48158
|
-
|
|
48159
|
-
|
|
48160
|
-
|
|
48161
|
-
|
|
48162
|
-
|
|
48163
|
-
|
|
48164
|
-
|
|
48165
|
-
|
|
48166
|
-
|
|
48167
|
-
|
|
48168
|
-
|
|
48169
|
-
|
|
48170
|
-
|
|
48171
|
-
|
|
48172
|
-
|
|
48173
|
-
|
|
48174
|
-
|
|
48175
|
-
|
|
48176
|
-
|
|
48177
|
-
|
|
48178
|
-
|
|
48179
|
-
|
|
48180
|
-
|
|
48181
|
-
|
|
48182
|
-
|
|
48183
|
-
|
|
48184
|
-
|
|
48185
|
-
|
|
48186
|
-
|
|
48187
|
-
|
|
48188
|
-
|
|
48189
|
-
|
|
48190
|
-
|
|
48191
|
-
|
|
48192
|
-
|
|
48193
|
-
|
|
48194
|
-
|
|
48195
|
-
|
|
48196
|
-
|
|
48197
|
-
|
|
48198
|
-
|
|
48199
|
-
|
|
48200
|
-
|
|
48201
|
-
|
|
48202
|
-
|
|
48203
|
-
|
|
48204
|
-
|
|
48205
|
-
|
|
48206
|
-
|
|
48207
|
-
|
|
48208
|
-
|
|
48209
|
-
|
|
48210
|
-
|
|
48211
|
-
|
|
48212
|
-
|
|
48213
|
-
|
|
48214
|
-
|
|
48215
|
-
|
|
48216
|
-
|
|
48217
|
-
|
|
48218
|
-
|
|
48219
|
-
|
|
48220
|
-
|
|
48221
|
-
|
|
48222
|
-
|
|
48223
|
-
|
|
48224
|
-
|
|
48225
|
-
|
|
48226
|
-
|
|
48227
|
-
|
|
48228
|
-
|
|
48229
|
-
|
|
48230
|
-
|
|
48231
|
-
|
|
48232
|
-
|
|
48233
|
-
|
|
48234
|
-
|
|
48235
|
-
|
|
48236
|
-
|
|
48237
|
-
|
|
48238
|
-
|
|
48239
|
-
|
|
48240
|
-
|
|
48241
|
-
|
|
48242
|
-
|
|
48243
|
-
|
|
48244
|
-
|
|
48245
|
-
|
|
48246
|
-
|
|
48247
|
-
|
|
48248
|
-
|
|
48249
|
-
|
|
48250
|
-
|
|
48251
|
-
|
|
48252
|
-
|
|
48253
|
-
|
|
48254
|
-
|
|
48255
|
-
|
|
48256
|
-
|
|
48257
|
-
|
|
48258
|
-
|
|
48259
|
-
|
|
48260
|
-
|
|
48261
|
-
|
|
48262
|
-
|
|
48263
|
-
|
|
48264
|
-
|
|
48265
|
-
|
|
48266
|
-
|
|
48267
|
-
|
|
48268
|
-
|
|
48269
|
-
|
|
48270
|
-
|
|
48271
|
-
|
|
48272
|
-
|
|
48273
|
-
|
|
48274
|
-
|
|
48275
|
-
|
|
48276
|
-
|
|
48277
|
-
|
|
48278
|
-
|
|
48279
|
-
|
|
48280
|
-
|
|
48281
|
-
|
|
48282
|
-
|
|
48283
|
-
|
|
48284
|
-
|
|
48285
|
-
|
|
48286
|
-
|
|
48287
|
-
|
|
48288
|
-
|
|
48289
|
-
|
|
48290
|
-
|
|
48291
|
-
|
|
48292
|
-
|
|
48293
|
-
|
|
48294
|
-
|
|
48295
|
-
|
|
48296
|
-
|
|
48297
|
-
|
|
48298
|
-
|
|
48299
|
-
|
|
48300
|
-
|
|
48301
|
-
|
|
48302
|
-
|
|
48303
|
-
|
|
48304
|
-
|
|
48305
|
-
|
|
48306
|
-
|
|
48307
|
-
|
|
48308
|
-
|
|
48309
|
-
|
|
48310
|
-
|
|
48311
|
-
|
|
48312
|
-
|
|
48313
|
-
|
|
48314
|
-
|
|
48315
|
-
|
|
48316
|
-
|
|
48317
|
-
|
|
48318
|
-
|
|
48319
|
-
|
|
48320
|
-
|
|
48321
|
-
|
|
48322
|
-
|
|
48323
|
-
|
|
48324
|
-
|
|
48325
|
-
|
|
48326
|
-
|
|
48327
|
-
|
|
48570
|
+
} | null
|
|
48571
|
+
/** Corresponding credential data as stored on Seam and the access system. */
|
|
48572
|
+
acs_credential_on_seam:
|
|
48573
|
+
| (
|
|
48574
|
+
| {
|
|
48575
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48576
|
+
acs_credential_id: string
|
|
48577
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48578
|
+
acs_user_id?: string | undefined
|
|
48579
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48580
|
+
user_identity_id?: string | undefined
|
|
48581
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48582
|
+
connected_account_id: string
|
|
48583
|
+
acs_credential_pool_id?: string | undefined
|
|
48584
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48585
|
+
acs_system_id: string
|
|
48586
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48587
|
+
parent_acs_credential_id?: string | undefined
|
|
48588
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
48589
|
+
display_name: string
|
|
48590
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48591
|
+
code?: (string | undefined) | null
|
|
48592
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
48593
|
+
is_one_time_use?: boolean | undefined
|
|
48594
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48595
|
+
card_number?: (string | undefined) | null
|
|
48596
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
48597
|
+
is_issued?: boolean | undefined
|
|
48598
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
48599
|
+
issued_at?: (string | undefined) | null
|
|
48600
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
48601
|
+
access_method:
|
|
48602
|
+
| 'code'
|
|
48603
|
+
| 'card'
|
|
48604
|
+
| 'mobile_key'
|
|
48605
|
+
| 'cloud_key'
|
|
48606
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
48607
|
+
external_type?:
|
|
48608
|
+
| (
|
|
48609
|
+
| 'pti_card'
|
|
48610
|
+
| 'brivo_credential'
|
|
48611
|
+
| 'brivo_digital_credential'
|
|
48612
|
+
| 'hid_credential'
|
|
48613
|
+
| 'visionline_card'
|
|
48614
|
+
| 'salto_ks_credential'
|
|
48615
|
+
| 'assa_abloy_vostio_key'
|
|
48616
|
+
| 'salto_space_key'
|
|
48617
|
+
| 'latch_access'
|
|
48618
|
+
| 'dormakaba_ambiance_credential'
|
|
48619
|
+
| 'hotek_card'
|
|
48620
|
+
)
|
|
48621
|
+
| undefined
|
|
48622
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
48623
|
+
external_type_display_name?: string | undefined
|
|
48624
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
48625
|
+
created_at: string
|
|
48626
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48627
|
+
workspace_id: string
|
|
48628
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
48629
|
+
starts_at?: string | undefined
|
|
48630
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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`. */
|
|
48631
|
+
ends_at?: string | undefined
|
|
48632
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48633
|
+
errors: {
|
|
48634
|
+
error_code: string
|
|
48635
|
+
message: string
|
|
48636
|
+
}[]
|
|
48637
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48638
|
+
warnings: (
|
|
48639
|
+
| {
|
|
48640
|
+
/** Date and time at which Seam created the warning. */
|
|
48641
|
+
created_at: string
|
|
48642
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48643
|
+
message: string
|
|
48644
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48645
|
+
warning_code: 'waiting_to_be_issued'
|
|
48646
|
+
}
|
|
48647
|
+
| {
|
|
48648
|
+
/** Date and time at which Seam created the warning. */
|
|
48649
|
+
created_at: string
|
|
48650
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48651
|
+
message: string
|
|
48652
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48653
|
+
warning_code: 'schedule_externally_modified'
|
|
48654
|
+
}
|
|
48655
|
+
| {
|
|
48656
|
+
/** Date and time at which Seam created the warning. */
|
|
48657
|
+
created_at: string
|
|
48658
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48659
|
+
message: string
|
|
48660
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48661
|
+
warning_code: 'schedule_modified'
|
|
48662
|
+
}
|
|
48663
|
+
| {
|
|
48664
|
+
/** Date and time at which Seam created the warning. */
|
|
48665
|
+
created_at: string
|
|
48666
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48667
|
+
message: string
|
|
48668
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48669
|
+
warning_code: 'being_deleted'
|
|
48670
|
+
}
|
|
48671
|
+
| {
|
|
48672
|
+
/** Date and time at which Seam created the warning. */
|
|
48673
|
+
created_at: string
|
|
48674
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48675
|
+
message: string
|
|
48676
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48677
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
48678
|
+
}
|
|
48679
|
+
| {
|
|
48680
|
+
/** Date and time at which Seam created the warning. */
|
|
48681
|
+
created_at: string
|
|
48682
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48683
|
+
message: string
|
|
48684
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48685
|
+
warning_code: 'needs_to_be_reissued'
|
|
48686
|
+
}
|
|
48687
|
+
)[]
|
|
48688
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
48689
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
48690
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
48691
|
+
is_latest_desired_state_synced_with_provider?:
|
|
48692
|
+
| (boolean | null)
|
|
48693
|
+
| undefined
|
|
48694
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
48695
|
+
latest_desired_state_synced_with_provider_at?:
|
|
48696
|
+
| (string | null)
|
|
48697
|
+
| undefined
|
|
48698
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48699
|
+
visionline_metadata?:
|
|
48700
|
+
| {
|
|
48701
|
+
/** Card function type in the Visionline access system. */
|
|
48702
|
+
card_function_type: 'guest' | 'staff'
|
|
48703
|
+
/** IDs of the credentials to which you want to join. */
|
|
48704
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
48705
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
48706
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
48707
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
48708
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
48709
|
+
/** Indicates whether the credential is valid. */
|
|
48710
|
+
is_valid?: boolean | undefined
|
|
48711
|
+
/** 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. */
|
|
48712
|
+
auto_join?: boolean | undefined
|
|
48713
|
+
/** ID of the card in the Visionline access system. */
|
|
48714
|
+
card_id?: string | undefined
|
|
48715
|
+
/** ID of the credential in the Visionline access system. */
|
|
48716
|
+
credential_id?: string | undefined
|
|
48717
|
+
}
|
|
48718
|
+
| undefined
|
|
48719
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48720
|
+
assa_abloy_vostio_metadata?:
|
|
48721
|
+
| {
|
|
48722
|
+
/** 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. */
|
|
48723
|
+
auto_join?: boolean | undefined
|
|
48724
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
48725
|
+
override_guest_acs_entrance_ids?:
|
|
48726
|
+
| string[]
|
|
48727
|
+
| undefined
|
|
48728
|
+
/** Key ID in the Vostio access system. */
|
|
48729
|
+
key_id?: string | undefined
|
|
48730
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
48731
|
+
key_issuing_request_id?: string | undefined
|
|
48732
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
48733
|
+
door_names?: string[] | undefined
|
|
48734
|
+
/** Endpoint ID in the Vostio access system. */
|
|
48735
|
+
endpoint_id?: string | undefined
|
|
48736
|
+
}
|
|
48737
|
+
| undefined
|
|
48738
|
+
is_managed: true
|
|
48739
|
+
}
|
|
48740
|
+
| {
|
|
48741
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48742
|
+
acs_credential_id: string
|
|
48743
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48744
|
+
acs_user_id?: string | undefined
|
|
48745
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48746
|
+
user_identity_id?: string | undefined
|
|
48747
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48748
|
+
connected_account_id: string
|
|
48749
|
+
acs_credential_pool_id?: string | undefined
|
|
48750
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48751
|
+
acs_system_id: string
|
|
48752
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48753
|
+
parent_acs_credential_id?: string | undefined
|
|
48754
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
48755
|
+
display_name: string
|
|
48756
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48757
|
+
code?: (string | undefined) | null
|
|
48758
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
48759
|
+
is_one_time_use?: boolean | undefined
|
|
48760
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48761
|
+
card_number?: (string | undefined) | null
|
|
48762
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
48763
|
+
is_issued?: boolean | undefined
|
|
48764
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
48765
|
+
issued_at?: (string | undefined) | null
|
|
48766
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
48767
|
+
access_method:
|
|
48768
|
+
| 'code'
|
|
48769
|
+
| 'card'
|
|
48770
|
+
| 'mobile_key'
|
|
48771
|
+
| 'cloud_key'
|
|
48772
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
48773
|
+
external_type?:
|
|
48774
|
+
| (
|
|
48775
|
+
| 'pti_card'
|
|
48776
|
+
| 'brivo_credential'
|
|
48777
|
+
| 'brivo_digital_credential'
|
|
48778
|
+
| 'hid_credential'
|
|
48779
|
+
| 'visionline_card'
|
|
48780
|
+
| 'salto_ks_credential'
|
|
48781
|
+
| 'assa_abloy_vostio_key'
|
|
48782
|
+
| 'salto_space_key'
|
|
48783
|
+
| 'latch_access'
|
|
48784
|
+
| 'dormakaba_ambiance_credential'
|
|
48785
|
+
| 'hotek_card'
|
|
48786
|
+
)
|
|
48787
|
+
| undefined
|
|
48788
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
48789
|
+
external_type_display_name?: string | undefined
|
|
48790
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
48791
|
+
created_at: string
|
|
48792
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48793
|
+
workspace_id: string
|
|
48794
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
48795
|
+
starts_at?: string | undefined
|
|
48796
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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`. */
|
|
48797
|
+
ends_at?: string | undefined
|
|
48798
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48799
|
+
errors: {
|
|
48800
|
+
error_code: string
|
|
48801
|
+
message: string
|
|
48802
|
+
}[]
|
|
48803
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48804
|
+
warnings: (
|
|
48805
|
+
| {
|
|
48806
|
+
/** Date and time at which Seam created the warning. */
|
|
48807
|
+
created_at: string
|
|
48808
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48809
|
+
message: string
|
|
48810
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48811
|
+
warning_code: 'waiting_to_be_issued'
|
|
48812
|
+
}
|
|
48813
|
+
| {
|
|
48814
|
+
/** Date and time at which Seam created the warning. */
|
|
48815
|
+
created_at: string
|
|
48816
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48817
|
+
message: string
|
|
48818
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48819
|
+
warning_code: 'schedule_externally_modified'
|
|
48820
|
+
}
|
|
48821
|
+
| {
|
|
48822
|
+
/** Date and time at which Seam created the warning. */
|
|
48823
|
+
created_at: string
|
|
48824
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48825
|
+
message: string
|
|
48826
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48827
|
+
warning_code: 'schedule_modified'
|
|
48828
|
+
}
|
|
48829
|
+
| {
|
|
48830
|
+
/** Date and time at which Seam created the warning. */
|
|
48831
|
+
created_at: string
|
|
48832
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48833
|
+
message: string
|
|
48834
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48835
|
+
warning_code: 'being_deleted'
|
|
48836
|
+
}
|
|
48837
|
+
| {
|
|
48838
|
+
/** Date and time at which Seam created the warning. */
|
|
48839
|
+
created_at: string
|
|
48840
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48841
|
+
message: string
|
|
48842
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48843
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
48844
|
+
}
|
|
48845
|
+
| {
|
|
48846
|
+
/** Date and time at which Seam created the warning. */
|
|
48847
|
+
created_at: string
|
|
48848
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48849
|
+
message: string
|
|
48850
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
48851
|
+
warning_code: 'needs_to_be_reissued'
|
|
48852
|
+
}
|
|
48853
|
+
)[]
|
|
48854
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
48855
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
48856
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
48857
|
+
is_latest_desired_state_synced_with_provider?:
|
|
48858
|
+
| (boolean | null)
|
|
48859
|
+
| undefined
|
|
48860
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
48861
|
+
latest_desired_state_synced_with_provider_at?:
|
|
48862
|
+
| (string | null)
|
|
48863
|
+
| undefined
|
|
48864
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48865
|
+
visionline_metadata?:
|
|
48866
|
+
| {
|
|
48867
|
+
/** Card function type in the Visionline access system. */
|
|
48868
|
+
card_function_type: 'guest' | 'staff'
|
|
48869
|
+
/** IDs of the credentials to which you want to join. */
|
|
48870
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
48871
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
48872
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
48873
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
48874
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
48875
|
+
/** Indicates whether the credential is valid. */
|
|
48876
|
+
is_valid?: boolean | undefined
|
|
48877
|
+
/** 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. */
|
|
48878
|
+
auto_join?: boolean | undefined
|
|
48879
|
+
/** ID of the card in the Visionline access system. */
|
|
48880
|
+
card_id?: string | undefined
|
|
48881
|
+
/** ID of the credential in the Visionline access system. */
|
|
48882
|
+
credential_id?: string | undefined
|
|
48883
|
+
}
|
|
48884
|
+
| undefined
|
|
48885
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48886
|
+
assa_abloy_vostio_metadata?:
|
|
48887
|
+
| {
|
|
48888
|
+
/** 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. */
|
|
48889
|
+
auto_join?: boolean | undefined
|
|
48890
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
48891
|
+
override_guest_acs_entrance_ids?:
|
|
48892
|
+
| string[]
|
|
48893
|
+
| undefined
|
|
48894
|
+
/** Key ID in the Vostio access system. */
|
|
48895
|
+
key_id?: string | undefined
|
|
48896
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
48897
|
+
key_issuing_request_id?: string | undefined
|
|
48898
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
48899
|
+
door_names?: string[] | undefined
|
|
48900
|
+
/** Endpoint ID in the Vostio access system. */
|
|
48901
|
+
endpoint_id?: string | undefined
|
|
48902
|
+
}
|
|
48903
|
+
| undefined
|
|
48904
|
+
is_managed: false
|
|
48905
|
+
}
|
|
48906
|
+
)
|
|
48907
|
+
| null
|
|
48908
|
+
/** 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. */
|
|
48909
|
+
warnings: {
|
|
48910
|
+
/** Indicates a warning related to scanning a credential. */
|
|
48911
|
+
warning_code:
|
|
48912
|
+
| 'acs_credential_on_encoder_out_of_sync'
|
|
48913
|
+
| 'acs_credential_on_seam_not_found'
|
|
48914
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
48915
|
+
warning_message: string
|
|
48916
|
+
}[]
|
|
48917
|
+
}
|
|
48918
|
+
}
|
|
48919
|
+
| {
|
|
48920
|
+
/** ID of the action attempt. */
|
|
48921
|
+
action_attempt_id: string
|
|
48922
|
+
status: 'error'
|
|
48923
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
48924
|
+
result: null
|
|
48925
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
48926
|
+
action_type: 'SCAN_CREDENTIAL'
|
|
48927
|
+
error:
|
|
48928
|
+
| {
|
|
48929
|
+
/** Type of the error associated with the action attempt. */
|
|
48930
|
+
type: 'uncategorized_error'
|
|
48931
|
+
/** Message for the error associated with the action attempt. */
|
|
48932
|
+
message: string
|
|
48933
|
+
}
|
|
48934
|
+
| {
|
|
48935
|
+
/** Type of the error associated with the action attempt. */
|
|
48936
|
+
type: 'action_attempt_expired'
|
|
48937
|
+
/** Message for the error associated with the action attempt. */
|
|
48938
|
+
message: string
|
|
48939
|
+
}
|
|
48940
|
+
| {
|
|
48941
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
48942
|
+
type: 'no_credential_on_encoder'
|
|
48943
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
48944
|
+
message: string
|
|
48945
|
+
}
|
|
48946
|
+
| {
|
|
48947
|
+
/** Error type to indicate that the encoder is not online. */
|
|
48948
|
+
type: 'encoder_not_online'
|
|
48949
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
48950
|
+
message: string
|
|
48951
|
+
}
|
|
48952
|
+
}
|
|
48953
|
+
| {
|
|
48954
|
+
/** ID of the action attempt. */
|
|
48955
|
+
action_attempt_id: string
|
|
48956
|
+
status: 'pending'
|
|
48957
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
48958
|
+
result: null
|
|
48959
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
48960
|
+
error: null
|
|
48961
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
48962
|
+
action_type: 'ENCODE_CREDENTIAL'
|
|
48963
|
+
}
|
|
48964
|
+
| {
|
|
48965
|
+
/** ID of the action attempt. */
|
|
48966
|
+
action_attempt_id: string
|
|
48967
|
+
status: 'success'
|
|
48968
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
48969
|
+
error: null
|
|
48970
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
48971
|
+
action_type: 'ENCODE_CREDENTIAL'
|
|
48972
|
+
/** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
|
|
48973
|
+
result:
|
|
48974
|
+
| {
|
|
48975
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48976
|
+
acs_credential_id: string
|
|
48977
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48978
|
+
acs_user_id?: string | undefined
|
|
48979
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48980
|
+
user_identity_id?: string | undefined
|
|
48981
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
48982
|
+
connected_account_id: string
|
|
48983
|
+
acs_credential_pool_id?: string | undefined
|
|
48984
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48985
|
+
acs_system_id: string
|
|
48986
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48987
|
+
parent_acs_credential_id?: string | undefined
|
|
48988
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
48989
|
+
display_name: string
|
|
48990
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48991
|
+
code?: (string | undefined) | null
|
|
48992
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
48993
|
+
is_one_time_use?: boolean | undefined
|
|
48994
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
48995
|
+
card_number?: (string | undefined) | null
|
|
48996
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
48997
|
+
is_issued?: boolean | undefined
|
|
48998
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
48999
|
+
issued_at?: (string | undefined) | null
|
|
49000
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
49001
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
49002
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
49003
|
+
external_type?:
|
|
49004
|
+
| (
|
|
49005
|
+
| 'pti_card'
|
|
49006
|
+
| 'brivo_credential'
|
|
49007
|
+
| 'brivo_digital_credential'
|
|
49008
|
+
| 'hid_credential'
|
|
49009
|
+
| 'visionline_card'
|
|
49010
|
+
| 'salto_ks_credential'
|
|
49011
|
+
| 'assa_abloy_vostio_key'
|
|
49012
|
+
| 'salto_space_key'
|
|
49013
|
+
| 'latch_access'
|
|
49014
|
+
| 'dormakaba_ambiance_credential'
|
|
49015
|
+
| 'hotek_card'
|
|
49016
|
+
)
|
|
49017
|
+
| undefined
|
|
49018
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
49019
|
+
external_type_display_name?: string | undefined
|
|
49020
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
49021
|
+
created_at: string
|
|
49022
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49023
|
+
workspace_id: string
|
|
49024
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
49025
|
+
starts_at?: string | undefined
|
|
49026
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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`. */
|
|
49027
|
+
ends_at?: string | undefined
|
|
49028
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49029
|
+
errors: {
|
|
49030
|
+
error_code: string
|
|
49031
|
+
message: string
|
|
49032
|
+
}[]
|
|
49033
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49034
|
+
warnings: (
|
|
49035
|
+
| {
|
|
49036
|
+
/** Date and time at which Seam created the warning. */
|
|
49037
|
+
created_at: string
|
|
49038
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49039
|
+
message: string
|
|
49040
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49041
|
+
warning_code: 'waiting_to_be_issued'
|
|
49042
|
+
}
|
|
49043
|
+
| {
|
|
49044
|
+
/** Date and time at which Seam created the warning. */
|
|
49045
|
+
created_at: string
|
|
49046
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49047
|
+
message: string
|
|
49048
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49049
|
+
warning_code: 'schedule_externally_modified'
|
|
49050
|
+
}
|
|
49051
|
+
| {
|
|
49052
|
+
/** Date and time at which Seam created the warning. */
|
|
49053
|
+
created_at: string
|
|
49054
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49055
|
+
message: string
|
|
49056
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49057
|
+
warning_code: 'schedule_modified'
|
|
49058
|
+
}
|
|
49059
|
+
| {
|
|
49060
|
+
/** Date and time at which Seam created the warning. */
|
|
49061
|
+
created_at: string
|
|
49062
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49063
|
+
message: string
|
|
49064
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49065
|
+
warning_code: 'being_deleted'
|
|
49066
|
+
}
|
|
49067
|
+
| {
|
|
49068
|
+
/** Date and time at which Seam created the warning. */
|
|
49069
|
+
created_at: string
|
|
49070
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49071
|
+
message: string
|
|
49072
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49073
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
49074
|
+
}
|
|
49075
|
+
| {
|
|
49076
|
+
/** Date and time at which Seam created the warning. */
|
|
49077
|
+
created_at: string
|
|
49078
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49079
|
+
message: string
|
|
49080
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49081
|
+
warning_code: 'needs_to_be_reissued'
|
|
49082
|
+
}
|
|
49083
|
+
)[]
|
|
49084
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
49085
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
49086
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
49087
|
+
is_latest_desired_state_synced_with_provider?:
|
|
49088
|
+
| (boolean | null)
|
|
49089
|
+
| undefined
|
|
49090
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
49091
|
+
latest_desired_state_synced_with_provider_at?:
|
|
49092
|
+
| (string | null)
|
|
49093
|
+
| undefined
|
|
49094
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49095
|
+
visionline_metadata?:
|
|
49096
|
+
| {
|
|
49097
|
+
/** Card function type in the Visionline access system. */
|
|
49098
|
+
card_function_type: 'guest' | 'staff'
|
|
49099
|
+
/** IDs of the credentials to which you want to join. */
|
|
49100
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
49101
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
49102
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
49103
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
49104
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
49105
|
+
/** Indicates whether the credential is valid. */
|
|
49106
|
+
is_valid?: boolean | undefined
|
|
49107
|
+
/** 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. */
|
|
49108
|
+
auto_join?: boolean | undefined
|
|
49109
|
+
/** ID of the card in the Visionline access system. */
|
|
49110
|
+
card_id?: string | undefined
|
|
49111
|
+
/** ID of the credential in the Visionline access system. */
|
|
49112
|
+
credential_id?: string | undefined
|
|
49113
|
+
}
|
|
49114
|
+
| undefined
|
|
49115
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49116
|
+
assa_abloy_vostio_metadata?:
|
|
49117
|
+
| {
|
|
49118
|
+
/** 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. */
|
|
49119
|
+
auto_join?: boolean | undefined
|
|
49120
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
49121
|
+
override_guest_acs_entrance_ids?: string[] | undefined
|
|
49122
|
+
/** Key ID in the Vostio access system. */
|
|
49123
|
+
key_id?: string | undefined
|
|
49124
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
49125
|
+
key_issuing_request_id?: string | undefined
|
|
49126
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
49127
|
+
door_names?: string[] | undefined
|
|
49128
|
+
/** Endpoint ID in the Vostio access system. */
|
|
49129
|
+
endpoint_id?: string | undefined
|
|
49130
|
+
}
|
|
49131
|
+
| undefined
|
|
49132
|
+
is_managed: true
|
|
49133
|
+
}
|
|
49134
|
+
| {
|
|
49135
|
+
/** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49136
|
+
acs_credential_id: string
|
|
49137
|
+
/** ID of the [ACS user](https://docs.seam.co/latest/capability-guides/access-systems/user-management) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
49138
|
+
acs_user_id?: string | undefined
|
|
49139
|
+
/** ID of the [user identity](https://docs.seam.co/latest/api/user_identities) to whom the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
49140
|
+
user_identity_id?: string | undefined
|
|
49141
|
+
/** ID of the [connected account](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials#connected-accounts) to which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) belongs. */
|
|
49142
|
+
connected_account_id: string
|
|
49143
|
+
acs_credential_pool_id?: string | undefined
|
|
49144
|
+
/** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49145
|
+
acs_system_id: string
|
|
49146
|
+
/** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49147
|
+
parent_acs_credential_id?: string | undefined
|
|
49148
|
+
/** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
49149
|
+
display_name: string
|
|
49150
|
+
/** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49151
|
+
code?: (string | undefined) | null
|
|
49152
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
|
|
49153
|
+
is_one_time_use?: boolean | undefined
|
|
49154
|
+
/** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49155
|
+
card_number?: (string | undefined) | null
|
|
49156
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
|
|
49157
|
+
is_issued?: boolean | undefined
|
|
49158
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
|
|
49159
|
+
issued_at?: (string | undefined) | null
|
|
49160
|
+
/** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
49161
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
49162
|
+
/** Brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
|
|
49163
|
+
external_type?:
|
|
49164
|
+
| (
|
|
49165
|
+
| 'pti_card'
|
|
49166
|
+
| 'brivo_credential'
|
|
49167
|
+
| 'brivo_digital_credential'
|
|
49168
|
+
| 'hid_credential'
|
|
49169
|
+
| 'visionline_card'
|
|
49170
|
+
| 'salto_ks_credential'
|
|
49171
|
+
| 'assa_abloy_vostio_key'
|
|
49172
|
+
| 'salto_space_key'
|
|
49173
|
+
| 'latch_access'
|
|
49174
|
+
| 'dormakaba_ambiance_credential'
|
|
49175
|
+
| 'hotek_card'
|
|
49176
|
+
)
|
|
49177
|
+
| undefined
|
|
49178
|
+
/** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
|
|
49179
|
+
external_type_display_name?: string | undefined
|
|
49180
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
|
|
49181
|
+
created_at: string
|
|
49182
|
+
/** ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces) that contains the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49183
|
+
workspace_id: string
|
|
49184
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
|
|
49185
|
+
starts_at?: string | undefined
|
|
49186
|
+
/** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/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`. */
|
|
49187
|
+
ends_at?: string | undefined
|
|
49188
|
+
/** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49189
|
+
errors: {
|
|
49190
|
+
error_code: string
|
|
49191
|
+
message: string
|
|
49192
|
+
}[]
|
|
49193
|
+
/** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49194
|
+
warnings: (
|
|
49195
|
+
| {
|
|
49196
|
+
/** Date and time at which Seam created the warning. */
|
|
49197
|
+
created_at: string
|
|
49198
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49199
|
+
message: string
|
|
49200
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49201
|
+
warning_code: 'waiting_to_be_issued'
|
|
49202
|
+
}
|
|
49203
|
+
| {
|
|
49204
|
+
/** Date and time at which Seam created the warning. */
|
|
49205
|
+
created_at: string
|
|
49206
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49207
|
+
message: string
|
|
49208
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49209
|
+
warning_code: 'schedule_externally_modified'
|
|
49210
|
+
}
|
|
49211
|
+
| {
|
|
49212
|
+
/** Date and time at which Seam created the warning. */
|
|
49213
|
+
created_at: string
|
|
49214
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49215
|
+
message: string
|
|
49216
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49217
|
+
warning_code: 'schedule_modified'
|
|
49218
|
+
}
|
|
49219
|
+
| {
|
|
49220
|
+
/** Date and time at which Seam created the warning. */
|
|
49221
|
+
created_at: string
|
|
49222
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49223
|
+
message: string
|
|
49224
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49225
|
+
warning_code: 'being_deleted'
|
|
49226
|
+
}
|
|
49227
|
+
| {
|
|
49228
|
+
/** Date and time at which Seam created the warning. */
|
|
49229
|
+
created_at: string
|
|
49230
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49231
|
+
message: string
|
|
49232
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49233
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
49234
|
+
}
|
|
49235
|
+
| {
|
|
49236
|
+
/** Date and time at which Seam created the warning. */
|
|
49237
|
+
created_at: string
|
|
49238
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
49239
|
+
message: string
|
|
49240
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
49241
|
+
warning_code: 'needs_to_be_reissued'
|
|
49242
|
+
}
|
|
49243
|
+
)[]
|
|
49244
|
+
/** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is a [multi-phone sync credential](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
|
|
49245
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
49246
|
+
/** Indicates whether the latest state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been synced from Seam to the provider. */
|
|
49247
|
+
is_latest_desired_state_synced_with_provider?:
|
|
49248
|
+
| (boolean | null)
|
|
49249
|
+
| undefined
|
|
49250
|
+
/** Date and time at which the state of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
|
|
49251
|
+
latest_desired_state_synced_with_provider_at?:
|
|
49252
|
+
| (string | null)
|
|
49253
|
+
| undefined
|
|
49254
|
+
/** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49255
|
+
visionline_metadata?:
|
|
49256
|
+
| {
|
|
49257
|
+
/** Card function type in the Visionline access system. */
|
|
49258
|
+
card_function_type: 'guest' | 'staff'
|
|
49259
|
+
/** IDs of the credentials to which you want to join. */
|
|
49260
|
+
joiner_acs_credential_ids?: string[] | undefined
|
|
49261
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
49262
|
+
guest_acs_entrance_ids?: string[] | undefined
|
|
49263
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
49264
|
+
common_acs_entrance_ids?: string[] | undefined
|
|
49265
|
+
/** Indicates whether the credential is valid. */
|
|
49266
|
+
is_valid?: boolean | undefined
|
|
49267
|
+
/** 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. */
|
|
49268
|
+
auto_join?: boolean | undefined
|
|
49269
|
+
/** ID of the card in the Visionline access system. */
|
|
49270
|
+
card_id?: string | undefined
|
|
49271
|
+
/** ID of the credential in the Visionline access system. */
|
|
49272
|
+
credential_id?: string | undefined
|
|
49273
|
+
}
|
|
49274
|
+
| undefined
|
|
49275
|
+
/** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
|
|
49276
|
+
assa_abloy_vostio_metadata?:
|
|
49277
|
+
| {
|
|
49278
|
+
/** 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. */
|
|
49279
|
+
auto_join?: boolean | undefined
|
|
49280
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
49281
|
+
override_guest_acs_entrance_ids?: string[] | undefined
|
|
49282
|
+
/** Key ID in the Vostio access system. */
|
|
49283
|
+
key_id?: string | undefined
|
|
49284
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
49285
|
+
key_issuing_request_id?: string | undefined
|
|
49286
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
49287
|
+
door_names?: string[] | undefined
|
|
49288
|
+
/** Endpoint ID in the Vostio access system. */
|
|
49289
|
+
endpoint_id?: string | undefined
|
|
49290
|
+
}
|
|
49291
|
+
| undefined
|
|
49292
|
+
is_managed: false
|
|
49293
|
+
}
|
|
49294
|
+
}
|
|
49295
|
+
| {
|
|
49296
|
+
/** ID of the action attempt. */
|
|
49297
|
+
action_attempt_id: string
|
|
49298
|
+
status: 'error'
|
|
49299
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49300
|
+
result: null
|
|
49301
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
49302
|
+
action_type: 'ENCODE_CREDENTIAL'
|
|
49303
|
+
error:
|
|
49304
|
+
| {
|
|
49305
|
+
/** Type of the error associated with the action attempt. */
|
|
49306
|
+
type: 'uncategorized_error'
|
|
49307
|
+
/** Message for the error associated with the action attempt. */
|
|
49308
|
+
message: string
|
|
49309
|
+
}
|
|
49310
|
+
| {
|
|
49311
|
+
/** Type of the error associated with the action attempt. */
|
|
49312
|
+
type: 'action_attempt_expired'
|
|
49313
|
+
/** Message for the error associated with the action attempt. */
|
|
49314
|
+
message: string
|
|
49315
|
+
}
|
|
49316
|
+
| {
|
|
49317
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
49318
|
+
type: 'no_credential_on_encoder'
|
|
49319
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49320
|
+
message: string
|
|
49321
|
+
}
|
|
49322
|
+
| {
|
|
49323
|
+
/** Error type to indicate an incompatible card format. */
|
|
49324
|
+
type: 'incompatible_card_format'
|
|
49325
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49326
|
+
message: string
|
|
49327
|
+
}
|
|
49328
|
+
| {
|
|
49329
|
+
/** Error type to indicate that the affected credential cannot be reissued. */
|
|
49330
|
+
type: 'credential_cannot_be_reissued'
|
|
49331
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49332
|
+
message: string
|
|
49333
|
+
}
|
|
49334
|
+
| {
|
|
49335
|
+
/** Error type to indicate that the encoder is not online. */
|
|
49336
|
+
type: 'encoder_not_online'
|
|
49337
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49338
|
+
message: string
|
|
49339
|
+
}
|
|
49340
|
+
}
|
|
49341
|
+
| {
|
|
49342
|
+
/** ID of the action attempt. */
|
|
49343
|
+
action_attempt_id: string
|
|
49344
|
+
status: 'pending'
|
|
49345
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49346
|
+
result: null
|
|
49347
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49348
|
+
error: null
|
|
49349
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
49350
|
+
action_type: 'RESET_SANDBOX_WORKSPACE'
|
|
49351
|
+
}
|
|
49352
|
+
| {
|
|
49353
|
+
/** ID of the action attempt. */
|
|
49354
|
+
action_attempt_id: string
|
|
49355
|
+
status: 'success'
|
|
49356
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49357
|
+
error: null
|
|
49358
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
49359
|
+
action_type: 'RESET_SANDBOX_WORKSPACE'
|
|
49360
|
+
/** Result of the action. */
|
|
49361
|
+
result: {}
|
|
49362
|
+
}
|
|
49363
|
+
| {
|
|
49364
|
+
/** ID of the action attempt. */
|
|
49365
|
+
action_attempt_id: string
|
|
49366
|
+
status: 'error'
|
|
49367
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49368
|
+
result: null
|
|
49369
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
49370
|
+
action_type: 'RESET_SANDBOX_WORKSPACE'
|
|
49371
|
+
/** Error associated with the action. */
|
|
49372
|
+
error: {
|
|
49373
|
+
/** Type of the error. */
|
|
49374
|
+
type: string
|
|
49375
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49376
|
+
message: string
|
|
49377
|
+
}
|
|
49378
|
+
}
|
|
49379
|
+
| {
|
|
49380
|
+
/** ID of the action attempt. */
|
|
49381
|
+
action_attempt_id: string
|
|
49382
|
+
status: 'pending'
|
|
49383
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49384
|
+
result: null
|
|
49385
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49386
|
+
error: null
|
|
49387
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
49388
|
+
action_type: 'SET_FAN_MODE'
|
|
49389
|
+
}
|
|
49390
|
+
| {
|
|
49391
|
+
/** ID of the action attempt. */
|
|
49392
|
+
action_attempt_id: string
|
|
49393
|
+
status: 'success'
|
|
49394
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49395
|
+
error: null
|
|
49396
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
49397
|
+
action_type: 'SET_FAN_MODE'
|
|
49398
|
+
/** Result of the action. */
|
|
49399
|
+
result: {}
|
|
49400
|
+
}
|
|
49401
|
+
| {
|
|
49402
|
+
/** ID of the action attempt. */
|
|
49403
|
+
action_attempt_id: string
|
|
49404
|
+
status: 'error'
|
|
49405
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49406
|
+
result: null
|
|
49407
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
49408
|
+
action_type: 'SET_FAN_MODE'
|
|
49409
|
+
/** Error associated with the action. */
|
|
49410
|
+
error: {
|
|
49411
|
+
/** Type of the error. */
|
|
49412
|
+
type: string
|
|
49413
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49414
|
+
message: string
|
|
49415
|
+
}
|
|
49416
|
+
}
|
|
49417
|
+
| {
|
|
49418
|
+
/** ID of the action attempt. */
|
|
49419
|
+
action_attempt_id: string
|
|
49420
|
+
status: 'pending'
|
|
49421
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49422
|
+
result: null
|
|
49423
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49424
|
+
error: null
|
|
49425
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
49426
|
+
action_type: 'SET_HVAC_MODE'
|
|
49427
|
+
}
|
|
49428
|
+
| {
|
|
49429
|
+
/** ID of the action attempt. */
|
|
49430
|
+
action_attempt_id: string
|
|
49431
|
+
status: 'success'
|
|
49432
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49433
|
+
error: null
|
|
49434
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
49435
|
+
action_type: 'SET_HVAC_MODE'
|
|
49436
|
+
/** Result of the action. */
|
|
49437
|
+
result: {}
|
|
49438
|
+
}
|
|
49439
|
+
| {
|
|
49440
|
+
/** ID of the action attempt. */
|
|
49441
|
+
action_attempt_id: string
|
|
49442
|
+
status: 'error'
|
|
49443
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49444
|
+
result: null
|
|
49445
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
49446
|
+
action_type: 'SET_HVAC_MODE'
|
|
49447
|
+
/** Error associated with the action. */
|
|
49448
|
+
error: {
|
|
49449
|
+
/** Type of the error. */
|
|
49450
|
+
type: string
|
|
49451
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49452
|
+
message: string
|
|
49453
|
+
}
|
|
49454
|
+
}
|
|
49455
|
+
| {
|
|
49456
|
+
/** ID of the action attempt. */
|
|
49457
|
+
action_attempt_id: string
|
|
49458
|
+
status: 'pending'
|
|
49459
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49460
|
+
result: null
|
|
49461
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49462
|
+
error: null
|
|
49463
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
49464
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET'
|
|
49465
|
+
}
|
|
49466
|
+
| {
|
|
49467
|
+
/** ID of the action attempt. */
|
|
49468
|
+
action_attempt_id: string
|
|
49469
|
+
status: 'success'
|
|
49470
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49471
|
+
error: null
|
|
49472
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
49473
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET'
|
|
49474
|
+
/** Result of the action. */
|
|
49475
|
+
result: {}
|
|
49476
|
+
}
|
|
49477
|
+
| {
|
|
49478
|
+
/** ID of the action attempt. */
|
|
49479
|
+
action_attempt_id: string
|
|
49480
|
+
status: 'error'
|
|
49481
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49482
|
+
result: null
|
|
49483
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
49484
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET'
|
|
49485
|
+
/** Error associated with the action. */
|
|
49486
|
+
error: {
|
|
49487
|
+
/** Type of the error. */
|
|
49488
|
+
type: string
|
|
49489
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49490
|
+
message: string
|
|
49491
|
+
}
|
|
49492
|
+
}
|
|
49493
|
+
| {
|
|
49494
|
+
/** ID of the action attempt. */
|
|
49495
|
+
action_attempt_id: string
|
|
49496
|
+
status: 'pending'
|
|
49497
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49498
|
+
result: null
|
|
49499
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49500
|
+
error: null
|
|
49501
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
49502
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
|
|
49503
|
+
}
|
|
49504
|
+
| {
|
|
49505
|
+
/** ID of the action attempt. */
|
|
49506
|
+
action_attempt_id: string
|
|
49507
|
+
status: 'success'
|
|
49508
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49509
|
+
error: null
|
|
49510
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
49511
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
|
|
49512
|
+
/** Result of the action. */
|
|
49513
|
+
result: {}
|
|
49514
|
+
}
|
|
49515
|
+
| {
|
|
49516
|
+
/** ID of the action attempt. */
|
|
49517
|
+
action_attempt_id: string
|
|
49518
|
+
status: 'error'
|
|
49519
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49520
|
+
result: null
|
|
49521
|
+
/** Action attempt to track the status of simulating a keypad code entry. */
|
|
49522
|
+
action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
|
|
49523
|
+
/** Error associated with the action. */
|
|
49524
|
+
error: {
|
|
49525
|
+
/** Type of the error. */
|
|
49526
|
+
type: string
|
|
49527
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49528
|
+
message: string
|
|
49529
|
+
}
|
|
49530
|
+
}
|
|
49531
|
+
| {
|
|
49532
|
+
/** ID of the action attempt. */
|
|
49533
|
+
action_attempt_id: string
|
|
49534
|
+
status: 'pending'
|
|
49535
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49536
|
+
result: null
|
|
49537
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49538
|
+
error: null
|
|
49539
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
49540
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
|
|
49541
|
+
}
|
|
49542
|
+
| {
|
|
49543
|
+
/** ID of the action attempt. */
|
|
49544
|
+
action_attempt_id: string
|
|
49545
|
+
status: 'success'
|
|
49546
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49547
|
+
error: null
|
|
49548
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
49549
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
|
|
49550
|
+
/** Result of the action. */
|
|
49551
|
+
result: {}
|
|
49552
|
+
}
|
|
49553
|
+
| {
|
|
49554
|
+
/** ID of the action attempt. */
|
|
49555
|
+
action_attempt_id: string
|
|
49556
|
+
status: 'error'
|
|
49557
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49558
|
+
result: null
|
|
49559
|
+
/** Action attempt to track the status of simulating a manual lock action using a keypad. */
|
|
49560
|
+
action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
|
|
49561
|
+
/** Error associated with the action. */
|
|
49562
|
+
error: {
|
|
49563
|
+
/** Type of the error. */
|
|
49564
|
+
type: string
|
|
49565
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49566
|
+
message: string
|
|
49567
|
+
}
|
|
49568
|
+
}
|
|
49569
|
+
| {
|
|
49570
|
+
/** ID of the action attempt. */
|
|
49571
|
+
action_attempt_id: string
|
|
49572
|
+
status: 'pending'
|
|
49573
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49574
|
+
result: null
|
|
49575
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49576
|
+
error: null
|
|
49577
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
49578
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS'
|
|
49579
|
+
}
|
|
49580
|
+
| {
|
|
49581
|
+
/** ID of the action attempt. */
|
|
49582
|
+
action_attempt_id: string
|
|
49583
|
+
status: 'success'
|
|
49584
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49585
|
+
error: null
|
|
49586
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
49587
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS'
|
|
49588
|
+
/** Result of the action. */
|
|
49589
|
+
result: {}
|
|
49590
|
+
}
|
|
49591
|
+
| {
|
|
49592
|
+
/** ID of the action attempt. */
|
|
49593
|
+
action_attempt_id: string
|
|
49594
|
+
status: 'error'
|
|
49595
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49596
|
+
result: null
|
|
49597
|
+
/** Action attempt to track the status of pushing thermostat programs. */
|
|
49598
|
+
action_type: 'PUSH_THERMOSTAT_PROGRAMS'
|
|
49599
|
+
/** Error associated with the action. */
|
|
49600
|
+
error: {
|
|
49601
|
+
/** Type of the error. */
|
|
49602
|
+
type: string
|
|
49603
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49604
|
+
message: string
|
|
49605
|
+
}
|
|
49606
|
+
}
|
|
49607
|
+
| {
|
|
49608
|
+
/** ID of the action attempt. */
|
|
49609
|
+
action_attempt_id: string
|
|
49610
|
+
status: 'pending'
|
|
49611
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49612
|
+
result: null
|
|
49613
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49614
|
+
error: null
|
|
49615
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
49616
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
49617
|
+
}
|
|
49618
|
+
| {
|
|
49619
|
+
/** ID of the action attempt. */
|
|
49620
|
+
action_attempt_id: string
|
|
49621
|
+
status: 'success'
|
|
49622
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49623
|
+
error: null
|
|
49624
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
49625
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
49626
|
+
/** Result of the action. */
|
|
49627
|
+
result: {}
|
|
49628
|
+
}
|
|
49629
|
+
| {
|
|
49630
|
+
/** ID of the action attempt. */
|
|
49631
|
+
action_attempt_id: string
|
|
49632
|
+
status: 'error'
|
|
49633
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49634
|
+
result: null
|
|
49635
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
49636
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
49637
|
+
/** Error associated with the action. */
|
|
49638
|
+
error: {
|
|
49639
|
+
/** Type of the error. */
|
|
49640
|
+
type: string
|
|
49641
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49642
|
+
message: string
|
|
49643
|
+
}
|
|
49644
|
+
}
|
|
49645
|
+
| {
|
|
49646
|
+
/** ID of the action attempt. */
|
|
49647
|
+
action_attempt_id: string
|
|
49648
|
+
status: 'pending'
|
|
49649
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49650
|
+
result: null
|
|
49651
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49652
|
+
error: null
|
|
49653
|
+
/** Syncing access codes is pending. */
|
|
49654
|
+
action_type: 'SYNC_ACCESS_CODES'
|
|
49655
|
+
}
|
|
49656
|
+
| {
|
|
49657
|
+
/** ID of the action attempt. */
|
|
49658
|
+
action_attempt_id: string
|
|
49659
|
+
status: 'success'
|
|
49660
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49661
|
+
error: null
|
|
49662
|
+
/** Syncing access codes succeeded. */
|
|
49663
|
+
action_type: 'SYNC_ACCESS_CODES'
|
|
49664
|
+
/** Result of the action. */
|
|
49665
|
+
result: {}
|
|
49666
|
+
}
|
|
49667
|
+
| {
|
|
49668
|
+
/** ID of the action attempt. */
|
|
49669
|
+
action_attempt_id: string
|
|
49670
|
+
status: 'error'
|
|
49671
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49672
|
+
result: null
|
|
49673
|
+
/** Syncing access codes failed. */
|
|
49674
|
+
action_type: 'SYNC_ACCESS_CODES'
|
|
49675
|
+
/** Error associated with the action. */
|
|
49676
|
+
error: {
|
|
49677
|
+
/** Type of the error. */
|
|
49678
|
+
type: string
|
|
49679
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49680
|
+
message: string
|
|
49681
|
+
}
|
|
49682
|
+
}
|
|
49683
|
+
| {
|
|
49684
|
+
/** ID of the action attempt. */
|
|
49685
|
+
action_attempt_id: string
|
|
49686
|
+
status: 'pending'
|
|
49687
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49688
|
+
result: null
|
|
49689
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49690
|
+
error: null
|
|
49691
|
+
/** Creating an access code is pending. */
|
|
49692
|
+
action_type: 'CREATE_ACCESS_CODE'
|
|
49693
|
+
}
|
|
49694
|
+
| {
|
|
49695
|
+
/** ID of the action attempt. */
|
|
49696
|
+
action_attempt_id: string
|
|
49697
|
+
status: 'success'
|
|
49698
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49699
|
+
error: null
|
|
49700
|
+
/** Creating an access code succeeded. */
|
|
49701
|
+
action_type: 'CREATE_ACCESS_CODE'
|
|
49702
|
+
/** Result of the action. */
|
|
49703
|
+
result: {
|
|
49704
|
+
/** Created access code. */
|
|
49705
|
+
access_code?: any
|
|
49706
|
+
}
|
|
49707
|
+
}
|
|
49708
|
+
| {
|
|
49709
|
+
/** ID of the action attempt. */
|
|
49710
|
+
action_attempt_id: string
|
|
49711
|
+
status: 'error'
|
|
49712
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49713
|
+
result: null
|
|
49714
|
+
/** Creating an access code failed. */
|
|
49715
|
+
action_type: 'CREATE_ACCESS_CODE'
|
|
49716
|
+
/** Error associated with the action. */
|
|
49717
|
+
error: {
|
|
49718
|
+
/** Type of the error. */
|
|
49719
|
+
type: string
|
|
49720
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49721
|
+
message: string
|
|
49722
|
+
}
|
|
49723
|
+
}
|
|
49724
|
+
| {
|
|
49725
|
+
/** ID of the action attempt. */
|
|
49726
|
+
action_attempt_id: string
|
|
49727
|
+
status: 'pending'
|
|
49728
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49729
|
+
result: null
|
|
49730
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49731
|
+
error: null
|
|
49732
|
+
/** Deleting an access code is pending. */
|
|
49733
|
+
action_type: 'DELETE_ACCESS_CODE'
|
|
49734
|
+
}
|
|
49735
|
+
| {
|
|
49736
|
+
/** ID of the action attempt. */
|
|
49737
|
+
action_attempt_id: string
|
|
49738
|
+
status: 'success'
|
|
49739
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49740
|
+
error: null
|
|
49741
|
+
/** Deleting an access code succeeded. */
|
|
49742
|
+
action_type: 'DELETE_ACCESS_CODE'
|
|
49743
|
+
/** Result of the action. */
|
|
49744
|
+
result: {}
|
|
49745
|
+
}
|
|
49746
|
+
| {
|
|
49747
|
+
/** ID of the action attempt. */
|
|
49748
|
+
action_attempt_id: string
|
|
49749
|
+
status: 'error'
|
|
49750
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49751
|
+
result: null
|
|
49752
|
+
/** Deleting an access code failed. */
|
|
49753
|
+
action_type: 'DELETE_ACCESS_CODE'
|
|
49754
|
+
/** Error associated with the action. */
|
|
49755
|
+
error: {
|
|
49756
|
+
/** Type of the error. */
|
|
49757
|
+
type: string
|
|
49758
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49759
|
+
message: string
|
|
49760
|
+
}
|
|
49761
|
+
}
|
|
49762
|
+
| {
|
|
49763
|
+
/** ID of the action attempt. */
|
|
49764
|
+
action_attempt_id: string
|
|
49765
|
+
status: 'pending'
|
|
49766
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49767
|
+
result: null
|
|
49768
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49769
|
+
error: null
|
|
49770
|
+
/** Updating an access code is pending. */
|
|
49771
|
+
action_type: 'UPDATE_ACCESS_CODE'
|
|
49772
|
+
}
|
|
49773
|
+
| {
|
|
49774
|
+
/** ID of the action attempt. */
|
|
49775
|
+
action_attempt_id: string
|
|
49776
|
+
status: 'success'
|
|
49777
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49778
|
+
error: null
|
|
49779
|
+
/** Updating an access code succeeded. */
|
|
49780
|
+
action_type: 'UPDATE_ACCESS_CODE'
|
|
49781
|
+
/** Result of the action. */
|
|
49782
|
+
result: {
|
|
49783
|
+
/** Updated access code. */
|
|
49784
|
+
access_code?: any
|
|
49785
|
+
}
|
|
49786
|
+
}
|
|
49787
|
+
| {
|
|
49788
|
+
/** ID of the action attempt. */
|
|
49789
|
+
action_attempt_id: string
|
|
49790
|
+
status: 'error'
|
|
49791
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49792
|
+
result: null
|
|
49793
|
+
/** Updating an access code failed. */
|
|
49794
|
+
action_type: 'UPDATE_ACCESS_CODE'
|
|
49795
|
+
/** Error associated with the action. */
|
|
49796
|
+
error: {
|
|
49797
|
+
/** Type of the error. */
|
|
49798
|
+
type: string
|
|
49799
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49800
|
+
message: string
|
|
49801
|
+
}
|
|
49802
|
+
}
|
|
49803
|
+
| {
|
|
49804
|
+
/** ID of the action attempt. */
|
|
49805
|
+
action_attempt_id: string
|
|
49806
|
+
status: 'pending'
|
|
49807
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49808
|
+
result: null
|
|
49809
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49810
|
+
error: null
|
|
49811
|
+
/** Creating a noise threshold is pending. */
|
|
49812
|
+
action_type: 'CREATE_NOISE_THRESHOLD'
|
|
49813
|
+
}
|
|
49814
|
+
| {
|
|
49815
|
+
/** ID of the action attempt. */
|
|
49816
|
+
action_attempt_id: string
|
|
49817
|
+
status: 'success'
|
|
49818
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49819
|
+
error: null
|
|
49820
|
+
/** Creating a noise threshold succeeded. */
|
|
49821
|
+
action_type: 'CREATE_NOISE_THRESHOLD'
|
|
49822
|
+
/** Result of the action. */
|
|
49823
|
+
result: {
|
|
49824
|
+
/** Created noise threshold. */
|
|
49825
|
+
noise_threshold?: any
|
|
49826
|
+
}
|
|
49827
|
+
}
|
|
49828
|
+
| {
|
|
49829
|
+
/** ID of the action attempt. */
|
|
49830
|
+
action_attempt_id: string
|
|
49831
|
+
status: 'error'
|
|
49832
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49833
|
+
result: null
|
|
49834
|
+
/** Creating a noise threshold failed. */
|
|
49835
|
+
action_type: 'CREATE_NOISE_THRESHOLD'
|
|
49836
|
+
/** Error associated with the action. */
|
|
49837
|
+
error: {
|
|
49838
|
+
/** Type of the error. */
|
|
49839
|
+
type: string
|
|
49840
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49841
|
+
message: string
|
|
49842
|
+
}
|
|
49843
|
+
}
|
|
49844
|
+
| {
|
|
49845
|
+
/** ID of the action attempt. */
|
|
49846
|
+
action_attempt_id: string
|
|
49847
|
+
status: 'pending'
|
|
49848
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49849
|
+
result: null
|
|
49850
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49851
|
+
error: null
|
|
49852
|
+
/** Deleting a noise threshold is pending. */
|
|
49853
|
+
action_type: 'DELETE_NOISE_THRESHOLD'
|
|
49854
|
+
}
|
|
49855
|
+
| {
|
|
49856
|
+
/** ID of the action attempt. */
|
|
49857
|
+
action_attempt_id: string
|
|
49858
|
+
status: 'success'
|
|
49859
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49860
|
+
error: null
|
|
49861
|
+
/** Deleting a noise threshold succeeded. */
|
|
49862
|
+
action_type: 'DELETE_NOISE_THRESHOLD'
|
|
49863
|
+
/** Result of the action. */
|
|
49864
|
+
result: {}
|
|
49865
|
+
}
|
|
49866
|
+
| {
|
|
49867
|
+
/** ID of the action attempt. */
|
|
49868
|
+
action_attempt_id: string
|
|
49869
|
+
status: 'error'
|
|
49870
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49871
|
+
result: null
|
|
49872
|
+
/** Deleting a noise threshold failed. */
|
|
49873
|
+
action_type: 'DELETE_NOISE_THRESHOLD'
|
|
49874
|
+
/** Error associated with the action. */
|
|
49875
|
+
error: {
|
|
49876
|
+
/** Type of the error. */
|
|
49877
|
+
type: string
|
|
49878
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49879
|
+
message: string
|
|
49880
|
+
}
|
|
49881
|
+
}
|
|
49882
|
+
| {
|
|
49883
|
+
/** ID of the action attempt. */
|
|
49884
|
+
action_attempt_id: string
|
|
49885
|
+
status: 'pending'
|
|
49886
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
49887
|
+
result: null
|
|
49888
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
49889
|
+
error: null
|
|
49890
|
+
/** Updating a noise threshold is pending. */
|
|
49891
|
+
action_type: 'UPDATE_NOISE_THRESHOLD'
|
|
49892
|
+
}
|
|
49893
|
+
| {
|
|
49894
|
+
/** ID of the action attempt. */
|
|
49895
|
+
action_attempt_id: string
|
|
49896
|
+
status: 'success'
|
|
49897
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
49898
|
+
error: null
|
|
49899
|
+
/** Updating a noise threshold succeeded. */
|
|
49900
|
+
action_type: 'UPDATE_NOISE_THRESHOLD'
|
|
49901
|
+
/** Result of the action. */
|
|
49902
|
+
result: {
|
|
49903
|
+
/** Updated noise threshold. */
|
|
49904
|
+
noise_threshold?: any
|
|
49905
|
+
}
|
|
49906
|
+
}
|
|
49907
|
+
| {
|
|
49908
|
+
/** ID of the action attempt. */
|
|
49909
|
+
action_attempt_id: string
|
|
49910
|
+
status: 'error'
|
|
49911
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
49912
|
+
result: null
|
|
49913
|
+
/** Updating a noise threshold failed. */
|
|
49914
|
+
action_type: 'UPDATE_NOISE_THRESHOLD'
|
|
49915
|
+
/** Error associated with the action. */
|
|
49916
|
+
error: {
|
|
49917
|
+
/** Type of the error. */
|
|
49918
|
+
type: string
|
|
49919
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
49920
|
+
message: string
|
|
49921
|
+
}
|
|
49922
|
+
}
|
|
49923
|
+
}
|
|
49924
|
+
maxDuration: undefined
|
|
49925
|
+
}
|
|
49926
|
+
'/locks/get': {
|
|
49927
|
+
route: '/locks/get'
|
|
49928
|
+
method: 'GET' | 'POST'
|
|
49929
|
+
queryParams: {}
|
|
49930
|
+
jsonBody: {}
|
|
49931
|
+
commonParams: {
|
|
49932
|
+
/** ID of the lock that you want to get. */
|
|
49933
|
+
device_id?: string | undefined
|
|
49934
|
+
/** Name of the lock that you want to get. */
|
|
49935
|
+
name?: string | undefined
|
|
49936
|
+
}
|
|
49937
|
+
formData: {}
|
|
49938
|
+
jsonResponse: {
|
|
49939
|
+
/** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
|
|
49940
|
+
lock: {
|
|
49941
|
+
/** ID of the device. */
|
|
49942
|
+
device_id: string
|
|
49943
|
+
/** Type of the device. */
|
|
49944
|
+
device_type:
|
|
49945
|
+
| (
|
|
49946
|
+
| 'akuvox_lock'
|
|
49947
|
+
| 'august_lock'
|
|
49948
|
+
| 'brivo_access_point'
|
|
49949
|
+
| 'butterflymx_panel'
|
|
49950
|
+
| 'avigilon_alta_entry'
|
|
49951
|
+
| 'doorking_lock'
|
|
49952
|
+
| 'genie_door'
|
|
49953
|
+
| 'igloo_lock'
|
|
49954
|
+
| 'linear_lock'
|
|
49955
|
+
| 'lockly_lock'
|
|
49956
|
+
| 'kwikset_lock'
|
|
49957
|
+
| 'nuki_lock'
|
|
49958
|
+
| 'salto_lock'
|
|
49959
|
+
| 'schlage_lock'
|
|
49960
|
+
| 'smartthings_lock'
|
|
49961
|
+
| 'wyze_lock'
|
|
49962
|
+
| 'yale_lock'
|
|
49963
|
+
| 'two_n_intercom'
|
|
49964
|
+
| 'controlbyweb_device'
|
|
49965
|
+
| 'ttlock_lock'
|
|
49966
|
+
| 'igloohome_lock'
|
|
49967
|
+
| 'four_suites_door'
|
|
49968
|
+
| 'dormakaba_oracode_door'
|
|
49969
|
+
| 'tedee_lock'
|
|
49970
|
+
| 'akiles_lock'
|
|
49971
|
+
| 'ultraloq_lock'
|
|
49972
|
+
| 'korelock_lock'
|
|
49973
|
+
)
|
|
49974
|
+
| 'keynest_key'
|
|
49975
|
+
| ('noiseaware_activity_zone' | 'minut_sensor')
|
|
49976
|
+
| (
|
|
49977
|
+
| 'ecobee_thermostat'
|
|
49978
|
+
| 'nest_thermostat'
|
|
49979
|
+
| 'honeywell_resideo_thermostat'
|
|
49980
|
+
| 'tado_thermostat'
|
|
49981
|
+
| 'sensi_thermostat'
|
|
49982
|
+
| 'smartthings_thermostat'
|
|
49983
|
+
)
|
|
49984
|
+
| ('ios_phone' | 'android_phone')
|
|
49985
|
+
| 'ring_camera'
|
|
49986
|
+
/** IDs of the spaces the device is in. */
|
|
49987
|
+
space_ids: string[]
|
|
49988
|
+
/** Optional nickname to describe the device, settable through Seam. */
|
|
49989
|
+
nickname?: string | undefined
|
|
49990
|
+
/** Display name of the device, defaults to nickname (if it is set) or `properties.appearance.name`, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices. */
|
|
49991
|
+
display_name: string
|
|
49992
|
+
/**
|
|
49993
|
+
Collection of capabilities that the device supports when connected to Seam. Values are `access_code`, which indicates that the device can manage and utilize digital PIN codes for secure access; `lock`, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; `noise_detection`, which indicates that the device supports monitoring and responding to ambient noise levels; `thermostat`, which indicates that the device can regulate and adjust indoor temperatures; `battery`, which indicates that the device can manage battery life and health; and `phone`, which indicates that the device is a mobile device, such as a smartphone. **Important:** Superseded by [capability flags](https://docs.seam.co/latest/capability-guides/device-and-system-capabilities#capability-flags).
|
|
49994
|
+
*/
|
|
49995
|
+
capabilities_supported: (
|
|
49996
|
+
| 'access_code'
|
|
49997
|
+
| 'lock'
|
|
49998
|
+
| 'noise_detection'
|
|
49999
|
+
| 'thermostat'
|
|
50000
|
+
| 'battery'
|
|
50001
|
+
| 'phone'
|
|
50002
|
+
)[]
|
|
50003
|
+
/** Properties of the device. */
|
|
50004
|
+
properties: (({
|
|
50005
|
+
/** Indicates whether the device is online. */
|
|
50006
|
+
online: boolean
|
|
50007
|
+
/** Name of the device.
|
|
50008
|
+
* @deprecated use device.display_name instead*/
|
|
50009
|
+
name: string
|
|
50010
|
+
/** Accessory keypad properties and state. */
|
|
50011
|
+
accessory_keypad?:
|
|
50012
|
+
| {
|
|
50013
|
+
/** Indicates if an accessory keypad is connected to the device.
|
|
50014
|
+
*/
|
|
50015
|
+
is_connected: boolean
|
|
50016
|
+
/** Keypad battery properties.
|
|
50017
|
+
*/
|
|
50018
|
+
battery?:
|
|
50019
|
+
| {
|
|
50020
|
+
level: number
|
|
50021
|
+
}
|
|
50022
|
+
| undefined
|
|
50023
|
+
}
|
|
50024
|
+
| undefined
|
|
50025
|
+
/** Appearance-related properties, as reported by the device. */
|
|
50026
|
+
appearance: {
|
|
50027
|
+
/** Name of the device as seen from the provider API and application, not settable through Seam. */
|
|
50028
|
+
name: string
|
|
50029
|
+
}
|
|
50030
|
+
/** Device model-related properties. */
|
|
50031
|
+
model: {
|
|
50032
|
+
/**
|
|
50033
|
+
Indicates whether the device can connect a accessory keypad.
|
|
50034
|
+
*/
|
|
50035
|
+
can_connect_accessory_keypad?: boolean | undefined
|
|
50036
|
+
/**
|
|
50037
|
+
Display name of the device model.
|
|
50038
|
+
*/
|
|
50039
|
+
display_name: string
|
|
50040
|
+
/**
|
|
50041
|
+
Display name that corresponds to the manufacturer-specific terminology for the device.
|
|
50042
|
+
*/
|
|
50043
|
+
manufacturer_display_name: string
|
|
50044
|
+
/**
|
|
50045
|
+
Indicates whether the device has a built in accessory keypad.
|
|
50046
|
+
*/
|
|
50047
|
+
has_built_in_keypad?: boolean | undefined
|
|
50048
|
+
/**
|
|
50049
|
+
* @deprecated use device.can_program_offline_access_codes.*/
|
|
50050
|
+
offline_access_codes_supported?: boolean | undefined
|
|
50051
|
+
/**
|
|
50052
|
+
* @deprecated use device.can_program_online_access_codes.*/
|
|
50053
|
+
online_access_codes_supported?: boolean | undefined
|
|
50054
|
+
/**
|
|
50055
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad*/
|
|
50056
|
+
accessory_keypad_supported?: boolean | undefined
|
|
50057
|
+
}
|
|
50058
|
+
/** Indicates whether the device has direct power. */
|
|
50059
|
+
has_direct_power?: boolean | undefined
|
|
50060
|
+
/** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
|
|
50061
|
+
battery_level?: number | undefined
|
|
50062
|
+
/** Represents the current status of the battery charge level. */
|
|
50063
|
+
battery?:
|
|
50064
|
+
| {
|
|
50065
|
+
/** Battery charge level as a value between 0 and 1, inclusive.
|
|
50066
|
+
*/
|
|
50067
|
+
level: number
|
|
50068
|
+
/** Represents the current status of the battery charge level. Values are `critical`, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; `low`, which signifies that the battery is under the preferred threshold and should be charged soon; `good`, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and `full`, which represents a battery that is fully charged, providing the maximum duration of usage.
|
|
50069
|
+
*/
|
|
50070
|
+
status: 'critical' | 'low' | 'good' | 'full'
|
|
50071
|
+
}
|
|
50072
|
+
| undefined
|
|
50073
|
+
/** Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub. */
|
|
50074
|
+
manufacturer?: string | undefined
|
|
50075
|
+
/** Image URL for the device. */
|
|
50076
|
+
image_url?: string | undefined
|
|
50077
|
+
/** Alt text for the device image. */
|
|
50078
|
+
image_alt_text?: string | undefined
|
|
50079
|
+
/** Serial number of the device. */
|
|
50080
|
+
serial_number?: string | undefined
|
|
50081
|
+
/** Indicates whether it is currently possible to use online access codes for the device.
|
|
50082
|
+
* @deprecated use device.can_program_online_access_codes*/
|
|
50083
|
+
online_access_codes_enabled?: boolean | undefined
|
|
50084
|
+
/** Indicates whether it is currently possible to use offline access codes for the device.
|
|
50085
|
+
* @deprecated use device.can_program_offline_access_codes*/
|
|
50086
|
+
offline_access_codes_enabled?: boolean | undefined
|
|
50087
|
+
/**
|
|
50088
|
+
* @deprecated use device.properties.model.can_connect_accessory_keypad*/
|
|
50089
|
+
supports_accessory_keypad?: boolean | undefined
|
|
50090
|
+
/**
|
|
50091
|
+
* @deprecated use offline_access_codes_enabled*/
|
|
50092
|
+
supports_offline_access_codes?: boolean | undefined
|
|
50093
|
+
/** Indicates current noise level in decibels, if the device supports noise detection. */
|
|
50094
|
+
noise_level_decibels?: number | undefined
|
|
50095
|
+
/** Array of noise threshold IDs that are currently triggering. */
|
|
50096
|
+
currently_triggering_noise_threshold_ids?: string[] | undefined
|
|
50097
|
+
} & {
|
|
50098
|
+
/** ASSA ABLOY Credential Service metadata for the phone. */
|
|
50099
|
+
assa_abloy_credential_service_metadata?:
|
|
50100
|
+
| (
|
|
50101
|
+
| {
|
|
50102
|
+
/** Indicates whether the credential service has active endpoints associated with the phone. */
|
|
50103
|
+
has_active_endpoint: boolean
|
|
50104
|
+
/** Endpoints associated with the phone. */
|
|
50105
|
+
endpoints: {
|
|
50106
|
+
/** ID of the associated endpoint. */
|
|
50107
|
+
endpoint_id: string
|
|
50108
|
+
/** Indicated whether the endpoint is active. */
|
|
50109
|
+
is_active: boolean
|
|
50110
|
+
}[]
|
|
50111
|
+
}
|
|
50112
|
+
| undefined
|
|
50113
|
+
)
|
|
50114
|
+
| undefined
|
|
50115
|
+
/** Salto Space credential service metadata for the phone. */
|
|
50116
|
+
salto_space_credential_service_metadata?:
|
|
50117
|
+
| (
|
|
50118
|
+
| {
|
|
50119
|
+
/** Indicates whether the credential service has an active associated phone. */
|
|
50120
|
+
has_active_phone: boolean
|
|
50121
|
+
}
|
|
50122
|
+
| undefined
|
|
50123
|
+
)
|
|
50124
|
+
| undefined
|
|
50125
|
+
}) & {
|
|
50126
|
+
/** Metadata for an August device. */
|
|
50127
|
+
august_metadata?:
|
|
50128
|
+
| {
|
|
50129
|
+
/** Lock ID for an August device. */
|
|
50130
|
+
lock_id: string
|
|
50131
|
+
/** Lock name for an August device. */
|
|
50132
|
+
lock_name: string
|
|
50133
|
+
/** House name for an August device. */
|
|
50134
|
+
house_name: string
|
|
50135
|
+
/** Indicates whether an August device has a keypad. */
|
|
50136
|
+
has_keypad: boolean
|
|
50137
|
+
/** Keypad battery level for an August device. */
|
|
50138
|
+
keypad_battery_level?: string | undefined
|
|
50139
|
+
/** Model for an August device. */
|
|
50140
|
+
model?: string | undefined
|
|
50141
|
+
/** House ID for an August device. */
|
|
50142
|
+
house_id?: string | undefined
|
|
50143
|
+
}
|
|
50144
|
+
| undefined
|
|
50145
|
+
/** Metadata for an Avigilon Alta system. */
|
|
50146
|
+
avigilon_alta_metadata?:
|
|
50147
|
+
| {
|
|
50148
|
+
/** Entry name for an Avigilon Alta system. */
|
|
50149
|
+
entry_name: string
|
|
50150
|
+
/** Organization name for an Avigilon Alta system. */
|
|
50151
|
+
org_name: string
|
|
50152
|
+
/** Zone ID for an Avigilon Alta system. */
|
|
50153
|
+
zone_id: number
|
|
50154
|
+
/** Zone name for an Avigilon Alta system. */
|
|
50155
|
+
zone_name: string
|
|
50156
|
+
/** Site ID for an Avigilon Alta system. */
|
|
50157
|
+
site_id: number
|
|
50158
|
+
/** Site name for an Avigilon Alta system. */
|
|
50159
|
+
site_name: string
|
|
50160
|
+
/** Total count of entry relays for an Avigilon Alta system. */
|
|
50161
|
+
entry_relays_total_count: number
|
|
50162
|
+
}
|
|
50163
|
+
| undefined
|
|
50164
|
+
/** Metadata for a Schlage device. */
|
|
50165
|
+
schlage_metadata?:
|
|
50166
|
+
| {
|
|
50167
|
+
/** Device ID for a Schlage device. */
|
|
50168
|
+
device_id: string
|
|
50169
|
+
/** Device name for a Schlage device. */
|
|
50170
|
+
device_name: string
|
|
50171
|
+
/** Model for a Schlage device. */
|
|
50172
|
+
model?: string | undefined
|
|
50173
|
+
}
|
|
50174
|
+
| undefined
|
|
50175
|
+
/** Metadata for a SmartThings device. */
|
|
50176
|
+
smartthings_metadata?:
|
|
50177
|
+
| {
|
|
50178
|
+
/** Device ID for a SmartThings device. */
|
|
50179
|
+
device_id: string
|
|
50180
|
+
/** Device name for a SmartThings device. */
|
|
50181
|
+
device_name: string
|
|
50182
|
+
/** Model for a SmartThings device. */
|
|
50183
|
+
model?: string | undefined
|
|
50184
|
+
/** Location ID for a SmartThings device. */
|
|
50185
|
+
location_id?: string | undefined
|
|
50186
|
+
}
|
|
50187
|
+
| undefined
|
|
50188
|
+
/** Metadata for a Lockly device. */
|
|
50189
|
+
lockly_metadata?:
|
|
50190
|
+
| {
|
|
50191
|
+
/** Device ID for a Lockly device. */
|
|
50192
|
+
device_id: string
|
|
50193
|
+
/** Device name for a Lockly device. */
|
|
50194
|
+
device_name: string
|
|
50195
|
+
/** Model for a Lockly device. */
|
|
50196
|
+
model?: string | undefined
|
|
50197
|
+
}
|
|
50198
|
+
| undefined
|
|
50199
|
+
/** Metadata for a Nuki device. */
|
|
50200
|
+
nuki_metadata?:
|
|
50201
|
+
| {
|
|
50202
|
+
/** Device ID for a Nuki device. */
|
|
50203
|
+
device_id: string
|
|
50204
|
+
/** Device name for a Nuki device. */
|
|
50205
|
+
device_name: string
|
|
50206
|
+
/** Indicates whether the keypad battery is in a critical state for a Nuki device. */
|
|
50207
|
+
keypad_battery_critical?: boolean | undefined
|
|
50208
|
+
/** Indicates whether the keypad is paired for a Nuki device. */
|
|
50209
|
+
keypad_paired?: boolean | undefined
|
|
50210
|
+
/** Indicates whether keypad 2 is paired for a Nuki device. */
|
|
50211
|
+
keypad_2_paired?: boolean | undefined
|
|
50212
|
+
}
|
|
50213
|
+
| undefined
|
|
50214
|
+
/** Metadata for a Kwikset device. */
|
|
50215
|
+
kwikset_metadata?:
|
|
50216
|
+
| {
|
|
50217
|
+
/** Device ID for a Kwikset device. */
|
|
50218
|
+
device_id: string
|
|
50219
|
+
/** Device name for a Kwikset device. */
|
|
50220
|
+
device_name: string
|
|
50221
|
+
/** Model number for a Kwikset device. */
|
|
50222
|
+
model_number: string
|
|
50223
|
+
}
|
|
50224
|
+
| undefined
|
|
50225
|
+
/** Metada for a Salto device.
|
|
50226
|
+
* @deprecated Use `salto_ks_metadata ` instead.*/
|
|
50227
|
+
salto_metadata?:
|
|
50228
|
+
| {
|
|
50229
|
+
/** Lock ID for a Salto device. */
|
|
50230
|
+
lock_id: string
|
|
50231
|
+
/** Customer reference for a Salto device. */
|
|
50232
|
+
customer_reference: string
|
|
50233
|
+
/** Lock type for a Salto device. */
|
|
50234
|
+
lock_type: string
|
|
50235
|
+
/** Battery level for a Salto device. */
|
|
50236
|
+
battery_level: string
|
|
50237
|
+
/** Locked state for a Salto device. */
|
|
50238
|
+
locked_state: string
|
|
50239
|
+
/** Model for a Salto device. */
|
|
50240
|
+
model?: string | undefined
|
|
50241
|
+
/** Site ID for the Salto KS site to which the device belongs. */
|
|
50242
|
+
site_id?: string | undefined
|
|
50243
|
+
/** Site name for the Salto KS site to which the device belongs. */
|
|
50244
|
+
site_name?: string | undefined
|
|
50245
|
+
}
|
|
50246
|
+
| undefined
|
|
50247
|
+
/** Metadata for a Salto KS device. */
|
|
50248
|
+
salto_ks_metadata?:
|
|
50249
|
+
| {
|
|
50250
|
+
/** Lock ID for a Salto KS device. */
|
|
50251
|
+
lock_id: string
|
|
50252
|
+
/** Customer reference for a Salto KS device. */
|
|
50253
|
+
customer_reference: string
|
|
50254
|
+
/** Lock type for a Salto KS device. */
|
|
50255
|
+
lock_type: string
|
|
50256
|
+
/** Battery level for a Salto KS device. */
|
|
50257
|
+
battery_level: string
|
|
50258
|
+
/** Locked state for a Salto KS device. */
|
|
50259
|
+
locked_state: string
|
|
50260
|
+
/** Model for a Salto KS device. */
|
|
50261
|
+
model?: string | undefined
|
|
50262
|
+
/** Indicates whether the site has a Salto KS subscription that supports custom PINs. */
|
|
48328
50263
|
has_custom_pin_subscription?: boolean | undefined
|
|
48329
50264
|
/** Site ID for the Salto KS site to which the device belongs. */
|
|
48330
50265
|
site_id?: string | undefined
|
|
@@ -48477,6 +50412,8 @@ export type Routes = {
|
|
|
48477
50412
|
incomplete_keyboard_passcode: boolean
|
|
48478
50413
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
48479
50414
|
wifi: boolean
|
|
50415
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
50416
|
+
auto_lock_time_config: boolean
|
|
48480
50417
|
}
|
|
48481
50418
|
/** Indicates whether a TTLock device has a gateway. */
|
|
48482
50419
|
has_gateway?: boolean | undefined
|
|
@@ -48833,6 +50770,10 @@ export type Routes = {
|
|
|
48833
50770
|
| undefined
|
|
48834
50771
|
/** Indicates whether the door is open. */
|
|
48835
50772
|
door_open?: (boolean | undefined) | undefined
|
|
50773
|
+
/** Indicates whether automatic locking is enabled. */
|
|
50774
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
50775
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
50776
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
48836
50777
|
} & {
|
|
48837
50778
|
/** Reported temperature in °F. */
|
|
48838
50779
|
temperature_fahrenheit?: number | undefined
|
|
@@ -49636,6 +51577,7 @@ export type Routes = {
|
|
|
49636
51577
|
can_simulate_hub_connection?: boolean | undefined
|
|
49637
51578
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
49638
51579
|
can_simulate_paid_subscription?: boolean | undefined
|
|
51580
|
+
can_configure_auto_lock?: boolean | undefined
|
|
49639
51581
|
}
|
|
49640
51582
|
/** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
|
|
49641
51583
|
device: {
|
|
@@ -50113,6 +52055,8 @@ export type Routes = {
|
|
|
50113
52055
|
incomplete_keyboard_passcode: boolean
|
|
50114
52056
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
50115
52057
|
wifi: boolean
|
|
52058
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
52059
|
+
auto_lock_time_config: boolean
|
|
50116
52060
|
}
|
|
50117
52061
|
/** Indicates whether a TTLock device has a gateway. */
|
|
50118
52062
|
has_gateway?: boolean | undefined
|
|
@@ -50469,6 +52413,10 @@ export type Routes = {
|
|
|
50469
52413
|
| undefined
|
|
50470
52414
|
/** Indicates whether the door is open. */
|
|
50471
52415
|
door_open?: (boolean | undefined) | undefined
|
|
52416
|
+
/** Indicates whether automatic locking is enabled. */
|
|
52417
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
52418
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
52419
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
50472
52420
|
} & {
|
|
50473
52421
|
/** Reported temperature in °F. */
|
|
50474
52422
|
temperature_fahrenheit?: number | undefined
|
|
@@ -51272,6 +53220,7 @@ export type Routes = {
|
|
|
51272
53220
|
can_simulate_hub_connection?: boolean | undefined
|
|
51273
53221
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
51274
53222
|
can_simulate_paid_subscription?: boolean | undefined
|
|
53223
|
+
can_configure_auto_lock?: boolean | undefined
|
|
51275
53224
|
}
|
|
51276
53225
|
}
|
|
51277
53226
|
maxDuration: undefined
|
|
@@ -51426,6 +53375,7 @@ export type Routes = {
|
|
|
51426
53375
|
| 'can_simulate_hub_connection'
|
|
51427
53376
|
| 'can_simulate_hub_disconnection'
|
|
51428
53377
|
| 'can_simulate_paid_subscription'
|
|
53378
|
+
| 'can_configure_auto_lock'
|
|
51429
53379
|
)[]
|
|
51430
53380
|
| undefined
|
|
51431
53381
|
/** */
|
|
@@ -51450,6 +53400,7 @@ export type Routes = {
|
|
|
51450
53400
|
| 'can_simulate_hub_connection'
|
|
51451
53401
|
| 'can_simulate_hub_disconnection'
|
|
51452
53402
|
| 'can_simulate_paid_subscription'
|
|
53403
|
+
| 'can_configure_auto_lock'
|
|
51453
53404
|
)[]
|
|
51454
53405
|
| undefined
|
|
51455
53406
|
/**
|
|
@@ -51937,6 +53888,8 @@ export type Routes = {
|
|
|
51937
53888
|
incomplete_keyboard_passcode: boolean
|
|
51938
53889
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
51939
53890
|
wifi: boolean
|
|
53891
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
53892
|
+
auto_lock_time_config: boolean
|
|
51940
53893
|
}
|
|
51941
53894
|
/** Indicates whether a TTLock device has a gateway. */
|
|
51942
53895
|
has_gateway?: boolean | undefined
|
|
@@ -52293,6 +54246,10 @@ export type Routes = {
|
|
|
52293
54246
|
| undefined
|
|
52294
54247
|
/** Indicates whether the door is open. */
|
|
52295
54248
|
door_open?: (boolean | undefined) | undefined
|
|
54249
|
+
/** Indicates whether automatic locking is enabled. */
|
|
54250
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
54251
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
54252
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
52296
54253
|
} & {
|
|
52297
54254
|
/** Reported temperature in °F. */
|
|
52298
54255
|
temperature_fahrenheit?: number | undefined
|
|
@@ -53096,6 +55053,7 @@ export type Routes = {
|
|
|
53096
55053
|
can_simulate_hub_connection?: boolean | undefined
|
|
53097
55054
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
53098
55055
|
can_simulate_paid_subscription?: boolean | undefined
|
|
55056
|
+
can_configure_auto_lock?: boolean | undefined
|
|
53099
55057
|
}[]
|
|
53100
55058
|
devices: {
|
|
53101
55059
|
/** ID of the device. */
|
|
@@ -53572,6 +55530,8 @@ export type Routes = {
|
|
|
53572
55530
|
incomplete_keyboard_passcode: boolean
|
|
53573
55531
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
53574
55532
|
wifi: boolean
|
|
55533
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
55534
|
+
auto_lock_time_config: boolean
|
|
53575
55535
|
}
|
|
53576
55536
|
/** Indicates whether a TTLock device has a gateway. */
|
|
53577
55537
|
has_gateway?: boolean | undefined
|
|
@@ -53928,6 +55888,10 @@ export type Routes = {
|
|
|
53928
55888
|
| undefined
|
|
53929
55889
|
/** Indicates whether the door is open. */
|
|
53930
55890
|
door_open?: (boolean | undefined) | undefined
|
|
55891
|
+
/** Indicates whether automatic locking is enabled. */
|
|
55892
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
55893
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
55894
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
53931
55895
|
} & {
|
|
53932
55896
|
/** Reported temperature in °F. */
|
|
53933
55897
|
temperature_fahrenheit?: number | undefined
|
|
@@ -54731,6 +56695,7 @@ export type Routes = {
|
|
|
54731
56695
|
can_simulate_hub_connection?: boolean | undefined
|
|
54732
56696
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
54733
56697
|
can_simulate_paid_subscription?: boolean | undefined
|
|
56698
|
+
can_configure_auto_lock?: boolean | undefined
|
|
54734
56699
|
}[]
|
|
54735
56700
|
}
|
|
54736
56701
|
maxDuration: undefined
|
|
@@ -55934,6 +57899,44 @@ export type Routes = {
|
|
|
55934
57899
|
message: string
|
|
55935
57900
|
}
|
|
55936
57901
|
}
|
|
57902
|
+
| {
|
|
57903
|
+
/** ID of the action attempt. */
|
|
57904
|
+
action_attempt_id: string
|
|
57905
|
+
status: 'pending'
|
|
57906
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
57907
|
+
result: null
|
|
57908
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
57909
|
+
error: null
|
|
57910
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
57911
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
57912
|
+
}
|
|
57913
|
+
| {
|
|
57914
|
+
/** ID of the action attempt. */
|
|
57915
|
+
action_attempt_id: string
|
|
57916
|
+
status: 'success'
|
|
57917
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
57918
|
+
error: null
|
|
57919
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
57920
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
57921
|
+
/** Result of the action. */
|
|
57922
|
+
result: {}
|
|
57923
|
+
}
|
|
57924
|
+
| {
|
|
57925
|
+
/** ID of the action attempt. */
|
|
57926
|
+
action_attempt_id: string
|
|
57927
|
+
status: 'error'
|
|
57928
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
57929
|
+
result: null
|
|
57930
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
57931
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
57932
|
+
/** Error associated with the action. */
|
|
57933
|
+
error: {
|
|
57934
|
+
/** Type of the error. */
|
|
57935
|
+
type: string
|
|
57936
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
57937
|
+
message: string
|
|
57938
|
+
}
|
|
57939
|
+
}
|
|
55937
57940
|
| {
|
|
55938
57941
|
/** ID of the action attempt. */
|
|
55939
57942
|
action_attempt_id: string
|
|
@@ -57414,6 +59417,44 @@ export type Routes = {
|
|
|
57414
59417
|
message: string
|
|
57415
59418
|
}
|
|
57416
59419
|
}
|
|
59420
|
+
| {
|
|
59421
|
+
/** ID of the action attempt. */
|
|
59422
|
+
action_attempt_id: string
|
|
59423
|
+
status: 'pending'
|
|
59424
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
59425
|
+
result: null
|
|
59426
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
59427
|
+
error: null
|
|
59428
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
59429
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
59430
|
+
}
|
|
59431
|
+
| {
|
|
59432
|
+
/** ID of the action attempt. */
|
|
59433
|
+
action_attempt_id: string
|
|
59434
|
+
status: 'success'
|
|
59435
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
59436
|
+
error: null
|
|
59437
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
59438
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
59439
|
+
/** Result of the action. */
|
|
59440
|
+
result: {}
|
|
59441
|
+
}
|
|
59442
|
+
| {
|
|
59443
|
+
/** ID of the action attempt. */
|
|
59444
|
+
action_attempt_id: string
|
|
59445
|
+
status: 'error'
|
|
59446
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
59447
|
+
result: null
|
|
59448
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
59449
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
59450
|
+
/** Error associated with the action. */
|
|
59451
|
+
error: {
|
|
59452
|
+
/** Type of the error. */
|
|
59453
|
+
type: string
|
|
59454
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
59455
|
+
message: string
|
|
59456
|
+
}
|
|
59457
|
+
}
|
|
57417
59458
|
| {
|
|
57418
59459
|
/** ID of the action attempt. */
|
|
57419
59460
|
action_attempt_id: string
|
|
@@ -58892,6 +60933,44 @@ export type Routes = {
|
|
|
58892
60933
|
message: string
|
|
58893
60934
|
}
|
|
58894
60935
|
}
|
|
60936
|
+
| {
|
|
60937
|
+
/** ID of the action attempt. */
|
|
60938
|
+
action_attempt_id: string
|
|
60939
|
+
status: 'pending'
|
|
60940
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
60941
|
+
result: null
|
|
60942
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
60943
|
+
error: null
|
|
60944
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
60945
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
60946
|
+
}
|
|
60947
|
+
| {
|
|
60948
|
+
/** ID of the action attempt. */
|
|
60949
|
+
action_attempt_id: string
|
|
60950
|
+
status: 'success'
|
|
60951
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
60952
|
+
error: null
|
|
60953
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
60954
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
60955
|
+
/** Result of the action. */
|
|
60956
|
+
result: {}
|
|
60957
|
+
}
|
|
60958
|
+
| {
|
|
60959
|
+
/** ID of the action attempt. */
|
|
60960
|
+
action_attempt_id: string
|
|
60961
|
+
status: 'error'
|
|
60962
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
60963
|
+
result: null
|
|
60964
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
60965
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
60966
|
+
/** Error associated with the action. */
|
|
60967
|
+
error: {
|
|
60968
|
+
/** Type of the error. */
|
|
60969
|
+
type: string
|
|
60970
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
60971
|
+
message: string
|
|
60972
|
+
}
|
|
60973
|
+
}
|
|
58895
60974
|
| {
|
|
58896
60975
|
/** ID of the action attempt. */
|
|
58897
60976
|
action_attempt_id: string
|
|
@@ -60372,6 +62451,44 @@ export type Routes = {
|
|
|
60372
62451
|
message: string
|
|
60373
62452
|
}
|
|
60374
62453
|
}
|
|
62454
|
+
| {
|
|
62455
|
+
/** ID of the action attempt. */
|
|
62456
|
+
action_attempt_id: string
|
|
62457
|
+
status: 'pending'
|
|
62458
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
62459
|
+
result: null
|
|
62460
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
62461
|
+
error: null
|
|
62462
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
62463
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
62464
|
+
}
|
|
62465
|
+
| {
|
|
62466
|
+
/** ID of the action attempt. */
|
|
62467
|
+
action_attempt_id: string
|
|
62468
|
+
status: 'success'
|
|
62469
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
62470
|
+
error: null
|
|
62471
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
62472
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
62473
|
+
/** Result of the action. */
|
|
62474
|
+
result: {}
|
|
62475
|
+
}
|
|
62476
|
+
| {
|
|
62477
|
+
/** ID of the action attempt. */
|
|
62478
|
+
action_attempt_id: string
|
|
62479
|
+
status: 'error'
|
|
62480
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
62481
|
+
result: null
|
|
62482
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
62483
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
62484
|
+
/** Error associated with the action. */
|
|
62485
|
+
error: {
|
|
62486
|
+
/** Type of the error. */
|
|
62487
|
+
type: string
|
|
62488
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
62489
|
+
message: string
|
|
62490
|
+
}
|
|
62491
|
+
}
|
|
60375
62492
|
| {
|
|
60376
62493
|
/** ID of the action attempt. */
|
|
60377
62494
|
action_attempt_id: string
|
|
@@ -60711,6 +62828,7 @@ export type Routes = {
|
|
|
60711
62828
|
| 'can_simulate_hub_connection'
|
|
60712
62829
|
| 'can_simulate_hub_disconnection'
|
|
60713
62830
|
| 'can_simulate_paid_subscription'
|
|
62831
|
+
| 'can_configure_auto_lock'
|
|
60714
62832
|
)[]
|
|
60715
62833
|
| undefined
|
|
60716
62834
|
/** */
|
|
@@ -60735,6 +62853,7 @@ export type Routes = {
|
|
|
60735
62853
|
| 'can_simulate_hub_connection'
|
|
60736
62854
|
| 'can_simulate_hub_disconnection'
|
|
60737
62855
|
| 'can_simulate_paid_subscription'
|
|
62856
|
+
| 'can_configure_auto_lock'
|
|
60738
62857
|
)[]
|
|
60739
62858
|
| undefined
|
|
60740
62859
|
/**
|
|
@@ -61222,6 +63341,8 @@ export type Routes = {
|
|
|
61222
63341
|
incomplete_keyboard_passcode: boolean
|
|
61223
63342
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
61224
63343
|
wifi: boolean
|
|
63344
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
63345
|
+
auto_lock_time_config: boolean
|
|
61225
63346
|
}
|
|
61226
63347
|
/** Indicates whether a TTLock device has a gateway. */
|
|
61227
63348
|
has_gateway?: boolean | undefined
|
|
@@ -61578,6 +63699,10 @@ export type Routes = {
|
|
|
61578
63699
|
| undefined
|
|
61579
63700
|
/** Indicates whether the door is open. */
|
|
61580
63701
|
door_open?: (boolean | undefined) | undefined
|
|
63702
|
+
/** Indicates whether automatic locking is enabled. */
|
|
63703
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
63704
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
63705
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
61581
63706
|
} & {
|
|
61582
63707
|
/** Reported temperature in °F. */
|
|
61583
63708
|
temperature_fahrenheit?: number | undefined
|
|
@@ -62381,6 +64506,7 @@ export type Routes = {
|
|
|
62381
64506
|
can_simulate_hub_connection?: boolean | undefined
|
|
62382
64507
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
62383
64508
|
can_simulate_paid_subscription?: boolean | undefined
|
|
64509
|
+
can_configure_auto_lock?: boolean | undefined
|
|
62384
64510
|
}[]
|
|
62385
64511
|
devices: {
|
|
62386
64512
|
/** ID of the device. */
|
|
@@ -62857,6 +64983,8 @@ export type Routes = {
|
|
|
62857
64983
|
incomplete_keyboard_passcode: boolean
|
|
62858
64984
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
62859
64985
|
wifi: boolean
|
|
64986
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
64987
|
+
auto_lock_time_config: boolean
|
|
62860
64988
|
}
|
|
62861
64989
|
/** Indicates whether a TTLock device has a gateway. */
|
|
62862
64990
|
has_gateway?: boolean | undefined
|
|
@@ -63213,6 +65341,10 @@ export type Routes = {
|
|
|
63213
65341
|
| undefined
|
|
63214
65342
|
/** Indicates whether the door is open. */
|
|
63215
65343
|
door_open?: (boolean | undefined) | undefined
|
|
65344
|
+
/** Indicates whether automatic locking is enabled. */
|
|
65345
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
65346
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
65347
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
63216
65348
|
} & {
|
|
63217
65349
|
/** Reported temperature in °F. */
|
|
63218
65350
|
temperature_fahrenheit?: number | undefined
|
|
@@ -64016,6 +66148,7 @@ export type Routes = {
|
|
|
64016
66148
|
can_simulate_hub_connection?: boolean | undefined
|
|
64017
66149
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
64018
66150
|
can_simulate_paid_subscription?: boolean | undefined
|
|
66151
|
+
can_configure_auto_lock?: boolean | undefined
|
|
64019
66152
|
}[]
|
|
64020
66153
|
}
|
|
64021
66154
|
maxDuration: undefined
|
|
@@ -65229,6 +67362,44 @@ export type Routes = {
|
|
|
65229
67362
|
message: string
|
|
65230
67363
|
}
|
|
65231
67364
|
}
|
|
67365
|
+
| {
|
|
67366
|
+
/** ID of the action attempt. */
|
|
67367
|
+
action_attempt_id: string
|
|
67368
|
+
status: 'pending'
|
|
67369
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
67370
|
+
result: null
|
|
67371
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
67372
|
+
error: null
|
|
67373
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
67374
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
67375
|
+
}
|
|
67376
|
+
| {
|
|
67377
|
+
/** ID of the action attempt. */
|
|
67378
|
+
action_attempt_id: string
|
|
67379
|
+
status: 'success'
|
|
67380
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
67381
|
+
error: null
|
|
67382
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
67383
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
67384
|
+
/** Result of the action. */
|
|
67385
|
+
result: {}
|
|
67386
|
+
}
|
|
67387
|
+
| {
|
|
67388
|
+
/** ID of the action attempt. */
|
|
67389
|
+
action_attempt_id: string
|
|
67390
|
+
status: 'error'
|
|
67391
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
67392
|
+
result: null
|
|
67393
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
67394
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
67395
|
+
/** Error associated with the action. */
|
|
67396
|
+
error: {
|
|
67397
|
+
/** Type of the error. */
|
|
67398
|
+
type: string
|
|
67399
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
67400
|
+
message: string
|
|
67401
|
+
}
|
|
67402
|
+
}
|
|
65232
67403
|
| {
|
|
65233
67404
|
/** ID of the action attempt. */
|
|
65234
67405
|
action_attempt_id: string
|
|
@@ -66728,6 +68899,44 @@ export type Routes = {
|
|
|
66728
68899
|
message: string
|
|
66729
68900
|
}
|
|
66730
68901
|
}
|
|
68902
|
+
| {
|
|
68903
|
+
/** ID of the action attempt. */
|
|
68904
|
+
action_attempt_id: string
|
|
68905
|
+
status: 'pending'
|
|
68906
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
68907
|
+
result: null
|
|
68908
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
68909
|
+
error: null
|
|
68910
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
68911
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
68912
|
+
}
|
|
68913
|
+
| {
|
|
68914
|
+
/** ID of the action attempt. */
|
|
68915
|
+
action_attempt_id: string
|
|
68916
|
+
status: 'success'
|
|
68917
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
68918
|
+
error: null
|
|
68919
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
68920
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
68921
|
+
/** Result of the action. */
|
|
68922
|
+
result: {}
|
|
68923
|
+
}
|
|
68924
|
+
| {
|
|
68925
|
+
/** ID of the action attempt. */
|
|
68926
|
+
action_attempt_id: string
|
|
68927
|
+
status: 'error'
|
|
68928
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
68929
|
+
result: null
|
|
68930
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
68931
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
68932
|
+
/** Error associated with the action. */
|
|
68933
|
+
error: {
|
|
68934
|
+
/** Type of the error. */
|
|
68935
|
+
type: string
|
|
68936
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
68937
|
+
message: string
|
|
68938
|
+
}
|
|
68939
|
+
}
|
|
66731
68940
|
| {
|
|
66732
68941
|
/** ID of the action attempt. */
|
|
66733
68942
|
action_attempt_id: string
|
|
@@ -68283,6 +70492,44 @@ export type Routes = {
|
|
|
68283
70492
|
message: string
|
|
68284
70493
|
}
|
|
68285
70494
|
}
|
|
70495
|
+
| {
|
|
70496
|
+
/** ID of the action attempt. */
|
|
70497
|
+
action_attempt_id: string
|
|
70498
|
+
status: 'pending'
|
|
70499
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
70500
|
+
result: null
|
|
70501
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
70502
|
+
error: null
|
|
70503
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
70504
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
70505
|
+
}
|
|
70506
|
+
| {
|
|
70507
|
+
/** ID of the action attempt. */
|
|
70508
|
+
action_attempt_id: string
|
|
70509
|
+
status: 'success'
|
|
70510
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
70511
|
+
error: null
|
|
70512
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
70513
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
70514
|
+
/** Result of the action. */
|
|
70515
|
+
result: {}
|
|
70516
|
+
}
|
|
70517
|
+
| {
|
|
70518
|
+
/** ID of the action attempt. */
|
|
70519
|
+
action_attempt_id: string
|
|
70520
|
+
status: 'error'
|
|
70521
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
70522
|
+
result: null
|
|
70523
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
70524
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
70525
|
+
/** Error associated with the action. */
|
|
70526
|
+
error: {
|
|
70527
|
+
/** Type of the error. */
|
|
70528
|
+
type: string
|
|
70529
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
70530
|
+
message: string
|
|
70531
|
+
}
|
|
70532
|
+
}
|
|
68286
70533
|
| {
|
|
68287
70534
|
/** ID of the action attempt. */
|
|
68288
70535
|
action_attempt_id: string
|
|
@@ -70798,6 +73045,44 @@ export type Routes = {
|
|
|
70798
73045
|
message: string
|
|
70799
73046
|
}
|
|
70800
73047
|
}
|
|
73048
|
+
| {
|
|
73049
|
+
/** ID of the action attempt. */
|
|
73050
|
+
action_attempt_id: string
|
|
73051
|
+
status: 'pending'
|
|
73052
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
73053
|
+
result: null
|
|
73054
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
73055
|
+
error: null
|
|
73056
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
73057
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
73058
|
+
}
|
|
73059
|
+
| {
|
|
73060
|
+
/** ID of the action attempt. */
|
|
73061
|
+
action_attempt_id: string
|
|
73062
|
+
status: 'success'
|
|
73063
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
73064
|
+
error: null
|
|
73065
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
73066
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
73067
|
+
/** Result of the action. */
|
|
73068
|
+
result: {}
|
|
73069
|
+
}
|
|
73070
|
+
| {
|
|
73071
|
+
/** ID of the action attempt. */
|
|
73072
|
+
action_attempt_id: string
|
|
73073
|
+
status: 'error'
|
|
73074
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
73075
|
+
result: null
|
|
73076
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
73077
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
73078
|
+
/** Error associated with the action. */
|
|
73079
|
+
error: {
|
|
73080
|
+
/** Type of the error. */
|
|
73081
|
+
type: string
|
|
73082
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
73083
|
+
message: string
|
|
73084
|
+
}
|
|
73085
|
+
}
|
|
70801
73086
|
| {
|
|
70802
73087
|
/** ID of the action attempt. */
|
|
70803
73088
|
action_attempt_id: string
|
|
@@ -77722,6 +80007,8 @@ export type Routes = {
|
|
|
77722
80007
|
incomplete_keyboard_passcode: boolean
|
|
77723
80008
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
77724
80009
|
wifi: boolean
|
|
80010
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
80011
|
+
auto_lock_time_config: boolean
|
|
77725
80012
|
}
|
|
77726
80013
|
/** Indicates whether a TTLock device has a gateway. */
|
|
77727
80014
|
has_gateway?: boolean | undefined
|
|
@@ -78082,6 +80369,10 @@ export type Routes = {
|
|
|
78082
80369
|
| undefined
|
|
78083
80370
|
/** Indicates whether the door is open. */
|
|
78084
80371
|
door_open?: (boolean | undefined) | undefined
|
|
80372
|
+
/** Indicates whether automatic locking is enabled. */
|
|
80373
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
80374
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
80375
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
78085
80376
|
} & {
|
|
78086
80377
|
/** Reported temperature in °F. */
|
|
78087
80378
|
temperature_fahrenheit?: number | undefined
|
|
@@ -78905,6 +81196,7 @@ export type Routes = {
|
|
|
78905
81196
|
can_simulate_hub_connection?: boolean | undefined
|
|
78906
81197
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
78907
81198
|
can_simulate_paid_subscription?: boolean | undefined
|
|
81199
|
+
can_configure_auto_lock?: boolean | undefined
|
|
78908
81200
|
}[]
|
|
78909
81201
|
| undefined
|
|
78910
81202
|
acs_entrances?:
|
|
@@ -80843,6 +83135,44 @@ export type Routes = {
|
|
|
80843
83135
|
message: string
|
|
80844
83136
|
}
|
|
80845
83137
|
}
|
|
83138
|
+
| {
|
|
83139
|
+
/** ID of the action attempt. */
|
|
83140
|
+
action_attempt_id: string
|
|
83141
|
+
status: 'pending'
|
|
83142
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
83143
|
+
result: null
|
|
83144
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
83145
|
+
error: null
|
|
83146
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
83147
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
83148
|
+
}
|
|
83149
|
+
| {
|
|
83150
|
+
/** ID of the action attempt. */
|
|
83151
|
+
action_attempt_id: string
|
|
83152
|
+
status: 'success'
|
|
83153
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
83154
|
+
error: null
|
|
83155
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
83156
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
83157
|
+
/** Result of the action. */
|
|
83158
|
+
result: {}
|
|
83159
|
+
}
|
|
83160
|
+
| {
|
|
83161
|
+
/** ID of the action attempt. */
|
|
83162
|
+
action_attempt_id: string
|
|
83163
|
+
status: 'error'
|
|
83164
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
83165
|
+
result: null
|
|
83166
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
83167
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
83168
|
+
/** Error associated with the action. */
|
|
83169
|
+
error: {
|
|
83170
|
+
/** Type of the error. */
|
|
83171
|
+
type: string
|
|
83172
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
83173
|
+
message: string
|
|
83174
|
+
}
|
|
83175
|
+
}
|
|
80846
83176
|
| {
|
|
80847
83177
|
/** ID of the action attempt. */
|
|
80848
83178
|
action_attempt_id: string
|
|
@@ -82327,6 +84657,44 @@ export type Routes = {
|
|
|
82327
84657
|
message: string
|
|
82328
84658
|
}
|
|
82329
84659
|
}
|
|
84660
|
+
| {
|
|
84661
|
+
/** ID of the action attempt. */
|
|
84662
|
+
action_attempt_id: string
|
|
84663
|
+
status: 'pending'
|
|
84664
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
84665
|
+
result: null
|
|
84666
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
84667
|
+
error: null
|
|
84668
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
84669
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
84670
|
+
}
|
|
84671
|
+
| {
|
|
84672
|
+
/** ID of the action attempt. */
|
|
84673
|
+
action_attempt_id: string
|
|
84674
|
+
status: 'success'
|
|
84675
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
84676
|
+
error: null
|
|
84677
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
84678
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
84679
|
+
/** Result of the action. */
|
|
84680
|
+
result: {}
|
|
84681
|
+
}
|
|
84682
|
+
| {
|
|
84683
|
+
/** ID of the action attempt. */
|
|
84684
|
+
action_attempt_id: string
|
|
84685
|
+
status: 'error'
|
|
84686
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
84687
|
+
result: null
|
|
84688
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
84689
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
84690
|
+
/** Error associated with the action. */
|
|
84691
|
+
error: {
|
|
84692
|
+
/** Type of the error. */
|
|
84693
|
+
type: string
|
|
84694
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
84695
|
+
message: string
|
|
84696
|
+
}
|
|
84697
|
+
}
|
|
82330
84698
|
| {
|
|
82331
84699
|
/** ID of the action attempt. */
|
|
82332
84700
|
action_attempt_id: string
|
|
@@ -83923,6 +86291,44 @@ export type Routes = {
|
|
|
83923
86291
|
message: string
|
|
83924
86292
|
}
|
|
83925
86293
|
}
|
|
86294
|
+
| {
|
|
86295
|
+
/** ID of the action attempt. */
|
|
86296
|
+
action_attempt_id: string
|
|
86297
|
+
status: 'pending'
|
|
86298
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
86299
|
+
result: null
|
|
86300
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
86301
|
+
error: null
|
|
86302
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
86303
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
86304
|
+
}
|
|
86305
|
+
| {
|
|
86306
|
+
/** ID of the action attempt. */
|
|
86307
|
+
action_attempt_id: string
|
|
86308
|
+
status: 'success'
|
|
86309
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
86310
|
+
error: null
|
|
86311
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
86312
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
86313
|
+
/** Result of the action. */
|
|
86314
|
+
result: {}
|
|
86315
|
+
}
|
|
86316
|
+
| {
|
|
86317
|
+
/** ID of the action attempt. */
|
|
86318
|
+
action_attempt_id: string
|
|
86319
|
+
status: 'error'
|
|
86320
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
86321
|
+
result: null
|
|
86322
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
86323
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
86324
|
+
/** Error associated with the action. */
|
|
86325
|
+
error: {
|
|
86326
|
+
/** Type of the error. */
|
|
86327
|
+
type: string
|
|
86328
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
86329
|
+
message: string
|
|
86330
|
+
}
|
|
86331
|
+
}
|
|
83926
86332
|
| {
|
|
83927
86333
|
/** ID of the action attempt. */
|
|
83928
86334
|
action_attempt_id: string
|
|
@@ -84708,6 +87114,8 @@ export type Routes = {
|
|
|
84708
87114
|
incomplete_keyboard_passcode: boolean
|
|
84709
87115
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
84710
87116
|
wifi: boolean
|
|
87117
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
87118
|
+
auto_lock_time_config: boolean
|
|
84711
87119
|
}
|
|
84712
87120
|
/** Indicates whether a TTLock device has a gateway. */
|
|
84713
87121
|
has_gateway?: boolean | undefined
|
|
@@ -85064,6 +87472,10 @@ export type Routes = {
|
|
|
85064
87472
|
| undefined
|
|
85065
87473
|
/** Indicates whether the door is open. */
|
|
85066
87474
|
door_open?: (boolean | undefined) | undefined
|
|
87475
|
+
/** Indicates whether automatic locking is enabled. */
|
|
87476
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
87477
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
87478
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
85067
87479
|
} & {
|
|
85068
87480
|
/** Reported temperature in °F. */
|
|
85069
87481
|
temperature_fahrenheit?: number | undefined
|
|
@@ -85867,6 +88279,7 @@ export type Routes = {
|
|
|
85867
88279
|
can_simulate_hub_connection?: boolean | undefined
|
|
85868
88280
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
85869
88281
|
can_simulate_paid_subscription?: boolean | undefined
|
|
88282
|
+
can_configure_auto_lock?: boolean | undefined
|
|
85870
88283
|
}
|
|
85871
88284
|
}
|
|
85872
88285
|
maxDuration: undefined
|
|
@@ -87074,6 +89487,44 @@ export type Routes = {
|
|
|
87074
89487
|
message: string
|
|
87075
89488
|
}
|
|
87076
89489
|
}
|
|
89490
|
+
| {
|
|
89491
|
+
/** ID of the action attempt. */
|
|
89492
|
+
action_attempt_id: string
|
|
89493
|
+
status: 'pending'
|
|
89494
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
89495
|
+
result: null
|
|
89496
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
89497
|
+
error: null
|
|
89498
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
89499
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
89500
|
+
}
|
|
89501
|
+
| {
|
|
89502
|
+
/** ID of the action attempt. */
|
|
89503
|
+
action_attempt_id: string
|
|
89504
|
+
status: 'success'
|
|
89505
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
89506
|
+
error: null
|
|
89507
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
89508
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
89509
|
+
/** Result of the action. */
|
|
89510
|
+
result: {}
|
|
89511
|
+
}
|
|
89512
|
+
| {
|
|
89513
|
+
/** ID of the action attempt. */
|
|
89514
|
+
action_attempt_id: string
|
|
89515
|
+
status: 'error'
|
|
89516
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
89517
|
+
result: null
|
|
89518
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
89519
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
89520
|
+
/** Error associated with the action. */
|
|
89521
|
+
error: {
|
|
89522
|
+
/** Type of the error. */
|
|
89523
|
+
type: string
|
|
89524
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
89525
|
+
message: string
|
|
89526
|
+
}
|
|
89527
|
+
}
|
|
87077
89528
|
| {
|
|
87078
89529
|
/** ID of the action attempt. */
|
|
87079
89530
|
action_attempt_id: string
|
|
@@ -88562,6 +91013,44 @@ export type Routes = {
|
|
|
88562
91013
|
message: string
|
|
88563
91014
|
}
|
|
88564
91015
|
}
|
|
91016
|
+
| {
|
|
91017
|
+
/** ID of the action attempt. */
|
|
91018
|
+
action_attempt_id: string
|
|
91019
|
+
status: 'pending'
|
|
91020
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
91021
|
+
result: null
|
|
91022
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
91023
|
+
error: null
|
|
91024
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
91025
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
91026
|
+
}
|
|
91027
|
+
| {
|
|
91028
|
+
/** ID of the action attempt. */
|
|
91029
|
+
action_attempt_id: string
|
|
91030
|
+
status: 'success'
|
|
91031
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
91032
|
+
error: null
|
|
91033
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
91034
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
91035
|
+
/** Result of the action. */
|
|
91036
|
+
result: {}
|
|
91037
|
+
}
|
|
91038
|
+
| {
|
|
91039
|
+
/** ID of the action attempt. */
|
|
91040
|
+
action_attempt_id: string
|
|
91041
|
+
status: 'error'
|
|
91042
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
91043
|
+
result: null
|
|
91044
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
91045
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
91046
|
+
/** Error associated with the action. */
|
|
91047
|
+
error: {
|
|
91048
|
+
/** Type of the error. */
|
|
91049
|
+
type: string
|
|
91050
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
91051
|
+
message: string
|
|
91052
|
+
}
|
|
91053
|
+
}
|
|
88565
91054
|
| {
|
|
88566
91055
|
/** ID of the action attempt. */
|
|
88567
91056
|
action_attempt_id: string
|
|
@@ -88928,6 +91417,7 @@ export type Routes = {
|
|
|
88928
91417
|
| 'can_simulate_hub_connection'
|
|
88929
91418
|
| 'can_simulate_hub_disconnection'
|
|
88930
91419
|
| 'can_simulate_paid_subscription'
|
|
91420
|
+
| 'can_configure_auto_lock'
|
|
88931
91421
|
)[]
|
|
88932
91422
|
| undefined
|
|
88933
91423
|
/** */
|
|
@@ -88952,6 +91442,7 @@ export type Routes = {
|
|
|
88952
91442
|
| 'can_simulate_hub_connection'
|
|
88953
91443
|
| 'can_simulate_hub_disconnection'
|
|
88954
91444
|
| 'can_simulate_paid_subscription'
|
|
91445
|
+
| 'can_configure_auto_lock'
|
|
88955
91446
|
)[]
|
|
88956
91447
|
| undefined
|
|
88957
91448
|
/**
|
|
@@ -89439,6 +91930,8 @@ export type Routes = {
|
|
|
89439
91930
|
incomplete_keyboard_passcode: boolean
|
|
89440
91931
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
89441
91932
|
wifi: boolean
|
|
91933
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
91934
|
+
auto_lock_time_config: boolean
|
|
89442
91935
|
}
|
|
89443
91936
|
/** Indicates whether a TTLock device has a gateway. */
|
|
89444
91937
|
has_gateway?: boolean | undefined
|
|
@@ -89795,6 +92288,10 @@ export type Routes = {
|
|
|
89795
92288
|
| undefined
|
|
89796
92289
|
/** Indicates whether the door is open. */
|
|
89797
92290
|
door_open?: (boolean | undefined) | undefined
|
|
92291
|
+
/** Indicates whether automatic locking is enabled. */
|
|
92292
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
92293
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
92294
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
89798
92295
|
} & {
|
|
89799
92296
|
/** Reported temperature in °F. */
|
|
89800
92297
|
temperature_fahrenheit?: number | undefined
|
|
@@ -90598,6 +93095,7 @@ export type Routes = {
|
|
|
90598
93095
|
can_simulate_hub_connection?: boolean | undefined
|
|
90599
93096
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
90600
93097
|
can_simulate_paid_subscription?: boolean | undefined
|
|
93098
|
+
can_configure_auto_lock?: boolean | undefined
|
|
90601
93099
|
}[]
|
|
90602
93100
|
devices: {
|
|
90603
93101
|
/** ID of the device. */
|
|
@@ -91074,6 +93572,8 @@ export type Routes = {
|
|
|
91074
93572
|
incomplete_keyboard_passcode: boolean
|
|
91075
93573
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
91076
93574
|
wifi: boolean
|
|
93575
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
93576
|
+
auto_lock_time_config: boolean
|
|
91077
93577
|
}
|
|
91078
93578
|
/** Indicates whether a TTLock device has a gateway. */
|
|
91079
93579
|
has_gateway?: boolean | undefined
|
|
@@ -91430,6 +93930,10 @@ export type Routes = {
|
|
|
91430
93930
|
| undefined
|
|
91431
93931
|
/** Indicates whether the door is open. */
|
|
91432
93932
|
door_open?: (boolean | undefined) | undefined
|
|
93933
|
+
/** Indicates whether automatic locking is enabled. */
|
|
93934
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
93935
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
93936
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
91433
93937
|
} & {
|
|
91434
93938
|
/** Reported temperature in °F. */
|
|
91435
93939
|
temperature_fahrenheit?: number | undefined
|
|
@@ -92233,6 +94737,7 @@ export type Routes = {
|
|
|
92233
94737
|
can_simulate_hub_connection?: boolean | undefined
|
|
92234
94738
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
92235
94739
|
can_simulate_paid_subscription?: boolean | undefined
|
|
94740
|
+
can_configure_auto_lock?: boolean | undefined
|
|
92236
94741
|
}[]
|
|
92237
94742
|
}
|
|
92238
94743
|
maxDuration: undefined
|
|
@@ -93436,6 +95941,44 @@ export type Routes = {
|
|
|
93436
95941
|
message: string
|
|
93437
95942
|
}
|
|
93438
95943
|
}
|
|
95944
|
+
| {
|
|
95945
|
+
/** ID of the action attempt. */
|
|
95946
|
+
action_attempt_id: string
|
|
95947
|
+
status: 'pending'
|
|
95948
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
95949
|
+
result: null
|
|
95950
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
95951
|
+
error: null
|
|
95952
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
95953
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
95954
|
+
}
|
|
95955
|
+
| {
|
|
95956
|
+
/** ID of the action attempt. */
|
|
95957
|
+
action_attempt_id: string
|
|
95958
|
+
status: 'success'
|
|
95959
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
95960
|
+
error: null
|
|
95961
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
95962
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
95963
|
+
/** Result of the action. */
|
|
95964
|
+
result: {}
|
|
95965
|
+
}
|
|
95966
|
+
| {
|
|
95967
|
+
/** ID of the action attempt. */
|
|
95968
|
+
action_attempt_id: string
|
|
95969
|
+
status: 'error'
|
|
95970
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
95971
|
+
result: null
|
|
95972
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
95973
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
95974
|
+
/** Error associated with the action. */
|
|
95975
|
+
error: {
|
|
95976
|
+
/** Type of the error. */
|
|
95977
|
+
type: string
|
|
95978
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
95979
|
+
message: string
|
|
95980
|
+
}
|
|
95981
|
+
}
|
|
93439
95982
|
| {
|
|
93440
95983
|
/** ID of the action attempt. */
|
|
93441
95984
|
action_attempt_id: string
|
|
@@ -95119,6 +97662,44 @@ export type Routes = {
|
|
|
95119
97662
|
message: string
|
|
95120
97663
|
}
|
|
95121
97664
|
}
|
|
97665
|
+
| {
|
|
97666
|
+
/** ID of the action attempt. */
|
|
97667
|
+
action_attempt_id: string
|
|
97668
|
+
status: 'pending'
|
|
97669
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
97670
|
+
result: null
|
|
97671
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
97672
|
+
error: null
|
|
97673
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
97674
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
97675
|
+
}
|
|
97676
|
+
| {
|
|
97677
|
+
/** ID of the action attempt. */
|
|
97678
|
+
action_attempt_id: string
|
|
97679
|
+
status: 'success'
|
|
97680
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
97681
|
+
error: null
|
|
97682
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
97683
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
97684
|
+
/** Result of the action. */
|
|
97685
|
+
result: {}
|
|
97686
|
+
}
|
|
97687
|
+
| {
|
|
97688
|
+
/** ID of the action attempt. */
|
|
97689
|
+
action_attempt_id: string
|
|
97690
|
+
status: 'error'
|
|
97691
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
97692
|
+
result: null
|
|
97693
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
97694
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
97695
|
+
/** Error associated with the action. */
|
|
97696
|
+
error: {
|
|
97697
|
+
/** Type of the error. */
|
|
97698
|
+
type: string
|
|
97699
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
97700
|
+
message: string
|
|
97701
|
+
}
|
|
97702
|
+
}
|
|
95122
97703
|
| {
|
|
95123
97704
|
/** ID of the action attempt. */
|
|
95124
97705
|
action_attempt_id: string
|
|
@@ -96635,6 +99216,44 @@ export type Routes = {
|
|
|
96635
99216
|
message: string
|
|
96636
99217
|
}
|
|
96637
99218
|
}
|
|
99219
|
+
| {
|
|
99220
|
+
/** ID of the action attempt. */
|
|
99221
|
+
action_attempt_id: string
|
|
99222
|
+
status: 'pending'
|
|
99223
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
99224
|
+
result: null
|
|
99225
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
99226
|
+
error: null
|
|
99227
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
99228
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
99229
|
+
}
|
|
99230
|
+
| {
|
|
99231
|
+
/** ID of the action attempt. */
|
|
99232
|
+
action_attempt_id: string
|
|
99233
|
+
status: 'success'
|
|
99234
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
99235
|
+
error: null
|
|
99236
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
99237
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
99238
|
+
/** Result of the action. */
|
|
99239
|
+
result: {}
|
|
99240
|
+
}
|
|
99241
|
+
| {
|
|
99242
|
+
/** ID of the action attempt. */
|
|
99243
|
+
action_attempt_id: string
|
|
99244
|
+
status: 'error'
|
|
99245
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
99246
|
+
result: null
|
|
99247
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
99248
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
99249
|
+
/** Error associated with the action. */
|
|
99250
|
+
error: {
|
|
99251
|
+
/** Type of the error. */
|
|
99252
|
+
type: string
|
|
99253
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
99254
|
+
message: string
|
|
99255
|
+
}
|
|
99256
|
+
}
|
|
96638
99257
|
| {
|
|
96639
99258
|
/** ID of the action attempt. */
|
|
96640
99259
|
action_attempt_id: string
|
|
@@ -98268,6 +100887,44 @@ export type Routes = {
|
|
|
98268
100887
|
message: string
|
|
98269
100888
|
}
|
|
98270
100889
|
}
|
|
100890
|
+
| {
|
|
100891
|
+
/** ID of the action attempt. */
|
|
100892
|
+
action_attempt_id: string
|
|
100893
|
+
status: 'pending'
|
|
100894
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
100895
|
+
result: null
|
|
100896
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
100897
|
+
error: null
|
|
100898
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
100899
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
100900
|
+
}
|
|
100901
|
+
| {
|
|
100902
|
+
/** ID of the action attempt. */
|
|
100903
|
+
action_attempt_id: string
|
|
100904
|
+
status: 'success'
|
|
100905
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
100906
|
+
error: null
|
|
100907
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
100908
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
100909
|
+
/** Result of the action. */
|
|
100910
|
+
result: {}
|
|
100911
|
+
}
|
|
100912
|
+
| {
|
|
100913
|
+
/** ID of the action attempt. */
|
|
100914
|
+
action_attempt_id: string
|
|
100915
|
+
status: 'error'
|
|
100916
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
100917
|
+
result: null
|
|
100918
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
100919
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
100920
|
+
/** Error associated with the action. */
|
|
100921
|
+
error: {
|
|
100922
|
+
/** Type of the error. */
|
|
100923
|
+
type: string
|
|
100924
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
100925
|
+
message: string
|
|
100926
|
+
}
|
|
100927
|
+
}
|
|
98271
100928
|
| {
|
|
98272
100929
|
/** ID of the action attempt. */
|
|
98273
100930
|
action_attempt_id: string
|
|
@@ -99603,6 +102260,8 @@ export type Routes = {
|
|
|
99603
102260
|
incomplete_keyboard_passcode: boolean
|
|
99604
102261
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
99605
102262
|
wifi: boolean
|
|
102263
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
102264
|
+
auto_lock_time_config: boolean
|
|
99606
102265
|
}
|
|
99607
102266
|
/** Indicates whether a TTLock device has a gateway. */
|
|
99608
102267
|
has_gateway?: boolean | undefined
|
|
@@ -99959,6 +102618,10 @@ export type Routes = {
|
|
|
99959
102618
|
| undefined
|
|
99960
102619
|
/** Indicates whether the door is open. */
|
|
99961
102620
|
door_open?: (boolean | undefined) | undefined
|
|
102621
|
+
/** Indicates whether automatic locking is enabled. */
|
|
102622
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
102623
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
102624
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
99962
102625
|
} & {
|
|
99963
102626
|
/** Reported temperature in °F. */
|
|
99964
102627
|
temperature_fahrenheit?: number | undefined
|
|
@@ -100762,6 +103425,7 @@ export type Routes = {
|
|
|
100762
103425
|
can_simulate_hub_connection?: boolean | undefined
|
|
100763
103426
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
100764
103427
|
can_simulate_paid_subscription?: boolean | undefined
|
|
103428
|
+
can_configure_auto_lock?: boolean | undefined
|
|
100765
103429
|
}[]
|
|
100766
103430
|
/**
|
|
100767
103431
|
* @deprecated Use devices.*/
|
|
@@ -101240,6 +103904,8 @@ export type Routes = {
|
|
|
101240
103904
|
incomplete_keyboard_passcode: boolean
|
|
101241
103905
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
101242
103906
|
wifi: boolean
|
|
103907
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
103908
|
+
auto_lock_time_config: boolean
|
|
101243
103909
|
}
|
|
101244
103910
|
/** Indicates whether a TTLock device has a gateway. */
|
|
101245
103911
|
has_gateway?: boolean | undefined
|
|
@@ -101596,6 +104262,10 @@ export type Routes = {
|
|
|
101596
104262
|
| undefined
|
|
101597
104263
|
/** Indicates whether the door is open. */
|
|
101598
104264
|
door_open?: (boolean | undefined) | undefined
|
|
104265
|
+
/** Indicates whether automatic locking is enabled. */
|
|
104266
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
104267
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
104268
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
101599
104269
|
} & {
|
|
101600
104270
|
/** Reported temperature in °F. */
|
|
101601
104271
|
temperature_fahrenheit?: number | undefined
|
|
@@ -102399,6 +105069,7 @@ export type Routes = {
|
|
|
102399
105069
|
can_simulate_hub_connection?: boolean | undefined
|
|
102400
105070
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
102401
105071
|
can_simulate_paid_subscription?: boolean | undefined
|
|
105072
|
+
can_configure_auto_lock?: boolean | undefined
|
|
102402
105073
|
}[]
|
|
102403
105074
|
}
|
|
102404
105075
|
maxDuration: undefined
|
|
@@ -103970,6 +106641,8 @@ export type Routes = {
|
|
|
103970
106641
|
incomplete_keyboard_passcode: boolean
|
|
103971
106642
|
/** Indicates whether a TTLock device supports Wi-Fi. */
|
|
103972
106643
|
wifi: boolean
|
|
106644
|
+
/** Indicates whether a TTLock device supports auto-lock time configuration. */
|
|
106645
|
+
auto_lock_time_config: boolean
|
|
103973
106646
|
}
|
|
103974
106647
|
/** Indicates whether a TTLock device has a gateway. */
|
|
103975
106648
|
has_gateway?: boolean | undefined
|
|
@@ -104330,6 +107003,10 @@ export type Routes = {
|
|
|
104330
107003
|
| undefined
|
|
104331
107004
|
/** Indicates whether the door is open. */
|
|
104332
107005
|
door_open?: (boolean | undefined) | undefined
|
|
107006
|
+
/** Indicates whether automatic locking is enabled. */
|
|
107007
|
+
auto_lock_enabled?: (boolean | undefined) | undefined
|
|
107008
|
+
/** The delay in seconds before the lock automatically locks after being unlocked. */
|
|
107009
|
+
auto_lock_delay_seconds?: (number | undefined) | undefined
|
|
104333
107010
|
} & {
|
|
104334
107011
|
/** Reported temperature in °F. */
|
|
104335
107012
|
temperature_fahrenheit?: number | undefined
|
|
@@ -105153,6 +107830,7 @@ export type Routes = {
|
|
|
105153
107830
|
can_simulate_hub_connection?: boolean | undefined
|
|
105154
107831
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
105155
107832
|
can_simulate_paid_subscription?: boolean | undefined
|
|
107833
|
+
can_configure_auto_lock?: boolean | undefined
|
|
105156
107834
|
}[]
|
|
105157
107835
|
| undefined
|
|
105158
107836
|
acs_entrances?:
|
|
@@ -107189,6 +109867,44 @@ export type Routes = {
|
|
|
107189
109867
|
message: string
|
|
107190
109868
|
}
|
|
107191
109869
|
}
|
|
109870
|
+
| {
|
|
109871
|
+
/** ID of the action attempt. */
|
|
109872
|
+
action_attempt_id: string
|
|
109873
|
+
status: 'pending'
|
|
109874
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
109875
|
+
result: null
|
|
109876
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
109877
|
+
error: null
|
|
109878
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
109879
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
109880
|
+
}
|
|
109881
|
+
| {
|
|
109882
|
+
/** ID of the action attempt. */
|
|
109883
|
+
action_attempt_id: string
|
|
109884
|
+
status: 'success'
|
|
109885
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
109886
|
+
error: null
|
|
109887
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
109888
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
109889
|
+
/** Result of the action. */
|
|
109890
|
+
result: {}
|
|
109891
|
+
}
|
|
109892
|
+
| {
|
|
109893
|
+
/** ID of the action attempt. */
|
|
109894
|
+
action_attempt_id: string
|
|
109895
|
+
status: 'error'
|
|
109896
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
109897
|
+
result: null
|
|
109898
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
109899
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
109900
|
+
/** Error associated with the action. */
|
|
109901
|
+
error: {
|
|
109902
|
+
/** Type of the error. */
|
|
109903
|
+
type: string
|
|
109904
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
109905
|
+
message: string
|
|
109906
|
+
}
|
|
109907
|
+
}
|
|
107192
109908
|
| {
|
|
107193
109909
|
/** ID of the action attempt. */
|
|
107194
109910
|
action_attempt_id: string
|
|
@@ -108490,6 +111206,7 @@ export type Routes = {
|
|
|
108490
111206
|
can_simulate_hub_connection?: boolean | undefined
|
|
108491
111207
|
can_simulate_hub_disconnection?: boolean | undefined
|
|
108492
111208
|
can_simulate_paid_subscription?: boolean | undefined
|
|
111209
|
+
can_configure_auto_lock?: boolean | undefined
|
|
108493
111210
|
}[]
|
|
108494
111211
|
| undefined
|
|
108495
111212
|
connect_webviews?:
|
|
@@ -114987,6 +117704,44 @@ export type Routes = {
|
|
|
114987
117704
|
message: string
|
|
114988
117705
|
}
|
|
114989
117706
|
}
|
|
117707
|
+
| {
|
|
117708
|
+
/** ID of the action attempt. */
|
|
117709
|
+
action_attempt_id: string
|
|
117710
|
+
status: 'pending'
|
|
117711
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117712
|
+
result: null
|
|
117713
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
117714
|
+
error: null
|
|
117715
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
117716
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
117717
|
+
}
|
|
117718
|
+
| {
|
|
117719
|
+
/** ID of the action attempt. */
|
|
117720
|
+
action_attempt_id: string
|
|
117721
|
+
status: 'success'
|
|
117722
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117723
|
+
error: null
|
|
117724
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
117725
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
117726
|
+
/** Result of the action. */
|
|
117727
|
+
result: {}
|
|
117728
|
+
}
|
|
117729
|
+
| {
|
|
117730
|
+
/** ID of the action attempt. */
|
|
117731
|
+
action_attempt_id: string
|
|
117732
|
+
status: 'error'
|
|
117733
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117734
|
+
result: null
|
|
117735
|
+
/** Action attempt to track the status of configuring the auto-lock on a lock. */
|
|
117736
|
+
action_type: 'CONFIGURE_AUTO_LOCK'
|
|
117737
|
+
/** Error associated with the action. */
|
|
117738
|
+
error: {
|
|
117739
|
+
/** Type of the error. */
|
|
117740
|
+
type: string
|
|
117741
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117742
|
+
message: string
|
|
117743
|
+
}
|
|
117744
|
+
}
|
|
114990
117745
|
| {
|
|
114991
117746
|
/** ID of the action attempt. */
|
|
114992
117747
|
action_attempt_id: string
|