@seamapi/types 1.1081.0 → 1.1083.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 (26) hide show
  1. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
  2. package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
  3. package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
  4. package/lib/seam/connect/models/action-attempts/activate-weekly-program.d.ts +77 -0
  5. package/lib/seam/connect/models/action-attempts/activate-weekly-program.js +31 -0
  6. package/lib/seam/connect/models/action-attempts/activate-weekly-program.js.map +1 -0
  7. package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
  8. package/lib/seam/connect/models/devices/device.d.ts +6 -0
  9. package/lib/seam/connect/models/devices/device.js +3 -0
  10. package/lib/seam/connect/models/devices/device.js.map +1 -1
  11. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +4 -0
  12. package/lib/seam/connect/models/events/devices.d.ts +6 -0
  13. package/lib/seam/connect/models/events/devices.js +4 -0
  14. package/lib/seam/connect/models/events/devices.js.map +1 -1
  15. package/lib/seam/connect/models/events/seam-event.d.ts +3 -0
  16. package/lib/seam/connect/models/instant-keys/instant-key-preview.d.ts +6 -6
  17. package/lib/seam/connect/openapi.js +189 -0
  18. package/lib/seam/connect/openapi.js.map +1 -1
  19. package/lib/seam/connect/route-types.d.ts +3268 -214
  20. package/package.json +1 -1
  21. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  22. package/src/lib/seam/connect/models/action-attempts/activate-weekly-program.ts +46 -0
  23. package/src/lib/seam/connect/models/devices/device.ts +5 -0
  24. package/src/lib/seam/connect/models/events/devices.ts +6 -0
  25. package/src/lib/seam/connect/openapi.ts +203 -0
  26. package/src/lib/seam/connect/route-types.ts +3691 -218
@@ -1710,6 +1710,44 @@ export type Routes = {
1710
1710
  message: string
1711
1711
  }
1712
1712
  }
1713
+ | {
1714
+ /** ID of the action attempt. */
1715
+ action_attempt_id: string
1716
+ status: 'pending'
1717
+ /** Result of the action attempt. Null for pending action attempts. */
1718
+ result: null
1719
+ /** Errors associated with the action attempt. Null for pending action attempts. */
1720
+ error: null
1721
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
1722
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
1723
+ }
1724
+ | {
1725
+ /** ID of the action attempt. */
1726
+ action_attempt_id: string
1727
+ status: 'success'
1728
+ /** Errors associated with the action attempt. Null for successful action attempts. */
1729
+ error: null
1730
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
1731
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
1732
+ /** Result of the action. */
1733
+ result: {}
1734
+ }
1735
+ | {
1736
+ /** ID of the action attempt. */
1737
+ action_attempt_id: string
1738
+ status: 'error'
1739
+ /** Result of the action attempt. Null for failed action attempts. */
1740
+ result: null
1741
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
1742
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
1743
+ /** Error associated with the action. */
1744
+ error: {
1745
+ /** Type of the error. */
1746
+ type: string
1747
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
1748
+ message: string
1749
+ }
1750
+ }
1713
1751
  | {
1714
1752
  /** ID of the action attempt. */
1715
1753
  action_attempt_id: string
@@ -4970,6 +5008,44 @@ export type Routes = {
4970
5008
  message: string
4971
5009
  }
4972
5010
  }
5011
+ | {
5012
+ /** ID of the action attempt. */
5013
+ action_attempt_id: string
5014
+ status: 'pending'
5015
+ /** Result of the action attempt. Null for pending action attempts. */
5016
+ result: null
5017
+ /** Errors associated with the action attempt. Null for pending action attempts. */
5018
+ error: null
5019
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
5020
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
5021
+ }
5022
+ | {
5023
+ /** ID of the action attempt. */
5024
+ action_attempt_id: string
5025
+ status: 'success'
5026
+ /** Errors associated with the action attempt. Null for successful action attempts. */
5027
+ error: null
5028
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
5029
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
5030
+ /** Result of the action. */
5031
+ result: {}
5032
+ }
5033
+ | {
5034
+ /** ID of the action attempt. */
5035
+ action_attempt_id: string
5036
+ status: 'error'
5037
+ /** Result of the action attempt. Null for failed action attempts. */
5038
+ result: null
5039
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
5040
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
5041
+ /** Error associated with the action. */
5042
+ error: {
5043
+ /** Type of the error. */
5044
+ type: string
5045
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
5046
+ message: string
5047
+ }
5048
+ }
4973
5049
  | {
4974
5050
  /** ID of the action attempt. */
4975
5051
  action_attempt_id: string
@@ -10019,6 +10095,44 @@ export type Routes = {
10019
10095
  message: string
10020
10096
  }
10021
10097
  }
10098
+ | {
10099
+ /** ID of the action attempt. */
10100
+ action_attempt_id: string
10101
+ status: 'pending'
10102
+ /** Result of the action attempt. Null for pending action attempts. */
10103
+ result: null
10104
+ /** Errors associated with the action attempt. Null for pending action attempts. */
10105
+ error: null
10106
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
10107
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
10108
+ }
10109
+ | {
10110
+ /** ID of the action attempt. */
10111
+ action_attempt_id: string
10112
+ status: 'success'
10113
+ /** Errors associated with the action attempt. Null for successful action attempts. */
10114
+ error: null
10115
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
10116
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
10117
+ /** Result of the action. */
10118
+ result: {}
10119
+ }
10120
+ | {
10121
+ /** ID of the action attempt. */
10122
+ action_attempt_id: string
10123
+ status: 'error'
10124
+ /** Result of the action attempt. Null for failed action attempts. */
10125
+ result: null
10126
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
10127
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
10128
+ /** Error associated with the action. */
10129
+ error: {
10130
+ /** Type of the error. */
10131
+ type: string
10132
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
10133
+ message: string
10134
+ }
10135
+ }
10022
10136
  | {
10023
10137
  /** ID of the action attempt. */
10024
10138
  action_attempt_id: string
@@ -13130,6 +13244,44 @@ export type Routes = {
13130
13244
  message: string
13131
13245
  }
13132
13246
  }
