@seamapi/types 1.765.0 → 1.767.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.
Files changed (40) hide show
  1. package/dist/connect.cjs +375 -106
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +2881 -10
  4. package/dist/index.cjs +375 -106
  5. package/dist/index.cjs.map +1 -1
  6. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
  7. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  8. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  9. package/lib/seam/connect/models/action-attempts/configure-auto-lock.d.ts +77 -0
  10. package/lib/seam/connect/models/action-attempts/configure-auto-lock.js +31 -0
  11. package/lib/seam/connect/models/action-attempts/configure-auto-lock.js.map +1 -0
  12. package/lib/seam/connect/models/batch.d.ts +166 -0
  13. package/lib/seam/connect/models/customer/customer-portal.d.ts +14 -0
  14. package/lib/seam/connect/models/customer/customer-portal.js +5 -0
  15. package/lib/seam/connect/models/customer/customer-portal.js.map +1 -1
  16. package/lib/seam/connect/models/devices/capability-properties/index.d.ts +6 -0
  17. package/lib/seam/connect/models/devices/capability-properties/lock.d.ts +6 -0
  18. package/lib/seam/connect/models/devices/capability-properties/lock.js +12 -0
  19. package/lib/seam/connect/models/devices/capability-properties/lock.js.map +1 -1
  20. package/lib/seam/connect/models/devices/device-metadata.d.ts +7 -0
  21. package/lib/seam/connect/models/devices/device-metadata.js +3 -0
  22. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  23. package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
  24. package/lib/seam/connect/models/devices/device.d.ts +25 -0
  25. package/lib/seam/connect/models/devices/device.js +1 -0
  26. package/lib/seam/connect/models/devices/device.js.map +1 -1
  27. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +17 -0
  28. package/lib/seam/connect/openapi.d.ts +132 -0
  29. package/lib/seam/connect/openapi.js +229 -0
  30. package/lib/seam/connect/openapi.js.map +1 -1
  31. package/lib/seam/connect/route-types.d.ts +2762 -306
  32. package/package.json +1 -1
  33. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  34. package/src/lib/seam/connect/models/action-attempts/configure-auto-lock.ts +46 -0
  35. package/src/lib/seam/connect/models/customer/customer-portal.ts +7 -0
  36. package/src/lib/seam/connect/models/devices/capability-properties/lock.ts +12 -0
  37. package/src/lib/seam/connect/models/devices/device-metadata.ts +5 -0
  38. package/src/lib/seam/connect/models/devices/device.ts +1 -0
  39. package/src/lib/seam/connect/openapi.ts +246 -0
  40. package/src/lib/seam/connect/route-types.ts +3089 -330
@@ -1051,6 +1051,41 @@ export type Routes = {
1051
1051
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1052
1052
  message: string;
1053
1053
  };
1054
+ } | {
1055
+ /** ID of the action attempt. */
1056
+ action_attempt_id: string;
1057
+ status: 'pending';
1058
+ /** Result of the action attempt. Null for pending action attempts. */
1059
+ result: null;
1060
+ /** Errors associated with the action attempt. Null for pending action attempts. */
1061
+ error: null;
1062
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
1063
+ action_type: 'CONFIGURE_AUTO_LOCK';
1064
+ } | {
1065
+ /** ID of the action attempt. */
1066
+ action_attempt_id: string;
1067
+ status: 'success';
1068
+ /** Errors associated with the action attempt. Null for successful action attempts. */
1069
+ error: null;
1070
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
1071
+ action_type: 'CONFIGURE_AUTO_LOCK';
1072
+ /** Result of the action. */
1073
+ result: {};
1074
+ } | {
1075
+ /** ID of the action attempt. */
1076
+ action_attempt_id: string;
1077
+ status: 'error';
1078
+ /** Result of the action attempt. Null for failed action attempts. */
1079
+ result: null;
1080
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
1081
+ action_type: 'CONFIGURE_AUTO_LOCK';
1082
+ /** Error associated with the action. */
1083
+ error: {
1084
+ /** Type of the error. */
1085
+ type: string;
1086
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1087
+ message: string;
1088
+ };
1054
1089
  } | {
1055
1090
  /** ID of the action attempt. */
1056
1091
  action_attempt_id: string;
@@ -3394,6 +3429,41 @@ export type Routes = {
3394
3429
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3395
3430
  message: string;
3396
3431
  };
3432
+ } | {
3433
+ /** ID of the action attempt. */
3434
+ action_attempt_id: string;
3435
+ status: 'pending';
3436
+ /** Result of the action attempt. Null for pending action attempts. */
3437
+ result: null;
3438
+ /** Errors associated with the action attempt. Null for pending action attempts. */
3439
+ error: null;
3440
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
3441
+ action_type: 'CONFIGURE_AUTO_LOCK';
3442
+ } | {
3443
+ /** ID of the action attempt. */
3444
+ action_attempt_id: string;
3445
+ status: 'success';
3446
+ /** Errors associated with the action attempt. Null for successful action attempts. */
3447
+ error: null;
3448
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
3449
+ action_type: 'CONFIGURE_AUTO_LOCK';
3450
+ /** Result of the action. */
3451
+ result: {};
3452
+ } | {
3453
+ /** ID of the action attempt. */
3454
+ action_attempt_id: string;
3455
+ status: 'error';
3456
+ /** Result of the action attempt. Null for failed action attempts. */
3457
+ result: null;
3458
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
3459
+ action_type: 'CONFIGURE_AUTO_LOCK';
3460
+ /** Error associated with the action. */
3461
+ error: {
3462
+ /** Type of the error. */
3463
+ type: string;
3464
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
3465
+ message: string;
3466
+ };
3397
3467
  } | {
3398
3468
  /** ID of the action attempt. */
3399
3469
  action_attempt_id: string;
@@ -7432,6 +7502,41 @@ export type Routes = {
7432
7502
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7433
7503
  message: string;
7434
7504
  };
7505
+ } | {
7506
+ /** ID of the action attempt. */
7507
+ action_attempt_id: string;
7508
+ status: 'pending';
7509
+ /** Result of the action attempt. Null for pending action attempts. */
7510
+ result: null;
7511
+ /** Errors associated with the action attempt. Null for pending action attempts. */
7512
+ error: null;
7513
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
7514
+ action_type: 'CONFIGURE_AUTO_LOCK';
7515
+ } | {
7516
+ /** ID of the action attempt. */
7517
+ action_attempt_id: string;
7518
+ status: 'success';
7519
+ /** Errors associated with the action attempt. Null for successful action attempts. */
7520
+ error: null;
7521
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
7522
+ action_type: 'CONFIGURE_AUTO_LOCK';
7523
+ /** Result of the action. */
7524
+ result: {};
7525
+ } | {
7526
+ /** ID of the action attempt. */
7527
+ action_attempt_id: string;
7528
+ status: 'error';
7529
+ /** Result of the action attempt. Null for failed action attempts. */
7530
+ result: null;
7531
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
7532
+ action_type: 'CONFIGURE_AUTO_LOCK';
7533
+ /** Error associated with the action. */
7534
+ error: {
7535
+ /** Type of the error. */
7536
+ type: string;
7537
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
7538
+ message: string;
7539
+ };
7435
7540
  } | {
7436
7541
  /** ID of the action attempt. */
7437
7542
  action_attempt_id: string;
@@ -9811,6 +9916,41 @@ export type Routes = {
9811
9916
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
9812
9917
  message: string;
9813
9918
  };
9919
+ } | {
9920
+ /** ID of the action attempt. */
9921
+ action_attempt_id: string;
9922
+ status: 'pending';
9923
+ /** Result of the action attempt. Null for pending action attempts. */
9924
+ result: null;
9925
+ /** Errors associated with the action attempt. Null for pending action attempts. */
9926
+ error: null;
9927
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
9928
+ action_type: 'CONFIGURE_AUTO_LOCK';
9929
+ } | {
9930
+ /** ID of the action attempt. */
9931
+ action_attempt_id: string;
9932
+ status: 'success';
9933
+ /** Errors associated with the action attempt. Null for successful action attempts. */
9934
+ error: null;
9935
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
9936
+ action_type: 'CONFIGURE_AUTO_LOCK';
9937
+ /** Result of the action. */
9938
+ result: {};
9939
+ } | {
9940
+ /** ID of the action attempt. */
9941
+ action_attempt_id: string;
9942
+ status: 'error';
9943
+ /** Result of the action attempt. Null for failed action attempts. */
9944
+ result: null;
9945
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
9946
+ action_type: 'CONFIGURE_AUTO_LOCK';
9947
+ /** Error associated with the action. */
9948
+ error: {
9949
+ /** Type of the error. */
9950
+ type: string;
9951
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
9952
+ message: string;
9953
+ };
9814
9954
  } | {
9815
9955
  /** ID of the action attempt. */
9816
9956
  action_attempt_id: string;
@@ -10926,6 +11066,8 @@ export type Routes = {
10926
11066
  incomplete_keyboard_passcode: boolean;
10927
11067
  /** Indicates whether a TTLock device supports Wi-Fi. */
10928
11068
  wifi: boolean;
11069
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
11070
+ auto_lock_time_config: boolean;
10929
11071
  };
10930
11072
  /** Indicates whether a TTLock device has a gateway. */
10931
11073
  has_gateway?: boolean | undefined;
@@ -11215,6 +11357,10 @@ export type Routes = {
11215
11357
  } | undefined) | undefined;
11216
11358
  /** Indicates whether the door is open. */
11217
11359
  door_open?: (boolean | undefined) | undefined;
11360
+ /** Indicates whether automatic locking is enabled. */
11361
+ auto_lock_enabled?: (boolean | undefined) | undefined;
11362
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
11363
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
11218
11364
  } & {
11219
11365
  /** Reported temperature in °F. */
11220
11366
  temperature_fahrenheit?: number | undefined;
@@ -11861,6 +12007,7 @@ export type Routes = {
11861
12007
  can_simulate_hub_connection?: boolean | undefined;
11862
12008
  can_simulate_hub_disconnection?: boolean | undefined;
11863
12009
  can_simulate_paid_subscription?: boolean | undefined;
12010
+ can_configure_auto_lock?: boolean | undefined;
11864
12011
  }[] | undefined;
11865
12012
  acs_entrances?: {
11866
12013
  /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -14364,6 +14511,41 @@ export type Routes = {
14364
14511
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
14365
14512
  message: string;
14366
14513
  };
14514
+ } | {
14515
+ /** ID of the action attempt. */
14516
+ action_attempt_id: string;
14517
+ status: 'pending';
14518
+ /** Result of the action attempt. Null for pending action attempts. */
14519
+ result: null;
14520
+ /** Errors associated with the action attempt. Null for pending action attempts. */
14521
+ error: null;
14522
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
14523
+ action_type: 'CONFIGURE_AUTO_LOCK';
14524
+ } | {
14525
+ /** ID of the action attempt. */
14526
+ action_attempt_id: string;
14527
+ status: 'success';
14528
+ /** Errors associated with the action attempt. Null for successful action attempts. */
14529
+ error: null;
14530
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
14531
+ action_type: 'CONFIGURE_AUTO_LOCK';
14532
+ /** Result of the action. */
14533
+ result: {};
14534
+ } | {
14535
+ /** ID of the action attempt. */
14536
+ action_attempt_id: string;
14537
+ status: 'error';
14538
+ /** Result of the action attempt. Null for failed action attempts. */
14539
+ result: null;
14540
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
14541
+ action_type: 'CONFIGURE_AUTO_LOCK';
14542
+ /** Error associated with the action. */
14543
+ error: {
14544
+ /** Type of the error. */
14545
+ type: string;
14546
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
14547
+ message: string;
14548
+ };
14367
14549
  } | {
14368
14550
  /** ID of the action attempt. */
14369
14551
  action_attempt_id: string;
@@ -15163,6 +15345,8 @@ export type Routes = {
15163
15345
  incomplete_keyboard_passcode: boolean;
15164
15346
  /** Indicates whether a TTLock device supports Wi-Fi. */
15165
15347
  wifi: boolean;
15348
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
15349
+ auto_lock_time_config: boolean;
15166
15350
  };
15167
15351
  /** Indicates whether a TTLock device has a gateway. */
15168
15352
  has_gateway?: boolean | undefined;
@@ -15452,6 +15636,10 @@ export type Routes = {
15452
15636
  } | undefined) | undefined;
15453
15637
  /** Indicates whether the door is open. */
15454
15638
  door_open?: (boolean | undefined) | undefined;
15639
+ /** Indicates whether automatic locking is enabled. */
15640
+ auto_lock_enabled?: (boolean | undefined) | undefined;
15641
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
15642
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
15455
15643
  } & {
15456
15644
  /** Reported temperature in °F. */
15457
15645
  temperature_fahrenheit?: number | undefined;
@@ -16098,6 +16286,7 @@ export type Routes = {
16098
16286
  can_simulate_hub_connection?: boolean | undefined;
16099
16287
  can_simulate_hub_disconnection?: boolean | undefined;
16100
16288
  can_simulate_paid_subscription?: boolean | undefined;
16289
+ can_configure_auto_lock?: boolean | undefined;
16101
16290
  }[] | undefined;
16102
16291
  acs_entrances?: {
16103
16292
  /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -20876,6 +21065,41 @@ export type Routes = {
20876
21065
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20877
21066
  message: string;
20878
21067
  };
21068
+ } | {
21069
+ /** ID of the action attempt. */
21070
+ action_attempt_id: string;
21071
+ status: 'pending';
21072
+ /** Result of the action attempt. Null for pending action attempts. */
21073
+ result: null;
21074
+ /** Errors associated with the action attempt. Null for pending action attempts. */
21075
+ error: null;
21076
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
21077
+ action_type: 'CONFIGURE_AUTO_LOCK';
21078
+ } | {
21079
+ /** ID of the action attempt. */
21080
+ action_attempt_id: string;
21081
+ status: 'success';
21082
+ /** Errors associated with the action attempt. Null for successful action attempts. */
21083
+ error: null;
21084
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
21085
+ action_type: 'CONFIGURE_AUTO_LOCK';
21086
+ /** Result of the action. */
21087
+ result: {};
21088
+ } | {
21089
+ /** ID of the action attempt. */
21090
+ action_attempt_id: string;
21091
+ status: 'error';
21092
+ /** Result of the action attempt. Null for failed action attempts. */
21093
+ result: null;
21094
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
21095
+ action_type: 'CONFIGURE_AUTO_LOCK';
21096
+ /** Error associated with the action. */
21097
+ error: {
21098
+ /** Type of the error. */
21099
+ type: string;
21100
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
21101
+ message: string;
21102
+ };
20879
21103
  } | {
20880
21104
  /** ID of the action attempt. */
20881
21105
  action_attempt_id: string;
@@ -22259,6 +22483,41 @@ export type Routes = {
22259
22483
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22260
22484
  message: string;
22261
22485
  };
22486
+ } | {
22487
+ /** ID of the action attempt. */
22488
+ action_attempt_id: string;
22489
+ status: 'pending';
22490
+ /** Result of the action attempt. Null for pending action attempts. */
22491
+ result: null;
22492
+ /** Errors associated with the action attempt. Null for pending action attempts. */
22493
+ error: null;
22494
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
22495
+ action_type: 'CONFIGURE_AUTO_LOCK';
22496
+ } | {
22497
+ /** ID of the action attempt. */
22498
+ action_attempt_id: string;
22499
+ status: 'success';
22500
+ /** Errors associated with the action attempt. Null for successful action attempts. */
22501
+ error: null;
22502
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
22503
+ action_type: 'CONFIGURE_AUTO_LOCK';
22504
+ /** Result of the action. */
22505
+ result: {};
22506
+ } | {
22507
+ /** ID of the action attempt. */
22508
+ action_attempt_id: string;
22509
+ status: 'error';
22510
+ /** Result of the action attempt. Null for failed action attempts. */
22511
+ result: null;
22512
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
22513
+ action_type: 'CONFIGURE_AUTO_LOCK';
22514
+ /** Error associated with the action. */
22515
+ error: {
22516
+ /** Type of the error. */
22517
+ type: string;
22518
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22519
+ message: string;
22520
+ };
22262
22521
  } | {
22263
22522
  /** ID of the action attempt. */
22264
22523
  action_attempt_id: string;
@@ -24104,6 +24363,41 @@ export type Routes = {
24104
24363
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24105
24364
  message: string;
24106
24365
  };
24366
+ } | {
24367
+ /** ID of the action attempt. */
24368
+ action_attempt_id: string;
24369
+ status: 'pending';
24370
+ /** Result of the action attempt. Null for pending action attempts. */
24371
+ result: null;
24372
+ /** Errors associated with the action attempt. Null for pending action attempts. */
24373
+ error: null;
24374
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
24375
+ action_type: 'CONFIGURE_AUTO_LOCK';
24376
+ } | {
24377
+ /** ID of the action attempt. */
24378
+ action_attempt_id: string;
24379
+ status: 'success';
24380
+ /** Errors associated with the action attempt. Null for successful action attempts. */
24381
+ error: null;
24382
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
24383
+ action_type: 'CONFIGURE_AUTO_LOCK';
24384
+ /** Result of the action. */
24385
+ result: {};
24386
+ } | {
24387
+ /** ID of the action attempt. */
24388
+ action_attempt_id: string;
24389
+ status: 'error';
24390
+ /** Result of the action attempt. Null for failed action attempts. */
24391
+ result: null;
24392
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
24393
+ action_type: 'CONFIGURE_AUTO_LOCK';
24394
+ /** Error associated with the action. */
24395
+ error: {
24396
+ /** Type of the error. */
24397
+ type: string;
24398
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
24399
+ message: string;
24400
+ };
24107
24401
  } | {
24108
24402
  /** ID of the action attempt. */
24109
24403
  action_attempt_id: string;
@@ -27416,6 +27710,41 @@ export type Routes = {
27416
27710
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27417
27711
  message: string;
27418
27712
  };
27713
+ } | {
27714
+ /** ID of the action attempt. */
27715
+ action_attempt_id: string;
27716
+ status: 'pending';
27717
+ /** Result of the action attempt. Null for pending action attempts. */
27718
+ result: null;
27719
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27720
+ error: null;
27721
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
27722
+ action_type: 'CONFIGURE_AUTO_LOCK';
27723
+ } | {
27724
+ /** ID of the action attempt. */
27725
+ action_attempt_id: string;
27726
+ status: 'success';
27727
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27728
+ error: null;
27729
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
27730
+ action_type: 'CONFIGURE_AUTO_LOCK';
27731
+ /** Result of the action. */
27732
+ result: {};
27733
+ } | {
27734
+ /** ID of the action attempt. */
27735
+ action_attempt_id: string;
27736
+ status: 'error';
27737
+ /** Result of the action attempt. Null for failed action attempts. */
27738
+ result: null;
27739
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
27740
+ action_type: 'CONFIGURE_AUTO_LOCK';
27741
+ /** Error associated with the action. */
27742
+ error: {
27743
+ /** Type of the error. */
27744
+ type: string;
27745
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27746
+ message: string;
27747
+ };
27419
27748
  } | {
27420
27749
  /** ID of the action attempt. */
27421
27750
  action_attempt_id: string;
@@ -28692,6 +29021,41 @@ export type Routes = {
28692
29021
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
28693
29022
  message: string;
28694
29023
  };
29024
+ } | {
29025
+ /** ID of the action attempt. */
29026
+ action_attempt_id: string;
29027
+ status: 'pending';
29028
+ /** Result of the action attempt. Null for pending action attempts. */
29029
+ result: null;
29030
+ /** Errors associated with the action attempt. Null for pending action attempts. */
29031
+ error: null;
29032
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
29033
+ action_type: 'CONFIGURE_AUTO_LOCK';
29034
+ } | {
29035
+ /** ID of the action attempt. */
29036
+ action_attempt_id: string;
29037
+ status: 'success';
29038
+ /** Errors associated with the action attempt. Null for successful action attempts. */
29039
+ error: null;
29040
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
29041
+ action_type: 'CONFIGURE_AUTO_LOCK';
29042
+ /** Result of the action. */
29043
+ result: {};
29044
+ } | {
29045
+ /** ID of the action attempt. */
29046
+ action_attempt_id: string;
29047
+ status: 'error';
29048
+ /** Result of the action attempt. Null for failed action attempts. */
29049
+ result: null;
29050
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
29051
+ action_type: 'CONFIGURE_AUTO_LOCK';
29052
+ /** Error associated with the action. */
29053
+ error: {
29054
+ /** Type of the error. */
29055
+ type: string;
29056
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
29057
+ message: string;
29058
+ };
28695
29059
  } | {
28696
29060
  /** ID of the action attempt. */
28697
29061
  action_attempt_id: string;
@@ -30134,6 +30498,8 @@ export type Routes = {
30134
30498
  exclude?: boolean;
30135
30499
  /** Indicates whether the customer can manage reservations for their properties. */
30136
30500
  exclude_reservation_management?: boolean;
30501
+ /** Indicates whether to exclude technical details from reservation views. */
30502
+ exclude_reservation_technical_details?: boolean;
30137
30503
  /** Indicates whether the customer can manage staff for their properties. */
30138
30504
  exclude_staff_management?: boolean;
30139
30505
  /** Configuration for event type filtering in the manage feature. */
@@ -31316,6 +31682,8 @@ export type Routes = {
31316
31682
  incomplete_keyboard_passcode: boolean;
31317
31683
  /** Indicates whether a TTLock device supports Wi-Fi. */
31318
31684
  wifi: boolean;
31685
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
31686
+ auto_lock_time_config: boolean;
31319
31687
  };
31320
31688
  /** Indicates whether a TTLock device has a gateway. */
31321
31689
  has_gateway?: boolean | undefined;
@@ -31605,6 +31973,10 @@ export type Routes = {
31605
31973
  } | undefined) | undefined;
31606
31974
  /** Indicates whether the door is open. */
31607
31975
  door_open?: (boolean | undefined) | undefined;
31976
+ /** Indicates whether automatic locking is enabled. */
31977
+ auto_lock_enabled?: (boolean | undefined) | undefined;
31978
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
31979
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
31608
31980
  } & {
31609
31981
  /** Reported temperature in °F. */
31610
31982
  temperature_fahrenheit?: number | undefined;
@@ -32251,6 +32623,7 @@ export type Routes = {
32251
32623
  can_simulate_hub_connection?: boolean | undefined;
32252
32624
  can_simulate_hub_disconnection?: boolean | undefined;
32253
32625
  can_simulate_paid_subscription?: boolean | undefined;
32626
+ can_configure_auto_lock?: boolean | undefined;
32254
32627
  };
32255
32628
  };
32256
32629
  maxDuration: undefined;
@@ -32290,9 +32663,9 @@ export type Routes = {
32290
32663
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
32291
32664
  page_cursor?: (string | undefined) | null;
32292
32665
  /** */
32293
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
32666
+ include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
32294
32667
  /** */
32295
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
32668
+ exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
32296
32669
  /**
32297
32670
  * @deprecated Use `space_id`.*/
32298
32671
  unstable_location_id?: (string | null) | undefined;
@@ -32679,6 +33052,8 @@ export type Routes = {
32679
33052
  incomplete_keyboard_passcode: boolean;
32680
33053
  /** Indicates whether a TTLock device supports Wi-Fi. */
32681
33054
  wifi: boolean;
33055
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
33056
+ auto_lock_time_config: boolean;
32682
33057
  };
32683
33058
  /** Indicates whether a TTLock device has a gateway. */
32684
33059
  has_gateway?: boolean | undefined;
@@ -32968,6 +33343,10 @@ export type Routes = {
32968
33343
  } | undefined) | undefined;
32969
33344
  /** Indicates whether the door is open. */
32970
33345
  door_open?: (boolean | undefined) | undefined;
33346
+ /** Indicates whether automatic locking is enabled. */
33347
+ auto_lock_enabled?: (boolean | undefined) | undefined;
33348
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
33349
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
32971
33350
  } & {
32972
33351
  /** Reported temperature in °F. */
32973
33352
  temperature_fahrenheit?: number | undefined;
@@ -33614,6 +33993,7 @@ export type Routes = {
33614
33993
  can_simulate_hub_connection?: boolean | undefined;
33615
33994
  can_simulate_hub_disconnection?: boolean | undefined;
33616
33995
  can_simulate_paid_subscription?: boolean | undefined;
33996
+ can_configure_auto_lock?: boolean | undefined;
33617
33997
  }[];
33618
33998
  /** Information about the current page of results. */
33619
33999
  pagination: {
@@ -33662,6 +34042,7 @@ export type Routes = {
33662
34042
  can_simulate_hub_connection?: boolean | undefined;
33663
34043
  can_simulate_hub_disconnection?: boolean | undefined;
33664
34044
  can_simulate_paid_subscription?: boolean | undefined;
34045
+ can_configure_auto_lock?: boolean | undefined;
33665
34046
  }[];
33666
34047
  };
33667
34048
  maxDuration: undefined;
@@ -34207,6 +34588,7 @@ export type Routes = {
34207
34588
  can_simulate_hub_connection?: boolean | undefined;
34208
34589
  can_simulate_hub_disconnection?: boolean | undefined;
34209
34590
  can_simulate_paid_subscription?: boolean | undefined;
34591
+ can_configure_auto_lock?: boolean | undefined;
34210
34592
  };
34211
34593
  };
34212
34594
  maxDuration: undefined;
@@ -34244,9 +34626,9 @@ export type Routes = {
34244
34626
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
34245
34627
  page_cursor?: (string | undefined) | null;
34246
34628
  /** */
34247
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
34629
+ include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
34248
34630
  /** */
34249
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
34631
+ exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
34250
34632
  /**
34251
34633
  * @deprecated Use `space_id`.*/
34252
34634
  unstable_location_id?: (string | null) | undefined;
@@ -34687,6 +35069,7 @@ export type Routes = {
34687
35069
  can_simulate_hub_connection?: boolean | undefined;
34688
35070
  can_simulate_hub_disconnection?: boolean | undefined;
34689
35071
  can_simulate_paid_subscription?: boolean | undefined;
35072
+ can_configure_auto_lock?: boolean | undefined;
34690
35073
  }[];
34691
35074
  /** Information about the current page of results. */
34692
35075
  pagination: {
@@ -40452,309 +40835,1623 @@ export type Routes = {
40452
40835
  };
40453
40836
  maxDuration: undefined;
40454
40837
  };
40455
- '/locks/get': {
40456
- route: '/locks/get';
40457
- method: 'GET' | 'POST';
40838
+ '/locks/configure_auto_lock': {
40839
+ route: '/locks/configure_auto_lock';
40840
+ method: 'POST';
40458
40841
  queryParams: {};
40459
- jsonBody: {};
40460
- commonParams: {
40461
- /** ID of the lock that you want to get. */
40462
- device_id?: string | undefined;
40463
- /** Name of the lock that you want to get. */
40464
- name?: string | undefined;
40842
+ jsonBody: {
40843
+ /** ID of the lock for which you want to configure the auto-lock. */
40844
+ device_id: string;
40845
+ /** Whether to enable or disable auto-lock. */
40846
+ auto_lock_enabled: boolean;
40847
+ /** Delay in seconds before the lock automatically locks. Required when enabling auto-lock. Must be between 1 and 60. */
40848
+ auto_lock_delay_seconds?: number | undefined;
40465
40849
  };
40850
+ commonParams: {};
40466
40851
  formData: {};
40467
40852
  jsonResponse: {
40468
- /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
40469
- lock: {
40470
- /** ID of the device. */
40471
- device_id: string;
40472
- /** Type of the device. */
40473
- device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'korelock_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera';
40474
- /** IDs of the spaces the device is in. */
40475
- space_ids: string[];
40476
- /** Optional nickname to describe the device, settable through Seam. */
40477
- nickname?: string | undefined;
40478
- /** 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. */
40479
- display_name: string;
40480
- /**
40481
- 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).
40482
- */
40483
- capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
40484
- /** Properties of the device. */
40485
- properties: (({
40486
- /** Indicates whether the device is online. */
40487
- online: boolean;
40488
- /** Name of the device.
40489
- * @deprecated use device.display_name instead*/
40490
- name: string;
40491
- /** Accessory keypad properties and state. */
40492
- accessory_keypad?: {
40493
- /** Indicates if an accessory keypad is connected to the device.
40494
- */
40495
- is_connected: boolean;
40496
- /** Keypad battery properties.
40497
- */
40498
- battery?: {
40499
- level: number;
40853
+ /** 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.
40854
+
40855
+ 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.
40856
+
40857
+ See also [Action Attempts](https://docs.seam.co/latest/core-concepts/action-attempts). */
40858
+ action_attempt: {
40859
+ /** ID of the action attempt. */
40860
+ action_attempt_id: string;
40861
+ status: 'pending';
40862
+ /** Result of the action attempt. Null for pending action attempts. */
40863
+ result: null;
40864
+ /** Errors associated with the action attempt. Null for pending action attempts. */
40865
+ error: null;
40866
+ /** Action attempt to track the status of locking a door. */
40867
+ action_type: 'LOCK_DOOR';
40868
+ } | {
40869
+ /** ID of the action attempt. */
40870
+ action_attempt_id: string;
40871
+ status: 'success';
40872
+ /** Errors associated with the action attempt. Null for successful action attempts. */
40873
+ error: null;
40874
+ /** Action attempt to track the status of locking a door. */
40875
+ action_type: 'LOCK_DOOR';
40876
+ /** Result of the action. */
40877
+ result: {
40878
+ /** Indicates whether the device confirmed that the lock action occurred. */
40879
+ was_confirmed_by_device?: boolean | undefined;
40880
+ };
40881
+ } | {
40882
+ /** ID of the action attempt. */
40883
+ action_attempt_id: string;
40884
+ status: 'error';
40885
+ /** Result of the action attempt. Null for failed action attempts. */
40886
+ result: null;
40887
+ /** Action attempt to track the status of locking a door. */
40888
+ action_type: 'LOCK_DOOR';
40889
+ /** Error associated with the action. */
40890
+ error: {
40891
+ /** Type of the error. */
40892
+ type: string;
40893
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40894
+ message: string;
40895
+ };
40896
+ } | {
40897
+ /** ID of the action attempt. */
40898
+ action_attempt_id: string;
40899
+ status: 'pending';
40900
+ /** Result of the action attempt. Null for pending action attempts. */
40901
+ result: null;
40902
+ /** Errors associated with the action attempt. Null for pending action attempts. */
40903
+ error: null;
40904
+ /** Action attempt to track the status of unlocking a door. */
40905
+ action_type: 'UNLOCK_DOOR';
40906
+ } | {
40907
+ /** ID of the action attempt. */
40908
+ action_attempt_id: string;
40909
+ status: 'success';
40910
+ /** Errors associated with the action attempt. Null for successful action attempts. */
40911
+ error: null;
40912
+ /** Action attempt to track the status of unlocking a door. */
40913
+ action_type: 'UNLOCK_DOOR';
40914
+ /** Result of the action. */
40915
+ result: {
40916
+ /** Indicates whether the device confirmed that the unlock action occurred. */
40917
+ was_confirmed_by_device?: boolean | undefined;
40918
+ };
40919
+ } | {
40920
+ /** ID of the action attempt. */
40921
+ action_attempt_id: string;
40922
+ status: 'error';
40923
+ /** Result of the action attempt. Null for failed action attempts. */
40924
+ result: null;
40925
+ /** Action attempt to track the status of unlocking a door. */
40926
+ action_type: 'UNLOCK_DOOR';
40927
+ /** Error associated with the action. */
40928
+ error: {
40929
+ /** Type of the error. */
40930
+ type: string;
40931
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
40932
+ message: string;
40933
+ };
40934
+ } | {
40935
+ /** ID of the action attempt. */
40936
+ action_attempt_id: string;
40937
+ status: 'pending';
40938
+ /** Result of the action attempt. Null for pending action attempts. */
40939
+ result: null;
40940
+ /** Errors associated with the action attempt. Null for pending action attempts. */
40941
+ error: null;
40942
+ /** Action attempt to track the status of scanning a credential. */
40943
+ action_type: 'SCAN_CREDENTIAL';
40944
+ } | {
40945
+ /** ID of the action attempt. */
40946
+ action_attempt_id: string;
40947
+ status: 'success';
40948
+ /** Errors associated with the action attempt. Null for successful action attempts. */
40949
+ error: null;
40950
+ /** Action attempt to track the status of scanning a credential. */
40951
+ action_type: 'SCAN_CREDENTIAL';
40952
+ /** 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. */
40953
+ result: {
40954
+ /** Snapshot of credential data read from the physical encoder. */
40955
+ acs_credential_on_encoder: {
40956
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
40957
+ created_at: string | null;
40958
+ is_issued: boolean | null;
40959
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) becomes usable. */
40960
+ starts_at: string | null;
40961
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) will stop being usable. */
40962
+ ends_at: string | null;
40963
+ /** A number or string that physically identifies the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
40964
+ card_number: string | null;
40965
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
40966
+ visionline_metadata?: {
40967
+ /** Card ID for the Visionline card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
40968
+ card_id: string;
40969
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is cancelled. */
40970
+ cancelled: boolean;
40971
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is discarded. */
40972
+ discarded: boolean;
40973
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is expired. */
40974
+ expired: boolean;
40975
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overwritten. */
40976
+ overwritten: boolean;
40977
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is overridden. */
40978
+ overridden?: boolean | undefined;
40979
+ /** Indicates whether the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) is pending auto-update. */
40980
+ pending_auto_update: boolean;
40981
+ /** Format of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
40982
+ card_format: 'TLCode' | 'rfid48';
40983
+ /** Holder of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
40984
+ card_holder?: string | undefined;
40985
+ /** Number of issued cards associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
40986
+ number_of_issued_cards: number;
40987
+ /** 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). */
40988
+ guest_acs_entrance_ids?: string[] | undefined;
40989
+ /** 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). */
40990
+ common_acs_entrance_ids?: string[] | undefined;
40500
40991
  } | undefined;
40501
- } | undefined;
40502
- /** Appearance-related properties, as reported by the device. */
40503
- appearance: {
40504
- /** Name of the device as seen from the provider API and application, not settable through Seam. */
40505
- name: string;
40506
- };
40507
- /** Device model-related properties. */
40508
- model: {
40509
- /**
40510
- Indicates whether the device can connect a accessory keypad.
40511
- */
40512
- can_connect_accessory_keypad?: boolean | undefined;
40513
- /**
40514
- Display name of the device model.
40515
- */
40992
+ } | null;
40993
+ /** Corresponding credential data as stored on Seam and the access system. */
40994
+ acs_credential_on_seam: ({
40995
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
40996
+ acs_credential_id: string;
40997
+ /** 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. */
40998
+ acs_user_id?: string | undefined;
40999
+ /** 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. */
41000
+ user_identity_id?: string | undefined;
41001
+ /** 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. */
41002
+ connected_account_id: string;
41003
+ acs_credential_pool_id?: string | undefined;
41004
+ /** 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). */
41005
+ acs_system_id: string;
41006
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41007
+ parent_acs_credential_id?: string | undefined;
41008
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
40516
41009
  display_name: string;
40517
- /**
40518
- Display name that corresponds to the manufacturer-specific terminology for the device.
40519
- */
40520
- manufacturer_display_name: string;
40521
- /**
40522
- Indicates whether the device has a built in accessory keypad.
40523
- */
40524
- has_built_in_keypad?: boolean | undefined;
40525
- /**
40526
- * @deprecated use device.can_program_offline_access_codes.*/
40527
- offline_access_codes_supported?: boolean | undefined;
40528
- /**
40529
- * @deprecated use device.can_program_online_access_codes.*/
40530
- online_access_codes_supported?: boolean | undefined;
40531
- /**
40532
- * @deprecated use device.properties.model.can_connect_accessory_keypad*/
40533
- accessory_keypad_supported?: boolean | undefined;
40534
- };
40535
- /** Indicates whether the device has direct power. */
40536
- has_direct_power?: boolean | undefined;
40537
- /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
40538
- battery_level?: number | undefined;
40539
- /** Represents the current status of the battery charge level. */
40540
- battery?: {
40541
- /** Battery charge level as a value between 0 and 1, inclusive.
40542
- */
40543
- level: number;
40544
- /** 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.
40545
- */
40546
- status: 'critical' | 'low' | 'good' | 'full';
40547
- } | undefined;
40548
- /** 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. */
40549
- manufacturer?: string | undefined;
40550
- /** Image URL for the device. */
40551
- image_url?: string | undefined;
40552
- /** Alt text for the device image. */
40553
- image_alt_text?: string | undefined;
40554
- /** Serial number of the device. */
40555
- serial_number?: string | undefined;
40556
- /** Indicates whether it is currently possible to use online access codes for the device.
40557
- * @deprecated use device.can_program_online_access_codes*/
40558
- online_access_codes_enabled?: boolean | undefined;
40559
- /** Indicates whether it is currently possible to use offline access codes for the device.
40560
- * @deprecated use device.can_program_offline_access_codes*/
40561
- offline_access_codes_enabled?: boolean | undefined;
40562
- /**
40563
- * @deprecated use device.properties.model.can_connect_accessory_keypad*/
40564
- supports_accessory_keypad?: boolean | undefined;
40565
- /**
40566
- * @deprecated use offline_access_codes_enabled*/
40567
- supports_offline_access_codes?: boolean | undefined;
40568
- /** Indicates current noise level in decibels, if the device supports noise detection. */
40569
- noise_level_decibels?: number | undefined;
40570
- /** Array of noise threshold IDs that are currently triggering. */
40571
- currently_triggering_noise_threshold_ids?: string[] | undefined;
40572
- } & {
40573
- /** ASSA ABLOY Credential Service metadata for the phone. */
40574
- assa_abloy_credential_service_metadata?: ({
40575
- /** Indicates whether the credential service has active endpoints associated with the phone. */
40576
- has_active_endpoint: boolean;
40577
- /** Endpoints associated with the phone. */
40578
- endpoints: {
40579
- /** ID of the associated endpoint. */
40580
- endpoint_id: string;
40581
- /** Indicated whether the endpoint is active. */
40582
- is_active: boolean;
41010
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41011
+ code?: (string | undefined) | null;
41012
+ /** 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. */
41013
+ is_one_time_use?: boolean | undefined;
41014
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41015
+ card_number?: (string | undefined) | null;
41016
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
41017
+ is_issued?: boolean | undefined;
41018
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
41019
+ issued_at?: (string | undefined) | null;
41020
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
41021
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
41022
+ /** 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`. */
41023
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
41024
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
41025
+ external_type_display_name?: string | undefined;
41026
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
41027
+ created_at: string;
41028
+ /** 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). */
41029
+ workspace_id: string;
41030
+ /** 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. */
41031
+ starts_at?: string | undefined;
41032
+ /** 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`. */
41033
+ ends_at?: string | undefined;
41034
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41035
+ errors: {
41036
+ error_code: string;
41037
+ message: string;
40583
41038
  }[];
40584
- } | undefined) | undefined;
40585
- /** Salto Space credential service metadata for the phone. */
40586
- salto_space_credential_service_metadata?: ({
40587
- /** Indicates whether the credential service has an active associated phone. */
40588
- has_active_phone: boolean;
40589
- } | undefined) | undefined;
40590
- }) & {
40591
- /** Metadata for an August device. */
40592
- august_metadata?: {
40593
- /** Lock ID for an August device. */
40594
- lock_id: string;
40595
- /** Lock name for an August device. */
40596
- lock_name: string;
40597
- /** House name for an August device. */
40598
- house_name: string;
40599
- /** Indicates whether an August device has a keypad. */
40600
- has_keypad: boolean;
40601
- /** Keypad battery level for an August device. */
40602
- keypad_battery_level?: string | undefined;
40603
- /** Model for an August device. */
40604
- model?: string | undefined;
40605
- /** House ID for an August device. */
40606
- house_id?: string | undefined;
40607
- } | undefined;
40608
- /** Metadata for an Avigilon Alta system. */
40609
- avigilon_alta_metadata?: {
40610
- /** Entry name for an Avigilon Alta system. */
40611
- entry_name: string;
40612
- /** Organization name for an Avigilon Alta system. */
40613
- org_name: string;
40614
- /** Zone ID for an Avigilon Alta system. */
40615
- zone_id: number;
40616
- /** Zone name for an Avigilon Alta system. */
40617
- zone_name: string;
40618
- /** Site ID for an Avigilon Alta system. */
40619
- site_id: number;
40620
- /** Site name for an Avigilon Alta system. */
40621
- site_name: string;
40622
- /** Total count of entry relays for an Avigilon Alta system. */
40623
- entry_relays_total_count: number;
40624
- } | undefined;
40625
- /** Metadata for a Schlage device. */
40626
- schlage_metadata?: {
40627
- /** Device ID for a Schlage device. */
40628
- device_id: string;
40629
- /** Device name for a Schlage device. */
40630
- device_name: string;
40631
- /** Model for a Schlage device. */
40632
- model?: string | undefined;
40633
- } | undefined;
40634
- /** Metadata for a SmartThings device. */
40635
- smartthings_metadata?: {
40636
- /** Device ID for a SmartThings device. */
40637
- device_id: string;
40638
- /** Device name for a SmartThings device. */
40639
- device_name: string;
40640
- /** Model for a SmartThings device. */
40641
- model?: string | undefined;
40642
- /** Location ID for a SmartThings device. */
40643
- location_id?: string | undefined;
40644
- } | undefined;
40645
- /** Metadata for a Lockly device. */
40646
- lockly_metadata?: {
40647
- /** Device ID for a Lockly device. */
40648
- device_id: string;
40649
- /** Device name for a Lockly device. */
40650
- device_name: string;
40651
- /** Model for a Lockly device. */
40652
- model?: string | undefined;
40653
- } | undefined;
40654
- /** Metadata for a Nuki device. */
40655
- nuki_metadata?: {
40656
- /** Device ID for a Nuki device. */
40657
- device_id: string;
40658
- /** Device name for a Nuki device. */
40659
- device_name: string;
40660
- /** Indicates whether the keypad battery is in a critical state for a Nuki device. */
40661
- keypad_battery_critical?: boolean | undefined;
40662
- /** Indicates whether the keypad is paired for a Nuki device. */
40663
- keypad_paired?: boolean | undefined;
40664
- /** Indicates whether keypad 2 is paired for a Nuki device. */
40665
- keypad_2_paired?: boolean | undefined;
40666
- } | undefined;
40667
- /** Metadata for a Kwikset device. */
40668
- kwikset_metadata?: {
40669
- /** Device ID for a Kwikset device. */
40670
- device_id: string;
40671
- /** Device name for a Kwikset device. */
40672
- device_name: string;
40673
- /** Model number for a Kwikset device. */
40674
- model_number: string;
40675
- } | undefined;
40676
- /** Metada for a Salto device.
40677
- * @deprecated Use `salto_ks_metadata ` instead.*/
40678
- salto_metadata?: {
40679
- /** Lock ID for a Salto device. */
40680
- lock_id: string;
40681
- /** Customer reference for a Salto device. */
40682
- customer_reference: string;
40683
- /** Lock type for a Salto device. */
40684
- lock_type: string;
40685
- /** Battery level for a Salto device. */
40686
- battery_level: string;
40687
- /** Locked state for a Salto device. */
40688
- locked_state: string;
40689
- /** Model for a Salto device. */
40690
- model?: string | undefined;
40691
- /** Site ID for the Salto KS site to which the device belongs. */
40692
- site_id?: string | undefined;
40693
- /** Site name for the Salto KS site to which the device belongs. */
40694
- site_name?: string | undefined;
40695
- } | undefined;
40696
- /** Metadata for a Salto KS device. */
40697
- salto_ks_metadata?: {
40698
- /** Lock ID for a Salto KS device. */
40699
- lock_id: string;
40700
- /** Customer reference for a Salto KS device. */
40701
- customer_reference: string;
40702
- /** Lock type for a Salto KS device. */
40703
- lock_type: string;
40704
- /** Battery level for a Salto KS device. */
40705
- battery_level: string;
40706
- /** Locked state for a Salto KS device. */
40707
- locked_state: string;
40708
- /** Model for a Salto KS device. */
40709
- model?: string | undefined;
40710
- /** Indicates whether the site has a Salto KS subscription that supports custom PINs. */
40711
- has_custom_pin_subscription?: boolean | undefined;
40712
- /** Site ID for the Salto KS site to which the device belongs. */
40713
- site_id?: string | undefined;
40714
- /** Site name for the Salto KS site to which the device belongs. */
40715
- site_name?: string | undefined;
40716
- } | undefined;
40717
- /** Metadata for a Genie device. */
40718
- genie_metadata?: {
40719
- /** Lock name for a Genie device. */
40720
- device_name: string;
40721
- /** Door name for a Genie device. */
40722
- door_name: string;
40723
- } | undefined;
40724
- /** Metadata for a Brivo device. */
40725
- brivo_metadata?: {
40726
- /** Device name for a Brivo device. */
40727
- device_name?: string | undefined;
40728
- /** Indicates whether the Brivo access point has activation (remote unlock) enabled. */
40729
- activation_enabled?: boolean | undefined;
40730
- } | undefined;
40731
- /** Metadata for an igloo device. */
40732
- igloo_metadata?: {
40733
- /** Device ID for an igloo device. */
40734
- device_id: string;
40735
- /** Bridge ID for an igloo device. */
40736
- bridge_id: string;
40737
- /** Model for an igloo device. */
40738
- model?: string | undefined;
40739
- } | undefined;
40740
- /** Metadata for a NoiseAware device. */
40741
- noiseaware_metadata?: {
40742
- /** Device model for a NoiseAware device. */
40743
- device_model: 'indoor' | 'outdoor';
40744
- /** Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device. */
40745
- noise_level_nrs: number;
40746
- /** Noise level, in decibels, for a NoiseAware device. */
40747
- noise_level_decibel: number;
40748
- /** Device name for a NoiseAware device. */
40749
- device_name: string;
40750
- /** Device ID for a NoiseAware device. */
40751
- device_id: string;
40752
- } | undefined;
40753
- /** Metadata for a Minut device. */
40754
- minut_metadata?: {
40755
- /** Device ID for a Minut device. */
40756
- device_id: string;
40757
- /** Device name for a Minut device. */
41039
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41040
+ warnings: ({
41041
+ /** Date and time at which Seam created the warning. */
41042
+ created_at: string;
41043
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41044
+ message: string;
41045
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41046
+ warning_code: 'waiting_to_be_issued';
41047
+ } | {
41048
+ /** Date and time at which Seam created the warning. */
41049
+ created_at: string;
41050
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41051
+ message: string;
41052
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41053
+ warning_code: 'schedule_externally_modified';
41054
+ } | {
41055
+ /** Date and time at which Seam created the warning. */
41056
+ created_at: string;
41057
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41058
+ message: string;
41059
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41060
+ warning_code: 'schedule_modified';
41061
+ } | {
41062
+ /** Date and time at which Seam created the warning. */
41063
+ created_at: string;
41064
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41065
+ message: string;
41066
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41067
+ warning_code: 'being_deleted';
41068
+ } | {
41069
+ /** Date and time at which Seam created the warning. */
41070
+ created_at: string;
41071
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41072
+ message: string;
41073
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41074
+ warning_code: 'unknown_issue_with_acs_credential';
41075
+ } | {
41076
+ /** Date and time at which Seam created the warning. */
41077
+ created_at: string;
41078
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41079
+ message: string;
41080
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41081
+ warning_code: 'needs_to_be_reissued';
41082
+ })[];
41083
+ /** 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). */
41084
+ is_multi_phone_sync_credential?: boolean | undefined;
41085
+ /** 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. */
41086
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
41087
+ /** 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. */
41088
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
41089
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41090
+ visionline_metadata?: {
41091
+ /** Card function type in the Visionline access system. */
41092
+ card_function_type: 'guest' | 'staff';
41093
+ /** IDs of the credentials to which you want to join. */
41094
+ joiner_acs_credential_ids?: string[] | undefined;
41095
+ /** Guest entrance IDs in the Visionline access system. */
41096
+ guest_acs_entrance_ids?: string[] | undefined;
41097
+ /** Common entrance IDs in the Visionline access system. */
41098
+ common_acs_entrance_ids?: string[] | undefined;
41099
+ /** Indicates whether the credential is valid. */
41100
+ is_valid?: boolean | undefined;
41101
+ /** 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. */
41102
+ auto_join?: boolean | undefined;
41103
+ /** ID of the card in the Visionline access system. */
41104
+ card_id?: string | undefined;
41105
+ /** ID of the credential in the Visionline access system. */
41106
+ credential_id?: string | undefined;
41107
+ } | undefined;
41108
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41109
+ assa_abloy_vostio_metadata?: {
41110
+ /** 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. */
41111
+ auto_join?: boolean | undefined;
41112
+ /** IDs of the guest entrances to override in the Vostio access system. */
41113
+ override_guest_acs_entrance_ids?: string[] | undefined;
41114
+ /** Key ID in the Vostio access system. */
41115
+ key_id?: string | undefined;
41116
+ /** Key issuing request ID in the Vostio access system. */
41117
+ key_issuing_request_id?: string | undefined;
41118
+ /** Names of the doors to which to grant access in the Vostio access system. */
41119
+ door_names?: string[] | undefined;
41120
+ /** Endpoint ID in the Vostio access system. */
41121
+ endpoint_id?: string | undefined;
41122
+ } | undefined;
41123
+ is_managed: true;
41124
+ } | {
41125
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41126
+ acs_credential_id: string;
41127
+ /** 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. */
41128
+ acs_user_id?: string | undefined;
41129
+ /** 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. */
41130
+ user_identity_id?: string | undefined;
41131
+ /** 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. */
41132
+ connected_account_id: string;
41133
+ acs_credential_pool_id?: string | undefined;
41134
+ /** 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). */
41135
+ acs_system_id: string;
41136
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41137
+ parent_acs_credential_id?: string | undefined;
41138
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
41139
+ display_name: string;
41140
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41141
+ code?: (string | undefined) | null;
41142
+ /** 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. */
41143
+ is_one_time_use?: boolean | undefined;
41144
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41145
+ card_number?: (string | undefined) | null;
41146
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
41147
+ is_issued?: boolean | undefined;
41148
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
41149
+ issued_at?: (string | undefined) | null;
41150
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
41151
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
41152
+ /** 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`. */
41153
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
41154
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
41155
+ external_type_display_name?: string | undefined;
41156
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
41157
+ created_at: string;
41158
+ /** 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). */
41159
+ workspace_id: string;
41160
+ /** 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. */
41161
+ starts_at?: string | undefined;
41162
+ /** 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`. */
41163
+ ends_at?: string | undefined;
41164
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41165
+ errors: {
41166
+ error_code: string;
41167
+ message: string;
41168
+ }[];
41169
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41170
+ warnings: ({
41171
+ /** Date and time at which Seam created the warning. */
41172
+ created_at: string;
41173
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41174
+ message: string;
41175
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41176
+ warning_code: 'waiting_to_be_issued';
41177
+ } | {
41178
+ /** Date and time at which Seam created the warning. */
41179
+ created_at: string;
41180
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41181
+ message: string;
41182
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41183
+ warning_code: 'schedule_externally_modified';
41184
+ } | {
41185
+ /** Date and time at which Seam created the warning. */
41186
+ created_at: string;
41187
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41188
+ message: string;
41189
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41190
+ warning_code: 'schedule_modified';
41191
+ } | {
41192
+ /** Date and time at which Seam created the warning. */
41193
+ created_at: string;
41194
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41195
+ message: string;
41196
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41197
+ warning_code: 'being_deleted';
41198
+ } | {
41199
+ /** Date and time at which Seam created the warning. */
41200
+ created_at: string;
41201
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41202
+ message: string;
41203
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41204
+ warning_code: 'unknown_issue_with_acs_credential';
41205
+ } | {
41206
+ /** Date and time at which Seam created the warning. */
41207
+ created_at: string;
41208
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41209
+ message: string;
41210
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41211
+ warning_code: 'needs_to_be_reissued';
41212
+ })[];
41213
+ /** 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). */
41214
+ is_multi_phone_sync_credential?: boolean | undefined;
41215
+ /** 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. */
41216
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
41217
+ /** 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. */
41218
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
41219
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41220
+ visionline_metadata?: {
41221
+ /** Card function type in the Visionline access system. */
41222
+ card_function_type: 'guest' | 'staff';
41223
+ /** IDs of the credentials to which you want to join. */
41224
+ joiner_acs_credential_ids?: string[] | undefined;
41225
+ /** Guest entrance IDs in the Visionline access system. */
41226
+ guest_acs_entrance_ids?: string[] | undefined;
41227
+ /** Common entrance IDs in the Visionline access system. */
41228
+ common_acs_entrance_ids?: string[] | undefined;
41229
+ /** Indicates whether the credential is valid. */
41230
+ is_valid?: boolean | undefined;
41231
+ /** 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. */
41232
+ auto_join?: boolean | undefined;
41233
+ /** ID of the card in the Visionline access system. */
41234
+ card_id?: string | undefined;
41235
+ /** ID of the credential in the Visionline access system. */
41236
+ credential_id?: string | undefined;
41237
+ } | undefined;
41238
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41239
+ assa_abloy_vostio_metadata?: {
41240
+ /** 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. */
41241
+ auto_join?: boolean | undefined;
41242
+ /** IDs of the guest entrances to override in the Vostio access system. */
41243
+ override_guest_acs_entrance_ids?: string[] | undefined;
41244
+ /** Key ID in the Vostio access system. */
41245
+ key_id?: string | undefined;
41246
+ /** Key issuing request ID in the Vostio access system. */
41247
+ key_issuing_request_id?: string | undefined;
41248
+ /** Names of the doors to which to grant access in the Vostio access system. */
41249
+ door_names?: string[] | undefined;
41250
+ /** Endpoint ID in the Vostio access system. */
41251
+ endpoint_id?: string | undefined;
41252
+ } | undefined;
41253
+ is_managed: false;
41254
+ }) | null;
41255
+ /** 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. */
41256
+ warnings: {
41257
+ /** Indicates a warning related to scanning a credential. */
41258
+ warning_code: 'acs_credential_on_encoder_out_of_sync' | 'acs_credential_on_seam_not_found';
41259
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41260
+ warning_message: string;
41261
+ }[];
41262
+ };
41263
+ } | {
41264
+ /** ID of the action attempt. */
41265
+ action_attempt_id: string;
41266
+ status: 'error';
41267
+ /** Result of the action attempt. Null for failed action attempts. */
41268
+ result: null;
41269
+ /** Action attempt to track the status of scanning a credential. */
41270
+ action_type: 'SCAN_CREDENTIAL';
41271
+ error: {
41272
+ /** Type of the error associated with the action attempt. */
41273
+ type: 'uncategorized_error';
41274
+ /** Message for the error associated with the action attempt. */
41275
+ message: string;
41276
+ } | {
41277
+ /** Type of the error associated with the action attempt. */
41278
+ type: 'action_attempt_expired';
41279
+ /** Message for the error associated with the action attempt. */
41280
+ message: string;
41281
+ } | {
41282
+ /** Error type to indicate that there is no credential on the encoder. */
41283
+ type: 'no_credential_on_encoder';
41284
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41285
+ message: string;
41286
+ } | {
41287
+ /** Error type to indicate that the encoder is not online. */
41288
+ type: 'encoder_not_online';
41289
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41290
+ message: string;
41291
+ };
41292
+ } | {
41293
+ /** ID of the action attempt. */
41294
+ action_attempt_id: string;
41295
+ status: 'pending';
41296
+ /** Result of the action attempt. Null for pending action attempts. */
41297
+ result: null;
41298
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41299
+ error: null;
41300
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
41301
+ action_type: 'ENCODE_CREDENTIAL';
41302
+ } | {
41303
+ /** ID of the action attempt. */
41304
+ action_attempt_id: string;
41305
+ status: 'success';
41306
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41307
+ error: null;
41308
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
41309
+ action_type: 'ENCODE_CREDENTIAL';
41310
+ /** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
41311
+ result: {
41312
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41313
+ acs_credential_id: string;
41314
+ /** 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. */
41315
+ acs_user_id?: string | undefined;
41316
+ /** 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. */
41317
+ user_identity_id?: string | undefined;
41318
+ /** 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. */
41319
+ connected_account_id: string;
41320
+ acs_credential_pool_id?: string | undefined;
41321
+ /** 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). */
41322
+ acs_system_id: string;
41323
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41324
+ parent_acs_credential_id?: string | undefined;
41325
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
41326
+ display_name: string;
41327
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41328
+ code?: (string | undefined) | null;
41329
+ /** 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. */
41330
+ is_one_time_use?: boolean | undefined;
41331
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41332
+ card_number?: (string | undefined) | null;
41333
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
41334
+ is_issued?: boolean | undefined;
41335
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
41336
+ issued_at?: (string | undefined) | null;
41337
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
41338
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
41339
+ /** 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`. */
41340
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
41341
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
41342
+ external_type_display_name?: string | undefined;
41343
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
41344
+ created_at: string;
41345
+ /** 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). */
41346
+ workspace_id: string;
41347
+ /** 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. */
41348
+ starts_at?: string | undefined;
41349
+ /** 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`. */
41350
+ ends_at?: string | undefined;
41351
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41352
+ errors: {
41353
+ error_code: string;
41354
+ message: string;
41355
+ }[];
41356
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41357
+ warnings: ({
41358
+ /** Date and time at which Seam created the warning. */
41359
+ created_at: string;
41360
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41361
+ message: string;
41362
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41363
+ warning_code: 'waiting_to_be_issued';
41364
+ } | {
41365
+ /** Date and time at which Seam created the warning. */
41366
+ created_at: string;
41367
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41368
+ message: string;
41369
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41370
+ warning_code: 'schedule_externally_modified';
41371
+ } | {
41372
+ /** Date and time at which Seam created the warning. */
41373
+ created_at: string;
41374
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41375
+ message: string;
41376
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41377
+ warning_code: 'schedule_modified';
41378
+ } | {
41379
+ /** Date and time at which Seam created the warning. */
41380
+ created_at: string;
41381
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41382
+ message: string;
41383
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41384
+ warning_code: 'being_deleted';
41385
+ } | {
41386
+ /** Date and time at which Seam created the warning. */
41387
+ created_at: string;
41388
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41389
+ message: string;
41390
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41391
+ warning_code: 'unknown_issue_with_acs_credential';
41392
+ } | {
41393
+ /** Date and time at which Seam created the warning. */
41394
+ created_at: string;
41395
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41396
+ message: string;
41397
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41398
+ warning_code: 'needs_to_be_reissued';
41399
+ })[];
41400
+ /** 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). */
41401
+ is_multi_phone_sync_credential?: boolean | undefined;
41402
+ /** 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. */
41403
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
41404
+ /** 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. */
41405
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
41406
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41407
+ visionline_metadata?: {
41408
+ /** Card function type in the Visionline access system. */
41409
+ card_function_type: 'guest' | 'staff';
41410
+ /** IDs of the credentials to which you want to join. */
41411
+ joiner_acs_credential_ids?: string[] | undefined;
41412
+ /** Guest entrance IDs in the Visionline access system. */
41413
+ guest_acs_entrance_ids?: string[] | undefined;
41414
+ /** Common entrance IDs in the Visionline access system. */
41415
+ common_acs_entrance_ids?: string[] | undefined;
41416
+ /** Indicates whether the credential is valid. */
41417
+ is_valid?: boolean | undefined;
41418
+ /** 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. */
41419
+ auto_join?: boolean | undefined;
41420
+ /** ID of the card in the Visionline access system. */
41421
+ card_id?: string | undefined;
41422
+ /** ID of the credential in the Visionline access system. */
41423
+ credential_id?: string | undefined;
41424
+ } | undefined;
41425
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41426
+ assa_abloy_vostio_metadata?: {
41427
+ /** 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. */
41428
+ auto_join?: boolean | undefined;
41429
+ /** IDs of the guest entrances to override in the Vostio access system. */
41430
+ override_guest_acs_entrance_ids?: string[] | undefined;
41431
+ /** Key ID in the Vostio access system. */
41432
+ key_id?: string | undefined;
41433
+ /** Key issuing request ID in the Vostio access system. */
41434
+ key_issuing_request_id?: string | undefined;
41435
+ /** Names of the doors to which to grant access in the Vostio access system. */
41436
+ door_names?: string[] | undefined;
41437
+ /** Endpoint ID in the Vostio access system. */
41438
+ endpoint_id?: string | undefined;
41439
+ } | undefined;
41440
+ is_managed: true;
41441
+ } | {
41442
+ /** ID of the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41443
+ acs_credential_id: string;
41444
+ /** 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. */
41445
+ acs_user_id?: string | undefined;
41446
+ /** 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. */
41447
+ user_identity_id?: string | undefined;
41448
+ /** 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. */
41449
+ connected_account_id: string;
41450
+ acs_credential_pool_id?: string | undefined;
41451
+ /** 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). */
41452
+ acs_system_id: string;
41453
+ /** ID of the parent [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41454
+ parent_acs_credential_id?: string | undefined;
41455
+ /** Display name that corresponds to the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
41456
+ display_name: string;
41457
+ /** Access (PIN) code for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41458
+ code?: (string | undefined) | null;
41459
+ /** 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. */
41460
+ is_one_time_use?: boolean | undefined;
41461
+ /** Number of the card associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41462
+ card_number?: (string | undefined) | null;
41463
+ /** Indicates whether the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) has been encoded onto a card. */
41464
+ is_issued?: boolean | undefined;
41465
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was encoded onto a card. */
41466
+ issued_at?: (string | undefined) | null;
41467
+ /** Access method for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
41468
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key';
41469
+ /** 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`. */
41470
+ external_type?: ('pti_card' | 'brivo_credential' | 'brivo_digital_credential' | 'hid_credential' | 'visionline_card' | 'salto_ks_credential' | 'assa_abloy_vostio_key' | 'salto_space_key' | 'latch_access' | 'dormakaba_ambiance_credential' | 'hotek_card') | undefined;
41471
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) type. */
41472
+ external_type_display_name?: string | undefined;
41473
+ /** Date and time at which the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials) was created. */
41474
+ created_at: string;
41475
+ /** 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). */
41476
+ workspace_id: string;
41477
+ /** 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. */
41478
+ starts_at?: string | undefined;
41479
+ /** 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`. */
41480
+ ends_at?: string | undefined;
41481
+ /** Errors associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41482
+ errors: {
41483
+ error_code: string;
41484
+ message: string;
41485
+ }[];
41486
+ /** Warnings associated with the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41487
+ warnings: ({
41488
+ /** Date and time at which Seam created the warning. */
41489
+ created_at: string;
41490
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41491
+ message: string;
41492
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41493
+ warning_code: 'waiting_to_be_issued';
41494
+ } | {
41495
+ /** Date and time at which Seam created the warning. */
41496
+ created_at: string;
41497
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41498
+ message: string;
41499
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41500
+ warning_code: 'schedule_externally_modified';
41501
+ } | {
41502
+ /** Date and time at which Seam created the warning. */
41503
+ created_at: string;
41504
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41505
+ message: string;
41506
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41507
+ warning_code: 'schedule_modified';
41508
+ } | {
41509
+ /** Date and time at which Seam created the warning. */
41510
+ created_at: string;
41511
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41512
+ message: string;
41513
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41514
+ warning_code: 'being_deleted';
41515
+ } | {
41516
+ /** Date and time at which Seam created the warning. */
41517
+ created_at: string;
41518
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41519
+ message: string;
41520
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41521
+ warning_code: 'unknown_issue_with_acs_credential';
41522
+ } | {
41523
+ /** Date and time at which Seam created the warning. */
41524
+ created_at: string;
41525
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
41526
+ message: string;
41527
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
41528
+ warning_code: 'needs_to_be_reissued';
41529
+ })[];
41530
+ /** 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). */
41531
+ is_multi_phone_sync_credential?: boolean | undefined;
41532
+ /** 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. */
41533
+ is_latest_desired_state_synced_with_provider?: (boolean | null) | undefined;
41534
+ /** 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. */
41535
+ latest_desired_state_synced_with_provider_at?: (string | null) | undefined;
41536
+ /** Visionline-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41537
+ visionline_metadata?: {
41538
+ /** Card function type in the Visionline access system. */
41539
+ card_function_type: 'guest' | 'staff';
41540
+ /** IDs of the credentials to which you want to join. */
41541
+ joiner_acs_credential_ids?: string[] | undefined;
41542
+ /** Guest entrance IDs in the Visionline access system. */
41543
+ guest_acs_entrance_ids?: string[] | undefined;
41544
+ /** Common entrance IDs in the Visionline access system. */
41545
+ common_acs_entrance_ids?: string[] | undefined;
41546
+ /** Indicates whether the credential is valid. */
41547
+ is_valid?: boolean | undefined;
41548
+ /** 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. */
41549
+ auto_join?: boolean | undefined;
41550
+ /** ID of the card in the Visionline access system. */
41551
+ card_id?: string | undefined;
41552
+ /** ID of the credential in the Visionline access system. */
41553
+ credential_id?: string | undefined;
41554
+ } | undefined;
41555
+ /** Vostio-specific metadata for the [credential](https://docs.seam.co/latest/capability-guides/access-systems/managing-credentials). */
41556
+ assa_abloy_vostio_metadata?: {
41557
+ /** 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. */
41558
+ auto_join?: boolean | undefined;
41559
+ /** IDs of the guest entrances to override in the Vostio access system. */
41560
+ override_guest_acs_entrance_ids?: string[] | undefined;
41561
+ /** Key ID in the Vostio access system. */
41562
+ key_id?: string | undefined;
41563
+ /** Key issuing request ID in the Vostio access system. */
41564
+ key_issuing_request_id?: string | undefined;
41565
+ /** Names of the doors to which to grant access in the Vostio access system. */
41566
+ door_names?: string[] | undefined;
41567
+ /** Endpoint ID in the Vostio access system. */
41568
+ endpoint_id?: string | undefined;
41569
+ } | undefined;
41570
+ is_managed: false;
41571
+ };
41572
+ } | {
41573
+ /** ID of the action attempt. */
41574
+ action_attempt_id: string;
41575
+ status: 'error';
41576
+ /** Result of the action attempt. Null for failed action attempts. */
41577
+ result: null;
41578
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
41579
+ action_type: 'ENCODE_CREDENTIAL';
41580
+ error: {
41581
+ /** Type of the error associated with the action attempt. */
41582
+ type: 'uncategorized_error';
41583
+ /** Message for the error associated with the action attempt. */
41584
+ message: string;
41585
+ } | {
41586
+ /** Type of the error associated with the action attempt. */
41587
+ type: 'action_attempt_expired';
41588
+ /** Message for the error associated with the action attempt. */
41589
+ message: string;
41590
+ } | {
41591
+ /** Error type to indicate that there is no credential on the encoder. */
41592
+ type: 'no_credential_on_encoder';
41593
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41594
+ message: string;
41595
+ } | {
41596
+ /** Error type to indicate an incompatible card format. */
41597
+ type: 'incompatible_card_format';
41598
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41599
+ message: string;
41600
+ } | {
41601
+ /** Error type to indicate that the affected credential cannot be reissued. */
41602
+ type: 'credential_cannot_be_reissued';
41603
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41604
+ message: string;
41605
+ } | {
41606
+ /** Error type to indicate that the encoder is not online. */
41607
+ type: 'encoder_not_online';
41608
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41609
+ message: string;
41610
+ };
41611
+ } | {
41612
+ /** ID of the action attempt. */
41613
+ action_attempt_id: string;
41614
+ status: 'pending';
41615
+ /** Result of the action attempt. Null for pending action attempts. */
41616
+ result: null;
41617
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41618
+ error: null;
41619
+ /** Action attempt to track the status of resetting a sandbox workspace. */
41620
+ action_type: 'RESET_SANDBOX_WORKSPACE';
41621
+ } | {
41622
+ /** ID of the action attempt. */
41623
+ action_attempt_id: string;
41624
+ status: 'success';
41625
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41626
+ error: null;
41627
+ /** Action attempt to track the status of resetting a sandbox workspace. */
41628
+ action_type: 'RESET_SANDBOX_WORKSPACE';
41629
+ /** Result of the action. */
41630
+ result: {};
41631
+ } | {
41632
+ /** ID of the action attempt. */
41633
+ action_attempt_id: string;
41634
+ status: 'error';
41635
+ /** Result of the action attempt. Null for failed action attempts. */
41636
+ result: null;
41637
+ /** Action attempt to track the status of resetting a sandbox workspace. */
41638
+ action_type: 'RESET_SANDBOX_WORKSPACE';
41639
+ /** Error associated with the action. */
41640
+ error: {
41641
+ /** Type of the error. */
41642
+ type: string;
41643
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41644
+ message: string;
41645
+ };
41646
+ } | {
41647
+ /** ID of the action attempt. */
41648
+ action_attempt_id: string;
41649
+ status: 'pending';
41650
+ /** Result of the action attempt. Null for pending action attempts. */
41651
+ result: null;
41652
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41653
+ error: null;
41654
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
41655
+ action_type: 'SET_FAN_MODE';
41656
+ } | {
41657
+ /** ID of the action attempt. */
41658
+ action_attempt_id: string;
41659
+ status: 'success';
41660
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41661
+ error: null;
41662
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
41663
+ action_type: 'SET_FAN_MODE';
41664
+ /** Result of the action. */
41665
+ result: {};
41666
+ } | {
41667
+ /** ID of the action attempt. */
41668
+ action_attempt_id: string;
41669
+ status: 'error';
41670
+ /** Result of the action attempt. Null for failed action attempts. */
41671
+ result: null;
41672
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
41673
+ action_type: 'SET_FAN_MODE';
41674
+ /** Error associated with the action. */
41675
+ error: {
41676
+ /** Type of the error. */
41677
+ type: string;
41678
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41679
+ message: string;
41680
+ };
41681
+ } | {
41682
+ /** ID of the action attempt. */
41683
+ action_attempt_id: string;
41684
+ status: 'pending';
41685
+ /** Result of the action attempt. Null for pending action attempts. */
41686
+ result: null;
41687
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41688
+ error: null;
41689
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
41690
+ action_type: 'SET_HVAC_MODE';
41691
+ } | {
41692
+ /** ID of the action attempt. */
41693
+ action_attempt_id: string;
41694
+ status: 'success';
41695
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41696
+ error: null;
41697
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
41698
+ action_type: 'SET_HVAC_MODE';
41699
+ /** Result of the action. */
41700
+ result: {};
41701
+ } | {
41702
+ /** ID of the action attempt. */
41703
+ action_attempt_id: string;
41704
+ status: 'error';
41705
+ /** Result of the action attempt. Null for failed action attempts. */
41706
+ result: null;
41707
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
41708
+ action_type: 'SET_HVAC_MODE';
41709
+ /** Error associated with the action. */
41710
+ error: {
41711
+ /** Type of the error. */
41712
+ type: string;
41713
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41714
+ message: string;
41715
+ };
41716
+ } | {
41717
+ /** ID of the action attempt. */
41718
+ action_attempt_id: string;
41719
+ status: 'pending';
41720
+ /** Result of the action attempt. Null for pending action attempts. */
41721
+ result: null;
41722
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41723
+ error: null;
41724
+ /** Action attempt to track the status of a climate preset activation. */
41725
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
41726
+ } | {
41727
+ /** ID of the action attempt. */
41728
+ action_attempt_id: string;
41729
+ status: 'success';
41730
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41731
+ error: null;
41732
+ /** Action attempt to track the status of a climate preset activation. */
41733
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
41734
+ /** Result of the action. */
41735
+ result: {};
41736
+ } | {
41737
+ /** ID of the action attempt. */
41738
+ action_attempt_id: string;
41739
+ status: 'error';
41740
+ /** Result of the action attempt. Null for failed action attempts. */
41741
+ result: null;
41742
+ /** Action attempt to track the status of a climate preset activation. */
41743
+ action_type: 'ACTIVATE_CLIMATE_PRESET';
41744
+ /** Error associated with the action. */
41745
+ error: {
41746
+ /** Type of the error. */
41747
+ type: string;
41748
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41749
+ message: string;
41750
+ };
41751
+ } | {
41752
+ /** ID of the action attempt. */
41753
+ action_attempt_id: string;
41754
+ status: 'pending';
41755
+ /** Result of the action attempt. Null for pending action attempts. */
41756
+ result: null;
41757
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41758
+ error: null;
41759
+ /** Action attempt to track the status of simulating a keypad code entry. */
41760
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
41761
+ } | {
41762
+ /** ID of the action attempt. */
41763
+ action_attempt_id: string;
41764
+ status: 'success';
41765
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41766
+ error: null;
41767
+ /** Action attempt to track the status of simulating a keypad code entry. */
41768
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
41769
+ /** Result of the action. */
41770
+ result: {};
41771
+ } | {
41772
+ /** ID of the action attempt. */
41773
+ action_attempt_id: string;
41774
+ status: 'error';
41775
+ /** Result of the action attempt. Null for failed action attempts. */
41776
+ result: null;
41777
+ /** Action attempt to track the status of simulating a keypad code entry. */
41778
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY';
41779
+ /** Error associated with the action. */
41780
+ error: {
41781
+ /** Type of the error. */
41782
+ type: string;
41783
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41784
+ message: string;
41785
+ };
41786
+ } | {
41787
+ /** ID of the action attempt. */
41788
+ action_attempt_id: string;
41789
+ status: 'pending';
41790
+ /** Result of the action attempt. Null for pending action attempts. */
41791
+ result: null;
41792
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41793
+ error: null;
41794
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
41795
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
41796
+ } | {
41797
+ /** ID of the action attempt. */
41798
+ action_attempt_id: string;
41799
+ status: 'success';
41800
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41801
+ error: null;
41802
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
41803
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
41804
+ /** Result of the action. */
41805
+ result: {};
41806
+ } | {
41807
+ /** ID of the action attempt. */
41808
+ action_attempt_id: string;
41809
+ status: 'error';
41810
+ /** Result of the action attempt. Null for failed action attempts. */
41811
+ result: null;
41812
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
41813
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD';
41814
+ /** Error associated with the action. */
41815
+ error: {
41816
+ /** Type of the error. */
41817
+ type: string;
41818
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41819
+ message: string;
41820
+ };
41821
+ } | {
41822
+ /** ID of the action attempt. */
41823
+ action_attempt_id: string;
41824
+ status: 'pending';
41825
+ /** Result of the action attempt. Null for pending action attempts. */
41826
+ result: null;
41827
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41828
+ error: null;
41829
+ /** Action attempt to track the status of pushing thermostat programs. */
41830
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
41831
+ } | {
41832
+ /** ID of the action attempt. */
41833
+ action_attempt_id: string;
41834
+ status: 'success';
41835
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41836
+ error: null;
41837
+ /** Action attempt to track the status of pushing thermostat programs. */
41838
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
41839
+ /** Result of the action. */
41840
+ result: {};
41841
+ } | {
41842
+ /** ID of the action attempt. */
41843
+ action_attempt_id: string;
41844
+ status: 'error';
41845
+ /** Result of the action attempt. Null for failed action attempts. */
41846
+ result: null;
41847
+ /** Action attempt to track the status of pushing thermostat programs. */
41848
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS';
41849
+ /** Error associated with the action. */
41850
+ error: {
41851
+ /** Type of the error. */
41852
+ type: string;
41853
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41854
+ message: string;
41855
+ };
41856
+ } | {
41857
+ /** ID of the action attempt. */
41858
+ action_attempt_id: string;
41859
+ status: 'pending';
41860
+ /** Result of the action attempt. Null for pending action attempts. */
41861
+ result: null;
41862
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41863
+ error: null;
41864
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
41865
+ action_type: 'CONFIGURE_AUTO_LOCK';
41866
+ } | {
41867
+ /** ID of the action attempt. */
41868
+ action_attempt_id: string;
41869
+ status: 'success';
41870
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41871
+ error: null;
41872
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
41873
+ action_type: 'CONFIGURE_AUTO_LOCK';
41874
+ /** Result of the action. */
41875
+ result: {};
41876
+ } | {
41877
+ /** ID of the action attempt. */
41878
+ action_attempt_id: string;
41879
+ status: 'error';
41880
+ /** Result of the action attempt. Null for failed action attempts. */
41881
+ result: null;
41882
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
41883
+ action_type: 'CONFIGURE_AUTO_LOCK';
41884
+ /** Error associated with the action. */
41885
+ error: {
41886
+ /** Type of the error. */
41887
+ type: string;
41888
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41889
+ message: string;
41890
+ };
41891
+ } | {
41892
+ /** ID of the action attempt. */
41893
+ action_attempt_id: string;
41894
+ status: 'pending';
41895
+ /** Result of the action attempt. Null for pending action attempts. */
41896
+ result: null;
41897
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41898
+ error: null;
41899
+ /** Syncing access codes is pending. */
41900
+ action_type: 'SYNC_ACCESS_CODES';
41901
+ } | {
41902
+ /** ID of the action attempt. */
41903
+ action_attempt_id: string;
41904
+ status: 'success';
41905
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41906
+ error: null;
41907
+ /** Syncing access codes succeeded. */
41908
+ action_type: 'SYNC_ACCESS_CODES';
41909
+ /** Result of the action. */
41910
+ result: {};
41911
+ } | {
41912
+ /** ID of the action attempt. */
41913
+ action_attempt_id: string;
41914
+ status: 'error';
41915
+ /** Result of the action attempt. Null for failed action attempts. */
41916
+ result: null;
41917
+ /** Syncing access codes failed. */
41918
+ action_type: 'SYNC_ACCESS_CODES';
41919
+ /** Error associated with the action. */
41920
+ error: {
41921
+ /** Type of the error. */
41922
+ type: string;
41923
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41924
+ message: string;
41925
+ };
41926
+ } | {
41927
+ /** ID of the action attempt. */
41928
+ action_attempt_id: string;
41929
+ status: 'pending';
41930
+ /** Result of the action attempt. Null for pending action attempts. */
41931
+ result: null;
41932
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41933
+ error: null;
41934
+ /** Creating an access code is pending. */
41935
+ action_type: 'CREATE_ACCESS_CODE';
41936
+ } | {
41937
+ /** ID of the action attempt. */
41938
+ action_attempt_id: string;
41939
+ status: 'success';
41940
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41941
+ error: null;
41942
+ /** Creating an access code succeeded. */
41943
+ action_type: 'CREATE_ACCESS_CODE';
41944
+ /** Result of the action. */
41945
+ result: {
41946
+ /** Created access code. */
41947
+ access_code?: any;
41948
+ };
41949
+ } | {
41950
+ /** ID of the action attempt. */
41951
+ action_attempt_id: string;
41952
+ status: 'error';
41953
+ /** Result of the action attempt. Null for failed action attempts. */
41954
+ result: null;
41955
+ /** Creating an access code failed. */
41956
+ action_type: 'CREATE_ACCESS_CODE';
41957
+ /** Error associated with the action. */
41958
+ error: {
41959
+ /** Type of the error. */
41960
+ type: string;
41961
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41962
+ message: string;
41963
+ };
41964
+ } | {
41965
+ /** ID of the action attempt. */
41966
+ action_attempt_id: string;
41967
+ status: 'pending';
41968
+ /** Result of the action attempt. Null for pending action attempts. */
41969
+ result: null;
41970
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41971
+ error: null;
41972
+ /** Deleting an access code is pending. */
41973
+ action_type: 'DELETE_ACCESS_CODE';
41974
+ } | {
41975
+ /** ID of the action attempt. */
41976
+ action_attempt_id: string;
41977
+ status: 'success';
41978
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41979
+ error: null;
41980
+ /** Deleting an access code succeeded. */
41981
+ action_type: 'DELETE_ACCESS_CODE';
41982
+ /** Result of the action. */
41983
+ result: {};
41984
+ } | {
41985
+ /** ID of the action attempt. */
41986
+ action_attempt_id: string;
41987
+ status: 'error';
41988
+ /** Result of the action attempt. Null for failed action attempts. */
41989
+ result: null;
41990
+ /** Deleting an access code failed. */
41991
+ action_type: 'DELETE_ACCESS_CODE';
41992
+ /** Error associated with the action. */
41993
+ error: {
41994
+ /** Type of the error. */
41995
+ type: string;
41996
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41997
+ message: string;
41998
+ };
41999
+ } | {
42000
+ /** ID of the action attempt. */
42001
+ action_attempt_id: string;
42002
+ status: 'pending';
42003
+ /** Result of the action attempt. Null for pending action attempts. */
42004
+ result: null;
42005
+ /** Errors associated with the action attempt. Null for pending action attempts. */
42006
+ error: null;
42007
+ /** Updating an access code is pending. */
42008
+ action_type: 'UPDATE_ACCESS_CODE';
42009
+ } | {
42010
+ /** ID of the action attempt. */
42011
+ action_attempt_id: string;
42012
+ status: 'success';
42013
+ /** Errors associated with the action attempt. Null for successful action attempts. */
42014
+ error: null;
42015
+ /** Updating an access code succeeded. */
42016
+ action_type: 'UPDATE_ACCESS_CODE';
42017
+ /** Result of the action. */
42018
+ result: {
42019
+ /** Updated access code. */
42020
+ access_code?: any;
42021
+ };
42022
+ } | {
42023
+ /** ID of the action attempt. */
42024
+ action_attempt_id: string;
42025
+ status: 'error';
42026
+ /** Result of the action attempt. Null for failed action attempts. */
42027
+ result: null;
42028
+ /** Updating an access code failed. */
42029
+ action_type: 'UPDATE_ACCESS_CODE';
42030
+ /** Error associated with the action. */
42031
+ error: {
42032
+ /** Type of the error. */
42033
+ type: string;
42034
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
42035
+ message: string;
42036
+ };
42037
+ } | {
42038
+ /** ID of the action attempt. */
42039
+ action_attempt_id: string;
42040
+ status: 'pending';
42041
+ /** Result of the action attempt. Null for pending action attempts. */
42042
+ result: null;
42043
+ /** Errors associated with the action attempt. Null for pending action attempts. */
42044
+ error: null;
42045
+ /** Creating a noise threshold is pending. */
42046
+ action_type: 'CREATE_NOISE_THRESHOLD';
42047
+ } | {
42048
+ /** ID of the action attempt. */
42049
+ action_attempt_id: string;
42050
+ status: 'success';
42051
+ /** Errors associated with the action attempt. Null for successful action attempts. */
42052
+ error: null;
42053
+ /** Creating a noise threshold succeeded. */
42054
+ action_type: 'CREATE_NOISE_THRESHOLD';
42055
+ /** Result of the action. */
42056
+ result: {
42057
+ /** Created noise threshold. */
42058
+ noise_threshold?: any;
42059
+ };
42060
+ } | {
42061
+ /** ID of the action attempt. */
42062
+ action_attempt_id: string;
42063
+ status: 'error';
42064
+ /** Result of the action attempt. Null for failed action attempts. */
42065
+ result: null;
42066
+ /** Creating a noise threshold failed. */
42067
+ action_type: 'CREATE_NOISE_THRESHOLD';
42068
+ /** Error associated with the action. */
42069
+ error: {
42070
+ /** Type of the error. */
42071
+ type: string;
42072
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
42073
+ message: string;
42074
+ };
42075
+ } | {
42076
+ /** ID of the action attempt. */
42077
+ action_attempt_id: string;
42078
+ status: 'pending';
42079
+ /** Result of the action attempt. Null for pending action attempts. */
42080
+ result: null;
42081
+ /** Errors associated with the action attempt. Null for pending action attempts. */
42082
+ error: null;
42083
+ /** Deleting a noise threshold is pending. */
42084
+ action_type: 'DELETE_NOISE_THRESHOLD';
42085
+ } | {
42086
+ /** ID of the action attempt. */
42087
+ action_attempt_id: string;
42088
+ status: 'success';
42089
+ /** Errors associated with the action attempt. Null for successful action attempts. */
42090
+ error: null;
42091
+ /** Deleting a noise threshold succeeded. */
42092
+ action_type: 'DELETE_NOISE_THRESHOLD';
42093
+ /** Result of the action. */
42094
+ result: {};
42095
+ } | {
42096
+ /** ID of the action attempt. */
42097
+ action_attempt_id: string;
42098
+ status: 'error';
42099
+ /** Result of the action attempt. Null for failed action attempts. */
42100
+ result: null;
42101
+ /** Deleting a noise threshold failed. */
42102
+ action_type: 'DELETE_NOISE_THRESHOLD';
42103
+ /** Error associated with the action. */
42104
+ error: {
42105
+ /** Type of the error. */
42106
+ type: string;
42107
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
42108
+ message: string;
42109
+ };
42110
+ } | {
42111
+ /** ID of the action attempt. */
42112
+ action_attempt_id: string;
42113
+ status: 'pending';
42114
+ /** Result of the action attempt. Null for pending action attempts. */
42115
+ result: null;
42116
+ /** Errors associated with the action attempt. Null for pending action attempts. */
42117
+ error: null;
42118
+ /** Updating a noise threshold is pending. */
42119
+ action_type: 'UPDATE_NOISE_THRESHOLD';
42120
+ } | {
42121
+ /** ID of the action attempt. */
42122
+ action_attempt_id: string;
42123
+ status: 'success';
42124
+ /** Errors associated with the action attempt. Null for successful action attempts. */
42125
+ error: null;
42126
+ /** Updating a noise threshold succeeded. */
42127
+ action_type: 'UPDATE_NOISE_THRESHOLD';
42128
+ /** Result of the action. */
42129
+ result: {
42130
+ /** Updated noise threshold. */
42131
+ noise_threshold?: any;
42132
+ };
42133
+ } | {
42134
+ /** ID of the action attempt. */
42135
+ action_attempt_id: string;
42136
+ status: 'error';
42137
+ /** Result of the action attempt. Null for failed action attempts. */
42138
+ result: null;
42139
+ /** Updating a noise threshold failed. */
42140
+ action_type: 'UPDATE_NOISE_THRESHOLD';
42141
+ /** Error associated with the action. */
42142
+ error: {
42143
+ /** Type of the error. */
42144
+ type: string;
42145
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
42146
+ message: string;
42147
+ };
42148
+ };
42149
+ };
42150
+ maxDuration: undefined;
42151
+ };
42152
+ '/locks/get': {
42153
+ route: '/locks/get';
42154
+ method: 'GET' | 'POST';
42155
+ queryParams: {};
42156
+ jsonBody: {};
42157
+ commonParams: {
42158
+ /** ID of the lock that you want to get. */
42159
+ device_id?: string | undefined;
42160
+ /** Name of the lock that you want to get. */
42161
+ name?: string | undefined;
42162
+ };
42163
+ formData: {};
42164
+ jsonResponse: {
42165
+ /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
42166
+ lock: {
42167
+ /** ID of the device. */
42168
+ device_id: string;
42169
+ /** Type of the device. */
42170
+ device_type: ('akuvox_lock' | 'august_lock' | 'brivo_access_point' | 'butterflymx_panel' | 'avigilon_alta_entry' | 'doorking_lock' | 'genie_door' | 'igloo_lock' | 'linear_lock' | 'lockly_lock' | 'kwikset_lock' | 'nuki_lock' | 'salto_lock' | 'schlage_lock' | 'smartthings_lock' | 'wyze_lock' | 'yale_lock' | 'two_n_intercom' | 'controlbyweb_device' | 'ttlock_lock' | 'igloohome_lock' | 'four_suites_door' | 'dormakaba_oracode_door' | 'tedee_lock' | 'akiles_lock' | 'ultraloq_lock' | 'korelock_lock') | 'keynest_key' | ('noiseaware_activity_zone' | 'minut_sensor') | ('ecobee_thermostat' | 'nest_thermostat' | 'honeywell_resideo_thermostat' | 'tado_thermostat' | 'sensi_thermostat' | 'smartthings_thermostat') | ('ios_phone' | 'android_phone') | 'ring_camera';
42171
+ /** IDs of the spaces the device is in. */
42172
+ space_ids: string[];
42173
+ /** Optional nickname to describe the device, settable through Seam. */
42174
+ nickname?: string | undefined;
42175
+ /** 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. */
42176
+ display_name: string;
42177
+ /**
42178
+ 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).
42179
+ */
42180
+ capabilities_supported: ('access_code' | 'lock' | 'noise_detection' | 'thermostat' | 'battery' | 'phone')[];
42181
+ /** Properties of the device. */
42182
+ properties: (({
42183
+ /** Indicates whether the device is online. */
42184
+ online: boolean;
42185
+ /** Name of the device.
42186
+ * @deprecated use device.display_name instead*/
42187
+ name: string;
42188
+ /** Accessory keypad properties and state. */
42189
+ accessory_keypad?: {
42190
+ /** Indicates if an accessory keypad is connected to the device.
42191
+ */
42192
+ is_connected: boolean;
42193
+ /** Keypad battery properties.
42194
+ */
42195
+ battery?: {
42196
+ level: number;
42197
+ } | undefined;
42198
+ } | undefined;
42199
+ /** Appearance-related properties, as reported by the device. */
42200
+ appearance: {
42201
+ /** Name of the device as seen from the provider API and application, not settable through Seam. */
42202
+ name: string;
42203
+ };
42204
+ /** Device model-related properties. */
42205
+ model: {
42206
+ /**
42207
+ Indicates whether the device can connect a accessory keypad.
42208
+ */
42209
+ can_connect_accessory_keypad?: boolean | undefined;
42210
+ /**
42211
+ Display name of the device model.
42212
+ */
42213
+ display_name: string;
42214
+ /**
42215
+ Display name that corresponds to the manufacturer-specific terminology for the device.
42216
+ */
42217
+ manufacturer_display_name: string;
42218
+ /**
42219
+ Indicates whether the device has a built in accessory keypad.
42220
+ */
42221
+ has_built_in_keypad?: boolean | undefined;
42222
+ /**
42223
+ * @deprecated use device.can_program_offline_access_codes.*/
42224
+ offline_access_codes_supported?: boolean | undefined;
42225
+ /**
42226
+ * @deprecated use device.can_program_online_access_codes.*/
42227
+ online_access_codes_supported?: boolean | undefined;
42228
+ /**
42229
+ * @deprecated use device.properties.model.can_connect_accessory_keypad*/
42230
+ accessory_keypad_supported?: boolean | undefined;
42231
+ };
42232
+ /** Indicates whether the device has direct power. */
42233
+ has_direct_power?: boolean | undefined;
42234
+ /** Indicates the battery level of the device as a decimal value between 0 and 1, inclusive. */
42235
+ battery_level?: number | undefined;
42236
+ /** Represents the current status of the battery charge level. */
42237
+ battery?: {
42238
+ /** Battery charge level as a value between 0 and 1, inclusive.
42239
+ */
42240
+ level: number;
42241
+ /** 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.
42242
+ */
42243
+ status: 'critical' | 'low' | 'good' | 'full';
42244
+ } | undefined;
42245
+ /** 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. */
42246
+ manufacturer?: string | undefined;
42247
+ /** Image URL for the device. */
42248
+ image_url?: string | undefined;
42249
+ /** Alt text for the device image. */
42250
+ image_alt_text?: string | undefined;
42251
+ /** Serial number of the device. */
42252
+ serial_number?: string | undefined;
42253
+ /** Indicates whether it is currently possible to use online access codes for the device.
42254
+ * @deprecated use device.can_program_online_access_codes*/
42255
+ online_access_codes_enabled?: boolean | undefined;
42256
+ /** Indicates whether it is currently possible to use offline access codes for the device.
42257
+ * @deprecated use device.can_program_offline_access_codes*/
42258
+ offline_access_codes_enabled?: boolean | undefined;
42259
+ /**
42260
+ * @deprecated use device.properties.model.can_connect_accessory_keypad*/
42261
+ supports_accessory_keypad?: boolean | undefined;
42262
+ /**
42263
+ * @deprecated use offline_access_codes_enabled*/
42264
+ supports_offline_access_codes?: boolean | undefined;
42265
+ /** Indicates current noise level in decibels, if the device supports noise detection. */
42266
+ noise_level_decibels?: number | undefined;
42267
+ /** Array of noise threshold IDs that are currently triggering. */
42268
+ currently_triggering_noise_threshold_ids?: string[] | undefined;
42269
+ } & {
42270
+ /** ASSA ABLOY Credential Service metadata for the phone. */
42271
+ assa_abloy_credential_service_metadata?: ({
42272
+ /** Indicates whether the credential service has active endpoints associated with the phone. */
42273
+ has_active_endpoint: boolean;
42274
+ /** Endpoints associated with the phone. */
42275
+ endpoints: {
42276
+ /** ID of the associated endpoint. */
42277
+ endpoint_id: string;
42278
+ /** Indicated whether the endpoint is active. */
42279
+ is_active: boolean;
42280
+ }[];
42281
+ } | undefined) | undefined;
42282
+ /** Salto Space credential service metadata for the phone. */
42283
+ salto_space_credential_service_metadata?: ({
42284
+ /** Indicates whether the credential service has an active associated phone. */
42285
+ has_active_phone: boolean;
42286
+ } | undefined) | undefined;
42287
+ }) & {
42288
+ /** Metadata for an August device. */
42289
+ august_metadata?: {
42290
+ /** Lock ID for an August device. */
42291
+ lock_id: string;
42292
+ /** Lock name for an August device. */
42293
+ lock_name: string;
42294
+ /** House name for an August device. */
42295
+ house_name: string;
42296
+ /** Indicates whether an August device has a keypad. */
42297
+ has_keypad: boolean;
42298
+ /** Keypad battery level for an August device. */
42299
+ keypad_battery_level?: string | undefined;
42300
+ /** Model for an August device. */
42301
+ model?: string | undefined;
42302
+ /** House ID for an August device. */
42303
+ house_id?: string | undefined;
42304
+ } | undefined;
42305
+ /** Metadata for an Avigilon Alta system. */
42306
+ avigilon_alta_metadata?: {
42307
+ /** Entry name for an Avigilon Alta system. */
42308
+ entry_name: string;
42309
+ /** Organization name for an Avigilon Alta system. */
42310
+ org_name: string;
42311
+ /** Zone ID for an Avigilon Alta system. */
42312
+ zone_id: number;
42313
+ /** Zone name for an Avigilon Alta system. */
42314
+ zone_name: string;
42315
+ /** Site ID for an Avigilon Alta system. */
42316
+ site_id: number;
42317
+ /** Site name for an Avigilon Alta system. */
42318
+ site_name: string;
42319
+ /** Total count of entry relays for an Avigilon Alta system. */
42320
+ entry_relays_total_count: number;
42321
+ } | undefined;
42322
+ /** Metadata for a Schlage device. */
42323
+ schlage_metadata?: {
42324
+ /** Device ID for a Schlage device. */
42325
+ device_id: string;
42326
+ /** Device name for a Schlage device. */
42327
+ device_name: string;
42328
+ /** Model for a Schlage device. */
42329
+ model?: string | undefined;
42330
+ } | undefined;
42331
+ /** Metadata for a SmartThings device. */
42332
+ smartthings_metadata?: {
42333
+ /** Device ID for a SmartThings device. */
42334
+ device_id: string;
42335
+ /** Device name for a SmartThings device. */
42336
+ device_name: string;
42337
+ /** Model for a SmartThings device. */
42338
+ model?: string | undefined;
42339
+ /** Location ID for a SmartThings device. */
42340
+ location_id?: string | undefined;
42341
+ } | undefined;
42342
+ /** Metadata for a Lockly device. */
42343
+ lockly_metadata?: {
42344
+ /** Device ID for a Lockly device. */
42345
+ device_id: string;
42346
+ /** Device name for a Lockly device. */
42347
+ device_name: string;
42348
+ /** Model for a Lockly device. */
42349
+ model?: string | undefined;
42350
+ } | undefined;
42351
+ /** Metadata for a Nuki device. */
42352
+ nuki_metadata?: {
42353
+ /** Device ID for a Nuki device. */
42354
+ device_id: string;
42355
+ /** Device name for a Nuki device. */
42356
+ device_name: string;
42357
+ /** Indicates whether the keypad battery is in a critical state for a Nuki device. */
42358
+ keypad_battery_critical?: boolean | undefined;
42359
+ /** Indicates whether the keypad is paired for a Nuki device. */
42360
+ keypad_paired?: boolean | undefined;
42361
+ /** Indicates whether keypad 2 is paired for a Nuki device. */
42362
+ keypad_2_paired?: boolean | undefined;
42363
+ } | undefined;
42364
+ /** Metadata for a Kwikset device. */
42365
+ kwikset_metadata?: {
42366
+ /** Device ID for a Kwikset device. */
42367
+ device_id: string;
42368
+ /** Device name for a Kwikset device. */
42369
+ device_name: string;
42370
+ /** Model number for a Kwikset device. */
42371
+ model_number: string;
42372
+ } | undefined;
42373
+ /** Metada for a Salto device.
42374
+ * @deprecated Use `salto_ks_metadata ` instead.*/
42375
+ salto_metadata?: {
42376
+ /** Lock ID for a Salto device. */
42377
+ lock_id: string;
42378
+ /** Customer reference for a Salto device. */
42379
+ customer_reference: string;
42380
+ /** Lock type for a Salto device. */
42381
+ lock_type: string;
42382
+ /** Battery level for a Salto device. */
42383
+ battery_level: string;
42384
+ /** Locked state for a Salto device. */
42385
+ locked_state: string;
42386
+ /** Model for a Salto device. */
42387
+ model?: string | undefined;
42388
+ /** Site ID for the Salto KS site to which the device belongs. */
42389
+ site_id?: string | undefined;
42390
+ /** Site name for the Salto KS site to which the device belongs. */
42391
+ site_name?: string | undefined;
42392
+ } | undefined;
42393
+ /** Metadata for a Salto KS device. */
42394
+ salto_ks_metadata?: {
42395
+ /** Lock ID for a Salto KS device. */
42396
+ lock_id: string;
42397
+ /** Customer reference for a Salto KS device. */
42398
+ customer_reference: string;
42399
+ /** Lock type for a Salto KS device. */
42400
+ lock_type: string;
42401
+ /** Battery level for a Salto KS device. */
42402
+ battery_level: string;
42403
+ /** Locked state for a Salto KS device. */
42404
+ locked_state: string;
42405
+ /** Model for a Salto KS device. */
42406
+ model?: string | undefined;
42407
+ /** Indicates whether the site has a Salto KS subscription that supports custom PINs. */
42408
+ has_custom_pin_subscription?: boolean | undefined;
42409
+ /** Site ID for the Salto KS site to which the device belongs. */
42410
+ site_id?: string | undefined;
42411
+ /** Site name for the Salto KS site to which the device belongs. */
42412
+ site_name?: string | undefined;
42413
+ } | undefined;
42414
+ /** Metadata for a Genie device. */
42415
+ genie_metadata?: {
42416
+ /** Lock name for a Genie device. */
42417
+ device_name: string;
42418
+ /** Door name for a Genie device. */
42419
+ door_name: string;
42420
+ } | undefined;
42421
+ /** Metadata for a Brivo device. */
42422
+ brivo_metadata?: {
42423
+ /** Device name for a Brivo device. */
42424
+ device_name?: string | undefined;
42425
+ /** Indicates whether the Brivo access point has activation (remote unlock) enabled. */
42426
+ activation_enabled?: boolean | undefined;
42427
+ } | undefined;
42428
+ /** Metadata for an igloo device. */
42429
+ igloo_metadata?: {
42430
+ /** Device ID for an igloo device. */
42431
+ device_id: string;
42432
+ /** Bridge ID for an igloo device. */
42433
+ bridge_id: string;
42434
+ /** Model for an igloo device. */
42435
+ model?: string | undefined;
42436
+ } | undefined;
42437
+ /** Metadata for a NoiseAware device. */
42438
+ noiseaware_metadata?: {
42439
+ /** Device model for a NoiseAware device. */
42440
+ device_model: 'indoor' | 'outdoor';
42441
+ /** Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device. */
42442
+ noise_level_nrs: number;
42443
+ /** Noise level, in decibels, for a NoiseAware device. */
42444
+ noise_level_decibel: number;
42445
+ /** Device name for a NoiseAware device. */
42446
+ device_name: string;
42447
+ /** Device ID for a NoiseAware device. */
42448
+ device_id: string;
42449
+ } | undefined;
42450
+ /** Metadata for a Minut device. */
42451
+ minut_metadata?: {
42452
+ /** Device ID for a Minut device. */
42453
+ device_id: string;
42454
+ /** Device name for a Minut device. */
40758
42455
  device_name: string;
40759
42456
  /** Latest sensor values for a Minut device. */
40760
42457
  latest_sensor_values: {
@@ -40842,6 +42539,8 @@ export type Routes = {
40842
42539
  incomplete_keyboard_passcode: boolean;
40843
42540
  /** Indicates whether a TTLock device supports Wi-Fi. */
40844
42541
  wifi: boolean;
42542
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
42543
+ auto_lock_time_config: boolean;
40845
42544
  };
40846
42545
  /** Indicates whether a TTLock device has a gateway. */
40847
42546
  has_gateway?: boolean | undefined;
@@ -41131,6 +42830,10 @@ export type Routes = {
41131
42830
  } | undefined) | undefined;
41132
42831
  /** Indicates whether the door is open. */
41133
42832
  door_open?: (boolean | undefined) | undefined;
42833
+ /** Indicates whether automatic locking is enabled. */
42834
+ auto_lock_enabled?: (boolean | undefined) | undefined;
42835
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
42836
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
41134
42837
  } & {
41135
42838
  /** Reported temperature in °F. */
41136
42839
  temperature_fahrenheit?: number | undefined;
@@ -41777,6 +43480,7 @@ export type Routes = {
41777
43480
  can_simulate_hub_connection?: boolean | undefined;
41778
43481
  can_simulate_hub_disconnection?: boolean | undefined;
41779
43482
  can_simulate_paid_subscription?: boolean | undefined;
43483
+ can_configure_auto_lock?: boolean | undefined;
41780
43484
  };
41781
43485
  /** Represents a [device](https://docs.seam.co/latest/core-concepts/devices) that has been connected to Seam. */
41782
43486
  device: {
@@ -42155,6 +43859,8 @@ export type Routes = {
42155
43859
  incomplete_keyboard_passcode: boolean;
42156
43860
  /** Indicates whether a TTLock device supports Wi-Fi. */
42157
43861
  wifi: boolean;
43862
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
43863
+ auto_lock_time_config: boolean;
42158
43864
  };
42159
43865
  /** Indicates whether a TTLock device has a gateway. */
42160
43866
  has_gateway?: boolean | undefined;
@@ -42444,6 +44150,10 @@ export type Routes = {
42444
44150
  } | undefined) | undefined;
42445
44151
  /** Indicates whether the door is open. */
42446
44152
  door_open?: (boolean | undefined) | undefined;
44153
+ /** Indicates whether automatic locking is enabled. */
44154
+ auto_lock_enabled?: (boolean | undefined) | undefined;
44155
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
44156
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
42447
44157
  } & {
42448
44158
  /** Reported temperature in °F. */
42449
44159
  temperature_fahrenheit?: number | undefined;
@@ -43090,6 +44800,7 @@ export type Routes = {
43090
44800
  can_simulate_hub_connection?: boolean | undefined;
43091
44801
  can_simulate_hub_disconnection?: boolean | undefined;
43092
44802
  can_simulate_paid_subscription?: boolean | undefined;
44803
+ can_configure_auto_lock?: boolean | undefined;
43093
44804
  };
43094
44805
  };
43095
44806
  maxDuration: undefined;
@@ -43129,9 +44840,9 @@ export type Routes = {
43129
44840
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
43130
44841
  page_cursor?: (string | undefined) | null;
43131
44842
  /** */
43132
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
44843
+ include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
43133
44844
  /** */
43134
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
44845
+ exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
43135
44846
  /**
43136
44847
  * @deprecated Use `space_id`.*/
43137
44848
  unstable_location_id?: (string | null) | undefined;
@@ -43518,6 +45229,8 @@ export type Routes = {
43518
45229
  incomplete_keyboard_passcode: boolean;
43519
45230
  /** Indicates whether a TTLock device supports Wi-Fi. */
43520
45231
  wifi: boolean;
45232
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
45233
+ auto_lock_time_config: boolean;
43521
45234
  };
43522
45235
  /** Indicates whether a TTLock device has a gateway. */
43523
45236
  has_gateway?: boolean | undefined;
@@ -43807,6 +45520,10 @@ export type Routes = {
43807
45520
  } | undefined) | undefined;
43808
45521
  /** Indicates whether the door is open. */
43809
45522
  door_open?: (boolean | undefined) | undefined;
45523
+ /** Indicates whether automatic locking is enabled. */
45524
+ auto_lock_enabled?: (boolean | undefined) | undefined;
45525
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
45526
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
43810
45527
  } & {
43811
45528
  /** Reported temperature in °F. */
43812
45529
  temperature_fahrenheit?: number | undefined;
@@ -44453,6 +46170,7 @@ export type Routes = {
44453
46170
  can_simulate_hub_connection?: boolean | undefined;
44454
46171
  can_simulate_hub_disconnection?: boolean | undefined;
44455
46172
  can_simulate_paid_subscription?: boolean | undefined;
46173
+ can_configure_auto_lock?: boolean | undefined;
44456
46174
  }[];
44457
46175
  devices: {
44458
46176
  /** ID of the device. */
@@ -44830,6 +46548,8 @@ export type Routes = {
44830
46548
  incomplete_keyboard_passcode: boolean;
44831
46549
  /** Indicates whether a TTLock device supports Wi-Fi. */
44832
46550
  wifi: boolean;
46551
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
46552
+ auto_lock_time_config: boolean;
44833
46553
  };
44834
46554
  /** Indicates whether a TTLock device has a gateway. */
44835
46555
  has_gateway?: boolean | undefined;
@@ -45119,6 +46839,10 @@ export type Routes = {
45119
46839
  } | undefined) | undefined;
45120
46840
  /** Indicates whether the door is open. */
45121
46841
  door_open?: (boolean | undefined) | undefined;
46842
+ /** Indicates whether automatic locking is enabled. */
46843
+ auto_lock_enabled?: (boolean | undefined) | undefined;
46844
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
46845
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
45122
46846
  } & {
45123
46847
  /** Reported temperature in °F. */
45124
46848
  temperature_fahrenheit?: number | undefined;
@@ -45765,6 +47489,7 @@ export type Routes = {
45765
47489
  can_simulate_hub_connection?: boolean | undefined;
45766
47490
  can_simulate_hub_disconnection?: boolean | undefined;
45767
47491
  can_simulate_paid_subscription?: boolean | undefined;
47492
+ can_configure_auto_lock?: boolean | undefined;
45768
47493
  }[];
45769
47494
  };
45770
47495
  maxDuration: undefined;
@@ -46785,6 +48510,41 @@ export type Routes = {
46785
48510
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
46786
48511
  message: string;
46787
48512
  };
48513
+ } | {
48514
+ /** ID of the action attempt. */
48515
+ action_attempt_id: string;
48516
+ status: 'pending';
48517
+ /** Result of the action attempt. Null for pending action attempts. */
48518
+ result: null;
48519
+ /** Errors associated with the action attempt. Null for pending action attempts. */
48520
+ error: null;
48521
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
48522
+ action_type: 'CONFIGURE_AUTO_LOCK';
48523
+ } | {
48524
+ /** ID of the action attempt. */
48525
+ action_attempt_id: string;
48526
+ status: 'success';
48527
+ /** Errors associated with the action attempt. Null for successful action attempts. */
48528
+ error: null;
48529
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
48530
+ action_type: 'CONFIGURE_AUTO_LOCK';
48531
+ /** Result of the action. */
48532
+ result: {};
48533
+ } | {
48534
+ /** ID of the action attempt. */
48535
+ action_attempt_id: string;
48536
+ status: 'error';
48537
+ /** Result of the action attempt. Null for failed action attempts. */
48538
+ result: null;
48539
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
48540
+ action_type: 'CONFIGURE_AUTO_LOCK';
48541
+ /** Error associated with the action. */
48542
+ error: {
48543
+ /** Type of the error. */
48544
+ type: string;
48545
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
48546
+ message: string;
48547
+ };
46788
48548
  } | {
46789
48549
  /** ID of the action attempt. */
46790
48550
  action_attempt_id: string;
@@ -48062,6 +49822,41 @@ export type Routes = {
48062
49822
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
48063
49823
  message: string;
48064
49824
  };
49825
+ } | {
49826
+ /** ID of the action attempt. */
49827
+ action_attempt_id: string;
49828
+ status: 'pending';
49829
+ /** Result of the action attempt. Null for pending action attempts. */
49830
+ result: null;
49831
+ /** Errors associated with the action attempt. Null for pending action attempts. */
49832
+ error: null;
49833
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
49834
+ action_type: 'CONFIGURE_AUTO_LOCK';
49835
+ } | {
49836
+ /** ID of the action attempt. */
49837
+ action_attempt_id: string;
49838
+ status: 'success';
49839
+ /** Errors associated with the action attempt. Null for successful action attempts. */
49840
+ error: null;
49841
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
49842
+ action_type: 'CONFIGURE_AUTO_LOCK';
49843
+ /** Result of the action. */
49844
+ result: {};
49845
+ } | {
49846
+ /** ID of the action attempt. */
49847
+ action_attempt_id: string;
49848
+ status: 'error';
49849
+ /** Result of the action attempt. Null for failed action attempts. */
49850
+ result: null;
49851
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
49852
+ action_type: 'CONFIGURE_AUTO_LOCK';
49853
+ /** Error associated with the action. */
49854
+ error: {
49855
+ /** Type of the error. */
49856
+ type: string;
49857
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
49858
+ message: string;
49859
+ };
48065
49860
  } | {
48066
49861
  /** ID of the action attempt. */
48067
49862
  action_attempt_id: string;
@@ -49337,6 +51132,41 @@ export type Routes = {
49337
51132
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
49338
51133
  message: string;
49339
51134
  };
51135
+ } | {
51136
+ /** ID of the action attempt. */
51137
+ action_attempt_id: string;
51138
+ status: 'pending';
51139
+ /** Result of the action attempt. Null for pending action attempts. */
51140
+ result: null;
51141
+ /** Errors associated with the action attempt. Null for pending action attempts. */
51142
+ error: null;
51143
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
51144
+ action_type: 'CONFIGURE_AUTO_LOCK';
51145
+ } | {
51146
+ /** ID of the action attempt. */
51147
+ action_attempt_id: string;
51148
+ status: 'success';
51149
+ /** Errors associated with the action attempt. Null for successful action attempts. */
51150
+ error: null;
51151
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
51152
+ action_type: 'CONFIGURE_AUTO_LOCK';
51153
+ /** Result of the action. */
51154
+ result: {};
51155
+ } | {
51156
+ /** ID of the action attempt. */
51157
+ action_attempt_id: string;
51158
+ status: 'error';
51159
+ /** Result of the action attempt. Null for failed action attempts. */
51160
+ result: null;
51161
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
51162
+ action_type: 'CONFIGURE_AUTO_LOCK';
51163
+ /** Error associated with the action. */
51164
+ error: {
51165
+ /** Type of the error. */
51166
+ type: string;
51167
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
51168
+ message: string;
51169
+ };
49340
51170
  } | {
49341
51171
  /** ID of the action attempt. */
49342
51172
  action_attempt_id: string;
@@ -50614,6 +52444,41 @@ export type Routes = {
50614
52444
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
50615
52445
  message: string;
50616
52446
  };
52447
+ } | {
52448
+ /** ID of the action attempt. */
52449
+ action_attempt_id: string;
52450
+ status: 'pending';
52451
+ /** Result of the action attempt. Null for pending action attempts. */
52452
+ result: null;
52453
+ /** Errors associated with the action attempt. Null for pending action attempts. */
52454
+ error: null;
52455
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
52456
+ action_type: 'CONFIGURE_AUTO_LOCK';
52457
+ } | {
52458
+ /** ID of the action attempt. */
52459
+ action_attempt_id: string;
52460
+ status: 'success';
52461
+ /** Errors associated with the action attempt. Null for successful action attempts. */
52462
+ error: null;
52463
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
52464
+ action_type: 'CONFIGURE_AUTO_LOCK';
52465
+ /** Result of the action. */
52466
+ result: {};
52467
+ } | {
52468
+ /** ID of the action attempt. */
52469
+ action_attempt_id: string;
52470
+ status: 'error';
52471
+ /** Result of the action attempt. Null for failed action attempts. */
52472
+ result: null;
52473
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
52474
+ action_type: 'CONFIGURE_AUTO_LOCK';
52475
+ /** Error associated with the action. */
52476
+ error: {
52477
+ /** Type of the error. */
52478
+ type: string;
52479
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
52480
+ message: string;
52481
+ };
50617
52482
  } | {
50618
52483
  /** ID of the action attempt. */
50619
52484
  action_attempt_id: string;
@@ -50910,9 +52775,9 @@ export type Routes = {
50910
52775
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
50911
52776
  page_cursor?: (string | undefined) | null;
50912
52777
  /** */
50913
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
52778
+ include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
50914
52779
  /** */
50915
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
52780
+ exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
50916
52781
  /**
50917
52782
  * @deprecated Use `space_id`.*/
50918
52783
  unstable_location_id?: (string | null) | undefined;
@@ -51299,6 +53164,8 @@ export type Routes = {
51299
53164
  incomplete_keyboard_passcode: boolean;
51300
53165
  /** Indicates whether a TTLock device supports Wi-Fi. */
51301
53166
  wifi: boolean;
53167
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
53168
+ auto_lock_time_config: boolean;
51302
53169
  };
51303
53170
  /** Indicates whether a TTLock device has a gateway. */
51304
53171
  has_gateway?: boolean | undefined;
@@ -51588,6 +53455,10 @@ export type Routes = {
51588
53455
  } | undefined) | undefined;
51589
53456
  /** Indicates whether the door is open. */
51590
53457
  door_open?: (boolean | undefined) | undefined;
53458
+ /** Indicates whether automatic locking is enabled. */
53459
+ auto_lock_enabled?: (boolean | undefined) | undefined;
53460
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
53461
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
51591
53462
  } & {
51592
53463
  /** Reported temperature in °F. */
51593
53464
  temperature_fahrenheit?: number | undefined;
@@ -52234,6 +54105,7 @@ export type Routes = {
52234
54105
  can_simulate_hub_connection?: boolean | undefined;
52235
54106
  can_simulate_hub_disconnection?: boolean | undefined;
52236
54107
  can_simulate_paid_subscription?: boolean | undefined;
54108
+ can_configure_auto_lock?: boolean | undefined;
52237
54109
  }[];
52238
54110
  devices: {
52239
54111
  /** ID of the device. */
@@ -52611,6 +54483,8 @@ export type Routes = {
52611
54483
  incomplete_keyboard_passcode: boolean;
52612
54484
  /** Indicates whether a TTLock device supports Wi-Fi. */
52613
54485
  wifi: boolean;
54486
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
54487
+ auto_lock_time_config: boolean;
52614
54488
  };
52615
54489
  /** Indicates whether a TTLock device has a gateway. */
52616
54490
  has_gateway?: boolean | undefined;
@@ -52900,6 +54774,10 @@ export type Routes = {
52900
54774
  } | undefined) | undefined;
52901
54775
  /** Indicates whether the door is open. */
52902
54776
  door_open?: (boolean | undefined) | undefined;
54777
+ /** Indicates whether automatic locking is enabled. */
54778
+ auto_lock_enabled?: (boolean | undefined) | undefined;
54779
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
54780
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
52903
54781
  } & {
52904
54782
  /** Reported temperature in °F. */
52905
54783
  temperature_fahrenheit?: number | undefined;
@@ -53546,6 +55424,7 @@ export type Routes = {
53546
55424
  can_simulate_hub_connection?: boolean | undefined;
53547
55425
  can_simulate_hub_disconnection?: boolean | undefined;
53548
55426
  can_simulate_paid_subscription?: boolean | undefined;
55427
+ can_configure_auto_lock?: boolean | undefined;
53549
55428
  }[];
53550
55429
  };
53551
55430
  maxDuration: undefined;
@@ -54576,6 +56455,41 @@ export type Routes = {
54576
56455
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
54577
56456
  message: string;
54578
56457
  };
56458
+ } | {
56459
+ /** ID of the action attempt. */
56460
+ action_attempt_id: string;
56461
+ status: 'pending';
56462
+ /** Result of the action attempt. Null for pending action attempts. */
56463
+ result: null;
56464
+ /** Errors associated with the action attempt. Null for pending action attempts. */
56465
+ error: null;
56466
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
56467
+ action_type: 'CONFIGURE_AUTO_LOCK';
56468
+ } | {
56469
+ /** ID of the action attempt. */
56470
+ action_attempt_id: string;
56471
+ status: 'success';
56472
+ /** Errors associated with the action attempt. Null for successful action attempts. */
56473
+ error: null;
56474
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
56475
+ action_type: 'CONFIGURE_AUTO_LOCK';
56476
+ /** Result of the action. */
56477
+ result: {};
56478
+ } | {
56479
+ /** ID of the action attempt. */
56480
+ action_attempt_id: string;
56481
+ status: 'error';
56482
+ /** Result of the action attempt. Null for failed action attempts. */
56483
+ result: null;
56484
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
56485
+ action_type: 'CONFIGURE_AUTO_LOCK';
56486
+ /** Error associated with the action. */
56487
+ error: {
56488
+ /** Type of the error. */
56489
+ type: string;
56490
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
56491
+ message: string;
56492
+ };
54579
56493
  } | {
54580
56494
  /** ID of the action attempt. */
54581
56495
  action_attempt_id: string;
@@ -55872,6 +57786,41 @@ export type Routes = {
55872
57786
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
55873
57787
  message: string;
55874
57788
  };
57789
+ } | {
57790
+ /** ID of the action attempt. */
57791
+ action_attempt_id: string;
57792
+ status: 'pending';
57793
+ /** Result of the action attempt. Null for pending action attempts. */
57794
+ result: null;
57795
+ /** Errors associated with the action attempt. Null for pending action attempts. */
57796
+ error: null;
57797
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
57798
+ action_type: 'CONFIGURE_AUTO_LOCK';
57799
+ } | {
57800
+ /** ID of the action attempt. */
57801
+ action_attempt_id: string;
57802
+ status: 'success';
57803
+ /** Errors associated with the action attempt. Null for successful action attempts. */
57804
+ error: null;
57805
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
57806
+ action_type: 'CONFIGURE_AUTO_LOCK';
57807
+ /** Result of the action. */
57808
+ result: {};
57809
+ } | {
57810
+ /** ID of the action attempt. */
57811
+ action_attempt_id: string;
57812
+ status: 'error';
57813
+ /** Result of the action attempt. Null for failed action attempts. */
57814
+ result: null;
57815
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
57816
+ action_type: 'CONFIGURE_AUTO_LOCK';
57817
+ /** Error associated with the action. */
57818
+ error: {
57819
+ /** Type of the error. */
57820
+ type: string;
57821
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
57822
+ message: string;
57823
+ };
55875
57824
  } | {
55876
57825
  /** ID of the action attempt. */
55877
57826
  action_attempt_id: string;
@@ -57224,6 +59173,41 @@ export type Routes = {
57224
59173
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
57225
59174
  message: string;
57226
59175
  };
59176
+ } | {
59177
+ /** ID of the action attempt. */
59178
+ action_attempt_id: string;
59179
+ status: 'pending';
59180
+ /** Result of the action attempt. Null for pending action attempts. */
59181
+ result: null;
59182
+ /** Errors associated with the action attempt. Null for pending action attempts. */
59183
+ error: null;
59184
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
59185
+ action_type: 'CONFIGURE_AUTO_LOCK';
59186
+ } | {
59187
+ /** ID of the action attempt. */
59188
+ action_attempt_id: string;
59189
+ status: 'success';
59190
+ /** Errors associated with the action attempt. Null for successful action attempts. */
59191
+ error: null;
59192
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
59193
+ action_type: 'CONFIGURE_AUTO_LOCK';
59194
+ /** Result of the action. */
59195
+ result: {};
59196
+ } | {
59197
+ /** ID of the action attempt. */
59198
+ action_attempt_id: string;
59199
+ status: 'error';
59200
+ /** Result of the action attempt. Null for failed action attempts. */
59201
+ result: null;
59202
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
59203
+ action_type: 'CONFIGURE_AUTO_LOCK';
59204
+ /** Error associated with the action. */
59205
+ error: {
59206
+ /** Type of the error. */
59207
+ type: string;
59208
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
59209
+ message: string;
59210
+ };
57227
59211
  } | {
57228
59212
  /** ID of the action attempt. */
57229
59213
  action_attempt_id: string;
@@ -59470,6 +61454,41 @@ export type Routes = {
59470
61454
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
59471
61455
  message: string;
59472
61456
  };
61457
+ } | {
61458
+ /** ID of the action attempt. */
61459
+ action_attempt_id: string;
61460
+ status: 'pending';
61461
+ /** Result of the action attempt. Null for pending action attempts. */
61462
+ result: null;
61463
+ /** Errors associated with the action attempt. Null for pending action attempts. */
61464
+ error: null;
61465
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
61466
+ action_type: 'CONFIGURE_AUTO_LOCK';
61467
+ } | {
61468
+ /** ID of the action attempt. */
61469
+ action_attempt_id: string;
61470
+ status: 'success';
61471
+ /** Errors associated with the action attempt. Null for successful action attempts. */
61472
+ error: null;
61473
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
61474
+ action_type: 'CONFIGURE_AUTO_LOCK';
61475
+ /** Result of the action. */
61476
+ result: {};
61477
+ } | {
61478
+ /** ID of the action attempt. */
61479
+ action_attempt_id: string;
61480
+ status: 'error';
61481
+ /** Result of the action attempt. Null for failed action attempts. */
61482
+ result: null;
61483
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
61484
+ action_type: 'CONFIGURE_AUTO_LOCK';
61485
+ /** Error associated with the action. */
61486
+ error: {
61487
+ /** Type of the error. */
61488
+ type: string;
61489
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
61490
+ message: string;
61491
+ };
59473
61492
  } | {
59474
61493
  /** ID of the action attempt. */
59475
61494
  action_attempt_id: string;
@@ -63261,6 +65280,8 @@ export type Routes = {
63261
65280
  exclude?: boolean;
63262
65281
  /** Indicates whether the customer can manage reservations for their properties. */
63263
65282
  exclude_reservation_management?: boolean;
65283
+ /** Indicates whether to exclude technical details from reservation views. */
65284
+ exclude_reservation_technical_details?: boolean;
63264
65285
  /** Indicates whether the customer can manage staff for their properties. */
63265
65286
  exclude_staff_management?: boolean;
63266
65287
  /** Configuration for event type filtering in the manage feature. */
@@ -65357,6 +67378,8 @@ export type Routes = {
65357
67378
  incomplete_keyboard_passcode: boolean;
65358
67379
  /** Indicates whether a TTLock device supports Wi-Fi. */
65359
67380
  wifi: boolean;
67381
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
67382
+ auto_lock_time_config: boolean;
65360
67383
  };
65361
67384
  /** Indicates whether a TTLock device has a gateway. */
65362
67385
  has_gateway?: boolean | undefined;
@@ -65646,6 +67669,10 @@ export type Routes = {
65646
67669
  } | undefined) | undefined;
65647
67670
  /** Indicates whether the door is open. */
65648
67671
  door_open?: (boolean | undefined) | undefined;
67672
+ /** Indicates whether automatic locking is enabled. */
67673
+ auto_lock_enabled?: (boolean | undefined) | undefined;
67674
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
67675
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
65649
67676
  } & {
65650
67677
  /** Reported temperature in °F. */
65651
67678
  temperature_fahrenheit?: number | undefined;
@@ -66292,6 +68319,7 @@ export type Routes = {
66292
68319
  can_simulate_hub_connection?: boolean | undefined;
66293
68320
  can_simulate_hub_disconnection?: boolean | undefined;
66294
68321
  can_simulate_paid_subscription?: boolean | undefined;
68322
+ can_configure_auto_lock?: boolean | undefined;
66295
68323
  }[] | undefined;
66296
68324
  acs_entrances?: {
66297
68325
  /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -67929,6 +69957,41 @@ export type Routes = {
67929
69957
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
67930
69958
  message: string;
67931
69959
  };
69960
+ } | {
69961
+ /** ID of the action attempt. */
69962
+ action_attempt_id: string;
69963
+ status: 'pending';
69964
+ /** Result of the action attempt. Null for pending action attempts. */
69965
+ result: null;
69966
+ /** Errors associated with the action attempt. Null for pending action attempts. */
69967
+ error: null;
69968
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
69969
+ action_type: 'CONFIGURE_AUTO_LOCK';
69970
+ } | {
69971
+ /** ID of the action attempt. */
69972
+ action_attempt_id: string;
69973
+ status: 'success';
69974
+ /** Errors associated with the action attempt. Null for successful action attempts. */
69975
+ error: null;
69976
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
69977
+ action_type: 'CONFIGURE_AUTO_LOCK';
69978
+ /** Result of the action. */
69979
+ result: {};
69980
+ } | {
69981
+ /** ID of the action attempt. */
69982
+ action_attempt_id: string;
69983
+ status: 'error';
69984
+ /** Result of the action attempt. Null for failed action attempts. */
69985
+ result: null;
69986
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
69987
+ action_type: 'CONFIGURE_AUTO_LOCK';
69988
+ /** Error associated with the action. */
69989
+ error: {
69990
+ /** Type of the error. */
69991
+ type: string;
69992
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
69993
+ message: string;
69994
+ };
67932
69995
  } | {
67933
69996
  /** ID of the action attempt. */
67934
69997
  action_attempt_id: string;
@@ -69210,6 +71273,41 @@ export type Routes = {
69210
71273
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
69211
71274
  message: string;
69212
71275
  };
71276
+ } | {
71277
+ /** ID of the action attempt. */
71278
+ action_attempt_id: string;
71279
+ status: 'pending';
71280
+ /** Result of the action attempt. Null for pending action attempts. */
71281
+ result: null;
71282
+ /** Errors associated with the action attempt. Null for pending action attempts. */
71283
+ error: null;
71284
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
71285
+ action_type: 'CONFIGURE_AUTO_LOCK';
71286
+ } | {
71287
+ /** ID of the action attempt. */
71288
+ action_attempt_id: string;
71289
+ status: 'success';
71290
+ /** Errors associated with the action attempt. Null for successful action attempts. */
71291
+ error: null;
71292
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
71293
+ action_type: 'CONFIGURE_AUTO_LOCK';
71294
+ /** Result of the action. */
71295
+ result: {};
71296
+ } | {
71297
+ /** ID of the action attempt. */
71298
+ action_attempt_id: string;
71299
+ status: 'error';
71300
+ /** Result of the action attempt. Null for failed action attempts. */
71301
+ result: null;
71302
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
71303
+ action_type: 'CONFIGURE_AUTO_LOCK';
71304
+ /** Error associated with the action. */
71305
+ error: {
71306
+ /** Type of the error. */
71307
+ type: string;
71308
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
71309
+ message: string;
71310
+ };
69213
71311
  } | {
69214
71312
  /** ID of the action attempt. */
69215
71313
  action_attempt_id: string;
@@ -70597,6 +72695,41 @@ export type Routes = {
70597
72695
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
70598
72696
  message: string;
70599
72697
  };
72698
+ } | {
72699
+ /** ID of the action attempt. */
72700
+ action_attempt_id: string;
72701
+ status: 'pending';
72702
+ /** Result of the action attempt. Null for pending action attempts. */
72703
+ result: null;
72704
+ /** Errors associated with the action attempt. Null for pending action attempts. */
72705
+ error: null;
72706
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
72707
+ action_type: 'CONFIGURE_AUTO_LOCK';
72708
+ } | {
72709
+ /** ID of the action attempt. */
72710
+ action_attempt_id: string;
72711
+ status: 'success';
72712
+ /** Errors associated with the action attempt. Null for successful action attempts. */
72713
+ error: null;
72714
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
72715
+ action_type: 'CONFIGURE_AUTO_LOCK';
72716
+ /** Result of the action. */
72717
+ result: {};
72718
+ } | {
72719
+ /** ID of the action attempt. */
72720
+ action_attempt_id: string;
72721
+ status: 'error';
72722
+ /** Result of the action attempt. Null for failed action attempts. */
72723
+ result: null;
72724
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
72725
+ action_type: 'CONFIGURE_AUTO_LOCK';
72726
+ /** Error associated with the action. */
72727
+ error: {
72728
+ /** Type of the error. */
72729
+ type: string;
72730
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
72731
+ message: string;
72732
+ };
70600
72733
  } | {
70601
72734
  /** ID of the action attempt. */
70602
72735
  action_attempt_id: string;
@@ -71263,6 +73396,8 @@ export type Routes = {
71263
73396
  incomplete_keyboard_passcode: boolean;
71264
73397
  /** Indicates whether a TTLock device supports Wi-Fi. */
71265
73398
  wifi: boolean;
73399
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
73400
+ auto_lock_time_config: boolean;
71266
73401
  };
71267
73402
  /** Indicates whether a TTLock device has a gateway. */
71268
73403
  has_gateway?: boolean | undefined;
@@ -71552,6 +73687,10 @@ export type Routes = {
71552
73687
  } | undefined) | undefined;
71553
73688
  /** Indicates whether the door is open. */
71554
73689
  door_open?: (boolean | undefined) | undefined;
73690
+ /** Indicates whether automatic locking is enabled. */
73691
+ auto_lock_enabled?: (boolean | undefined) | undefined;
73692
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
73693
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
71555
73694
  } & {
71556
73695
  /** Reported temperature in °F. */
71557
73696
  temperature_fahrenheit?: number | undefined;
@@ -72198,6 +74337,7 @@ export type Routes = {
72198
74337
  can_simulate_hub_connection?: boolean | undefined;
72199
74338
  can_simulate_hub_disconnection?: boolean | undefined;
72200
74339
  can_simulate_paid_subscription?: boolean | undefined;
74340
+ can_configure_auto_lock?: boolean | undefined;
72201
74341
  };
72202
74342
  };
72203
74343
  maxDuration: undefined;
@@ -73222,6 +75362,41 @@ export type Routes = {
73222
75362
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
73223
75363
  message: string;
73224
75364
  };
75365
+ } | {
75366
+ /** ID of the action attempt. */
75367
+ action_attempt_id: string;
75368
+ status: 'pending';
75369
+ /** Result of the action attempt. Null for pending action attempts. */
75370
+ result: null;
75371
+ /** Errors associated with the action attempt. Null for pending action attempts. */
75372
+ error: null;
75373
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
75374
+ action_type: 'CONFIGURE_AUTO_LOCK';
75375
+ } | {
75376
+ /** ID of the action attempt. */
75377
+ action_attempt_id: string;
75378
+ status: 'success';
75379
+ /** Errors associated with the action attempt. Null for successful action attempts. */
75380
+ error: null;
75381
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
75382
+ action_type: 'CONFIGURE_AUTO_LOCK';
75383
+ /** Result of the action. */
75384
+ result: {};
75385
+ } | {
75386
+ /** ID of the action attempt. */
75387
+ action_attempt_id: string;
75388
+ status: 'error';
75389
+ /** Result of the action attempt. Null for failed action attempts. */
75390
+ result: null;
75391
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
75392
+ action_type: 'CONFIGURE_AUTO_LOCK';
75393
+ /** Error associated with the action. */
75394
+ error: {
75395
+ /** Type of the error. */
75396
+ type: string;
75397
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
75398
+ message: string;
75399
+ };
73225
75400
  } | {
73226
75401
  /** ID of the action attempt. */
73227
75402
  action_attempt_id: string;
@@ -74507,6 +76682,41 @@ export type Routes = {
74507
76682
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
74508
76683
  message: string;
74509
76684
  };
76685
+ } | {
76686
+ /** ID of the action attempt. */
76687
+ action_attempt_id: string;
76688
+ status: 'pending';
76689
+ /** Result of the action attempt. Null for pending action attempts. */
76690
+ result: null;
76691
+ /** Errors associated with the action attempt. Null for pending action attempts. */
76692
+ error: null;
76693
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
76694
+ action_type: 'CONFIGURE_AUTO_LOCK';
76695
+ } | {
76696
+ /** ID of the action attempt. */
76697
+ action_attempt_id: string;
76698
+ status: 'success';
76699
+ /** Errors associated with the action attempt. Null for successful action attempts. */
76700
+ error: null;
76701
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
76702
+ action_type: 'CONFIGURE_AUTO_LOCK';
76703
+ /** Result of the action. */
76704
+ result: {};
76705
+ } | {
76706
+ /** ID of the action attempt. */
76707
+ action_attempt_id: string;
76708
+ status: 'error';
76709
+ /** Result of the action attempt. Null for failed action attempts. */
76710
+ result: null;
76711
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
76712
+ action_type: 'CONFIGURE_AUTO_LOCK';
76713
+ /** Error associated with the action. */
76714
+ error: {
76715
+ /** Type of the error. */
76716
+ type: string;
76717
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
76718
+ message: string;
76719
+ };
74510
76720
  } | {
74511
76721
  /** ID of the action attempt. */
74512
76722
  action_attempt_id: string;
@@ -74803,9 +77013,9 @@ export type Routes = {
74803
77013
  /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
74804
77014
  page_cursor?: (string | undefined) | null;
74805
77015
  /** */
74806
- include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
77016
+ include_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
74807
77017
  /** */
74808
- exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription')[] | undefined;
77018
+ exclude_if?: ('can_remotely_unlock' | 'can_remotely_lock' | 'can_program_offline_access_codes' | 'can_program_online_access_codes' | 'can_hvac_heat' | 'can_hvac_cool' | 'can_hvac_heat_cool' | 'can_turn_off_hvac' | 'can_simulate_removal' | 'can_simulate_connection' | 'can_simulate_disconnection' | 'can_unlock_with_code' | 'can_run_thermostat_programs' | 'can_program_thermostat_programs_as_weekday_weekend' | 'can_program_thermostat_programs_as_different_each_day' | 'can_program_thermostat_programs_as_same_each_day' | 'can_simulate_hub_connection' | 'can_simulate_hub_disconnection' | 'can_simulate_paid_subscription' | 'can_configure_auto_lock')[] | undefined;
74809
77019
  /**
74810
77020
  * @deprecated Use `space_id`.*/
74811
77021
  unstable_location_id?: (string | null) | undefined;
@@ -75192,6 +77402,8 @@ export type Routes = {
75192
77402
  incomplete_keyboard_passcode: boolean;
75193
77403
  /** Indicates whether a TTLock device supports Wi-Fi. */
75194
77404
  wifi: boolean;
77405
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
77406
+ auto_lock_time_config: boolean;
75195
77407
  };
75196
77408
  /** Indicates whether a TTLock device has a gateway. */
75197
77409
  has_gateway?: boolean | undefined;
@@ -75481,6 +77693,10 @@ export type Routes = {
75481
77693
  } | undefined) | undefined;
75482
77694
  /** Indicates whether the door is open. */
75483
77695
  door_open?: (boolean | undefined) | undefined;
77696
+ /** Indicates whether automatic locking is enabled. */
77697
+ auto_lock_enabled?: (boolean | undefined) | undefined;
77698
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
77699
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
75484
77700
  } & {
75485
77701
  /** Reported temperature in °F. */
75486
77702
  temperature_fahrenheit?: number | undefined;
@@ -76127,6 +78343,7 @@ export type Routes = {
76127
78343
  can_simulate_hub_connection?: boolean | undefined;
76128
78344
  can_simulate_hub_disconnection?: boolean | undefined;
76129
78345
  can_simulate_paid_subscription?: boolean | undefined;
78346
+ can_configure_auto_lock?: boolean | undefined;
76130
78347
  }[];
76131
78348
  devices: {
76132
78349
  /** ID of the device. */
@@ -76504,6 +78721,8 @@ export type Routes = {
76504
78721
  incomplete_keyboard_passcode: boolean;
76505
78722
  /** Indicates whether a TTLock device supports Wi-Fi. */
76506
78723
  wifi: boolean;
78724
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
78725
+ auto_lock_time_config: boolean;
76507
78726
  };
76508
78727
  /** Indicates whether a TTLock device has a gateway. */
76509
78728
  has_gateway?: boolean | undefined;
@@ -76793,6 +79012,10 @@ export type Routes = {
76793
79012
  } | undefined) | undefined;
76794
79013
  /** Indicates whether the door is open. */
76795
79014
  door_open?: (boolean | undefined) | undefined;
79015
+ /** Indicates whether automatic locking is enabled. */
79016
+ auto_lock_enabled?: (boolean | undefined) | undefined;
79017
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
79018
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
76796
79019
  } & {
76797
79020
  /** Reported temperature in °F. */
76798
79021
  temperature_fahrenheit?: number | undefined;
@@ -77439,6 +79662,7 @@ export type Routes = {
77439
79662
  can_simulate_hub_connection?: boolean | undefined;
77440
79663
  can_simulate_hub_disconnection?: boolean | undefined;
77441
79664
  can_simulate_paid_subscription?: boolean | undefined;
79665
+ can_configure_auto_lock?: boolean | undefined;
77442
79666
  }[];
77443
79667
  };
77444
79668
  maxDuration: undefined;
@@ -78459,6 +80683,41 @@ export type Routes = {
78459
80683
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
78460
80684
  message: string;
78461
80685
  };
80686
+ } | {
80687
+ /** ID of the action attempt. */
80688
+ action_attempt_id: string;
80689
+ status: 'pending';
80690
+ /** Result of the action attempt. Null for pending action attempts. */
80691
+ result: null;
80692
+ /** Errors associated with the action attempt. Null for pending action attempts. */
80693
+ error: null;
80694
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
80695
+ action_type: 'CONFIGURE_AUTO_LOCK';
80696
+ } | {
80697
+ /** ID of the action attempt. */
80698
+ action_attempt_id: string;
80699
+ status: 'success';
80700
+ /** Errors associated with the action attempt. Null for successful action attempts. */
80701
+ error: null;
80702
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
80703
+ action_type: 'CONFIGURE_AUTO_LOCK';
80704
+ /** Result of the action. */
80705
+ result: {};
80706
+ } | {
80707
+ /** ID of the action attempt. */
80708
+ action_attempt_id: string;
80709
+ status: 'error';
80710
+ /** Result of the action attempt. Null for failed action attempts. */
80711
+ result: null;
80712
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
80713
+ action_type: 'CONFIGURE_AUTO_LOCK';
80714
+ /** Error associated with the action. */
80715
+ error: {
80716
+ /** Type of the error. */
80717
+ type: string;
80718
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
80719
+ message: string;
80720
+ };
78462
80721
  } | {
78463
80722
  /** ID of the action attempt. */
78464
80723
  action_attempt_id: string;
@@ -79939,6 +82198,41 @@ export type Routes = {
79939
82198
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
79940
82199
  message: string;
79941
82200
  };
82201
+ } | {
82202
+ /** ID of the action attempt. */
82203
+ action_attempt_id: string;
82204
+ status: 'pending';
82205
+ /** Result of the action attempt. Null for pending action attempts. */
82206
+ result: null;
82207
+ /** Errors associated with the action attempt. Null for pending action attempts. */
82208
+ error: null;
82209
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
82210
+ action_type: 'CONFIGURE_AUTO_LOCK';
82211
+ } | {
82212
+ /** ID of the action attempt. */
82213
+ action_attempt_id: string;
82214
+ status: 'success';
82215
+ /** Errors associated with the action attempt. Null for successful action attempts. */
82216
+ error: null;
82217
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
82218
+ action_type: 'CONFIGURE_AUTO_LOCK';
82219
+ /** Result of the action. */
82220
+ result: {};
82221
+ } | {
82222
+ /** ID of the action attempt. */
82223
+ action_attempt_id: string;
82224
+ status: 'error';
82225
+ /** Result of the action attempt. Null for failed action attempts. */
82226
+ result: null;
82227
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
82228
+ action_type: 'CONFIGURE_AUTO_LOCK';
82229
+ /** Error associated with the action. */
82230
+ error: {
82231
+ /** Type of the error. */
82232
+ type: string;
82233
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
82234
+ message: string;
82235
+ };
79942
82236
  } | {
79943
82237
  /** ID of the action attempt. */
79944
82238
  action_attempt_id: string;
@@ -81247,6 +83541,41 @@ export type Routes = {
81247
83541
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
81248
83542
  message: string;
81249
83543
  };
83544
+ } | {
83545
+ /** ID of the action attempt. */
83546
+ action_attempt_id: string;
83547
+ status: 'pending';
83548
+ /** Result of the action attempt. Null for pending action attempts. */
83549
+ result: null;
83550
+ /** Errors associated with the action attempt. Null for pending action attempts. */
83551
+ error: null;
83552
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
83553
+ action_type: 'CONFIGURE_AUTO_LOCK';
83554
+ } | {
83555
+ /** ID of the action attempt. */
83556
+ action_attempt_id: string;
83557
+ status: 'success';
83558
+ /** Errors associated with the action attempt. Null for successful action attempts. */
83559
+ error: null;
83560
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
83561
+ action_type: 'CONFIGURE_AUTO_LOCK';
83562
+ /** Result of the action. */
83563
+ result: {};
83564
+ } | {
83565
+ /** ID of the action attempt. */
83566
+ action_attempt_id: string;
83567
+ status: 'error';
83568
+ /** Result of the action attempt. Null for failed action attempts. */
83569
+ result: null;
83570
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
83571
+ action_type: 'CONFIGURE_AUTO_LOCK';
83572
+ /** Error associated with the action. */
83573
+ error: {
83574
+ /** Type of the error. */
83575
+ type: string;
83576
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
83577
+ message: string;
83578
+ };
81250
83579
  } | {
81251
83580
  /** ID of the action attempt. */
81252
83581
  action_attempt_id: string;
@@ -82667,6 +84996,41 @@ export type Routes = {
82667
84996
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
82668
84997
  message: string;
82669
84998
  };
84999
+ } | {
85000
+ /** ID of the action attempt. */
85001
+ action_attempt_id: string;
85002
+ status: 'pending';
85003
+ /** Result of the action attempt. Null for pending action attempts. */
85004
+ result: null;
85005
+ /** Errors associated with the action attempt. Null for pending action attempts. */
85006
+ error: null;
85007
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
85008
+ action_type: 'CONFIGURE_AUTO_LOCK';
85009
+ } | {
85010
+ /** ID of the action attempt. */
85011
+ action_attempt_id: string;
85012
+ status: 'success';
85013
+ /** Errors associated with the action attempt. Null for successful action attempts. */
85014
+ error: null;
85015
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
85016
+ action_type: 'CONFIGURE_AUTO_LOCK';
85017
+ /** Result of the action. */
85018
+ result: {};
85019
+ } | {
85020
+ /** ID of the action attempt. */
85021
+ action_attempt_id: string;
85022
+ status: 'error';
85023
+ /** Result of the action attempt. Null for failed action attempts. */
85024
+ result: null;
85025
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
85026
+ action_type: 'CONFIGURE_AUTO_LOCK';
85027
+ /** Error associated with the action. */
85028
+ error: {
85029
+ /** Type of the error. */
85030
+ type: string;
85031
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85032
+ message: string;
85033
+ };
82670
85034
  } | {
82671
85035
  /** ID of the action attempt. */
82672
85036
  action_attempt_id: string;
@@ -83862,6 +86226,8 @@ export type Routes = {
83862
86226
  incomplete_keyboard_passcode: boolean;
83863
86227
  /** Indicates whether a TTLock device supports Wi-Fi. */
83864
86228
  wifi: boolean;
86229
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
86230
+ auto_lock_time_config: boolean;
83865
86231
  };
83866
86232
  /** Indicates whether a TTLock device has a gateway. */
83867
86233
  has_gateway?: boolean | undefined;
@@ -84151,6 +86517,10 @@ export type Routes = {
84151
86517
  } | undefined) | undefined;
84152
86518
  /** Indicates whether the door is open. */
84153
86519
  door_open?: (boolean | undefined) | undefined;
86520
+ /** Indicates whether automatic locking is enabled. */
86521
+ auto_lock_enabled?: (boolean | undefined) | undefined;
86522
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
86523
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
84154
86524
  } & {
84155
86525
  /** Reported temperature in °F. */
84156
86526
  temperature_fahrenheit?: number | undefined;
@@ -84797,6 +87167,7 @@ export type Routes = {
84797
87167
  can_simulate_hub_connection?: boolean | undefined;
84798
87168
  can_simulate_hub_disconnection?: boolean | undefined;
84799
87169
  can_simulate_paid_subscription?: boolean | undefined;
87170
+ can_configure_auto_lock?: boolean | undefined;
84800
87171
  }[];
84801
87172
  /**
84802
87173
  * @deprecated Use devices.*/
@@ -85176,6 +87547,8 @@ export type Routes = {
85176
87547
  incomplete_keyboard_passcode: boolean;
85177
87548
  /** Indicates whether a TTLock device supports Wi-Fi. */
85178
87549
  wifi: boolean;
87550
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
87551
+ auto_lock_time_config: boolean;
85179
87552
  };
85180
87553
  /** Indicates whether a TTLock device has a gateway. */
85181
87554
  has_gateway?: boolean | undefined;
@@ -85465,6 +87838,10 @@ export type Routes = {
85465
87838
  } | undefined) | undefined;