13247
+ | {
13248
+ /** ID of the action attempt. */
13249
+ action_attempt_id: string
13250
+ status: 'pending'
13251
+ /** Result of the action attempt. Null for pending action attempts. */
13252
+ result: null
13253
+ /** Errors associated with the action attempt. Null for pending action attempts. */
13254
+ error: null
13255
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
13256
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
13257
+ }
13258
+ | {
13259
+ /** ID of the action attempt. */
13260
+ action_attempt_id: string
13261
+ status: 'success'
13262
+ /** Errors associated with the action attempt. Null for successful action attempts. */
13263
+ error: null
13264
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
13265
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
13266
+ /** Result of the action. */
13267
+ result: {}
13268
+ }
13269
+ | {
13270
+ /** ID of the action attempt. */
13271
+ action_attempt_id: string
13272
+ status: 'error'
13273
+ /** Result of the action attempt. Null for failed action attempts. */
13274
+ result: null
13275
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
13276
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
13277
+ /** Error associated with the action. */
13278
+ error: {
13279
+ /** Type of the error. */
13280
+ type: string
13281
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
13282
+ message: string
13283
+ }
13284
+ }
13133
13285
  | {
13134
13286
  /** ID of the action attempt. */
13135
13287
  action_attempt_id: string
@@ -16133,6 +16285,8 @@ export type Routes = {
16133
16285
  can_hvac_heat_cool?: boolean | undefined
16134
16286
  /** Indicates whether the thermostat can be turned off. */
16135
16287
  can_turn_off_hvac?: boolean | undefined
16288
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
16289
+ can_activate_weekly_program?: boolean | undefined
16136
16290
  /** Indicates whether the device supports simulating removal in a sandbox. */
16137
16291
  can_simulate_removal?: boolean | undefined
16138
16292
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -19886,6 +20040,44 @@ export type Routes = {
19886
20040
  message: string
19887
20041
  }
19888
20042
  }
20043
+ | {
20044
+ /** ID of the action attempt. */
20045
+ action_attempt_id: string
20046
+ status: 'pending'
20047
+ /** Result of the action attempt. Null for pending action attempts. */
20048
+ result: null
20049
+ /** Errors associated with the action attempt. Null for pending action attempts. */
20050
+ error: null
20051
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
20052
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
20053
+ }
20054
+ | {
20055
+ /** ID of the action attempt. */
20056
+ action_attempt_id: string
20057
+ status: 'success'
20058
+ /** Errors associated with the action attempt. Null for successful action attempts. */
20059
+ error: null
20060
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
20061
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
20062
+ /** Result of the action. */
20063
+ result: {}
20064
+ }
20065
+ | {
20066
+ /** ID of the action attempt. */
20067
+ action_attempt_id: string
20068
+ status: 'error'
20069
+ /** Result of the action attempt. Null for failed action attempts. */
20070
+ result: null
20071
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
20072
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
20073
+ /** Error associated with the action. */
20074
+ error: {
20075
+ /** Type of the error. */
20076
+ type: string
20077
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
20078
+ message: string
20079
+ }
20080
+ }
19889
20081
  | {
19890
20082
  /** ID of the action attempt. */
19891
20083
  action_attempt_id: string
@@ -22026,6 +22218,44 @@ export type Routes = {
22026
22218
  message: string
22027
22219
  }
22028
22220
  }
22221
+ | {
22222
+ /** ID of the action attempt. */
22223
+ action_attempt_id: string
22224
+ status: 'pending'
22225
+ /** Result of the action attempt. Null for pending action attempts. */
22226
+ result: null
22227
+ /** Errors associated with the action attempt. Null for pending action attempts. */
22228
+ error: null
22229
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
22230
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
22231
+ }
22232
+ | {
22233
+ /** ID of the action attempt. */
22234
+ action_attempt_id: string
22235
+ status: 'success'
22236
+ /** Errors associated with the action attempt. Null for successful action attempts. */
22237
+ error: null
22238
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
22239
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
22240
+ /** Result of the action. */
22241
+ result: {}
22242
+ }
22243
+ | {
22244
+ /** ID of the action attempt. */
22245
+ action_attempt_id: string
22246
+ status: 'error'
22247
+ /** Result of the action attempt. Null for failed action attempts. */
22248
+ result: null
22249
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
22250
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
22251
+ /** Error associated with the action. */
22252
+ error: {
22253
+ /** Type of the error. */
22254
+ type: string
22255
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
22256
+ message: string
22257
+ }
22258
+ }
22029
22259
  | {
22030
22260
  /** ID of the action attempt. */
22031
22261
  action_attempt_id: string
@@ -24671,6 +24901,8 @@ export type Routes = {
24671
24901
  can_hvac_heat_cool?: boolean | undefined
24672
24902
  /** Indicates whether the thermostat can be turned off. */
24673
24903
  can_turn_off_hvac?: boolean | undefined
24904
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
24905
+ can_activate_weekly_program?: boolean | undefined
24674
24906
  /** Indicates whether the device supports simulating removal in a sandbox. */
24675
24907
  can_simulate_removal?: boolean | undefined
24676
24908
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -27449,6 +27681,44 @@ export type Routes = {
27449
27681
  message: string
27450
27682
  }
27451
27683
  }
27684
+ | {
27685
+ /** ID of the action attempt. */
27686
+ action_attempt_id: string
27687
+ status: 'pending'
27688
+ /** Result of the action attempt. Null for pending action attempts. */
27689
+ result: null
27690
+ /** Errors associated with the action attempt. Null for pending action attempts. */
27691
+ error: null
27692
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
27693
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
27694
+ }
27695
+ | {
27696
+ /** ID of the action attempt. */
27697
+ action_attempt_id: string
27698
+ status: 'success'
27699
+ /** Errors associated with the action attempt. Null for successful action attempts. */
27700
+ error: null
27701
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
27702
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
27703
+ /** Result of the action. */
27704
+ result: {}
27705
+ }
27706
+ | {
27707
+ /** ID of the action attempt. */
27708
+ action_attempt_id: string
27709
+ status: 'error'
27710
+ /** Result of the action attempt. Null for failed action attempts. */
27711
+ result: null
27712
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
27713
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
27714
+ /** Error associated with the action. */
27715
+ error: {
27716
+ /** Type of the error. */
27717
+ type: string
27718
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
27719
+ message: string
27720
+ }
27721
+ }
27452
27722
  | {
27453
27723
  /** ID of the action attempt. */
27454
27724
  action_attempt_id: string
@@ -33705,6 +33975,44 @@ export type Routes = {
33705
33975
  message: string
33706
33976
  }
33707
33977
  }
33978
+ | {
33979
+ /** ID of the action attempt. */
33980
+ action_attempt_id: string
33981
+ status: 'pending'
33982
+ /** Result of the action attempt. Null for pending action attempts. */
33983
+ result: null
33984
+ /** Errors associated with the action attempt. Null for pending action attempts. */
33985
+ error: null
33986
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
33987
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
33988
+ }
33989
+ | {
33990
+ /** ID of the action attempt. */
33991
+ action_attempt_id: string
33992
+ status: 'success'
33993
+ /** Errors associated with the action attempt. Null for successful action attempts. */
33994
+ error: null
33995
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
33996
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
33997
+ /** Result of the action. */
33998
+ result: {}
33999
+ }
34000
+ | {
34001
+ /** ID of the action attempt. */
34002
+ action_attempt_id: string
34003
+ status: 'error'
34004
+ /** Result of the action attempt. Null for failed action attempts. */
34005
+ result: null
34006
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
34007
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
34008
+ /** Error associated with the action. */
34009
+ error: {
34010
+ /** Type of the error. */
34011
+ type: string
34012
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
34013
+ message: string
34014
+ }
34015
+ }
33708
34016
  | {
33709
34017
  /** ID of the action attempt. */
33710
34018
  action_attempt_id: string
@@ -35933,6 +36241,44 @@ export type Routes = {
35933
36241
  message: string
35934
36242
  }
35935
36243
  }
36244
+ | {
36245
+ /** ID of the action attempt. */
36246
+ action_attempt_id: string
36247
+ status: 'pending'
36248
+ /** Result of the action attempt. Null for pending action attempts. */
36249
+ result: null
36250
+ /** Errors associated with the action attempt. Null for pending action attempts. */
36251
+ error: null
36252
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
36253
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
36254
+ }
36255
+ | {
36256
+ /** ID of the action attempt. */
36257
+ action_attempt_id: string
36258
+ status: 'success'
36259
+ /** Errors associated with the action attempt. Null for successful action attempts. */
36260
+ error: null
36261
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
36262
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
36263
+ /** Result of the action. */
36264
+ result: {}
36265
+ }
36266
+ | {
36267
+ /** ID of the action attempt. */
36268
+ action_attempt_id: string
36269
+ status: 'error'
36270
+ /** Result of the action attempt. Null for failed action attempts. */
36271
+ result: null
36272
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
36273
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
36274
+ /** Error associated with the action. */
36275
+ error: {
36276
+ /** Type of the error. */
36277
+ type: string
36278
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
36279
+ message: string
36280
+ }
36281
+ }
35936
36282
  | {
35937
36283
  /** ID of the action attempt. */
35938
36284
  action_attempt_id: string
@@ -38060,6 +38406,44 @@ export type Routes = {
38060
38406
  message: string
38061
38407
  }
38062
38408
  }
38409
+ | {
38410
+ /** ID of the action attempt. */
38411
+ action_attempt_id: string
38412
+ status: 'pending'
38413
+ /** Result of the action attempt. Null for pending action attempts. */
38414
+ result: null
38415
+ /** Errors associated with the action attempt. Null for pending action attempts. */
38416
+ error: null
38417
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
38418
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
38419
+ }
38420
+ | {
38421
+ /** ID of the action attempt. */
38422
+ action_attempt_id: string
38423
+ status: 'success'
38424
+ /** Errors associated with the action attempt. Null for successful action attempts. */
38425
+ error: null
38426
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
38427
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
38428
+ /** Result of the action. */
38429
+ result: {}
38430
+ }
38431
+ | {
38432
+ /** ID of the action attempt. */
38433
+ action_attempt_id: string
38434
+ status: 'error'
38435
+ /** Result of the action attempt. Null for failed action attempts. */
38436
+ result: null
38437
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
38438
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
38439
+ /** Error associated with the action. */
38440
+ error: {
38441
+ /** Type of the error. */
38442
+ type: string
38443
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
38444
+ message: string
38445
+ }
38446
+ }
38063
38447
  | {
38064
38448
  /** ID of the action attempt. */
38065
38449
  action_attempt_id: string
@@ -41072,6 +41456,44 @@ export type Routes = {
41072
41456
  message: string
41073
41457
  }
41074
41458
  }
41459
+ | {
41460
+ /** ID of the action attempt. */
41461
+ action_attempt_id: string
41462
+ status: 'pending'
41463
+ /** Result of the action attempt. Null for pending action attempts. */
41464
+ result: null
41465
+ /** Errors associated with the action attempt. Null for pending action attempts. */
41466
+ error: null
41467
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
41468
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
41469
+ }
41470
+ | {
41471
+ /** ID of the action attempt. */
41472
+ action_attempt_id: string
41473
+ status: 'success'
41474
+ /** Errors associated with the action attempt. Null for successful action attempts. */
41475
+ error: null
41476
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
41477
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
41478
+ /** Result of the action. */
41479
+ result: {}
41480
+ }
41481
+ | {
41482
+ /** ID of the action attempt. */
41483
+ action_attempt_id: string
41484
+ status: 'error'
41485
+ /** Result of the action attempt. Null for failed action attempts. */
41486
+ result: null
41487
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
41488
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
41489
+ /** Error associated with the action. */
41490
+ error: {
41491
+ /** Type of the error. */
41492
+ type: string
41493
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
41494
+ message: string
41495
+ }
41496
+ }
41075
41497
  | {
41076
41498
  /** ID of the action attempt. */
41077
41499
  action_attempt_id: string
@@ -45998,6 +46420,44 @@ export type Routes = {
45998
46420
  message: string
45999
46421
  }
46000
46422
  }
46423
+ | {
46424
+ /** ID of the action attempt. */
46425
+ action_attempt_id: string
46426
+ status: 'pending'
46427
+ /** Result of the action attempt. Null for pending action attempts. */
46428
+ result: null
46429
+ /** Errors associated with the action attempt. Null for pending action attempts. */
46430
+ error: null
46431
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
46432
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
46433
+ }
46434
+ | {
46435
+ /** ID of the action attempt. */
46436
+ action_attempt_id: string
46437
+ status: 'success'
46438
+ /** Errors associated with the action attempt. Null for successful action attempts. */
46439
+ error: null
46440
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
46441
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
46442
+ /** Result of the action. */
46443
+ result: {}
46444
+ }
46445
+ | {
46446
+ /** ID of the action attempt. */
46447
+ action_attempt_id: string
46448
+ status: 'error'
46449
+ /** Result of the action attempt. Null for failed action attempts. */
46450
+ result: null
46451
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
46452
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
46453
+ /** Error associated with the action. */
46454
+ error: {
46455
+ /** Type of the error. */
46456
+ type: string
46457
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
46458
+ message: string
46459
+ }
46460
+ }
46001
46461
  | {
46002
46462
  /** ID of the action attempt. */
46003
46463
  action_attempt_id: string
@@ -48115,6 +48575,44 @@ export type Routes = {
48115
48575
  message: string
48116
48576
  }
48117
48577
  }
48578
+ | {
48579
+ /** ID of the action attempt. */
48580
+ action_attempt_id: string
48581
+ status: 'pending'
48582
+ /** Result of the action attempt. Null for pending action attempts. */
48583
+ result: null
48584
+ /** Errors associated with the action attempt. Null for pending action attempts. */
48585
+ error: null
48586
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
48587
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
48588
+ }
48589
+ | {
48590
+ /** ID of the action attempt. */
48591
+ action_attempt_id: string
48592
+ status: 'success'
48593
+ /** Errors associated with the action attempt. Null for successful action attempts. */
48594
+ error: null
48595
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
48596
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
48597
+ /** Result of the action. */
48598
+ result: {}
48599
+ }
48600
+ | {
48601
+ /** ID of the action attempt. */
48602
+ action_attempt_id: string
48603
+ status: 'error'
48604
+ /** Result of the action attempt. Null for failed action attempts. */
48605
+ result: null
48606
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
48607
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
48608
+ /** Error associated with the action. */
48609
+ error: {
48610
+ /** Type of the error. */
48611
+ type: string
48612
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
48613
+ message: string
48614
+ }
48615
+ }
48118
48616
  | {
48119
48617
  /** ID of the action attempt. */
48120
48618
  action_attempt_id: string
@@ -53059,6 +53557,8 @@ export type Routes = {
53059
53557
  can_hvac_heat_cool?: boolean | undefined
53060
53558
  /** Indicates whether the thermostat can be turned off. */
53061
53559
  can_turn_off_hvac?: boolean | undefined
53560
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
53561
+ can_activate_weekly_program?: boolean | undefined
53062
53562
  /** Indicates whether the device supports simulating removal in a sandbox. */
53063
53563
  can_simulate_removal?: boolean | undefined
53064
53564
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -53290,6 +53790,7 @@ export type Routes = {
53290
53790
  | 'can_hvac_cool'
53291
53791
  | 'can_hvac_heat_cool'
53292
53792
  | 'can_turn_off_hvac'
53793
+ | 'can_activate_weekly_program'
53293
53794
  | 'can_simulate_removal'
53294
53795
  | 'can_simulate_connection'
53295
53796
  | 'can_simulate_disconnection'
@@ -53315,6 +53816,7 @@ export type Routes = {
53315
53816
  | 'can_hvac_cool'
53316
53817
  | 'can_hvac_heat_cool'
53317
53818
  | 'can_turn_off_hvac'
53819
+ | 'can_activate_weekly_program'
53318
53820
  | 'can_simulate_removal'
53319
53821
  | 'can_simulate_connection'
53320
53822
  | 'can_simulate_disconnection'
@@ -55232,6 +55734,8 @@ export type Routes = {
55232
55734
  can_hvac_heat_cool?: boolean | undefined
55233
55735
  /** Indicates whether the thermostat can be turned off. */
55234
55736
  can_turn_off_hvac?: boolean | undefined
55737
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
55738
+ can_activate_weekly_program?: boolean | undefined
55235
55739
  /** Indicates whether the device supports simulating removal in a sandbox. */
55236
55740
  can_simulate_removal?: boolean | undefined
55237
55741
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -55393,6 +55897,8 @@ export type Routes = {
55393
55897
  can_hvac_heat_cool?: boolean | undefined
55394
55898
  /** Indicates whether the thermostat can be turned off. */
55395
55899
  can_turn_off_hvac?: boolean | undefined
55900
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
55901
+ can_activate_weekly_program?: boolean | undefined
55396
55902
  /** Indicates whether the device supports simulating removal in a sandbox. */
55397
55903
  can_simulate_removal?: boolean | undefined
55398
55904
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -57406,6 +57912,8 @@ export type Routes = {
57406
57912
  can_hvac_heat_cool?: boolean | undefined
57407
57913
  /** Indicates whether the thermostat can be turned off. */
57408
57914
  can_turn_off_hvac?: boolean | undefined
57915
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
57916
+ can_activate_weekly_program?: boolean | undefined
57409
57917
  /** Indicates whether the device supports simulating removal in a sandbox. */
57410
57918
  can_simulate_removal?: boolean | undefined
57411
57919
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -57627,6 +58135,7 @@ export type Routes = {
57627
58135
  | 'can_hvac_cool'
57628
58136
  | 'can_hvac_heat_cool'
57629
58137
  | 'can_turn_off_hvac'
58138
+ | 'can_activate_weekly_program'
57630
58139
  | 'can_simulate_removal'
57631
58140
  | 'can_simulate_connection'
57632
58141
  | 'can_simulate_disconnection'
@@ -57652,6 +58161,7 @@ export type Routes = {
57652
58161
  | 'can_hvac_cool'
57653
58162
  | 'can_hvac_heat_cool'
57654
58163
  | 'can_turn_off_hvac'
58164
+ | 'can_activate_weekly_program'
57655
58165
  | 'can_simulate_removal'
57656
58166
  | 'can_simulate_connection'
57657
58167
  | 'can_simulate_disconnection'
@@ -58241,6 +58751,8 @@ export type Routes = {
58241
58751
  can_hvac_heat_cool?: boolean | undefined
58242
58752
  /** Indicates whether the thermostat can be turned off. */
58243
58753
  can_turn_off_hvac?: boolean | undefined
58754
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
58755
+ can_activate_weekly_program?: boolean | undefined
58244
58756
  /** Indicates whether the device supports simulating removal in a sandbox. */
58245
58757
  can_simulate_removal?: boolean | undefined
58246
58758
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -62203,6 +62715,10 @@ export type Routes = {
62203
62715
  image_url?: string | undefined
62204
62716
  /** URL to a short video clip captured at the time of activation. */
62205
62717
  video_url?: string | undefined
62718
+ /** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
62719
+ media_status?:
62720
+ | ('pending' | 'available' | 'unavailable' | 'failed')
62721
+ | undefined
62206
62722
  }
62207
62723
  | {
62208
62724
  /** ID of the event. */
@@ -66496,6 +67012,9 @@ export type Routes = {
66496
67012
  image_url?: string | undefined
66497
67013
  /** URL to a short video clip captured at the time of activation. */
66498
67014
  video_url?: string | undefined
67015
+ /** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
67016
+ media_status?:
67017
+ ('pending' | 'available' | 'unavailable' | 'failed') | undefined
66499
67018
  }
66500
67019
  | {
66501
67020
  /** ID of the event. */
@@ -68419,6 +68938,44 @@ export type Routes = {
68419
68938
  message: string
68420
68939
  }
68421
68940
  }
68941
+ | {
68942
+ /** ID of the action attempt. */
68943
+ action_attempt_id: string
68944
+ status: 'pending'
68945
+ /** Result of the action attempt. Null for pending action attempts. */
68946
+ result: null
68947
+ /** Errors associated with the action attempt. Null for pending action attempts. */
68948
+ error: null
68949
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68950
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
68951
+ }
68952
+ | {
68953
+ /** ID of the action attempt. */
68954
+ action_attempt_id: string
68955
+ status: 'success'
68956
+ /** Errors associated with the action attempt. Null for successful action attempts. */
68957
+ error: null
68958
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68959
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
68960
+ /** Result of the action. */
68961
+ result: {}
68962
+ }
68963
+ | {
68964
+ /** ID of the action attempt. */
68965
+ action_attempt_id: string
68966
+ status: 'error'
68967
+ /** Result of the action attempt. Null for failed action attempts. */
68968
+ result: null
68969
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68970
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
68971
+ /** Error associated with the action. */
68972
+ error: {
68973
+ /** Type of the error. */
68974
+ type: string
68975
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
68976
+ message: string
68977
+ }
68978
+ }
68422
68979
  | {
68423
68980
  /** ID of the action attempt. */
68424
68981
  action_attempt_id: string
@@ -70769,6 +71326,8 @@ export type Routes = {
70769
71326
  can_hvac_heat_cool?: boolean | undefined
70770
71327
  /** Indicates whether the thermostat can be turned off. */
70771
71328
  can_turn_off_hvac?: boolean | undefined
71329
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
71330
+ can_activate_weekly_program?: boolean | undefined
70772
71331
  /** Indicates whether the device supports simulating removal in a sandbox. */
70773
71332
  can_simulate_removal?: boolean | undefined
70774
71333
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -72689,6 +73248,8 @@ export type Routes = {
72689
73248
  can_hvac_heat_cool?: boolean | undefined
72690
73249
  /** Indicates whether the thermostat can be turned off. */
72691
73250
  can_turn_off_hvac?: boolean | undefined
73251
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
73252
+ can_activate_weekly_program?: boolean | undefined
72692
73253
  /** Indicates whether the device supports simulating removal in a sandbox. */
72693
73254
  can_simulate_removal?: boolean | undefined
72694
73255
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -74738,6 +75299,8 @@ export type Routes = {
74738
75299
  can_hvac_heat_cool?: boolean | undefined
74739
75300
  /** Indicates whether the thermostat can be turned off. */
74740
75301
  can_turn_off_hvac?: boolean | undefined
75302
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
75303
+ can_activate_weekly_program?: boolean | undefined
74741
75304
  /** Indicates whether the device supports simulating removal in a sandbox. */
74742
75305
  can_simulate_removal?: boolean | undefined
74743
75306
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -76657,6 +77220,8 @@ export type Routes = {
76657
77220
  can_hvac_heat_cool?: boolean | undefined
76658
77221
  /** Indicates whether the thermostat can be turned off. */
76659
77222
  can_turn_off_hvac?: boolean | undefined
77223
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
77224
+ can_activate_weekly_program?: boolean | undefined
76660
77225
  /** Indicates whether the device supports simulating removal in a sandbox. */
76661
77226
  can_simulate_removal?: boolean | undefined
76662
77227
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -78361,6 +78926,44 @@ export type Routes = {
78361
78926
  message: string
78362
78927
  }
78363
78928
  }
78929
+ | {
78930
+ /** ID of the action attempt. */
78931
+ action_attempt_id: string
78932
+ status: 'pending'
78933
+ /** Result of the action attempt. Null for pending action attempts. */
78934
+ result: null
78935
+ /** Errors associated with the action attempt. Null for pending action attempts. */
78936
+ error: null
78937
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
78938
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
78939
+ }
78940
+ | {
78941
+ /** ID of the action attempt. */
78942
+ action_attempt_id: string
78943
+ status: 'success'
78944
+ /** Errors associated with the action attempt. Null for successful action attempts. */
78945
+ error: null
78946
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
78947
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
78948
+ /** Result of the action. */
78949
+ result: {}
78950
+ }
78951
+ | {
78952
+ /** ID of the action attempt. */
78953
+ action_attempt_id: string
78954
+ status: 'error'
78955
+ /** Result of the action attempt. Null for failed action attempts. */
78956
+ result: null
78957
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
78958
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
78959
+ /** Error associated with the action. */
78960
+ error: {
78961
+ /** Type of the error. */
78962
+ type: string
78963
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
78964
+ message: string
78965
+ }
78966
+ }
78364
78967
  | {
78365
78968
  /** ID of the action attempt. */
78366
78969
  action_attempt_id: string
@@ -80479,6 +81082,44 @@ export type Routes = {
80479
81082
  message: string
80480
81083
  }
80481
81084
  }
81085
+ | {
81086
+ /** ID of the action attempt. */
81087
+ action_attempt_id: string
81088
+ status: 'pending'
81089
+ /** Result of the action attempt. Null for pending action attempts. */
81090
+ result: null
81091
+ /** Errors associated with the action attempt. Null for pending action attempts. */
81092
+ error: null
81093
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
81094
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
81095
+ }
81096
+ | {
81097
+ /** ID of the action attempt. */
81098
+ action_attempt_id: string
81099
+ status: 'success'
81100
+ /** Errors associated with the action attempt. Null for successful action attempts. */
81101
+ error: null
81102
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
81103
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
81104
+ /** Result of the action. */
81105
+ result: {}
81106
+ }
81107
+ | {
81108
+ /** ID of the action attempt. */
81109
+ action_attempt_id: string
81110
+ status: 'error'
81111
+ /** Result of the action attempt. Null for failed action attempts. */
81112
+ result: null
81113
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
81114
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
81115
+ /** Error associated with the action. */
81116
+ error: {
81117
+ /** Type of the error. */
81118
+ type: string
81119
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
81120
+ message: string
81121
+ }
81122
+ }
80482
81123
  | {
80483
81124
  /** ID of the action attempt. */
80484
81125
  action_attempt_id: string
@@ -82595,6 +83236,44 @@ export type Routes = {
82595
83236
  message: string
82596
83237
  }
82597
83238
  }
83239
+ | {
83240
+ /** ID of the action attempt. */
83241
+ action_attempt_id: string
83242
+ status: 'pending'
83243
+ /** Result of the action attempt. Null for pending action attempts. */
83244
+ result: null
83245
+ /** Errors associated with the action attempt. Null for pending action attempts. */
83246
+ error: null
83247
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83248
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
83249
+ }
83250
+ | {
83251
+ /** ID of the action attempt. */
83252
+ action_attempt_id: string
83253
+ status: 'success'
83254
+ /** Errors associated with the action attempt. Null for successful action attempts. */
83255
+ error: null
83256
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83257
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
83258
+ /** Result of the action. */
83259
+ result: {}
83260
+ }
83261
+ | {
83262
+ /** ID of the action attempt. */
83263
+ action_attempt_id: string
83264
+ status: 'error'
83265
+ /** Result of the action attempt. Null for failed action attempts. */
83266
+ result: null
83267
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83268
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
83269
+ /** Error associated with the action. */
83270
+ error: {
83271
+ /** Type of the error. */
83272
+ type: string
83273
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
83274
+ message: string
83275
+ }
83276
+ }
82598
83277
  | {
82599
83278
  /** ID of the action attempt. */
82600
83279
  action_attempt_id: string
@@ -84713,6 +85392,44 @@ export type Routes = {
84713
85392
  message: string
84714
85393
  }
84715
85394
  }
85395
+ | {
85396
+ /** ID of the action attempt. */
85397
+ action_attempt_id: string
85398
+ status: 'pending'
85399
+ /** Result of the action attempt. Null for pending action attempts. */
85400
+ result: null
85401
+ /** Errors associated with the action attempt. Null for pending action attempts. */
85402
+ error: null
85403
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
85404
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
85405
+ }
85406
+ | {
85407
+ /** ID of the action attempt. */
85408
+ action_attempt_id: string
85409
+ status: 'success'
85410
+ /** Errors associated with the action attempt. Null for successful action attempts. */
85411
+ error: null
85412
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
85413
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
85414
+ /** Result of the action. */
85415
+ result: {}
85416
+ }
85417
+ | {
85418
+ /** ID of the action attempt. */
85419
+ action_attempt_id: string
85420
+ status: 'error'
85421
+ /** Result of the action attempt. Null for failed action attempts. */
85422
+ result: null
85423
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
85424
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
85425
+ /** Error associated with the action. */
85426
+ error: {
85427
+ /** Type of the error. */
85428
+ type: string
85429
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85430
+ message: string
85431
+ }
85432
+ }
84716
85433
  | {
84717
85434
  /** ID of the action attempt. */
84718
85435
  action_attempt_id: string
@@ -87070,6 +87787,8 @@ export type Routes = {
87070
87787
  can_hvac_heat_cool?: boolean | undefined
87071
87788
  /** Indicates whether the thermostat can be turned off. */
87072
87789
  can_turn_off_hvac?: boolean | undefined
87790
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
87791
+ can_activate_weekly_program?: boolean | undefined
87073
87792
  /** Indicates whether the device supports simulating removal in a sandbox. */
87074
87793
  can_simulate_removal?: boolean | undefined
87075
87794
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -88989,6 +89708,8 @@ export type Routes = {
88989
89708
  can_hvac_heat_cool?: boolean | undefined
88990
89709
  /** Indicates whether the thermostat can be turned off. */
88991
89710
  can_turn_off_hvac?: boolean | undefined
89711
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
89712
+ can_activate_weekly_program?: boolean | undefined
88992
89713
  /** Indicates whether the device supports simulating removal in a sandbox. */
88993
89714
  can_simulate_removal?: boolean | undefined
88994
89715
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -90703,6 +91424,44 @@ export type Routes = {
90703
91424
  message: string
90704
91425
  }
90705
91426
  }
91427
+ | {
91428
+ /** ID of the action attempt. */
91429
+ action_attempt_id: string
91430
+ status: 'pending'
91431
+ /** Result of the action attempt. Null for pending action attempts. */
91432
+ result: null
91433
+ /** Errors associated with the action attempt. Null for pending action attempts. */
91434
+ error: null
91435
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
91436
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
91437
+ }
91438
+ | {
91439
+ /** ID of the action attempt. */
91440
+ action_attempt_id: string
91441
+ status: 'success'
91442
+ /** Errors associated with the action attempt. Null for successful action attempts. */
91443
+ error: null
91444
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
91445
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
91446
+ /** Result of the action. */
91447
+ result: {}
91448
+ }
91449
+ | {
91450
+ /** ID of the action attempt. */
91451
+ action_attempt_id: string
91452
+ status: 'error'
91453
+ /** Result of the action attempt. Null for failed action attempts. */
91454
+ result: null
91455
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
91456
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
91457
+ /** Error associated with the action. */
91458
+ error: {
91459
+ /** Type of the error. */
91460
+ type: string
91461
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
91462
+ message: string
91463
+ }
91464
+ }
90706
91465
  | {
90707
91466
  /** ID of the action attempt. */
90708
91467
  action_attempt_id: string
@@ -92840,6 +93599,44 @@ export type Routes = {
92840
93599
  message: string
92841
93600
  }
92842
93601
  }
93602
+ | {
93603
+ /** ID of the action attempt. */
93604
+ action_attempt_id: string
93605
+ status: 'pending'
93606
+ /** Result of the action attempt. Null for pending action attempts. */
93607
+ result: null
93608
+ /** Errors associated with the action attempt. Null for pending action attempts. */
93609
+ error: null
93610
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
93611
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
93612
+ }
93613
+ | {
93614
+ /** ID of the action attempt. */
93615
+ action_attempt_id: string
93616
+ status: 'success'
93617
+ /** Errors associated with the action attempt. Null for successful action attempts. */
93618
+ error: null
93619
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
93620
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
93621
+ /** Result of the action. */
93622
+ result: {}
93623
+ }
93624
+ | {
93625
+ /** ID of the action attempt. */
93626
+ action_attempt_id: string
93627
+ status: 'error'
93628
+ /** Result of the action attempt. Null for failed action attempts. */
93629
+ result: null
93630
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
93631
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
93632
+ /** Error associated with the action. */
93633
+ error: {
93634
+ /** Type of the error. */
93635
+ type: string
93636
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
93637
+ message: string
93638
+ }
93639
+ }
92843
93640
  | {
92844
93641
  /** ID of the action attempt. */
92845
93642
  action_attempt_id: string
@@ -95033,6 +95830,44 @@ export type Routes = {
95033
95830
  message: string
95034
95831
  }
95035
95832
  }
95833
+ | {
95834
+ /** ID of the action attempt. */
95835
+ action_attempt_id: string
95836
+ status: 'pending'
95837
+ /** Result of the action attempt. Null for pending action attempts. */
95838
+ result: null
95839
+ /** Errors associated with the action attempt. Null for pending action attempts. */
95840
+ error: null
95841
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
95842
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
95843
+ }
95844
+ | {
95845
+ /** ID of the action attempt. */
95846
+ action_attempt_id: string
95847
+ status: 'success'
95848
+ /** Errors associated with the action attempt. Null for successful action attempts. */
95849
+ error: null
95850
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
95851
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
95852
+ /** Result of the action. */
95853
+ result: {}
95854
+ }
95855
+ | {
95856
+ /** ID of the action attempt. */
95857
+ action_attempt_id: string
95858
+ status: 'error'
95859
+ /** Result of the action attempt. Null for failed action attempts. */
95860
+ result: null
95861
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
95862
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
95863
+ /** Error associated with the action. */
95864
+ error: {
95865
+ /** Type of the error. */
95866
+ type: string
95867
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
95868
+ message: string
95869
+ }
95870
+ }
95036
95871
  | {
95037
95872
  /** ID of the action attempt. */
95038
95873
  action_attempt_id: string
@@ -99120,6 +99955,44 @@ export type Routes = {
99120
99955
  message: string
99121
99956
  }
99122
99957
  }
99958
+ | {
99959
+ /** ID of the action attempt. */
99960
+ action_attempt_id: string
99961
+ status: 'pending'
99962
+ /** Result of the action attempt. Null for pending action attempts. */
99963
+ result: null
99964
+ /** Errors associated with the action attempt. Null for pending action attempts. */
99965
+ error: null
99966
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99967
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
99968
+ }
99969
+ | {
99970
+ /** ID of the action attempt. */
99971
+ action_attempt_id: string
99972
+ status: 'success'
99973
+ /** Errors associated with the action attempt. Null for successful action attempts. */
99974
+ error: null
99975
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99976
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
99977
+ /** Result of the action. */
99978
+ result: {}
99979
+ }
99980
+ | {
99981
+ /** ID of the action attempt. */
99982
+ action_attempt_id: string
99983
+ status: 'error'
99984
+ /** Result of the action attempt. Null for failed action attempts. */
99985
+ result: null
99986
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99987
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
99988
+ /** Error associated with the action. */
99989
+ error: {
99990
+ /** Type of the error. */
99991
+ type: string
99992
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99993
+ message: string
99994
+ }
99995
+ }
99123
99996
  | {
99124
99997
  /** ID of the action attempt. */
99125
99998
  action_attempt_id: string
@@ -104667,6 +105540,9 @@ export type Routes = {
104667
105540
  image_url?: string | undefined
104668
105541
  /** URL to a short video clip captured at the time of activation. */
104669
105542
  video_url?: string | undefined
105543
+ /** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
105544
+ media_status?:
105545
+ ('pending' | 'available' | 'unavailable' | 'failed') | undefined
104670
105546
  }
104671
105547
  | {
104672
105548
  /** ID of the event. */
@@ -111305,6 +112181,9 @@ export type Routes = {
111305
112181
  image_url?: string | undefined
111306
112182
  /** URL to a short video clip captured at the time of activation. */
111307
112183
  video_url?: string | undefined
112184
+ /** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
112185
+ media_status?:
112186
+ ('pending' | 'available' | 'unavailable' | 'failed') | undefined
111308
112187
  }
111309
112188
  | {
111310
112189
  /** ID of the event. */
@@ -113713,6 +114592,8 @@ export type Routes = {
113713
114592
  can_hvac_heat_cool?: boolean | undefined
113714
114593
  /** Indicates whether the thermostat can be turned off. */
113715
114594
  can_turn_off_hvac?: boolean | undefined
114595
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
114596
+ can_activate_weekly_program?: boolean | undefined
113716
114597
  /** Indicates whether the device supports simulating removal in a sandbox. */
113717
114598
  can_simulate_removal?: boolean | undefined
113718
114599
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -114597,235 +115478,2391 @@ export type Routes = {
114597
115478
  )[]
114598
115479
  /** ID of the customization profile associated with the access method. */
114599
115480
  customization_profile_id?: string | undefined
114600
- }[]
114601
- | undefined
114602
- }
114603
- }
114604
- maxDuration: undefined
114605
- }
114606
- '/spaces/list': {
114607
- route: '/spaces/list'
114608
- method: 'GET' | 'POST'
114609
- queryParams: {}
114610
- jsonBody: {}
114611
- commonParams: {
114612
- /** Customer key for which you want to list spaces. */
114613
- customer_key?: string | undefined
114614
- /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
114615
- search?: string | undefined
114616
- /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
114617
- connected_account_id?: string | undefined
114618
- /** Filter spaces by space_key. */
114619
- space_key?: string | undefined
114620
- /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
114621
- parent_space_id?: string | undefined
114622
- /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
114623
- parent_space_key?: string | undefined
114624
- /** Maximum number of records to return per page. */
114625
- limit?: number
114626
- /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
114627
- page_cursor?: (string | undefined) | null
114628
- }
114629
- formData: {}
114630
- jsonResponse: {
114631
- spaces: {
114632
- /** ID of the space. */
114633
- space_id: string
114634
- /** ID of the workspace associated with the space. */
114635
- workspace_id: string
114636
- /** Unique key for the space within the workspace. */
114637
- space_key?: string | undefined
114638
- /** Name of the space. */
114639
- name: string
114640
- /** Display name for the space. */
114641
- display_name: string
114642
- /** Date and time at which the space was created. */
114643
- created_at: string
114644
- /** Number of devices in the space. */
114645
- device_count: number
114646
- /** Number of entrances in the space. */
114647
- acs_entrance_count: number
114648
- /** Customer key associated with the space. */
114649
- customer_key?: string | undefined
114650
- /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
114651
- customer_data?:
114652
- | {
114653
- /** IANA time zone for the space, e.g. America/Los_Angeles. */
114654
- time_zone?: (string | null) | undefined
114655
- /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
114656
- default_checkin_time?: (string | null) | undefined
114657
- /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
114658
- default_checkout_time?: (string | null) | undefined
114659
- /** Postal address for the space. */
114660
- address?: (string | null) | undefined
115481
+ }[]
115482
+ | undefined
115483
+ }
115484
+ }
115485
+ maxDuration: undefined
115486
+ }
115487
+ '/spaces/list': {
115488
+ route: '/spaces/list'
115489
+ method: 'GET' | 'POST'
115490
+ queryParams: {}
115491
+ jsonBody: {}
115492
+ commonParams: {
115493
+ /** Customer key for which you want to list spaces. */
115494
+ customer_key?: string | undefined
115495
+ /** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
115496
+ search?: string | undefined
115497
+ /** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
115498
+ connected_account_id?: string | undefined
115499
+ /** Filter spaces by space_key. */
115500
+ space_key?: string | undefined
115501
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
115502
+ parent_space_id?: string | undefined
115503
+ /** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
115504
+ parent_space_key?: string | undefined
115505
+ /** Maximum number of records to return per page. */
115506
+ limit?: number
115507
+ /** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
115508
+ page_cursor?: (string | undefined) | null
115509
+ }
115510
+ formData: {}
115511
+ jsonResponse: {
115512
+ spaces: {
115513
+ /** ID of the space. */
115514
+ space_id: string
115515
+ /** ID of the workspace associated with the space. */
115516
+ workspace_id: string
115517
+ /** Unique key for the space within the workspace. */
115518
+ space_key?: string | undefined
115519
+ /** Name of the space. */
115520
+ name: string
115521
+ /** Display name for the space. */
115522
+ display_name: string
115523
+ /** Date and time at which the space was created. */
115524
+ created_at: string
115525
+ /** Number of devices in the space. */
115526
+ device_count: number
115527
+ /** Number of entrances in the space. */
115528
+ acs_entrance_count: number
115529
+ /** Customer key associated with the space. */
115530
+ customer_key?: string | undefined
115531
+ /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
115532
+ customer_data?:
115533
+ | {
115534
+ /** IANA time zone for the space, e.g. America/Los_Angeles. */
115535
+ time_zone?: (string | null) | undefined
115536
+ /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
115537
+ default_checkin_time?: (string | null) | undefined
115538
+ /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
115539
+ default_checkout_time?: (string | null) | undefined
115540
+ /** Postal address for the space. */
115541
+ address?: (string | null) | undefined
115542
+ }
115543
+ | undefined
115544
+ /** Geographic coordinates (latitude and longitude) of the space. */
115545
+ geolocation?:
115546
+ | ({
115547
+ /** Latitude of the space, in decimal degrees. */
115548
+ latitude: number
115549
+ /** Longitude of the space, in decimal degrees. */
115550
+ longitude: number
115551
+ } | null)
115552
+ | undefined
115553
+ /** */
115554
+ parent_space_id?: string | undefined
115555
+ /** */
115556
+ parent_space_key?: string | undefined
115557
+ }[]
115558
+ /** Information about the current page of results. */
115559
+ pagination: {
115560
+ /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
115561
+ next_page_cursor: string | null
115562
+ /** Indicates whether there is another page of results after this one. */
115563
+ has_next_page: boolean
115564
+ /** URL to get the next page of results. */
115565
+ next_page_url: string | null
115566
+ }
115567
+ }
115568
+ maxDuration: undefined
115569
+ }
115570
+ '/spaces/remove_acs_entrances': {
115571
+ route: '/spaces/remove_acs_entrances'
115572
+ method: 'POST' | 'DELETE'
115573
+ queryParams: {}
115574
+ jsonBody: {}
115575
+ commonParams: {
115576
+ /** ID of the space from which you want to remove entrances. */
115577
+ space_id: string
115578
+ /** IDs of the entrances that you want to remove from the space. */
115579
+ acs_entrance_ids: string[]
115580
+ }
115581
+ formData: {}
115582
+ jsonResponse: {}
115583
+ maxDuration: undefined
115584
+ }
115585
+ '/spaces/remove_connected_account': {
115586
+ route: '/spaces/remove_connected_account'
115587
+ method: 'POST' | 'DELETE'
115588
+ queryParams: {}
115589
+ jsonBody: {}
115590
+ commonParams: {
115591
+ /** ID of the space from which you want to remove the connected account. */
115592
+ space_id: string
115593
+ /** ID of the connected account that you want to remove from the space. */
115594
+ connected_account_id: string
115595
+ }
115596
+ formData: {}
115597
+ jsonResponse: {}
115598
+ maxDuration: undefined
115599
+ }
115600
+ '/spaces/remove_devices': {
115601
+ route: '/spaces/remove_devices'
115602
+ method: 'POST' | 'DELETE'
115603
+ queryParams: {}
115604
+ jsonBody: {}
115605
+ commonParams: {
115606
+ /** ID of the space from which you want to remove devices. */
115607
+ space_id: string
115608
+ /** IDs of the devices that you want to remove from the space. */
115609
+ device_ids: string[]
115610
+ }
115611
+ formData: {}
115612
+ jsonResponse: {}
115613
+ maxDuration: undefined
115614
+ }
115615
+ '/spaces/update': {
115616
+ route: '/spaces/update'
115617
+ method: 'POST' | 'PATCH'
115618
+ queryParams: {}
115619
+ jsonBody: {
115620
+ /** Name of the space. */
115621
+ name?: string | undefined
115622
+ /** ID of the space that you want to update. */
115623
+ space_id?: string | undefined
115624
+ /** Unique key of the space that you want to update. */
115625
+ space_key?: string | undefined
115626
+ /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
115627
+ device_ids?: string[] | undefined
115628
+ /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
115629
+ acs_entrance_ids?: string[] | undefined
115630
+ /** Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it. */
115631
+ customer_data?:
115632
+ | {
115633
+ /** IANA time zone for the space, e.g. America/Los_Angeles. */
115634
+ time_zone?: (string | null) | undefined
115635
+ /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
115636
+ default_checkin_time?: (string | null) | undefined
115637
+ /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
115638
+ default_checkout_time?: (string | null) | undefined
115639
+ /** Postal address for the space. */
115640
+ address?: (string | null) | undefined
115641
+ }
115642
+ | undefined
115643
+ /** Reassign this space to the parent space (site) with this `parent_space_id`. */
115644
+ parent_space_id?: string | undefined
115645
+ /** Reassign this space to the parent space (site) with this `parent_space_key`. */
115646
+ parent_space_key?: string | undefined
115647
+ }
115648
+ commonParams: {}
115649
+ formData: {}
115650
+ jsonResponse: {
115651
+ /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
115652
+ space: {
115653
+ /** ID of the space. */
115654
+ space_id: string
115655
+ /** ID of the workspace associated with the space. */
115656
+ workspace_id: string
115657
+ /** Unique key for the space within the workspace. */
115658
+ space_key?: string | undefined
115659
+ /** Name of the space. */
115660
+ name: string
115661
+ /** Display name for the space. */
115662
+ display_name: string
115663
+ /** Date and time at which the space was created. */
115664
+ created_at: string
115665
+ /** Number of devices in the space. */
115666
+ device_count: number
115667
+ /** Number of entrances in the space. */
115668
+ acs_entrance_count: number
115669
+ /** Customer key associated with the space. */
115670
+ customer_key?: string | undefined
115671
+ /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
115672
+ customer_data?:
115673
+ | {
115674
+ /** IANA time zone for the space, e.g. America/Los_Angeles. */
115675
+ time_zone?: (string | null) | undefined
115676
+ /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
115677
+ default_checkin_time?: (string | null) | undefined
115678
+ /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
115679
+ default_checkout_time?: (string | null) | undefined
115680
+ /** Postal address for the space. */
115681
+ address?: (string | null) | undefined
115682
+ }
115683
+ | undefined
115684
+ /** Geographic coordinates (latitude and longitude) of the space. */
115685
+ geolocation?:
115686
+ | ({
115687
+ /** Latitude of the space, in decimal degrees. */
115688
+ latitude: number
115689
+ /** Longitude of the space, in decimal degrees. */
115690
+ longitude: number
115691
+ } | null)
115692
+ | undefined
115693
+ /** */
115694
+ parent_space_id?: string | undefined
115695
+ /** */
115696
+ parent_space_key?: string | undefined
115697
+ }
115698
+ }
115699
+ maxDuration: undefined
115700
+ }
115701
+ '/thermostats/activate_climate_preset': {
115702
+ route: '/thermostats/activate_climate_preset'
115703
+ method: 'POST'
115704
+ queryParams: {}
115705
+ jsonBody: {
115706
+ /** ID of the thermostat device for which you want to activate a climate preset. */
115707
+ device_id: string
115708
+ /** Climate preset key of the climate preset that you want to activate. */
115709
+ climate_preset_key: string
115710
+ }
115711
+ commonParams: {}
115712
+ formData: {}
115713
+ jsonResponse: {
115714
+ /** 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.
115715
+
115716
+ 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.
115717
+
115718
+ See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts). */
115719
+ action_attempt:
115720
+ | {
115721
+ /** ID of the action attempt. */
115722
+ action_attempt_id: string
115723
+ status: 'pending'
115724
+ /** Result of the action attempt. Null for pending action attempts. */
115725
+ result: null
115726
+ /** Errors associated with the action attempt. Null for pending action attempts. */
115727
+ error: null
115728
+ /** Action attempt to track the status of locking a door. */
115729
+ action_type: 'LOCK_DOOR'
115730
+ }
115731
+ | {
115732
+ /** ID of the action attempt. */
115733
+ action_attempt_id: string
115734
+ status: 'success'
115735
+ /** Errors associated with the action attempt. Null for successful action attempts. */
115736
+ error: null
115737
+ /** Action attempt to track the status of locking a door. */
115738
+ action_type: 'LOCK_DOOR'
115739
+ /** Result of the action. */
115740
+ result: {
115741
+ /** Indicates whether the device confirmed that the lock action occurred. */
115742
+ was_confirmed_by_device?: boolean | undefined
115743
+ }
115744
+ }
115745
+ | {
115746
+ /** ID of the action attempt. */
115747
+ action_attempt_id: string
115748
+ status: 'error'
115749
+ /** Result of the action attempt. Null for failed action attempts. */
115750
+ result: null
115751
+ /** Action attempt to track the status of locking a door. */
115752
+ action_type: 'LOCK_DOOR'
115753
+ /** Error associated with the action. */
115754
+ error: {
115755
+ /** Type of the error. */
115756
+ type: string
115757
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
115758
+ message: string
115759
+ }
115760
+ }
115761
+ | {
115762
+ /** ID of the action attempt. */
115763
+ action_attempt_id: string
115764
+ status: 'pending'
115765
+ /** Result of the action attempt. Null for pending action attempts. */
115766
+ result: null
115767
+ /** Errors associated with the action attempt. Null for pending action attempts. */
115768
+ error: null
115769
+ /** Action attempt to track the status of unlocking a door. */
115770
+ action_type: 'UNLOCK_DOOR'
115771
+ }
115772
+ | {
115773
+ /** ID of the action attempt. */
115774
+ action_attempt_id: string
115775
+ status: 'success'
115776
+ /** Errors associated with the action attempt. Null for successful action attempts. */
115777
+ error: null
115778
+ /** Action attempt to track the status of unlocking a door. */
115779
+ action_type: 'UNLOCK_DOOR'
115780
+ /** Result of the action. */
115781
+ result: {
115782
+ /** Indicates whether the device confirmed that the unlock action occurred. */
115783
+ was_confirmed_by_device?: boolean | undefined
115784
+ }
115785
+ }
115786
+ | {
115787
+ /** ID of the action attempt. */
115788
+ action_attempt_id: string
115789
+ status: 'error'
115790
+ /** Result of the action attempt. Null for failed action attempts. */
115791
+ result: null
115792
+ /** Action attempt to track the status of unlocking a door. */
115793
+ action_type: 'UNLOCK_DOOR'
115794
+ /** Error associated with the action. */
115795
+ error: {
115796
+ /** Type of the error. */
115797
+ type: string
115798
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
115799
+ message: string
115800
+ }
115801
+ }
115802
+ | {
115803
+ /** ID of the action attempt. */
115804
+ action_attempt_id: string
115805
+ status: 'pending'
115806
+ /** Result of the action attempt. Null for pending action attempts. */
115807
+ result: null
115808
+ /** Errors associated with the action attempt. Null for pending action attempts. */
115809
+ error: null
115810
+ /** Action attempt to track the status of scanning a credential. */
115811
+ action_type: 'SCAN_CREDENTIAL'
115812
+ }
115813
+ | {
115814
+ /** ID of the action attempt. */
115815
+ action_attempt_id: string
115816
+ status: 'success'
115817
+ /** Errors associated with the action attempt. Null for successful action attempts. */
115818
+ error: null
115819
+ /** Action attempt to track the status of scanning a credential. */
115820
+ action_type: 'SCAN_CREDENTIAL'
115821
+ /** 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. */
115822
+ result: {
115823
+ /** Snapshot of credential data read from the physical encoder. */
115824
+ acs_credential_on_encoder: {
115825
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
115826
+ created_at: string | null
115827
+ /** Indicates whether the credential has been issued (encoded onto a card). */
115828
+ is_issued: boolean | null
115829
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */
115830
+ starts_at: string | null
115831
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */
115832
+ ends_at: string | null
115833
+ /** A number or string that physically identifies the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115834
+ card_number: string | null
115835
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115836
+ visionline_metadata?:
115837
+ | {
115838
+ /** Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115839
+ card_id?: (string | undefined) | undefined
115840
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */
115841
+ cancelled?: (boolean | undefined) | undefined
115842
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded. */
115843
+ discarded?: (boolean | undefined) | undefined
115844
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */
115845
+ expired?: (boolean | undefined) | undefined
115846
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */
115847
+ overwritten?: (boolean | undefined) | undefined
115848
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */
115849
+ overridden?: (boolean | undefined) | undefined
115850
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */
115851
+ pending_auto_update?: (boolean | undefined) | undefined
115852
+ /** Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115853
+ card_format?:
115854
+ (('TLCode' | 'rfid48') | undefined) | undefined
115855
+ /** Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115856
+ card_holder?: (string | undefined) | undefined
115857
+ /** Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115858
+ number_of_issued_cards?: (number | undefined) | undefined
115859
+ /** IDs of the guest [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115860
+ guest_acs_entrance_ids?:
115861
+ (string[] | undefined) | undefined
115862
+ /** IDs of the common [entrances](https://www.seam.co/docs/low-level-apis/access-systems/retrieving-entrance-details) for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115863
+ common_acs_entrance_ids?:
115864
+ (string[] | undefined) | undefined
115865
+ }
115866
+ | undefined
115867
+ } | null
115868
+ /** Corresponding credential data as stored on Seam and the access system. */
115869
+ acs_credential_on_seam:
115870
+ | (
115871
+ | {
115872
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115873
+ acs_credential_id: string
115874
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
115875
+ acs_user_id?: string | undefined
115876
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
115877
+ user_identity_id?: string | undefined
115878
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
115879
+ connected_account_id: string
115880
+ /** ID of the credential pool to which the credential belongs. */
115881
+ acs_credential_pool_id?: string | undefined
115882
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115883
+ acs_system_id: string
115884
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115885
+ parent_acs_credential_id?: string | undefined
115886
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
115887
+ display_name: string
115888
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115889
+ code?: (string | undefined) | null
115890
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
115891
+ is_one_time_use?: boolean | undefined
115892
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115893
+ card_number?: (string | undefined) | null
115894
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
115895
+ is_issued?: boolean | undefined
115896
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
115897
+ issued_at?: (string | undefined) | null
115898
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
115899
+ access_method:
115900
+ 'code' | 'card' | 'mobile_key' | 'cloud_key'
115901
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
115902
+ external_type?:
115903
+ | (
115904
+ | 'pti_card'
115905
+ | 'brivo_credential'
115906
+ | 'hid_credential'
115907
+ | 'visionline_card'
115908
+ | 'salto_ks_credential'
115909
+ | 'assa_abloy_vostio_key'
115910
+ | 'salto_space_key'
115911
+ | 'latch_access'
115912
+ | 'dormakaba_ambiance_credential'
115913
+ | 'hotek_card'
115914
+ | 'salto_ks_tag'
115915
+ | 'avigilon_alta_credential'
115916
+ | 'kisi_credential'
115917
+ | 'akiles_credential'
115918
+ )
115919
+ | undefined
115920
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
115921
+ external_type_display_name?: string | undefined
115922
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
115923
+ created_at: string
115924
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115925
+ workspace_id: string
115926
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
115927
+ starts_at?: string | undefined
115928
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
115929
+ ends_at?: string | undefined
115930
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115931
+ errors: {
115932
+ error_code: string
115933
+ message: string
115934
+ /** Date and time at which Seam created the error. */
115935
+ created_at: string
115936
+ }[]
115937
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
115938
+ warnings: (
115939
+ | {
115940
+ /** Date and time at which Seam created the warning. */
115941
+ created_at: string
115942
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115943
+ message: string
115944
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115945
+ warning_code: 'waiting_to_be_issued'
115946
+ }
115947
+ | {
115948
+ /** Date and time at which Seam created the warning. */
115949
+ created_at: string
115950
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115951
+ message: string
115952
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115953
+ warning_code: 'schedule_externally_modified'
115954
+ }
115955
+ | {
115956
+ /** Date and time at which Seam created the warning. */
115957
+ created_at: string
115958
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115959
+ message: string
115960
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115961
+ warning_code: 'schedule_modified'
115962
+ }
115963
+ | {
115964
+ /** Date and time at which Seam created the warning. */
115965
+ created_at: string
115966
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115967
+ message: string
115968
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115969
+ warning_code: 'being_deleted'
115970
+ }
115971
+ | {
115972
+ /** Date and time at which Seam created the warning. */
115973
+ created_at: string
115974
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115975
+ message: string
115976
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115977
+ warning_code: 'unknown_issue_with_acs_credential'
115978
+ }
115979
+ | {
115980
+ /** Date and time at which Seam created the warning. */
115981
+ created_at: string
115982
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115983
+ message: string
115984
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115985
+ warning_code: 'needs_to_be_reissued'
115986
+ }
115987
+ | {
115988
+ /** Date and time at which Seam created the warning. */
115989
+ created_at: string
115990
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
115991
+ message: string
115992
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
115993
+ warning_code: 'requested_code_unavailable'
115994
+ /** The originally requested PIN code that could not be used. */
115995
+ original_code: string
115996
+ /** The PIN code that was assigned instead. */
115997
+ new_code: string
115998
+ }
115999
+ )[]
116000
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
116001
+ is_multi_phone_sync_credential?: boolean | undefined
116002
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
116003
+ is_latest_desired_state_synced_with_provider?:
116004
+ (boolean | null) | undefined
116005
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
116006
+ latest_desired_state_synced_with_provider_at?:
116007
+ (string | null) | undefined
116008
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116009
+ visionline_metadata?:
116010
+ | {
116011
+ /** Card function type in the Visionline access system. */
116012
+ card_function_type?:
116013
+ (('guest' | 'staff') | undefined) | undefined
116014
+ /** IDs of the credentials to which you want to join. */
116015
+ joiner_acs_credential_ids?:
116016
+ (string[] | undefined) | undefined
116017
+ /** Guest entrance IDs in the Visionline access system. */
116018
+ guest_acs_entrance_ids?:
116019
+ (string[] | undefined) | undefined
116020
+ /** Common entrance IDs in the Visionline access system. */
116021
+ common_acs_entrance_ids?:
116022
+ (string[] | undefined) | undefined
116023
+ /** Indicates whether the credential is valid. */
116024
+ is_valid?: (boolean | undefined) | undefined
116025
+ /** 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. */
116026
+ auto_join?: (boolean | undefined) | undefined
116027
+ /** ID of the card in the Visionline access system. */
116028
+ card_id?: (string | undefined) | undefined
116029
+ /** ID of the credential in the Visionline access system. */
116030
+ credential_id?: (string | undefined) | undefined
116031
+ }
116032
+ | undefined
116033
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116034
+ assa_abloy_vostio_metadata?:
116035
+ | {
116036
+ /** 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. */
116037
+ auto_join?: (boolean | undefined) | undefined
116038
+ /** IDs of the guest entrances to override in the Vostio access system. */
116039
+ override_guest_acs_entrance_ids?:
116040
+ (string[] | undefined) | undefined
116041
+ /** Key ID in the Vostio access system. */
116042
+ key_id?: (string | undefined) | undefined
116043
+ /** Key issuing request ID in the Vostio access system. */
116044
+ key_issuing_request_id?:
116045
+ (string | undefined) | undefined
116046
+ /** Names of the doors to which to grant access in the Vostio access system. */
116047
+ door_names?: (string[] | undefined) | undefined
116048
+ /** Endpoint ID in the Vostio access system. */
116049
+ endpoint_id?: (string | undefined) | undefined
116050
+ }
116051
+ | undefined
116052
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116053
+ akiles_metadata?:
116054
+ | {
116055
+ /** ID of the Akiles member PIN. */
116056
+ member_pin_id?: (string | undefined) | undefined
116057
+ }
116058
+ | undefined
116059
+ /** Indicates whether Seam manages the credential. */
116060
+ is_managed: true
116061
+ }
116062
+ | {
116063
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116064
+ acs_credential_id: string
116065
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116066
+ acs_user_id?: string | undefined
116067
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116068
+ user_identity_id?: string | undefined
116069
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116070
+ connected_account_id: string
116071
+ /** ID of the credential pool to which the credential belongs. */
116072
+ acs_credential_pool_id?: string | undefined
116073
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116074
+ acs_system_id: string
116075
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116076
+ parent_acs_credential_id?: string | undefined
116077
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116078
+ display_name: string
116079
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116080
+ code?: (string | undefined) | null
116081
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
116082
+ is_one_time_use?: boolean | undefined
116083
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116084
+ card_number?: (string | undefined) | null
116085
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
116086
+ is_issued?: boolean | undefined
116087
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
116088
+ issued_at?: (string | undefined) | null
116089
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
116090
+ access_method:
116091
+ 'code' | 'card' | 'mobile_key' | 'cloud_key'
116092
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
116093
+ external_type?:
116094
+ | (
116095
+ | 'pti_card'
116096
+ | 'brivo_credential'
116097
+ | 'hid_credential'
116098
+ | 'visionline_card'
116099
+ | 'salto_ks_credential'
116100
+ | 'assa_abloy_vostio_key'
116101
+ | 'salto_space_key'
116102
+ | 'latch_access'
116103
+ | 'dormakaba_ambiance_credential'
116104
+ | 'hotek_card'
116105
+ | 'salto_ks_tag'
116106
+ | 'avigilon_alta_credential'
116107
+ | 'kisi_credential'
116108
+ | 'akiles_credential'
116109
+ )
116110
+ | undefined
116111
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116112
+ external_type_display_name?: string | undefined
116113
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
116114
+ created_at: string
116115
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116116
+ workspace_id: string
116117
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
116118
+ starts_at?: string | undefined
116119
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
116120
+ ends_at?: string | undefined
116121
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116122
+ errors: {
116123
+ error_code: string
116124
+ message: string
116125
+ /** Date and time at which Seam created the error. */
116126
+ created_at: string
116127
+ }[]
116128
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116129
+ warnings: (
116130
+ | {
116131
+ /** Date and time at which Seam created the warning. */
116132
+ created_at: string
116133
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116134
+ message: string
116135
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116136
+ warning_code: 'waiting_to_be_issued'
116137
+ }
116138
+ | {
116139
+ /** Date and time at which Seam created the warning. */
116140
+ created_at: string
116141
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116142
+ message: string
116143
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116144
+ warning_code: 'schedule_externally_modified'
116145
+ }
116146
+ | {
116147
+ /** Date and time at which Seam created the warning. */
116148
+ created_at: string
116149
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116150
+ message: string
116151
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116152
+ warning_code: 'schedule_modified'
116153
+ }
116154
+ | {
116155
+ /** Date and time at which Seam created the warning. */
116156
+ created_at: string
116157
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116158
+ message: string
116159
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116160
+ warning_code: 'being_deleted'
116161
+ }
116162
+ | {
116163
+ /** Date and time at which Seam created the warning. */
116164
+ created_at: string
116165
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116166
+ message: string
116167
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116168
+ warning_code: 'unknown_issue_with_acs_credential'
116169
+ }
116170
+ | {
116171
+ /** Date and time at which Seam created the warning. */
116172
+ created_at: string
116173
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116174
+ message: string
116175
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116176
+ warning_code: 'needs_to_be_reissued'
116177
+ }
116178
+ | {
116179
+ /** Date and time at which Seam created the warning. */
116180
+ created_at: string
116181
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116182
+ message: string
116183
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116184
+ warning_code: 'requested_code_unavailable'
116185
+ /** The originally requested PIN code that could not be used. */
116186
+ original_code: string
116187
+ /** The PIN code that was assigned instead. */
116188
+ new_code: string
116189
+ }
116190
+ )[]
116191
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
116192
+ is_multi_phone_sync_credential?: boolean | undefined
116193
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
116194
+ is_latest_desired_state_synced_with_provider?:
116195
+ (boolean | null) | undefined
116196
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
116197
+ latest_desired_state_synced_with_provider_at?:
116198
+ (string | null) | undefined
116199
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116200
+ visionline_metadata?:
116201
+ | {
116202
+ /** Card function type in the Visionline access system. */
116203
+ card_function_type?:
116204
+ (('guest' | 'staff') | undefined) | undefined
116205
+ /** IDs of the credentials to which you want to join. */
116206
+ joiner_acs_credential_ids?:
116207
+ (string[] | undefined) | undefined
116208
+ /** Guest entrance IDs in the Visionline access system. */
116209
+ guest_acs_entrance_ids?:
116210
+ (string[] | undefined) | undefined
116211
+ /** Common entrance IDs in the Visionline access system. */
116212
+ common_acs_entrance_ids?:
116213
+ (string[] | undefined) | undefined
116214
+ /** Indicates whether the credential is valid. */
116215
+ is_valid?: (boolean | undefined) | undefined
116216
+ /** 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. */
116217
+ auto_join?: (boolean | undefined) | undefined
116218
+ /** ID of the card in the Visionline access system. */
116219
+ card_id?: (string | undefined) | undefined
116220
+ /** ID of the credential in the Visionline access system. */
116221
+ credential_id?: (string | undefined) | undefined
116222
+ }
116223
+ | undefined
116224
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116225
+ assa_abloy_vostio_metadata?:
116226
+ | {
116227
+ /** 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. */
116228
+ auto_join?: (boolean | undefined) | undefined
116229
+ /** IDs of the guest entrances to override in the Vostio access system. */
116230
+ override_guest_acs_entrance_ids?:
116231
+ (string[] | undefined) | undefined
116232
+ /** Key ID in the Vostio access system. */
116233
+ key_id?: (string | undefined) | undefined
116234
+ /** Key issuing request ID in the Vostio access system. */
116235
+ key_issuing_request_id?:
116236
+ (string | undefined) | undefined
116237
+ /** Names of the doors to which to grant access in the Vostio access system. */
116238
+ door_names?: (string[] | undefined) | undefined
116239
+ /** Endpoint ID in the Vostio access system. */
116240
+ endpoint_id?: (string | undefined) | undefined
116241
+ }
116242
+ | undefined
116243
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116244
+ akiles_metadata?:
116245
+ | {
116246
+ /** ID of the Akiles member PIN. */
116247
+ member_pin_id?: (string | undefined) | undefined
116248
+ }
116249
+ | undefined
116250
+ is_managed: false
116251
+ }
116252
+ )
116253
+ | null
116254
+ /** 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. */
116255
+ warnings: {
116256
+ /** Indicates a warning related to scanning a credential. */
116257
+ warning_code:
116258
+ | 'acs_credential_on_encoder_out_of_sync'
116259
+ | 'acs_credential_on_seam_not_found'
116260
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116261
+ warning_message: string
116262
+ }[]
116263
+ }
116264
+ }
116265
+ | {
116266
+ /** ID of the action attempt. */
116267
+ action_attempt_id: string
116268
+ status: 'error'
116269
+ /** Result of the action attempt. Null for failed action attempts. */
116270
+ result: null
116271
+ /** Action attempt to track the status of scanning a credential. */
116272
+ action_type: 'SCAN_CREDENTIAL'
116273
+ error:
116274
+ | {
116275
+ /** Type of the error associated with the action attempt. */
116276
+ type: 'uncategorized_error'
116277
+ /** Message for the error associated with the action attempt. */
116278
+ message: string
116279
+ }
116280
+ | {
116281
+ /** Type of the error associated with the action attempt. */
116282
+ type: 'action_attempt_expired'
116283
+ /** Message for the error associated with the action attempt. */
116284
+ message: string
116285
+ }
116286
+ | {
116287
+ /** Error type to indicate that there is no credential on the encoder. */
116288
+ type: 'no_credential_on_encoder'
116289
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116290
+ message: string
116291
+ }
116292
+ | {
116293
+ /** Error type to indicate that the encoder is not online. */
116294
+ type: 'encoder_not_online'
116295
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116296
+ message: string
116297
+ }
116298
+ | {
116299
+ /** Error type to indicate that communication with the encoder timed out. */
116300
+ type: 'encoder_communication_timeout'
116301
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116302
+ message: string
116303
+ }
116304
+ | {
116305
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
116306
+ type: 'bridge_disconnected'
116307
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116308
+ message: string
116309
+ }
116310
+ }
116311
+ | {
116312
+ /** ID of the action attempt. */
116313
+ action_attempt_id: string
116314
+ status: 'pending'
116315
+ /** Result of the action attempt. Null for pending action attempts. */
116316
+ result: null
116317
+ /** Errors associated with the action attempt. Null for pending action attempts. */
116318
+ error: null
116319
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
116320
+ action_type: 'ENCODE_CREDENTIAL'
116321
+ }
116322
+ | {
116323
+ /** ID of the action attempt. */
116324
+ action_attempt_id: string
116325
+ status: 'success'
116326
+ /** Errors associated with the action attempt. Null for successful action attempts. */
116327
+ error: null
116328
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
116329
+ action_type: 'ENCODE_CREDENTIAL'
116330
+ /** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
116331
+ result:
116332
+ | {
116333
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116334
+ acs_credential_id: string
116335
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116336
+ acs_user_id?: string | undefined
116337
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116338
+ user_identity_id?: string | undefined
116339
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116340
+ connected_account_id: string
116341
+ /** ID of the credential pool to which the credential belongs. */
116342
+ acs_credential_pool_id?: string | undefined
116343
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116344
+ acs_system_id: string
116345
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116346
+ parent_acs_credential_id?: string | undefined
116347
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116348
+ display_name: string
116349
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116350
+ code?: (string | undefined) | null
116351
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
116352
+ is_one_time_use?: boolean | undefined
116353
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116354
+ card_number?: (string | undefined) | null
116355
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
116356
+ is_issued?: boolean | undefined
116357
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
116358
+ issued_at?: (string | undefined) | null
116359
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
116360
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
116361
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
116362
+ external_type?:
116363
+ | (
116364
+ | 'pti_card'
116365
+ | 'brivo_credential'
116366
+ | 'hid_credential'
116367
+ | 'visionline_card'
116368
+ | 'salto_ks_credential'
116369
+ | 'assa_abloy_vostio_key'
116370
+ | 'salto_space_key'
116371
+ | 'latch_access'
116372
+ | 'dormakaba_ambiance_credential'
116373
+ | 'hotek_card'
116374
+ | 'salto_ks_tag'
116375
+ | 'avigilon_alta_credential'
116376
+ | 'kisi_credential'
116377
+ | 'akiles_credential'
116378
+ )
116379
+ | undefined
116380
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116381
+ external_type_display_name?: string | undefined
116382
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
116383
+ created_at: string
116384
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116385
+ workspace_id: string
116386
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
116387
+ starts_at?: string | undefined
116388
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
116389
+ ends_at?: string | undefined
116390
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116391
+ errors: {
116392
+ error_code: string
116393
+ message: string
116394
+ /** Date and time at which Seam created the error. */
116395
+ created_at: string
116396
+ }[]
116397
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116398
+ warnings: (
116399
+ | {
116400
+ /** Date and time at which Seam created the warning. */
116401
+ created_at: string
116402
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116403
+ message: string
116404
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116405
+ warning_code: 'waiting_to_be_issued'
116406
+ }
116407
+ | {
116408
+ /** Date and time at which Seam created the warning. */
116409
+ created_at: string
116410
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116411
+ message: string
116412
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116413
+ warning_code: 'schedule_externally_modified'
116414
+ }
116415
+ | {
116416
+ /** Date and time at which Seam created the warning. */
116417
+ created_at: string
116418
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116419
+ message: string
116420
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116421
+ warning_code: 'schedule_modified'
116422
+ }
116423
+ | {
116424
+ /** Date and time at which Seam created the warning. */
116425
+ created_at: string
116426
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116427
+ message: string
116428
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116429
+ warning_code: 'being_deleted'
116430
+ }
116431
+ | {
116432
+ /** Date and time at which Seam created the warning. */
116433
+ created_at: string
116434
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116435
+ message: string
116436
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116437
+ warning_code: 'unknown_issue_with_acs_credential'
116438
+ }
116439
+ | {
116440
+ /** Date and time at which Seam created the warning. */
116441
+ created_at: string
116442
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116443
+ message: string
116444
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116445
+ warning_code: 'needs_to_be_reissued'
116446
+ }
116447
+ | {
116448
+ /** Date and time at which Seam created the warning. */
116449
+ created_at: string
116450
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116451
+ message: string
116452
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116453
+ warning_code: 'requested_code_unavailable'
116454
+ /** The originally requested PIN code that could not be used. */
116455
+ original_code: string
116456
+ /** The PIN code that was assigned instead. */
116457
+ new_code: string
116458
+ }
116459
+ )[]
116460
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
116461
+ is_multi_phone_sync_credential?: boolean | undefined
116462
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
116463
+ is_latest_desired_state_synced_with_provider?:
116464
+ (boolean | null) | undefined
116465
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
116466
+ latest_desired_state_synced_with_provider_at?:
116467
+ (string | null) | undefined
116468
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116469
+ visionline_metadata?:
116470
+ | {
116471
+ /** Card function type in the Visionline access system. */
116472
+ card_function_type?:
116473
+ (('guest' | 'staff') | undefined) | undefined
116474
+ /** IDs of the credentials to which you want to join. */
116475
+ joiner_acs_credential_ids?:
116476
+ (string[] | undefined) | undefined
116477
+ /** Guest entrance IDs in the Visionline access system. */
116478
+ guest_acs_entrance_ids?:
116479
+ (string[] | undefined) | undefined
116480
+ /** Common entrance IDs in the Visionline access system. */
116481
+ common_acs_entrance_ids?:
116482
+ (string[] | undefined) | undefined
116483
+ /** Indicates whether the credential is valid. */
116484
+ is_valid?: (boolean | undefined) | undefined
116485
+ /** 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. */
116486
+ auto_join?: (boolean | undefined) | undefined
116487
+ /** ID of the card in the Visionline access system. */
116488
+ card_id?: (string | undefined) | undefined
116489
+ /** ID of the credential in the Visionline access system. */
116490
+ credential_id?: (string | undefined) | undefined
116491
+ }
116492
+ | undefined
116493
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116494
+ assa_abloy_vostio_metadata?:
116495
+ | {
116496
+ /** 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. */
116497
+ auto_join?: (boolean | undefined) | undefined
116498
+ /** IDs of the guest entrances to override in the Vostio access system. */
116499
+ override_guest_acs_entrance_ids?:
116500
+ (string[] | undefined) | undefined
116501
+ /** Key ID in the Vostio access system. */
116502
+ key_id?: (string | undefined) | undefined
116503
+ /** Key issuing request ID in the Vostio access system. */
116504
+ key_issuing_request_id?:
116505
+ (string | undefined) | undefined
116506
+ /** Names of the doors to which to grant access in the Vostio access system. */
116507
+ door_names?: (string[] | undefined) | undefined
116508
+ /** Endpoint ID in the Vostio access system. */
116509
+ endpoint_id?: (string | undefined) | undefined
116510
+ }
116511
+ | undefined
116512
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116513
+ akiles_metadata?:
116514
+ | {
116515
+ /** ID of the Akiles member PIN. */
116516
+ member_pin_id?: (string | undefined) | undefined
116517
+ }
116518
+ | undefined
116519
+ /** Indicates whether Seam manages the credential. */
116520
+ is_managed: true
116521
+ }
116522
+ | {
116523
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116524
+ acs_credential_id: string
116525
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116526
+ acs_user_id?: string | undefined
116527
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116528
+ user_identity_id?: string | undefined
116529
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116530
+ connected_account_id: string
116531
+ /** ID of the credential pool to which the credential belongs. */
116532
+ acs_credential_pool_id?: string | undefined
116533
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116534
+ acs_system_id: string
116535
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116536
+ parent_acs_credential_id?: string | undefined
116537
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116538
+ display_name: string
116539
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116540
+ code?: (string | undefined) | null
116541
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
116542
+ is_one_time_use?: boolean | undefined
116543
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116544
+ card_number?: (string | undefined) | null
116545
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
116546
+ is_issued?: boolean | undefined
116547
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
116548
+ issued_at?: (string | undefined) | null
116549
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
116550
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
116551
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
116552
+ external_type?:
116553
+ | (
116554
+ | 'pti_card'
116555
+ | 'brivo_credential'
116556
+ | 'hid_credential'
116557
+ | 'visionline_card'
116558
+ | 'salto_ks_credential'
116559
+ | 'assa_abloy_vostio_key'
116560
+ | 'salto_space_key'
116561
+ | 'latch_access'
116562
+ | 'dormakaba_ambiance_credential'
116563
+ | 'hotek_card'
116564
+ | 'salto_ks_tag'
116565
+ | 'avigilon_alta_credential'
116566
+ | 'kisi_credential'
116567
+ | 'akiles_credential'
116568
+ )
116569
+ | undefined
116570
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116571
+ external_type_display_name?: string | undefined
116572
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
116573
+ created_at: string
116574
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116575
+ workspace_id: string
116576
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
116577
+ starts_at?: string | undefined
116578
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
116579
+ ends_at?: string | undefined
116580
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116581
+ errors: {
116582
+ error_code: string
116583
+ message: string
116584
+ /** Date and time at which Seam created the error. */
116585
+ created_at: string
116586
+ }[]
116587
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116588
+ warnings: (
116589
+ | {
116590
+ /** Date and time at which Seam created the warning. */
116591
+ created_at: string
116592
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116593
+ message: string
116594
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116595
+ warning_code: 'waiting_to_be_issued'
116596
+ }
116597
+ | {
116598
+ /** Date and time at which Seam created the warning. */
116599
+ created_at: string
116600
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116601
+ message: string
116602
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116603
+ warning_code: 'schedule_externally_modified'
116604
+ }
116605
+ | {
116606
+ /** Date and time at which Seam created the warning. */
116607
+ created_at: string
116608
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116609
+ message: string
116610
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116611
+ warning_code: 'schedule_modified'
116612
+ }
116613
+ | {
116614
+ /** Date and time at which Seam created the warning. */
116615
+ created_at: string
116616
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116617
+ message: string
116618
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116619
+ warning_code: 'being_deleted'
116620
+ }
116621
+ | {
116622
+ /** Date and time at which Seam created the warning. */
116623
+ created_at: string
116624
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116625
+ message: string
116626
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116627
+ warning_code: 'unknown_issue_with_acs_credential'
116628
+ }
116629
+ | {
116630
+ /** Date and time at which Seam created the warning. */
116631
+ created_at: string
116632
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116633
+ message: string
116634
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116635
+ warning_code: 'needs_to_be_reissued'
116636
+ }
116637
+ | {
116638
+ /** Date and time at which Seam created the warning. */
116639
+ created_at: string
116640
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116641
+ message: string
116642
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116643
+ warning_code: 'requested_code_unavailable'
116644
+ /** The originally requested PIN code that could not be used. */
116645
+ original_code: string
116646
+ /** The PIN code that was assigned instead. */
116647
+ new_code: string
116648
+ }
116649
+ )[]
116650
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
116651
+ is_multi_phone_sync_credential?: boolean | undefined
116652
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
116653
+ is_latest_desired_state_synced_with_provider?:
116654
+ (boolean | null) | undefined
116655
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
116656
+ latest_desired_state_synced_with_provider_at?:
116657
+ (string | null) | undefined
116658
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116659
+ visionline_metadata?:
116660
+ | {
116661
+ /** Card function type in the Visionline access system. */
116662
+ card_function_type?:
116663
+ (('guest' | 'staff') | undefined) | undefined
116664
+ /** IDs of the credentials to which you want to join. */
116665
+ joiner_acs_credential_ids?:
116666
+ (string[] | undefined) | undefined
116667
+ /** Guest entrance IDs in the Visionline access system. */
116668
+ guest_acs_entrance_ids?:
116669
+ (string[] | undefined) | undefined
116670
+ /** Common entrance IDs in the Visionline access system. */
116671
+ common_acs_entrance_ids?:
116672
+ (string[] | undefined) | undefined
116673
+ /** Indicates whether the credential is valid. */
116674
+ is_valid?: (boolean | undefined) | undefined
116675
+ /** 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. */
116676
+ auto_join?: (boolean | undefined) | undefined
116677
+ /** ID of the card in the Visionline access system. */
116678
+ card_id?: (string | undefined) | undefined
116679
+ /** ID of the credential in the Visionline access system. */
116680
+ credential_id?: (string | undefined) | undefined
116681
+ }
116682
+ | undefined
116683
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116684
+ assa_abloy_vostio_metadata?:
116685
+ | {
116686
+ /** 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. */
116687
+ auto_join?: (boolean | undefined) | undefined
116688
+ /** IDs of the guest entrances to override in the Vostio access system. */
116689
+ override_guest_acs_entrance_ids?:
116690
+ (string[] | undefined) | undefined
116691
+ /** Key ID in the Vostio access system. */
116692
+ key_id?: (string | undefined) | undefined
116693
+ /** Key issuing request ID in the Vostio access system. */
116694
+ key_issuing_request_id?:
116695
+ (string | undefined) | undefined
116696
+ /** Names of the doors to which to grant access in the Vostio access system. */
116697
+ door_names?: (string[] | undefined) | undefined
116698
+ /** Endpoint ID in the Vostio access system. */
116699
+ endpoint_id?: (string | undefined) | undefined
116700
+ }
116701
+ | undefined
116702
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116703
+ akiles_metadata?:
116704
+ | {
116705
+ /** ID of the Akiles member PIN. */
116706
+ member_pin_id?: (string | undefined) | undefined
116707
+ }
116708
+ | undefined
116709
+ is_managed: false
116710
+ }
116711
+ }
116712
+ | {
116713
+ /** ID of the action attempt. */
116714
+ action_attempt_id: string
116715
+ status: 'error'
116716
+ /** Result of the action attempt. Null for failed action attempts. */
116717
+ result: null
116718
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
116719
+ action_type: 'ENCODE_CREDENTIAL'
116720
+ error:
116721
+ | {
116722
+ /** Type of the error associated with the action attempt. */
116723
+ type: 'uncategorized_error'
116724
+ /** Message for the error associated with the action attempt. */
116725
+ message: string
116726
+ }
116727
+ | {
116728
+ /** Type of the error associated with the action attempt. */
116729
+ type: 'action_attempt_expired'
116730
+ /** Message for the error associated with the action attempt. */
116731
+ message: string
116732
+ }
116733
+ | {
116734
+ /** Error type to indicate that there is no credential on the encoder. */
116735
+ type: 'no_credential_on_encoder'
116736
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116737
+ message: string
116738
+ }
116739
+ | {
116740
+ /** Error type to indicate an incompatible card format. */
116741
+ type: 'incompatible_card_format'
116742
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116743
+ message: string
116744
+ }
116745
+ | {
116746
+ /** Error type to indicate that the affected credential cannot be reissued. */
116747
+ type: 'credential_cannot_be_reissued'
116748
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116749
+ message: string
116750
+ }
116751
+ | {
116752
+ /** Error type to indicate that the encoder is not online. */
116753
+ type: 'encoder_not_online'
116754
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116755
+ message: string
116756
+ }
116757
+ | {
116758
+ /** Error type to indicate that communication with the encoder timed out. */
116759
+ type: 'encoder_communication_timeout'
116760
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116761
+ message: string
116762
+ }
116763
+ | {
116764
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
116765
+ type: 'bridge_disconnected'
116766
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116767
+ message: string
116768
+ }
116769
+ | {
116770
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
116771
+ type: 'encoding_interrupted'
116772
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116773
+ message: string
116774
+ }
116775
+ | {
116776
+ /** Error type to indicate that the credential was deleted and can no longer be encoded. */
116777
+ type: 'credential_deleted'
116778
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
116779
+ message: string
116780
+ }
116781
+ }
116782
+ | {
116783
+ /** ID of the action attempt. */
116784
+ action_attempt_id: string
116785
+ status: 'pending'
116786
+ /** Result of the action attempt. Null for pending action attempts. */
116787
+ result: null
116788
+ /** Errors associated with the action attempt. Null for pending action attempts. */
116789
+ error: null
116790
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
116791
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
116792
+ }
116793
+ | {
116794
+ /** ID of the action attempt. */
116795
+ action_attempt_id: string
116796
+ status: 'success'
116797
+ /** Errors associated with the action attempt. Null for successful action attempts. */
116798
+ error: null
116799
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
116800
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
116801
+ /** Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. */
116802
+ result: {
116803
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116804
+ acs_credential_id: string
116805
+ /** ID of the [ACS user](https://www.seam.co/docs/low-level-apis/access-systems/user-management) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116806
+ acs_user_id?: string | undefined
116807
+ /** ID of the [user identity](https://www.seam.co/docs/api/user_identities/object) to whom the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116808
+ user_identity_id?: string | undefined
116809
+ /** ID of the [connected account](https://www.seam.co/docs/core-concepts/connected-accounts) to which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) belongs. */
116810
+ connected_account_id: string
116811
+ /** ID of the credential pool to which the credential belongs. */
116812
+ acs_credential_pool_id?: string | undefined
116813
+ /** ID of the [access control system](https://www.seam.co/docs/low-level-apis/access-systems) that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116814
+ acs_system_id: string
116815
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116816
+ parent_acs_credential_id?: string | undefined
116817
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116818
+ display_name: string
116819
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116820
+ code?: (string | undefined) | null
116821
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) can only be used once. If `true`, the code becomes invalid after the first use. */
116822
+ is_one_time_use?: boolean | undefined
116823
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116824
+ card_number?: (string | undefined) | null
116825
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
116826
+ is_issued?: boolean | undefined
116827
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
116828
+ issued_at?: (string | undefined) | null
116829
+ /** Access method for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
116830
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
116831
+ /** Brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. Supported values: `pti_card`, `brivo_credential`, `hid_credential`, `visionline_card`. */
116832
+ external_type?:
116833
+ | (
116834
+ | 'pti_card'
116835
+ | 'brivo_credential'
116836
+ | 'hid_credential'
116837
+ | 'visionline_card'
116838
+ | 'salto_ks_credential'
116839
+ | 'assa_abloy_vostio_key'
116840
+ | 'salto_space_key'
116841
+ | 'latch_access'
116842
+ | 'dormakaba_ambiance_credential'
116843
+ | 'hotek_card'
116844
+ | 'salto_ks_tag'
116845
+ | 'avigilon_alta_credential'
116846
+ | 'kisi_credential'
116847
+ | 'akiles_credential'
116848
+ )
116849
+ | undefined
116850
+ /** Display name that corresponds to the brand-specific terminology for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
116851
+ external_type_display_name?: string | undefined
116852
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
116853
+ created_at: string
116854
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116855
+ workspace_id: string
116856
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity starts, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. */
116857
+ starts_at?: string | undefined
116858
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) validity ends, in [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) format. Must be a time in the future and after `starts_at`. */
116859
+ ends_at?: string | undefined
116860
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116861
+ errors: {
116862
+ error_code: string
116863
+ message: string
116864
+ /** Date and time at which Seam created the error. */
116865
+ created_at: string
116866
+ }[]
116867
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116868
+ warnings: (
116869
+ | {
116870
+ /** Date and time at which Seam created the warning. */
116871
+ created_at: string
116872
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116873
+ message: string
116874
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116875
+ warning_code: 'waiting_to_be_issued'
116876
+ }
116877
+ | {
116878
+ /** Date and time at which Seam created the warning. */
116879
+ created_at: string
116880
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116881
+ message: string
116882
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116883
+ warning_code: 'schedule_externally_modified'
116884
+ }
116885
+ | {
116886
+ /** Date and time at which Seam created the warning. */
116887
+ created_at: string
116888
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116889
+ message: string
116890
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116891
+ warning_code: 'schedule_modified'
116892
+ }
116893
+ | {
116894
+ /** Date and time at which Seam created the warning. */
116895
+ created_at: string
116896
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116897
+ message: string
116898
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116899
+ warning_code: 'being_deleted'
116900
+ }
116901
+ | {
116902
+ /** Date and time at which Seam created the warning. */
116903
+ created_at: string
116904
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116905
+ message: string
116906
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116907
+ warning_code: 'unknown_issue_with_acs_credential'
116908
+ }
116909
+ | {
116910
+ /** Date and time at which Seam created the warning. */
116911
+ created_at: string
116912
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116913
+ message: string
116914
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116915
+ warning_code: 'needs_to_be_reissued'
116916
+ }
116917
+ | {
116918
+ /** Date and time at which Seam created the warning. */
116919
+ created_at: string
116920
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
116921
+ message: string
116922
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
116923
+ warning_code: 'requested_code_unavailable'
116924
+ /** The originally requested PIN code that could not be used. */
116925
+ original_code: string
116926
+ /** The PIN code that was assigned instead. */
116927
+ new_code: string
116928
+ }
116929
+ )[]
116930
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is a [multi-phone sync credential](https://www.seam.co/docs/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#what-are-multi-phone-sync-credentials). */
116931
+ is_multi_phone_sync_credential?: boolean | undefined
116932
+ /** Indicates whether the latest state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been synced from Seam to the provider. */
116933
+ is_latest_desired_state_synced_with_provider?:
116934
+ (boolean | null) | undefined
116935
+ /** Date and time at which the state of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was most recently synced from Seam to the provider. */
116936
+ latest_desired_state_synced_with_provider_at?:
116937
+ (string | null) | undefined
116938
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116939
+ visionline_metadata?:
116940
+ | {
116941
+ /** Card function type in the Visionline access system. */
116942
+ card_function_type?:
116943
+ (('guest' | 'staff') | undefined) | undefined
116944
+ /** IDs of the credentials to which you want to join. */
116945
+ joiner_acs_credential_ids?:
116946
+ (string[] | undefined) | undefined
116947
+ /** Guest entrance IDs in the Visionline access system. */
116948
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined
116949
+ /** Common entrance IDs in the Visionline access system. */
116950
+ common_acs_entrance_ids?: (string[] | undefined) | undefined
116951
+ /** Indicates whether the credential is valid. */
116952
+ is_valid?: (boolean | undefined) | undefined
116953
+ /** 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. */
116954
+ auto_join?: (boolean | undefined) | undefined
116955
+ /** ID of the card in the Visionline access system. */
116956
+ card_id?: (string | undefined) | undefined
116957
+ /** ID of the credential in the Visionline access system. */
116958
+ credential_id?: (string | undefined) | undefined
116959
+ }
116960
+ | undefined
116961
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116962
+ assa_abloy_vostio_metadata?:
116963
+ | {
116964
+ /** 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. */
116965
+ auto_join?: (boolean | undefined) | undefined
116966
+ /** IDs of the guest entrances to override in the Vostio access system. */
116967
+ override_guest_acs_entrance_ids?:
116968
+ (string[] | undefined) | undefined
116969
+ /** Key ID in the Vostio access system. */
116970
+ key_id?: (string | undefined) | undefined
116971
+ /** Key issuing request ID in the Vostio access system. */
116972
+ key_issuing_request_id?: (string | undefined) | undefined
116973
+ /** Names of the doors to which to grant access in the Vostio access system. */
116974
+ door_names?: (string[] | undefined) | undefined
116975
+ /** Endpoint ID in the Vostio access system. */
116976
+ endpoint_id?: (string | undefined) | undefined
116977
+ }
116978
+ | undefined
116979
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
116980
+ akiles_metadata?:
116981
+ | {
116982
+ /** ID of the Akiles member PIN. */
116983
+ member_pin_id?: (string | undefined) | undefined
116984
+ }
116985
+ | undefined
116986
+ /** Indicates whether Seam manages the credential. */
116987
+ is_managed: true
116988
+ }
116989
+ }
116990
+ | {
116991
+ /** ID of the action attempt. */
116992
+ action_attempt_id: string
116993
+ status: 'error'
116994
+ /** Result of the action attempt. Null for failed action attempts. */
116995
+ result: null
116996
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
116997
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
116998
+ error:
116999
+ | {
117000
+ /** Type of the error associated with the action attempt. */
117001
+ type: 'uncategorized_error'
117002
+ /** Message for the error associated with the action attempt. */
117003
+ message: string
117004
+ }
117005
+ | {
117006
+ /** Type of the error associated with the action attempt. */
117007
+ type: 'action_attempt_expired'
117008
+ /** Message for the error associated with the action attempt. */
117009
+ message: string
117010
+ }
117011
+ | {
117012
+ /** Error type to indicate that there is no credential on the encoder. */
117013
+ type: 'no_credential_on_encoder'
117014
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117015
+ message: string
117016
+ }
117017
+ }
117018
+ | {
117019
+ /** ID of the action attempt. */
117020
+ action_attempt_id: string
117021
+ status: 'pending'
117022
+ /** Result of the action attempt. Null for pending action attempts. */
117023
+ result: null
117024
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117025
+ error: null
117026
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
117027
+ action_type: 'ASSIGN_CREDENTIAL'
117028
+ }
117029
+ | {
117030
+ /** ID of the action attempt. */
117031
+ action_attempt_id: string
117032
+ status: 'success'
117033
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117034
+ error: null
117035
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
117036
+ action_type: 'ASSIGN_CREDENTIAL'
117037
+ /** Result of assigning a credential. If successful, includes the updated access method with the assigned credential. */
117038
+ result: {
117039
+ /** ID of the Seam workspace associated with the access method. */
117040
+ workspace_id: string
117041
+ /** ID of the access method. */
117042
+ access_method_id: string
117043
+ /** Display name of the access method. */
117044
+ display_name: string
117045
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
117046
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
117047
+ /** Date and time at which the access method was created. */
117048
+ created_at: string
117049
+ /** Date and time at which the access method was issued. */
117050
+ issued_at: string | null
117051
+ /** Indicates whether the access method has been issued. */
117052
+ is_issued: boolean
117053
+ /** Human-readable sentence describing where the access method sits in its relationship with the device or access system, for example `Awaiting encoding`. For display only. The wording is not stable and is not an enumeration — it may change at any time, so never compare against or branch on it. To make decisions, read `is_issued`, `errors`, and `pending_mutations`. */
117054
+ display_status: string
117055
+ /** URL of the Instant Key for mobile key access methods. */
117056
+ instant_key_url?: string | undefined
117057
+ /** Token of the client session associated with the access method. */
117058
+ client_session_token?: string | undefined
117059
+ /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
117060
+ is_encoding_required?: boolean | undefined
117061
+ /** Indicates whether the access method is ready to be encoded. This is true when the credential has been created and the card has not yet been issued. */
117062
+ is_ready_for_encoding?: boolean | undefined
117063
+ /** Indicates whether an existing card credential must be assigned to this access method before it can be issued. Only applies to card-mode access methods on systems that support credential assignment. */
117064
+ is_assignment_required?: boolean | undefined
117065
+ /** Indicates whether the access method is ready for card assignment. This is true when the access method is in card mode, has not yet been issued, and the system supports credential assignment. */
117066
+ is_ready_for_assignment?: boolean | undefined
117067
+ /** The actual PIN code for code access methods. */
117068
+ code?: (string | null) | undefined
117069
+ /** Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
117070
+ warnings: (
117071
+ | {
117072
+ /** Date and time at which Seam created the warning. */
117073
+ created_at: string
117074
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
117075
+ message: string
117076
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117077
+ warning_code: 'being_deleted'
117078
+ }
117079
+ | {
117080
+ /** Date and time at which Seam created the warning. */
117081
+ created_at: string
117082
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
117083
+ message: string
117084
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117085
+ warning_code: 'updating_access_times'
117086
+ }
117087
+ | {
117088
+ /** Date and time at which Seam created the warning. */
117089
+ created_at: string
117090
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
117091
+ message: string
117092
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117093
+ warning_code: 'pulled_backup_access_code'
117094
+ /** ID of the original access method from which this backup access method was split, if applicable. */
117095
+ original_access_method_id?: string | undefined
117096
+ }
117097
+ | {
117098
+ /** Date and time at which Seam created the warning. */
117099
+ created_at: string
117100
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
117101
+ message: string
117102
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117103
+ warning_code: 'delay_in_issuing'
117104
+ }
117105
+ | {
117106
+ /** Date and time at which Seam created the warning. */
117107
+ created_at: string
117108
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
117109
+ message: string
117110
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117111
+ warning_code: 'user_identity_missing_email_address'
117112
+ }
117113
+ | {
117114
+ /** Date and time at which Seam created the warning. */
117115
+ created_at: string
117116
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
117117
+ message: string
117118
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
117119
+ warning_code: 'user_identity_missing_phone_number'
117120
+ }
117121
+ )[]
117122
+ /** Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
117123
+ errors: {
117124
+ /** Date and time at which Seam created the error. */
117125
+ created_at: string
117126
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117127
+ message: string
117128
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
117129
+ error_code: 'failed_to_issue'
117130
+ }[]
117131
+ /** Pending mutations for the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). Indicates operations that are in progress. */
117132
+ pending_mutations: (
117133
+ | {
117134
+ /** Date and time at which the mutation was created. */
117135
+ created_at: string
117136
+ /** Detailed description of the mutation. */
117137
+ message: string
117138
+ /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
117139
+ mutation_code: 'provisioning_access'
117140
+ /** Previous device configuration. */
117141
+ from: {
117142
+ /** Previous device IDs where access was provisioned. */
117143
+ device_ids: string[]
117144
+ }
117145
+ /** New device configuration. */
117146
+ to: {
117147
+ /** New device IDs where access is being provisioned. */
117148
+ device_ids: string[]
117149
+ }
117150
+ }
117151
+ | {
117152
+ /** Date and time at which the mutation was created. */
117153
+ created_at: string
117154
+ /** Detailed description of the mutation. */
117155
+ message: string
117156
+ /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
117157
+ mutation_code: 'revoking_access'
117158
+ /** Previous device configuration. */
117159
+ from: {
117160
+ /** Previous device IDs where access existed. */
117161
+ device_ids: string[]
117162
+ }
117163
+ /** New device configuration. */
117164
+ to: {
117165
+ /** New device IDs where access should remain. */
117166
+ device_ids: string[]
117167
+ }
117168
+ }
117169
+ | {
117170
+ /** Date and time at which the mutation was created. */
117171
+ created_at: string
117172
+ /** Detailed description of the mutation. */
117173
+ message: string
117174
+ /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
117175
+ mutation_code: 'updating_access_times'
117176
+ /** Previous access time configuration. */
117177
+ from: {
117178
+ /** Previous start time for access. */
117179
+ starts_at: string | null
117180
+ /** Previous end time for access. */
117181
+ ends_at: string | null
117182
+ }
117183
+ /** New access time configuration. */
117184
+ to: {
117185
+ /** New start time for access. */
117186
+ starts_at: string | null
117187
+ /** New end time for access. */
117188
+ ends_at: string | null
117189
+ }
117190
+ }
117191
+ )[]
117192
+ /** ID of the customization profile associated with the access method. */
117193
+ customization_profile_id?: string | undefined
114661
117194
  }
114662
- | undefined
114663
- /** Geographic coordinates (latitude and longitude) of the space. */
114664
- geolocation?:
114665
- | ({
114666
- /** Latitude of the space, in decimal degrees. */
114667
- latitude: number
114668
- /** Longitude of the space, in decimal degrees. */
114669
- longitude: number
114670
- } | null)
114671
- | undefined
114672
- /** */
114673
- parent_space_id?: string | undefined
114674
- /** */
114675
- parent_space_key?: string | undefined
114676
- }[]
114677
- /** Information about the current page of results. */
114678
- pagination: {
114679
- /** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
114680
- next_page_cursor: string | null
114681
- /** Indicates whether there is another page of results after this one. */
114682
- has_next_page: boolean
114683
- /** URL to get the next page of results. */
114684
- next_page_url: string | null
114685
- }
114686
- }
114687
- maxDuration: undefined
114688
- }
114689
- '/spaces/remove_acs_entrances': {
114690
- route: '/spaces/remove_acs_entrances'
114691
- method: 'POST' | 'DELETE'
114692
- queryParams: {}
114693
- jsonBody: {}
114694
- commonParams: {
114695
- /** ID of the space from which you want to remove entrances. */
114696
- space_id: string
114697
- /** IDs of the entrances that you want to remove from the space. */
114698
- acs_entrance_ids: string[]
114699
- }
114700
- formData: {}
114701
- jsonResponse: {}
114702
- maxDuration: undefined
114703
- }
114704
- '/spaces/remove_connected_account': {
114705
- route: '/spaces/remove_connected_account'
114706
- method: 'POST' | 'DELETE'
114707
- queryParams: {}
114708
- jsonBody: {}
114709
- commonParams: {
114710
- /** ID of the space from which you want to remove the connected account. */
114711
- space_id: string
114712
- /** ID of the connected account that you want to remove from the space. */
114713
- connected_account_id: string
114714
- }
114715
- formData: {}
114716
- jsonResponse: {}
114717
- maxDuration: undefined
114718
- }
114719
- '/spaces/remove_devices': {
114720
- route: '/spaces/remove_devices'
114721
- method: 'POST' | 'DELETE'
114722
- queryParams: {}
114723
- jsonBody: {}
114724
- commonParams: {
114725
- /** ID of the space from which you want to remove devices. */
114726
- space_id: string
114727
- /** IDs of the devices that you want to remove from the space. */
114728
- device_ids: string[]
114729
- }
114730
- formData: {}
114731
- jsonResponse: {}
114732
- maxDuration: undefined
114733
- }
114734
- '/spaces/update': {
114735
- route: '/spaces/update'
114736
- method: 'POST' | 'PATCH'
114737
- queryParams: {}
114738
- jsonBody: {
114739
- /** Name of the space. */
114740
- name?: string | undefined
114741
- /** ID of the space that you want to update. */
114742
- space_id?: string | undefined
114743
- /** Unique key of the space that you want to update. */
114744
- space_key?: string | undefined
114745
- /** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
114746
- device_ids?: string[] | undefined
114747
- /** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
114748
- acs_entrance_ids?: string[] | undefined
114749
- /** Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it. */
114750
- customer_data?:
117195
+ }
114751
117196
  | {
114752
- /** IANA time zone for the space, e.g. America/Los_Angeles. */
114753
- time_zone?: (string | null) | undefined
114754
- /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
114755
- default_checkin_time?: (string | null) | undefined
114756
- /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
114757
- default_checkout_time?: (string | null) | undefined
114758
- /** Postal address for the space. */
114759
- address?: (string | null) | undefined
117197
+ /** ID of the action attempt. */
117198
+ action_attempt_id: string
117199
+ status: 'error'
117200
+ /** Result of the action attempt. Null for failed action attempts. */
117201
+ result: null
117202
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
117203
+ action_type: 'ASSIGN_CREDENTIAL'
117204
+ error:
117205
+ | {
117206
+ /** Type of the error associated with the action attempt. */
117207
+ type: 'uncategorized_error'
117208
+ /** Message for the error associated with the action attempt. */
117209
+ message: string
117210
+ }
117211
+ | {
117212
+ /** Type of the error associated with the action attempt. */
117213
+ type: 'action_attempt_expired'
117214
+ /** Message for the error associated with the action attempt. */
117215
+ message: string
117216
+ }
117217
+ | {
117218
+ /** Error type to indicate that no matching credential was found. */
117219
+ type: 'credential_not_found'
117220
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117221
+ message: string
117222
+ }
114760
117223
  }
114761
- | undefined
114762
- /** Reassign this space to the parent space (site) with this `parent_space_id`. */
114763
- parent_space_id?: string | undefined
114764
- /** Reassign this space to the parent space (site) with this `parent_space_key`. */
114765
- parent_space_key?: string | undefined
114766
- }
114767
- commonParams: {}
114768
- formData: {}
114769
- jsonResponse: {
114770
- /** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
114771
- space: {
114772
- /** ID of the space. */
114773
- space_id: string
114774
- /** ID of the workspace associated with the space. */
114775
- workspace_id: string
114776
- /** Unique key for the space within the workspace. */
114777
- space_key?: string | undefined
114778
- /** Name of the space. */
114779
- name: string
114780
- /** Display name for the space. */
114781
- display_name: string
114782
- /** Date and time at which the space was created. */
114783
- created_at: string
114784
- /** Number of devices in the space. */
114785
- device_count: number
114786
- /** Number of entrances in the space. */
114787
- acs_entrance_count: number
114788
- /** Customer key associated with the space. */
114789
- customer_key?: string | undefined
114790
- /** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
114791
- customer_data?:
114792
- | {
114793
- /** IANA time zone for the space, e.g. America/Los_Angeles. */
114794
- time_zone?: (string | null) | undefined
114795
- /** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
114796
- default_checkin_time?: (string | null) | undefined
114797
- /** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
114798
- default_checkout_time?: (string | null) | undefined
114799
- /** Postal address for the space. */
114800
- address?: (string | null) | undefined
117224
+ | {
117225
+ /** ID of the action attempt. */
117226
+ action_attempt_id: string
117227
+ status: 'pending'
117228
+ /** Result of the action attempt. Null for pending action attempts. */
117229
+ result: null
117230
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117231
+ error: null
117232
+ /** Action attempt to track the status of resetting a sandbox workspace. */
117233
+ action_type: 'RESET_SANDBOX_WORKSPACE'
117234
+ }
117235
+ | {
117236
+ /** ID of the action attempt. */
117237
+ action_attempt_id: string
117238
+ status: 'success'
117239
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117240
+ error: null
117241
+ /** Action attempt to track the status of resetting a sandbox workspace. */
117242
+ action_type: 'RESET_SANDBOX_WORKSPACE'
117243
+ /** Result of the action. */
117244
+ result: {}
117245
+ }
117246
+ | {
117247
+ /** ID of the action attempt. */
117248
+ action_attempt_id: string
117249
+ status: 'error'
117250
+ /** Result of the action attempt. Null for failed action attempts. */
117251
+ result: null
117252
+ /** Action attempt to track the status of resetting a sandbox workspace. */
117253
+ action_type: 'RESET_SANDBOX_WORKSPACE'
117254
+ /** Error associated with the action. */
117255
+ error: {
117256
+ /** Type of the error. */
117257
+ type: string
117258
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117259
+ message: string
114801
117260
  }
114802
- | undefined
114803
- /** Geographic coordinates (latitude and longitude) of the space. */
114804
- geolocation?:
114805
- | ({
114806
- /** Latitude of the space, in decimal degrees. */
114807
- latitude: number
114808
- /** Longitude of the space, in decimal degrees. */
114809
- longitude: number
114810
- } | null)
114811
- | undefined
114812
- /** */
114813
- parent_space_id?: string | undefined
114814
- /** */
114815
- parent_space_key?: string | undefined
114816
- }
117261
+ }
117262
+ | {
117263
+ /** ID of the action attempt. */
117264
+ action_attempt_id: string
117265
+ status: 'pending'
117266
+ /** Result of the action attempt. Null for pending action attempts. */
117267
+ result: null
117268
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117269
+ error: null
117270
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
117271
+ action_type: 'SET_FAN_MODE'
117272
+ }
117273
+ | {
117274
+ /** ID of the action attempt. */
117275
+ action_attempt_id: string
117276
+ status: 'success'
117277
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117278
+ error: null
117279
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
117280
+ action_type: 'SET_FAN_MODE'
117281
+ /** Result of the action. */
117282
+ result: {}
117283
+ }
117284
+ | {
117285
+ /** ID of the action attempt. */
117286
+ action_attempt_id: string
117287
+ status: 'error'
117288
+ /** Result of the action attempt. Null for failed action attempts. */
117289
+ result: null
117290
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
117291
+ action_type: 'SET_FAN_MODE'
117292
+ /** Error associated with the action. */
117293
+ error: {
117294
+ /** Type of the error. */
117295
+ type: string
117296
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117297
+ message: string
117298
+ }
117299
+ }
117300
+ | {
117301
+ /** ID of the action attempt. */
117302
+ action_attempt_id: string
117303
+ status: 'pending'
117304
+ /** Result of the action attempt. Null for pending action attempts. */
117305
+ result: null
117306
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117307
+ error: null
117308
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
117309
+ action_type: 'SET_HVAC_MODE'
117310
+ }
117311
+ | {
117312
+ /** ID of the action attempt. */
117313
+ action_attempt_id: string
117314
+ status: 'success'
117315
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117316
+ error: null
117317
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
117318
+ action_type: 'SET_HVAC_MODE'
117319
+ /** Result of the action. */
117320
+ result: {}
117321
+ }
117322
+ | {
117323
+ /** ID of the action attempt. */
117324
+ action_attempt_id: string
117325
+ status: 'error'
117326
+ /** Result of the action attempt. Null for failed action attempts. */
117327
+ result: null
117328
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
117329
+ action_type: 'SET_HVAC_MODE'
117330
+ /** Error associated with the action. */
117331
+ error: {
117332
+ /** Type of the error. */
117333
+ type: string
117334
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117335
+ message: string
117336
+ }
117337
+ }
117338
+ | {
117339
+ /** ID of the action attempt. */
117340
+ action_attempt_id: string
117341
+ status: 'pending'
117342
+ /** Result of the action attempt. Null for pending action attempts. */
117343
+ result: null
117344
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117345
+ error: null
117346
+ /** Action attempt to track the status of a climate preset activation. */
117347
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
117348
+ }
117349
+ | {
117350
+ /** ID of the action attempt. */
117351
+ action_attempt_id: string
117352
+ status: 'success'
117353
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117354
+ error: null
117355
+ /** Action attempt to track the status of a climate preset activation. */
117356
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
117357
+ /** Result of the action. */
117358
+ result: {}
117359
+ }
117360
+ | {
117361
+ /** ID of the action attempt. */
117362
+ action_attempt_id: string
117363
+ status: 'error'
117364
+ /** Result of the action attempt. Null for failed action attempts. */
117365
+ result: null
117366
+ /** Action attempt to track the status of a climate preset activation. */
117367
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
117368
+ /** Error associated with the action. */
117369
+ error: {
117370
+ /** Type of the error. */
117371
+ type: string
117372
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117373
+ message: string
117374
+ }
117375
+ }
117376
+ | {
117377
+ /** ID of the action attempt. */
117378
+ action_attempt_id: string
117379
+ status: 'pending'
117380
+ /** Result of the action attempt. Null for pending action attempts. */
117381
+ result: null
117382
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117383
+ error: null
117384
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117385
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
117386
+ }
117387
+ | {
117388
+ /** ID of the action attempt. */
117389
+ action_attempt_id: string
117390
+ status: 'success'
117391
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117392
+ error: null
117393
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117394
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
117395
+ /** Result of the action. */
117396
+ result: {}
117397
+ }
117398
+ | {
117399
+ /** ID of the action attempt. */
117400
+ action_attempt_id: string
117401
+ status: 'error'
117402
+ /** Result of the action attempt. Null for failed action attempts. */
117403
+ result: null
117404
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117405
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
117406
+ /** Error associated with the action. */
117407
+ error: {
117408
+ /** Type of the error. */
117409
+ type: string
117410
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117411
+ message: string
117412
+ }
117413
+ }
117414
+ | {
117415
+ /** ID of the action attempt. */
117416
+ action_attempt_id: string
117417
+ status: 'pending'
117418
+ /** Result of the action attempt. Null for pending action attempts. */
117419
+ result: null
117420
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117421
+ error: null
117422
+ /** Action attempt to track the status of simulating a keypad code entry. */
117423
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
117424
+ }
117425
+ | {
117426
+ /** ID of the action attempt. */
117427
+ action_attempt_id: string
117428
+ status: 'success'
117429
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117430
+ error: null
117431
+ /** Action attempt to track the status of simulating a keypad code entry. */
117432
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
117433
+ /** Result of the action. */
117434
+ result: {}
117435
+ }
117436
+ | {
117437
+ /** ID of the action attempt. */
117438
+ action_attempt_id: string
117439
+ status: 'error'
117440
+ /** Result of the action attempt. Null for failed action attempts. */
117441
+ result: null
117442
+ /** Action attempt to track the status of simulating a keypad code entry. */
117443
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
117444
+ /** Error associated with the action. */
117445
+ error: {
117446
+ /** Type of the error. */
117447
+ type: string
117448
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117449
+ message: string
117450
+ }
117451
+ }
117452
+ | {
117453
+ /** ID of the action attempt. */
117454
+ action_attempt_id: string
117455
+ status: 'pending'
117456
+ /** Result of the action attempt. Null for pending action attempts. */
117457
+ result: null
117458
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117459
+ error: null
117460
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
117461
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
117462
+ }
117463
+ | {
117464
+ /** ID of the action attempt. */
117465
+ action_attempt_id: string
117466
+ status: 'success'
117467
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117468
+ error: null
117469
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
117470
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
117471
+ /** Result of the action. */
117472
+ result: {}
117473
+ }
117474
+ | {
117475
+ /** ID of the action attempt. */
117476
+ action_attempt_id: string
117477
+ status: 'error'
117478
+ /** Result of the action attempt. Null for failed action attempts. */
117479
+ result: null
117480
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
117481
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
117482
+ /** Error associated with the action. */
117483
+ error: {
117484
+ /** Type of the error. */
117485
+ type: string
117486
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117487
+ message: string
117488
+ }
117489
+ }
117490
+ | {
117491
+ /** ID of the action attempt. */
117492
+ action_attempt_id: string
117493
+ status: 'pending'
117494
+ /** Result of the action attempt. Null for pending action attempts. */
117495
+ result: null
117496
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117497
+ error: null
117498
+ /** Action attempt to track the status of pushing thermostat programs. */
117499
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
117500
+ }
117501
+ | {
117502
+ /** ID of the action attempt. */
117503
+ action_attempt_id: string
117504
+ status: 'success'
117505
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117506
+ error: null
117507
+ /** Action attempt to track the status of pushing thermostat programs. */
117508
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
117509
+ /** Result of the action. */
117510
+ result: {}
117511
+ }
117512
+ | {
117513
+ /** ID of the action attempt. */
117514
+ action_attempt_id: string
117515
+ status: 'error'
117516
+ /** Result of the action attempt. Null for failed action attempts. */
117517
+ result: null
117518
+ /** Action attempt to track the status of pushing thermostat programs. */
117519
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
117520
+ /** Error associated with the action. */
117521
+ error: {
117522
+ /** Type of the error. */
117523
+ type: string
117524
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117525
+ message: string
117526
+ }
117527
+ }
117528
+ | {
117529
+ /** ID of the action attempt. */
117530
+ action_attempt_id: string
117531
+ status: 'pending'
117532
+ /** Result of the action attempt. Null for pending action attempts. */
117533
+ result: null
117534
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117535
+ error: null
117536
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
117537
+ action_type: 'CONFIGURE_AUTO_LOCK'
117538
+ }
117539
+ | {
117540
+ /** ID of the action attempt. */
117541
+ action_attempt_id: string
117542
+ status: 'success'
117543
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117544
+ error: null
117545
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
117546
+ action_type: 'CONFIGURE_AUTO_LOCK'
117547
+ /** Result of the action. */
117548
+ result: {}
117549
+ }
117550
+ | {
117551
+ /** ID of the action attempt. */
117552
+ action_attempt_id: string
117553
+ status: 'error'
117554
+ /** Result of the action attempt. Null for failed action attempts. */
117555
+ result: null
117556
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
117557
+ action_type: 'CONFIGURE_AUTO_LOCK'
117558
+ /** Error associated with the action. */
117559
+ error: {
117560
+ /** Type of the error. */
117561
+ type: string
117562
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117563
+ message: string
117564
+ }
117565
+ }
117566
+ | {
117567
+ /** ID of the action attempt. */
117568
+ action_attempt_id: string
117569
+ status: 'pending'
117570
+ /** Result of the action attempt. Null for pending action attempts. */
117571
+ result: null
117572
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117573
+ error: null
117574
+ /** Syncing access codes is pending. */
117575
+ action_type: 'SYNC_ACCESS_CODES'
117576
+ }
117577
+ | {
117578
+ /** ID of the action attempt. */
117579
+ action_attempt_id: string
117580
+ status: 'success'
117581
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117582
+ error: null
117583
+ /** Syncing access codes succeeded. */
117584
+ action_type: 'SYNC_ACCESS_CODES'
117585
+ /** Result of the action. */
117586
+ result: {}
117587
+ }
117588
+ | {
117589
+ /** ID of the action attempt. */
117590
+ action_attempt_id: string
117591
+ status: 'error'
117592
+ /** Result of the action attempt. Null for failed action attempts. */
117593
+ result: null
117594
+ /** Syncing access codes failed. */
117595
+ action_type: 'SYNC_ACCESS_CODES'
117596
+ /** Error associated with the action. */
117597
+ error: {
117598
+ /** Type of the error. */
117599
+ type: string
117600
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117601
+ message: string
117602
+ }
117603
+ }
117604
+ | {
117605
+ /** ID of the action attempt. */
117606
+ action_attempt_id: string
117607
+ status: 'pending'
117608
+ /** Result of the action attempt. Null for pending action attempts. */
117609
+ result: null
117610
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117611
+ error: null
117612
+ /** Creating an access code is pending. */
117613
+ action_type: 'CREATE_ACCESS_CODE'
117614
+ }
117615
+ | {
117616
+ /** ID of the action attempt. */
117617
+ action_attempt_id: string
117618
+ status: 'success'
117619
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117620
+ error: null
117621
+ /** Creating an access code succeeded. */
117622
+ action_type: 'CREATE_ACCESS_CODE'
117623
+ /** Result of the action. */
117624
+ result: {
117625
+ /** Created access code. */
117626
+ access_code: {
117627
+ [x: string]: any
117628
+ }
117629
+ }
117630
+ }
117631
+ | {
117632
+ /** ID of the action attempt. */
117633
+ action_attempt_id: string
117634
+ status: 'error'
117635
+ /** Result of the action attempt. Null for failed action attempts. */
117636
+ result: null
117637
+ /** Creating an access code failed. */
117638
+ action_type: 'CREATE_ACCESS_CODE'
117639
+ /** Error associated with the action. */
117640
+ error: {
117641
+ /** Type of the error. */
117642
+ type: string
117643
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117644
+ message: string
117645
+ }
117646
+ }
117647
+ | {
117648
+ /** ID of the action attempt. */
117649
+ action_attempt_id: string
117650
+ status: 'pending'
117651
+ /** Result of the action attempt. Null for pending action attempts. */
117652
+ result: null
117653
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117654
+ error: null
117655
+ /** Deleting an access code is pending. */
117656
+ action_type: 'DELETE_ACCESS_CODE'
117657
+ }
117658
+ | {
117659
+ /** ID of the action attempt. */
117660
+ action_attempt_id: string
117661
+ status: 'success'
117662
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117663
+ error: null
117664
+ /** Deleting an access code succeeded. */
117665
+ action_type: 'DELETE_ACCESS_CODE'
117666
+ /** Result of the action. */
117667
+ result: {}
117668
+ }
117669
+ | {
117670
+ /** ID of the action attempt. */
117671
+ action_attempt_id: string
117672
+ status: 'error'
117673
+ /** Result of the action attempt. Null for failed action attempts. */
117674
+ result: null
117675
+ /** Deleting an access code failed. */
117676
+ action_type: 'DELETE_ACCESS_CODE'
117677
+ /** Error associated with the action. */
117678
+ error: {
117679
+ /** Type of the error. */
117680
+ type: string
117681
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117682
+ message: string
117683
+ }
117684
+ }
117685
+ | {
117686
+ /** ID of the action attempt. */
117687
+ action_attempt_id: string
117688
+ status: 'pending'
117689
+ /** Result of the action attempt. Null for pending action attempts. */
117690
+ result: null
117691
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117692
+ error: null
117693
+ /** Updating an access code is pending. */
117694
+ action_type: 'UPDATE_ACCESS_CODE'
117695
+ }
117696
+ | {
117697
+ /** ID of the action attempt. */
117698
+ action_attempt_id: string
117699
+ status: 'success'
117700
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117701
+ error: null
117702
+ /** Updating an access code succeeded. */
117703
+ action_type: 'UPDATE_ACCESS_CODE'
117704
+ /** Result of the action. */
117705
+ result: {
117706
+ /** Updated access code. */
117707
+ access_code?:
117708
+ | {
117709
+ [x: string]: any
117710
+ }
117711
+ | undefined
117712
+ }
117713
+ }
117714
+ | {
117715
+ /** ID of the action attempt. */
117716
+ action_attempt_id: string
117717
+ status: 'error'
117718
+ /** Result of the action attempt. Null for failed action attempts. */
117719
+ result: null
117720
+ /** Updating an access code failed. */
117721
+ action_type: 'UPDATE_ACCESS_CODE'
117722
+ /** Error associated with the action. */
117723
+ error: {
117724
+ /** Type of the error. */
117725
+ type: string
117726
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117727
+ message: string
117728
+ }
117729
+ }
117730
+ | {
117731
+ /** ID of the action attempt. */
117732
+ action_attempt_id: string
117733
+ status: 'pending'
117734
+ /** Result of the action attempt. Null for pending action attempts. */
117735
+ result: null
117736
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117737
+ error: null
117738
+ /** Creating a noise threshold is pending. */
117739
+ action_type: 'CREATE_NOISE_THRESHOLD'
117740
+ }
117741
+ | {
117742
+ /** ID of the action attempt. */
117743
+ action_attempt_id: string
117744
+ status: 'success'
117745
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117746
+ error: null
117747
+ /** Creating a noise threshold succeeded. */
117748
+ action_type: 'CREATE_NOISE_THRESHOLD'
117749
+ /** Result of the action. */
117750
+ result: {
117751
+ /** Created noise threshold. */
117752
+ noise_threshold: {
117753
+ [x: string]: any
117754
+ }
117755
+ }
117756
+ }
117757
+ | {
117758
+ /** ID of the action attempt. */
117759
+ action_attempt_id: string
117760
+ status: 'error'
117761
+ /** Result of the action attempt. Null for failed action attempts. */
117762
+ result: null
117763
+ /** Creating a noise threshold failed. */
117764
+ action_type: 'CREATE_NOISE_THRESHOLD'
117765
+ /** Error associated with the action. */
117766
+ error: {
117767
+ /** Type of the error. */
117768
+ type: string
117769
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117770
+ message: string
117771
+ }
117772
+ }
117773
+ | {
117774
+ /** ID of the action attempt. */
117775
+ action_attempt_id: string
117776
+ status: 'pending'
117777
+ /** Result of the action attempt. Null for pending action attempts. */
117778
+ result: null
117779
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117780
+ error: null
117781
+ /** Deleting a noise threshold is pending. */
117782
+ action_type: 'DELETE_NOISE_THRESHOLD'
117783
+ }
117784
+ | {
117785
+ /** ID of the action attempt. */
117786
+ action_attempt_id: string
117787
+ status: 'success'
117788
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117789
+ error: null
117790
+ /** Deleting a noise threshold succeeded. */
117791
+ action_type: 'DELETE_NOISE_THRESHOLD'
117792
+ /** Result of the action. */
117793
+ result: {}
117794
+ }
117795
+ | {
117796
+ /** ID of the action attempt. */
117797
+ action_attempt_id: string
117798
+ status: 'error'
117799
+ /** Result of the action attempt. Null for failed action attempts. */
117800
+ result: null
117801
+ /** Deleting a noise threshold failed. */
117802
+ action_type: 'DELETE_NOISE_THRESHOLD'
117803
+ /** Error associated with the action. */
117804
+ error: {
117805
+ /** Type of the error. */
117806
+ type: string
117807
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117808
+ message: string
117809
+ }
117810
+ }
117811
+ | {
117812
+ /** ID of the action attempt. */
117813
+ action_attempt_id: string
117814
+ status: 'pending'
117815
+ /** Result of the action attempt. Null for pending action attempts. */
117816
+ result: null
117817
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117818
+ error: null
117819
+ /** Updating a noise threshold is pending. */
117820
+ action_type: 'UPDATE_NOISE_THRESHOLD'
117821
+ }
117822
+ | {
117823
+ /** ID of the action attempt. */
117824
+ action_attempt_id: string
117825
+ status: 'success'
117826
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117827
+ error: null
117828
+ /** Updating a noise threshold succeeded. */
117829
+ action_type: 'UPDATE_NOISE_THRESHOLD'
117830
+ /** Result of the action. */
117831
+ result: {
117832
+ /** Updated noise threshold. */
117833
+ noise_threshold: {
117834
+ [x: string]: any
117835
+ }
117836
+ }
117837
+ }
117838
+ | {
117839
+ /** ID of the action attempt. */
117840
+ action_attempt_id: string
117841
+ status: 'error'
117842
+ /** Result of the action attempt. Null for failed action attempts. */
117843
+ result: null
117844
+ /** Updating a noise threshold failed. */
117845
+ action_type: 'UPDATE_NOISE_THRESHOLD'
117846
+ /** Error associated with the action. */
117847
+ error: {
117848
+ /** Type of the error. */
117849
+ type: string
117850
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117851
+ message: string
117852
+ }
117853
+ }
114817
117854
  }
114818
117855
  maxDuration: undefined
114819
117856
  }
114820
- '/thermostats/activate_climate_preset': {
114821
- route: '/thermostats/activate_climate_preset'
117857
+ '/thermostats/activate_weekly_program': {
117858
+ route: '/thermostats/activate_weekly_program'
114822
117859
  method: 'POST'
114823
117860
  queryParams: {}
114824
117861
  jsonBody: {
114825
- /** ID of the thermostat device for which you want to activate a climate preset. */
117862
+ /** ID of the thermostat device that you want to return to its weekly program. */
114826
117863
  device_id: string
114827
- /** Climate preset key of the climate preset that you want to activate. */
114828
- climate_preset_key: string
117864
+ /** */
117865
+ sync?: boolean
114829
117866
  }
114830
117867
  commonParams: {}
114831
117868
  formData: {}
@@ -116492,6 +119529,44 @@ export type Routes = {
116492
119529
  message: string
116493
119530
  }
116494
119531
  }
119532
+ | {
119533
+ /** ID of the action attempt. */
119534
+ action_attempt_id: string
119535
+ status: 'pending'
119536
+ /** Result of the action attempt. Null for pending action attempts. */
119537
+ result: null
119538
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119539
+ error: null
119540
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119541
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
119542
+ }
119543
+ | {
119544
+ /** ID of the action attempt. */
119545
+ action_attempt_id: string
119546
+ status: 'success'
119547
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119548
+ error: null
119549
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119550
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
119551
+ /** Result of the action. */
119552
+ result: {}
119553
+ }
119554
+ | {
119555
+ /** ID of the action attempt. */
119556
+ action_attempt_id: string
119557
+ status: 'error'
119558
+ /** Result of the action attempt. Null for failed action attempts. */
119559
+ result: null
119560
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119561
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
119562
+ /** Error associated with the action. */
119563
+ error: {
119564
+ /** Type of the error. */
119565
+ type: string
119566
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119567
+ message: string
119568
+ }
119569
+ }
116495
119570
  | {
116496
119571
  /** ID of the action attempt. */
116497
119572
  action_attempt_id: string
@@ -118614,6 +121689,44 @@ export type Routes = {
118614
121689
  message: string
118615
121690
  }
118616
121691
  }
121692
+ | {
121693
+ /** ID of the action attempt. */
121694
+ action_attempt_id: string
121695
+ status: 'pending'
121696
+ /** Result of the action attempt. Null for pending action attempts. */
121697
+ result: null
121698
+ /** Errors associated with the action attempt. Null for pending action attempts. */
121699
+ error: null
121700
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
121701
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
121702
+ }
121703
+ | {
121704
+ /** ID of the action attempt. */
121705
+ action_attempt_id: string
121706
+ status: 'success'
121707
+ /** Errors associated with the action attempt. Null for successful action attempts. */
121708
+ error: null
121709
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
121710
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
121711
+ /** Result of the action. */
121712
+ result: {}
121713
+ }
121714
+ | {
121715
+ /** ID of the action attempt. */
121716
+ action_attempt_id: string
121717
+ status: 'error'
121718
+ /** Result of the action attempt. Null for failed action attempts. */
121719
+ result: null
121720
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
121721
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
121722
+ /** Error associated with the action. */
121723
+ error: {
121724
+ /** Type of the error. */
121725
+ type: string
121726
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
121727
+ message: string
121728
+ }
121729
+ }
118617
121730
  | {
118618
121731
  /** ID of the action attempt. */
118619
121732
  action_attempt_id: string
@@ -120847,6 +123960,44 @@ export type Routes = {
120847
123960
  message: string
120848
123961
  }
120849
123962
  }
123963
+ | {
123964
+ /** ID of the action attempt. */
123965
+ action_attempt_id: string
123966
+ status: 'pending'
123967
+ /** Result of the action attempt. Null for pending action attempts. */
123968
+ result: null
123969
+ /** Errors associated with the action attempt. Null for pending action attempts. */
123970
+ error: null
123971
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
123972
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
123973
+ }
123974
+ | {
123975
+ /** ID of the action attempt. */
123976
+ action_attempt_id: string
123977
+ status: 'success'
123978
+ /** Errors associated with the action attempt. Null for successful action attempts. */
123979
+ error: null
123980
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
123981
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
123982
+ /** Result of the action. */
123983
+ result: {}
123984
+ }
123985
+ | {
123986
+ /** ID of the action attempt. */
123987
+ action_attempt_id: string
123988
+ status: 'error'
123989
+ /** Result of the action attempt. Null for failed action attempts. */
123990
+ result: null
123991
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
123992
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
123993
+ /** Error associated with the action. */
123994
+ error: {
123995
+ /** Type of the error. */
123996
+ type: string
123997
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
123998
+ message: string
123999
+ }
124000
+ }
120850
124001
  | {
120851
124002
  /** ID of the action attempt. */
120852
124003
  action_attempt_id: string
@@ -123212,6 +126363,8 @@ export type Routes = {
123212
126363
  can_hvac_heat_cool?: boolean | undefined
123213
126364
  /** Indicates whether the thermostat can be turned off. */
123214
126365
  can_turn_off_hvac?: boolean | undefined
126366
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
126367
+ can_activate_weekly_program?: boolean | undefined
123215
126368
  /** Indicates whether the device supports simulating removal in a sandbox. */
123216
126369
  can_simulate_removal?: boolean | undefined
123217
126370
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -124920,6 +128073,44 @@ export type Routes = {
124920
128073
  message: string
124921
128074
  }
124922
128075
  }
128076
+ | {
128077
+ /** ID of the action attempt. */
128078
+ action_attempt_id: string
128079
+ status: 'pending'
128080
+ /** Result of the action attempt. Null for pending action attempts. */
128081
+ result: null
128082
+ /** Errors associated with the action attempt. Null for pending action attempts. */
128083
+ error: null
128084
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128085
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
128086
+ }
128087
+ | {
128088
+ /** ID of the action attempt. */
128089
+ action_attempt_id: string
128090
+ status: 'success'
128091
+ /** Errors associated with the action attempt. Null for successful action attempts. */
128092
+ error: null
128093
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128094
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
128095
+ /** Result of the action. */
128096
+ result: {}
128097
+ }
128098
+ | {
128099
+ /** ID of the action attempt. */
128100
+ action_attempt_id: string
128101
+ status: 'error'
128102
+ /** Result of the action attempt. Null for failed action attempts. */
128103
+ result: null
128104
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128105
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
128106
+ /** Error associated with the action. */
128107
+ error: {
128108
+ /** Type of the error. */
128109
+ type: string
128110
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
128111
+ message: string
128112
+ }
128113
+ }
124923
128114
  | {
124924
128115
  /** ID of the action attempt. */
124925
128116
  action_attempt_id: string
@@ -127046,6 +130237,44 @@ export type Routes = {
127046
130237
  message: string
127047
130238
  }
127048
130239
  }
130240
+ | {
130241
+ /** ID of the action attempt. */
130242
+ action_attempt_id: string
130243
+ status: 'pending'
130244
+ /** Result of the action attempt. Null for pending action attempts. */
130245
+ result: null
130246
+ /** Errors associated with the action attempt. Null for pending action attempts. */
130247
+ error: null
130248
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
130249
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
130250
+ }
130251
+ | {
130252
+ /** ID of the action attempt. */
130253
+ action_attempt_id: string
130254
+ status: 'success'
130255
+ /** Errors associated with the action attempt. Null for successful action attempts. */
130256
+ error: null
130257
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
130258
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
130259
+ /** Result of the action. */
130260
+ result: {}
130261
+ }
130262
+ | {
130263
+ /** ID of the action attempt. */
130264
+ action_attempt_id: string
130265
+ status: 'error'
130266
+ /** Result of the action attempt. Null for failed action attempts. */
130267
+ result: null
130268
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
130269
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
130270
+ /** Error associated with the action. */
130271
+ error: {
130272
+ /** Type of the error. */
130273
+ type: string
130274
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130275
+ message: string
130276
+ }
130277
+ }
127049
130278
  | {
127050
130279
  /** ID of the action attempt. */
127051
130280
  action_attempt_id: string
@@ -129430,6 +132659,8 @@ export type Routes = {
129430
132659
  can_hvac_heat_cool?: boolean | undefined
129431
132660
  /** Indicates whether the thermostat can be turned off. */
129432
132661
  can_turn_off_hvac?: boolean | undefined
132662
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
132663
+ can_activate_weekly_program?: boolean | undefined
129433
132664
  /** Indicates whether the device supports simulating removal in a sandbox. */
129434
132665
  can_simulate_removal?: boolean | undefined
129435
132666
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -131349,6 +134580,8 @@ export type Routes = {
131349
134580
  can_hvac_heat_cool?: boolean | undefined
131350
134581
  /** Indicates whether the thermostat can be turned off. */
131351
134582
  can_turn_off_hvac?: boolean | undefined
134583
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
134584
+ can_activate_weekly_program?: boolean | undefined
131352
134585
  /** Indicates whether the device supports simulating removal in a sandbox. */
131353
134586
  can_simulate_removal?: boolean | undefined
131354
134587
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -133053,6 +136286,44 @@ export type Routes = {
133053
136286
  message: string
133054
136287
  }
133055
136288
  }
136289
+ | {
136290
+ /** ID of the action attempt. */
136291
+ action_attempt_id: string
136292
+ status: 'pending'
136293
+ /** Result of the action attempt. Null for pending action attempts. */
136294
+ result: null
136295
+ /** Errors associated with the action attempt. Null for pending action attempts. */
136296
+ error: null
136297
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
136298
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
136299
+ }
136300
+ | {
136301
+ /** ID of the action attempt. */
136302
+ action_attempt_id: string
136303
+ status: 'success'
136304
+ /** Errors associated with the action attempt. Null for successful action attempts. */
136305
+ error: null
136306
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
136307
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
136308
+ /** Result of the action. */
136309
+ result: {}
136310
+ }
136311
+ | {
136312
+ /** ID of the action attempt. */
136313
+ action_attempt_id: string
136314
+ status: 'error'
136315
+ /** Result of the action attempt. Null for failed action attempts. */
136316
+ result: null
136317
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
136318
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
136319
+ /** Error associated with the action. */
136320
+ error: {
136321
+ /** Type of the error. */
136322
+ type: string
136323
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
136324
+ message: string
136325
+ }
136326
+ }
133056
136327
  | {
133057
136328
  /** ID of the action attempt. */
133058
136329
  action_attempt_id: string
@@ -135380,6 +138651,44 @@ export type Routes = {
135380
138651
  message: string
135381
138652
  }
135382
138653
  }
138654
+ | {
138655
+ /** ID of the action attempt. */
138656
+ action_attempt_id: string
138657
+ status: 'pending'
138658
+ /** Result of the action attempt. Null for pending action attempts. */
138659
+ result: null
138660
+ /** Errors associated with the action attempt. Null for pending action attempts. */
138661
+ error: null
138662
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
138663
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
138664
+ }
138665
+ | {
138666
+ /** ID of the action attempt. */
138667
+ action_attempt_id: string
138668
+ status: 'success'
138669
+ /** Errors associated with the action attempt. Null for successful action attempts. */
138670
+ error: null
138671
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
138672
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
138673
+ /** Result of the action. */
138674
+ result: {}
138675
+ }
138676
+ | {
138677
+ /** ID of the action attempt. */
138678
+ action_attempt_id: string
138679
+ status: 'error'
138680
+ /** Result of the action attempt. Null for failed action attempts. */
138681
+ result: null
138682
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
138683
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
138684
+ /** Error associated with the action. */
138685
+ error: {
138686
+ /** Type of the error. */
138687
+ type: string
138688
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
138689
+ message: string
138690
+ }
138691
+ }
135383
138692
  | {
135384
138693
  /** ID of the action attempt. */
135385
138694
  action_attempt_id: string
@@ -137534,6 +140843,44 @@ export type Routes = {
137534
140843
  message: string
137535
140844
  }
137536
140845
  }
140846
+ | {
140847
+ /** ID of the action attempt. */
140848
+ action_attempt_id: string
140849
+ status: 'pending'
140850
+ /** Result of the action attempt. Null for pending action attempts. */
140851
+ result: null
140852
+ /** Errors associated with the action attempt. Null for pending action attempts. */
140853
+ error: null
140854
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
140855
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
140856
+ }
140857
+ | {
140858
+ /** ID of the action attempt. */
140859
+ action_attempt_id: string
140860
+ status: 'success'
140861
+ /** Errors associated with the action attempt. Null for successful action attempts. */
140862
+ error: null
140863
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
140864
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
140865
+ /** Result of the action. */
140866
+ result: {}
140867
+ }
140868
+ | {
140869
+ /** ID of the action attempt. */
140870
+ action_attempt_id: string
140871
+ status: 'error'
140872
+ /** Result of the action attempt. Null for failed action attempts. */
140873
+ result: null
140874
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
140875
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
140876
+ /** Error associated with the action. */
140877
+ error: {
140878
+ /** Type of the error. */
140879
+ type: string
140880
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
140881
+ message: string
140882
+ }
140883
+ }
137537
140884
  | {
137538
140885
  /** ID of the action attempt. */
137539
140886
  action_attempt_id: string
@@ -139804,6 +143151,44 @@ export type Routes = {
139804
143151
  message: string
139805
143152
  }
139806
143153
  }
143154
+ | {
143155
+ /** ID of the action attempt. */
143156
+ action_attempt_id: string
143157
+ status: 'pending'
143158
+ /** Result of the action attempt. Null for pending action attempts. */
143159
+ result: null
143160
+ /** Errors associated with the action attempt. Null for pending action attempts. */
143161
+ error: null
143162
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
143163
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
143164
+ }
143165
+ | {
143166
+ /** ID of the action attempt. */
143167
+ action_attempt_id: string
143168
+ status: 'success'
143169
+ /** Errors associated with the action attempt. Null for successful action attempts. */
143170
+ error: null
143171
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
143172
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
143173
+ /** Result of the action. */
143174
+ result: {}
143175
+ }
143176
+ | {
143177
+ /** ID of the action attempt. */
143178
+ action_attempt_id: string
143179
+ status: 'error'
143180
+ /** Result of the action attempt. Null for failed action attempts. */
143181
+ result: null
143182
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
143183
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
143184
+ /** Error associated with the action. */
143185
+ error: {
143186
+ /** Type of the error. */
143187
+ type: string
143188
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
143189
+ message: string
143190
+ }
143191
+ }
139807
143192
  | {
139808
143193
  /** ID of the action attempt. */
139809
143194
  action_attempt_id: string
@@ -142786,6 +146171,8 @@ export type Routes = {
142786
146171
  can_hvac_heat_cool?: boolean | undefined
142787
146172
  /** Indicates whether the thermostat can be turned off. */
142788
146173
  can_turn_off_hvac?: boolean | undefined
146174
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
146175
+ can_activate_weekly_program?: boolean | undefined
142789
146176
  /** Indicates whether the device supports simulating removal in a sandbox. */
142790
146177
  can_simulate_removal?: boolean | undefined
142791
146178
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -144707,6 +148094,8 @@ export type Routes = {
144707
148094
  can_hvac_heat_cool?: boolean | undefined
144708
148095
  /** Indicates whether the thermostat can be turned off. */
144709
148096
  can_turn_off_hvac?: boolean | undefined
148097
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
148098
+ can_activate_weekly_program?: boolean | undefined
144710
148099
  /** Indicates whether the device supports simulating removal in a sandbox. */
144711
148100
  can_simulate_removal?: boolean | undefined
144712
148101
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -148217,6 +151606,8 @@ export type Routes = {
148217
151606
  can_hvac_heat_cool?: boolean | undefined
148218
151607
  /** Indicates whether the thermostat can be turned off. */
148219
151608
  can_turn_off_hvac?: boolean | undefined
151609
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
151610
+ can_activate_weekly_program?: boolean | undefined
148220
151611
  /** Indicates whether the device supports simulating removal in a sandbox. */
148221
151612
  can_simulate_removal?: boolean | undefined
148222
151613
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -150946,6 +154337,44 @@ export type Routes = {
150946
154337
  message: string
150947
154338
  }
150948
154339
  }
154340
+ | {
154341
+ /** ID of the action attempt. */
154342
+ action_attempt_id: string
154343
+ status: 'pending'
154344
+ /** Result of the action attempt. Null for pending action attempts. */
154345
+ result: null
154346
+ /** Errors associated with the action attempt. Null for pending action attempts. */
154347
+ error: null
154348
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
154349
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
154350
+ }
154351
+ | {
154352
+ /** ID of the action attempt. */
154353
+ action_attempt_id: string
154354
+ status: 'success'
154355
+ /** Errors associated with the action attempt. Null for successful action attempts. */
154356
+ error: null
154357
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
154358
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
154359
+ /** Result of the action. */
154360
+ result: {}
154361
+ }
154362
+ | {
154363
+ /** ID of the action attempt. */
154364
+ action_attempt_id: string
154365
+ status: 'error'
154366
+ /** Result of the action attempt. Null for failed action attempts. */
154367
+ result: null
154368
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
154369
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
154370
+ /** Error associated with the action. */
154371
+ error: {
154372
+ /** Type of the error. */
154373
+ type: string
154374
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
154375
+ message: string
154376
+ }
154377
+ }
150949
154378
  | {
150950
154379
  /** ID of the action attempt. */
150951
154380
  action_attempt_id: string
@@ -152498,6 +155927,8 @@ export type Routes = {
152498
155927
  can_hvac_heat_cool?: boolean | undefined
152499
155928
  /** Indicates whether the thermostat can be turned off. */
152500
155929
  can_turn_off_hvac?: boolean | undefined
155930
+ /** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
155931
+ can_activate_weekly_program?: boolean | undefined
152501
155932
  /** Indicates whether the device supports simulating removal in a sandbox. */
152502
155933
  can_simulate_removal?: boolean | undefined
152503
155934
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -157063,6 +160494,10 @@ export type Routes = {
157063
160494
  image_url?: string | undefined
157064
160495
  /** URL to a short video clip captured at the time of activation. */
157065
160496
  video_url?: string | undefined
160497
+ /** Status of the recorded clip and thumbnail for this activation, when the camera supports event recordings. `pending` while Seam retrieves the recording, `available` once it is stored, `unavailable` if no recording covers the activation, and `failed` if retrieval failed. */
160498
+ media_status?:
160499
+ | ('pending' | 'available' | 'unavailable' | 'failed')
160500
+ | undefined
157066
160501
  }
157067
160502
  | {
157068
160503
  /** ID of the event. */
@@ -160467,6 +163902,44 @@ export type Routes = {
160467
163902
  message: string
160468
163903
  }
160469
163904
  }
163905
+ | {
163906
+ /** ID of the action attempt. */
163907
+ action_attempt_id: string
163908
+ status: 'pending'
163909
+ /** Result of the action attempt. Null for pending action attempts. */
163910
+ result: null
163911
+ /** Errors associated with the action attempt. Null for pending action attempts. */
163912
+ error: null
163913
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
163914
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
163915
+ }
163916
+ | {
163917
+ /** ID of the action attempt. */
163918
+ action_attempt_id: string
163919
+ status: 'success'
163920
+ /** Errors associated with the action attempt. Null for successful action attempts. */
163921
+ error: null
163922
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
163923
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
163924
+ /** Result of the action. */
163925
+ result: {}
163926
+ }
163927
+ | {
163928
+ /** ID of the action attempt. */
163929
+ action_attempt_id: string
163930
+ status: 'error'
163931
+ /** Result of the action attempt. Null for failed action attempts. */
163932
+ result: null
163933
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
163934
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
163935
+ /** Error associated with the action. */
163936
+ error: {
163937
+ /** Type of the error. */
163938
+ type: string
163939
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
163940
+ message: string
163941
+ }
163942
+ }
160470
163943
  | {
160471
163944
  /** ID of the action attempt. */
160472
163945
  action_attempt_id: string