85466
87839
  /** Indicates whether the door is open. */
85467
87840
  door_open?: (boolean | undefined) | undefined;
87841
+ /** Indicates whether automatic locking is enabled. */
87842
+ auto_lock_enabled?: (boolean | undefined) | undefined;
87843
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
87844
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
85468
87845
  } & {
85469
87846
  /** Reported temperature in °F. */
85470
87847
  temperature_fahrenheit?: number | undefined;
@@ -86111,6 +88488,7 @@ export type Routes = {
86111
88488
  can_simulate_hub_connection?: boolean | undefined;
86112
88489
  can_simulate_hub_disconnection?: boolean | undefined;
86113
88490
  can_simulate_paid_subscription?: boolean | undefined;
88491
+ can_configure_auto_lock?: boolean | undefined;
86114
88492
  }[];
86115
88493
  };
86116
88494
  maxDuration: undefined;
@@ -87468,6 +89846,8 @@ export type Routes = {
87468
89846
  incomplete_keyboard_passcode: boolean;
87469
89847
  /** Indicates whether a TTLock device supports Wi-Fi. */
87470
89848
  wifi: boolean;
89849
+ /** Indicates whether a TTLock device supports auto-lock time configuration. */
89850
+ auto_lock_time_config: boolean;
87471
89851
  };
87472
89852
  /** Indicates whether a TTLock device has a gateway. */
87473
89853
  has_gateway?: boolean | undefined;
@@ -87757,6 +90137,10 @@ export type Routes = {
87757
90137
  } | undefined) | undefined;
87758
90138
  /** Indicates whether the door is open. */
87759
90139
  door_open?: (boolean | undefined) | undefined;
90140
+ /** Indicates whether automatic locking is enabled. */
90141
+ auto_lock_enabled?: (boolean | undefined) | undefined;
90142
+ /** The delay in seconds before the lock automatically locks after being unlocked. */
90143
+ auto_lock_delay_seconds?: (number | undefined) | undefined;
87760
90144
  } & {
87761
90145
  /** Reported temperature in °F. */
87762
90146
  temperature_fahrenheit?: number | undefined;
@@ -88403,6 +90787,7 @@ export type Routes = {
88403
90787
  can_simulate_hub_connection?: boolean | undefined;
88404
90788
  can_simulate_hub_disconnection?: boolean | undefined;
88405
90789
  can_simulate_paid_subscription?: boolean | undefined;
90790
+ can_configure_auto_lock?: boolean | undefined;
88406
90791
  }[] | undefined;
88407
90792
  acs_entrances?: {
88408
90793
  /** ID of the [access control system](https://docs.seam.co/latest/capability-guides/access-systems) that contains the [entrance](https://docs.seam.co/latest/capability-guides/access-systems/retrieving-entrance-details). */
@@ -90064,6 +92449,41 @@ export type Routes = {
90064
92449
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
90065
92450
  message: string;
90066
92451
  };
92452
+ } | {
92453
+ /** ID of the action attempt. */
92454
+ action_attempt_id: string;
92455
+ status: 'pending';
92456
+ /** Result of the action attempt. Null for pending action attempts. */
92457
+ result: null;
92458
+ /** Errors associated with the action attempt. Null for pending action attempts. */
92459
+ error: null;
92460
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
92461
+ action_type: 'CONFIGURE_AUTO_LOCK';
92462
+ } | {
92463
+ /** ID of the action attempt. */
92464
+ action_attempt_id: string;
92465
+ status: 'success';
92466
+ /** Errors associated with the action attempt. Null for successful action attempts. */
92467
+ error: null;
92468
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
92469
+ action_type: 'CONFIGURE_AUTO_LOCK';
92470
+ /** Result of the action. */
92471
+ result: {};
92472
+ } | {
92473
+ /** ID of the action attempt. */
92474
+ action_attempt_id: string;
92475
+ status: 'error';
92476
+ /** Result of the action attempt. Null for failed action attempts. */
92477
+ result: null;
92478
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
92479
+ action_type: 'CONFIGURE_AUTO_LOCK';
92480
+ /** Error associated with the action. */
92481
+ error: {
92482
+ /** Type of the error. */
92483
+ type: string;
92484
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
92485
+ message: string;
92486
+ };
90067
92487
  } | {
90068
92488
  /** ID of the action attempt. */
90069
92489
  action_attempt_id: string;
@@ -91167,6 +93587,7 @@ export type Routes = {
91167
93587
  can_simulate_hub_connection?: boolean | undefined;
91168
93588
  can_simulate_hub_disconnection?: boolean | undefined;
91169
93589
  can_simulate_paid_subscription?: boolean | undefined;
93590
+ can_configure_auto_lock?: boolean | undefined;
91170
93591
  }[] | undefined;
91171
93592
  connect_webviews?: {
91172
93593
  /** ID of the Connect Webview. */
@@ -96869,6 +99290,41 @@ export type Routes = {
96869
99290
  /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
96870
99291
  message: string;
96871
99292
  };
99293
+ } | {
99294
+ /** ID of the action attempt. */
99295
+ action_attempt_id: string;
99296
+ status: 'pending';
99297
+ /** Result of the action attempt. Null for pending action attempts. */
99298
+ result: null;
99299
+ /** Errors associated with the action attempt. Null for pending action attempts. */
99300
+ error: null;
99301
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
99302
+ action_type: 'CONFIGURE_AUTO_LOCK';
99303
+ } | {
99304
+ /** ID of the action attempt. */
99305
+ action_attempt_id: string;
99306
+ status: 'success';
99307
+ /** Errors associated with the action attempt. Null for successful action attempts. */
99308
+ error: null;
99309
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
99310
+ action_type: 'CONFIGURE_AUTO_LOCK';
99311
+ /** Result of the action. */
99312
+ result: {};
99313
+ } | {
99314
+ /** ID of the action attempt. */
99315
+ action_attempt_id: string;
99316
+ status: 'error';
99317
+ /** Result of the action attempt. Null for failed action attempts. */
99318
+ result: null;
99319
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
99320
+ action_type: 'CONFIGURE_AUTO_LOCK';
99321
+ /** Error associated with the action. */
99322
+ error: {
99323
+ /** Type of the error. */
99324
+ type: string;
99325
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99326
+ message: string;
99327
+ };
96872
99328
  } | {
96873
99329
  /** ID of the action attempt. */
96874
99330
  action_attempt_id: string;