@seamapi/types 1.1080.0 → 1.1082.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (31) 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-metadata.d.ts +33 -0
  8. package/lib/seam/connect/models/devices/device-metadata.js +23 -0
  9. package/lib/seam/connect/models/devices/device-metadata.js.map +1 -1
  10. package/lib/seam/connect/models/devices/device-provider.d.ts +5 -1
  11. package/lib/seam/connect/models/devices/device-provider.js +2 -1
  12. package/lib/seam/connect/models/devices/device-provider.js.map +1 -1
  13. package/lib/seam/connect/models/devices/device-type.d.ts +2 -1
  14. package/lib/seam/connect/models/devices/device-type.js +1 -0
  15. package/lib/seam/connect/models/devices/device-type.js.map +1 -1
  16. package/lib/seam/connect/models/devices/device.d.ts +56 -3
  17. package/lib/seam/connect/models/devices/device.js +3 -0
  18. package/lib/seam/connect/models/devices/device.js.map +1 -1
  19. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +40 -3
  20. package/lib/seam/connect/openapi.js +220 -6
  21. package/lib/seam/connect/openapi.js.map +1 -1
  22. package/lib/seam/connect/route-types.d.ts +3417 -152
  23. package/package.json +1 -1
  24. package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
  25. package/src/lib/seam/connect/models/action-attempts/activate-weekly-program.ts +46 -0
  26. package/src/lib/seam/connect/models/devices/device-metadata.ts +24 -0
  27. package/src/lib/seam/connect/models/devices/device-provider.ts +2 -1
  28. package/src/lib/seam/connect/models/devices/device-type.ts +1 -0
  29. package/src/lib/seam/connect/models/devices/device.ts +5 -0
  30. package/src/lib/seam/connect/openapi.ts +233 -6
  31. package/src/lib/seam/connect/route-types.ts +3790 -24
@@ -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
@@ -14238,7 +14390,7 @@ export type Routes = {
14238
14390
  | 'smartthings_thermostat'
14239
14391
  )
14240
14392
  | ('ios_phone' | 'android_phone')
14241
- | ('ring_camera' | 'tapo_camera')
14393
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
14242
14394
  /** IDs of the spaces the device is in. */
14243
14395
  space_ids: string[]
14244
14396
  /** Optional nickname to describe the device, settable through Seam. */
@@ -15071,6 +15223,24 @@ export type Routes = {
15071
15223
  | undefined
15072
15224
  )
15073
15225
  | undefined
15226
+ /** Metadata for an Arlo camera. */
15227
+ arlo_metadata?:
15228
+ | (
15229
+ | {
15230
+ /** Device ID reported by Arlo. */
15231
+ device_id?: (string | undefined) | undefined
15232
+ /** Device name reported by Arlo. */
15233
+ device_name?: (string | undefined) | undefined
15234
+ /** Model ID reported by Arlo. */
15235
+ model_id?: (string | undefined) | undefined
15236
+ /** Hardware version reported by Arlo. */
15237
+ hardware_version?: (string | undefined) | undefined
15238
+ /** Firmware version reported by Arlo. */
15239
+ firmware_version?: (string | undefined) | undefined
15240
+ }
15241
+ | undefined
15242
+ )
15243
+ | undefined
15074
15244
  /** Metadata for a Ring device. */
15075
15245
  ring_metadata?:
15076
15246
  | {
@@ -16115,6 +16285,8 @@ export type Routes = {
16115
16285
  can_hvac_heat_cool?: boolean | undefined
16116
16286
  /** Indicates whether the thermostat can be turned off. */
16117
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
16118
16290
  /** Indicates whether the device supports simulating removal in a sandbox. */
16119
16291
  can_simulate_removal?: boolean | undefined
16120
16292
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -19868,6 +20040,44 @@ export type Routes = {
19868
20040
  message: string
19869
20041
  }
19870
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
+ }
19871
20081
  | {
19872
20082
  /** ID of the action attempt. */
19873
20083
  action_attempt_id: string
@@ -22008,6 +22218,44 @@ export type Routes = {
22008
22218
  message: string
22009
22219
  }
22010
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
+ }
22011
22259
  | {
22012
22260
  /** ID of the action attempt. */
22013
22261
  action_attempt_id: string
@@ -22758,7 +23006,7 @@ export type Routes = {
22758
23006
  | 'smartthings_thermostat'
22759
23007
  )
22760
23008
  | ('ios_phone' | 'android_phone')
22761
- | ('ring_camera' | 'tapo_camera')
23009
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
22762
23010
  /** IDs of the spaces the device is in. */
22763
23011
  space_ids: string[]
22764
23012
  /** Optional nickname to describe the device, settable through Seam. */
@@ -23591,6 +23839,24 @@ export type Routes = {
23591
23839
  | undefined
23592
23840
  )
23593
23841
  | undefined
23842
+ /** Metadata for an Arlo camera. */
23843
+ arlo_metadata?:
23844
+ | (
23845
+ | {
23846
+ /** Device ID reported by Arlo. */
23847
+ device_id?: (string | undefined) | undefined
23848
+ /** Device name reported by Arlo. */
23849
+ device_name?: (string | undefined) | undefined
23850
+ /** Model ID reported by Arlo. */
23851
+ model_id?: (string | undefined) | undefined
23852
+ /** Hardware version reported by Arlo. */
23853
+ hardware_version?: (string | undefined) | undefined
23854
+ /** Firmware version reported by Arlo. */
23855
+ firmware_version?: (string | undefined) | undefined
23856
+ }
23857
+ | undefined
23858
+ )
23859
+ | undefined
23594
23860
  /** Metadata for a Ring device. */
23595
23861
  ring_metadata?:
23596
23862
  | {
@@ -24635,6 +24901,8 @@ export type Routes = {
24635
24901
  can_hvac_heat_cool?: boolean | undefined
24636
24902
  /** Indicates whether the thermostat can be turned off. */
24637
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
24638
24906
  /** Indicates whether the device supports simulating removal in a sandbox. */
24639
24907
  can_simulate_removal?: boolean | undefined
24640
24908
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -27413,6 +27681,44 @@ export type Routes = {
27413
27681
  message: string
27414
27682
  }
27415
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
+ }
27416
27722
  | {
27417
27723
  /** ID of the action attempt. */
27418
27724
  action_attempt_id: string
@@ -33669,6 +33975,44 @@ export type Routes = {
33669
33975
  message: string
33670
33976
  }
33671
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
+ }
33672
34016
  | {
33673
34017
  /** ID of the action attempt. */
33674
34018
  action_attempt_id: string
@@ -35897,6 +36241,44 @@ export type Routes = {
35897
36241
  message: string
35898
36242
  }
35899
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
+ }
35900
36282
  | {
35901
36283
  /** ID of the action attempt. */
35902
36284
  action_attempt_id: string
@@ -38024,6 +38406,44 @@ export type Routes = {
38024
38406
  message: string
38025
38407
  }
38026
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
+ }
38027
38447
  | {
38028
38448
  /** ID of the action attempt. */
38029
38449
  action_attempt_id: string
@@ -41036,6 +41456,44 @@ export type Routes = {
41036
41456
  message: string
41037
41457
  }
41038
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
+ }
41039
41497
  | {
41040
41498
  /** ID of the action attempt. */
41041
41499
  action_attempt_id: string
@@ -45962,6 +46420,44 @@ export type Routes = {
45962
46420
  message: string
45963
46421
  }
45964
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
+ }
45965
46461
  | {
45966
46462
  /** ID of the action attempt. */
45967
46463
  action_attempt_id: string
@@ -48079,6 +48575,44 @@ export type Routes = {
48079
48575
  message: string
48080
48576
  }
48081
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
+ }
48082
48616
  | {
48083
48617
  /** ID of the action attempt. */
48084
48618
  action_attempt_id: string
@@ -49014,6 +49548,7 @@ export type Routes = {
49014
49548
  | 'thirty_three_lock'
49015
49549
  | 'ring'
49016
49550
  | 'tapo'
49551
+ | 'arlo'
49017
49552
  | 'ical'
49018
49553
  | 'lodgify'
49019
49554
  | 'hostaway'
@@ -51178,7 +51713,7 @@ export type Routes = {
51178
51713
  | 'smartthings_thermostat'
51179
51714
  )
51180
51715
  | ('ios_phone' | 'android_phone')
51181
- | ('ring_camera' | 'tapo_camera')
51716
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
51182
51717
  /** IDs of the spaces the device is in. */
51183
51718
  space_ids: string[]
51184
51719
  /** Optional nickname to describe the device, settable through Seam. */
@@ -51986,6 +52521,24 @@ export type Routes = {
51986
52521
  | undefined
51987
52522
  )
51988
52523
  | undefined
52524
+ /** Metadata for an Arlo camera. */
52525
+ arlo_metadata?:
52526
+ | (
52527
+ | {
52528
+ /** Device ID reported by Arlo. */
52529
+ device_id?: (string | undefined) | undefined
52530
+ /** Device name reported by Arlo. */
52531
+ device_name?: (string | undefined) | undefined
52532
+ /** Model ID reported by Arlo. */
52533
+ model_id?: (string | undefined) | undefined
52534
+ /** Hardware version reported by Arlo. */
52535
+ hardware_version?: (string | undefined) | undefined
52536
+ /** Firmware version reported by Arlo. */
52537
+ firmware_version?: (string | undefined) | undefined
52538
+ }
52539
+ | undefined
52540
+ )
52541
+ | undefined
51989
52542
  /** Metadata for a Ring device. */
51990
52543
  ring_metadata?:
51991
52544
  | {
@@ -53004,6 +53557,8 @@ export type Routes = {
53004
53557
  can_hvac_heat_cool?: boolean | undefined
53005
53558
  /** Indicates whether the thermostat can be turned off. */
53006
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
53007
53562
  /** Indicates whether the device supports simulating removal in a sandbox. */
53008
53563
  can_simulate_removal?: boolean | undefined
53009
53564
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -53094,7 +53649,7 @@ export type Routes = {
53094
53649
  | 'smartthings_thermostat'
53095
53650
  )
53096
53651
  | ('ios_phone' | 'android_phone')
53097
- | ('ring_camera' | 'tapo_camera')
53652
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
53098
53653
  )
53099
53654
  | undefined
53100
53655
  /** Array of device types for which you want to list devices. */
@@ -53144,7 +53699,7 @@ export type Routes = {
53144
53699
  | 'smartthings_thermostat'
53145
53700
  )
53146
53701
  | ('ios_phone' | 'android_phone')
53147
- | ('ring_camera' | 'tapo_camera')
53702
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
53148
53703
  )[]
53149
53704
  | undefined
53150
53705
  /** Manufacturer for which you want to list devices. */
@@ -53196,6 +53751,7 @@ export type Routes = {
53196
53751
  | 'ultraloq'
53197
53752
  | 'ring'
53198
53753
  | 'tapo'
53754
+ | 'arlo'
53199
53755
  | 'ical'
53200
53756
  | 'lodgify'
53201
53757
  | 'hostaway'
@@ -53234,6 +53790,7 @@ export type Routes = {
53234
53790
  | 'can_hvac_cool'
53235
53791
  | 'can_hvac_heat_cool'
53236
53792
  | 'can_turn_off_hvac'
53793
+ | 'can_activate_weekly_program'
53237
53794
  | 'can_simulate_removal'
53238
53795
  | 'can_simulate_connection'
53239
53796
  | 'can_simulate_disconnection'
@@ -53259,6 +53816,7 @@ export type Routes = {
53259
53816
  | 'can_hvac_cool'
53260
53817
  | 'can_hvac_heat_cool'
53261
53818
  | 'can_turn_off_hvac'
53819
+ | 'can_activate_weekly_program'
53262
53820
  | 'can_simulate_removal'
53263
53821
  | 'can_simulate_connection'
53264
53822
  | 'can_simulate_disconnection'
@@ -53332,7 +53890,7 @@ export type Routes = {
53332
53890
  | 'smartthings_thermostat'
53333
53891
  )
53334
53892
  | ('ios_phone' | 'android_phone')
53335
- | ('ring_camera' | 'tapo_camera')
53893
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
53336
53894
  /** IDs of the spaces the device is in. */
53337
53895
  space_ids: string[]
53338
53896
  /** Optional nickname to describe the device, settable through Seam. */
@@ -54140,6 +54698,24 @@ export type Routes = {
54140
54698
  | undefined
54141
54699
  )
54142
54700
  | undefined
54701
+ /** Metadata for an Arlo camera. */
54702
+ arlo_metadata?:
54703
+ | (
54704
+ | {
54705
+ /** Device ID reported by Arlo. */
54706
+ device_id?: (string | undefined) | undefined
54707
+ /** Device name reported by Arlo. */
54708
+ device_name?: (string | undefined) | undefined
54709
+ /** Model ID reported by Arlo. */
54710
+ model_id?: (string | undefined) | undefined
54711
+ /** Hardware version reported by Arlo. */
54712
+ hardware_version?: (string | undefined) | undefined
54713
+ /** Firmware version reported by Arlo. */
54714
+ firmware_version?: (string | undefined) | undefined
54715
+ }
54716
+ | undefined
54717
+ )
54718
+ | undefined
54143
54719
  /** Metadata for a Ring device. */
54144
54720
  ring_metadata?:
54145
54721
  | {
@@ -55158,6 +55734,8 @@ export type Routes = {
55158
55734
  can_hvac_heat_cool?: boolean | undefined
55159
55735
  /** Indicates whether the thermostat can be turned off. */
55160
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
55161
55739
  /** Indicates whether the device supports simulating removal in a sandbox. */
55162
55740
  can_simulate_removal?: boolean | undefined
55163
55741
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -55279,6 +55857,7 @@ export type Routes = {
55279
55857
  | 'thirty_three_lock'
55280
55858
  | 'ring'
55281
55859
  | 'tapo'
55860
+ | 'arlo'
55282
55861
  | 'ical'
55283
55862
  | 'lodgify'
55284
55863
  | 'hostaway'
@@ -55318,6 +55897,8 @@ export type Routes = {
55318
55897
  can_hvac_heat_cool?: boolean | undefined
55319
55898
  /** Indicates whether the thermostat can be turned off. */
55320
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
55321
55902
  /** Indicates whether the device supports simulating removal in a sandbox. */
55322
55903
  can_simulate_removal?: boolean | undefined
55323
55904
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -56812,7 +57393,7 @@ export type Routes = {
56812
57393
  | 'smartthings_thermostat'
56813
57394
  )
56814
57395
  | ('ios_phone' | 'android_phone')
56815
- | ('ring_camera' | 'tapo_camera')
57396
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
56816
57397
  /** Unique identifier for the account associated with the device. */
56817
57398
  connected_account_id: string
56818
57399
  /** Location information for the device. */
@@ -57331,6 +57912,8 @@ export type Routes = {
57331
57912
  can_hvac_heat_cool?: boolean | undefined
57332
57913
  /** Indicates whether the thermostat can be turned off. */
57333
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
57334
57917
  /** Indicates whether the device supports simulating removal in a sandbox. */
57335
57918
  can_simulate_removal?: boolean | undefined
57336
57919
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -57421,7 +58004,7 @@ export type Routes = {
57421
58004
  | 'smartthings_thermostat'
57422
58005
  )
57423
58006
  | ('ios_phone' | 'android_phone')
57424
- | ('ring_camera' | 'tapo_camera')
58007
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
57425
58008
  )
57426
58009
  | undefined
57427
58010
  /** Array of device types for which you want to list devices. */
@@ -57471,7 +58054,7 @@ export type Routes = {
57471
58054
  | 'smartthings_thermostat'
57472
58055
  )
57473
58056
  | ('ios_phone' | 'android_phone')
57474
- | ('ring_camera' | 'tapo_camera')
58057
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
57475
58058
  )[]
57476
58059
  | undefined
57477
58060
  /** Manufacturer for which you want to list devices. */
@@ -57523,6 +58106,7 @@ export type Routes = {
57523
58106
  | 'ultraloq'
57524
58107
  | 'ring'
57525
58108
  | 'tapo'
58109
+ | 'arlo'
57526
58110
  | 'ical'
57527
58111
  | 'lodgify'
57528
58112
  | 'hostaway'
@@ -57551,6 +58135,7 @@ export type Routes = {
57551
58135
  | 'can_hvac_cool'
57552
58136
  | 'can_hvac_heat_cool'
57553
58137
  | 'can_turn_off_hvac'
58138
+ | 'can_activate_weekly_program'
57554
58139
  | 'can_simulate_removal'
57555
58140
  | 'can_simulate_connection'
57556
58141
  | 'can_simulate_disconnection'
@@ -57576,6 +58161,7 @@ export type Routes = {
57576
58161
  | 'can_hvac_cool'
57577
58162
  | 'can_hvac_heat_cool'
57578
58163
  | 'can_turn_off_hvac'
58164
+ | 'can_activate_weekly_program'
57579
58165
  | 'can_simulate_removal'
57580
58166
  | 'can_simulate_connection'
57581
58167
  | 'can_simulate_disconnection'
@@ -57646,7 +58232,7 @@ export type Routes = {
57646
58232
  | 'smartthings_thermostat'
57647
58233
  )
57648
58234
  | ('ios_phone' | 'android_phone')
57649
- | ('ring_camera' | 'tapo_camera')
58235
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
57650
58236
  /** Unique identifier for the account associated with the device. */
57651
58237
  connected_account_id: string
57652
58238
  /** Location information for the device. */
@@ -58165,6 +58751,8 @@ export type Routes = {
58165
58751
  can_hvac_heat_cool?: boolean | undefined
58166
58752
  /** Indicates whether the thermostat can be turned off. */
58167
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
58168
58756
  /** Indicates whether the device supports simulating removal in a sandbox. */
58169
58757
  can_simulate_removal?: boolean | undefined
58170
58758
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -68343,6 +68931,44 @@ export type Routes = {
68343
68931
  message: string
68344
68932
  }
68345
68933
  }
68934
+ | {
68935
+ /** ID of the action attempt. */
68936
+ action_attempt_id: string
68937
+ status: 'pending'
68938
+ /** Result of the action attempt. Null for pending action attempts. */
68939
+ result: null
68940
+ /** Errors associated with the action attempt. Null for pending action attempts. */
68941
+ error: null
68942
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68943
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
68944
+ }
68945
+ | {
68946
+ /** ID of the action attempt. */
68947
+ action_attempt_id: string
68948
+ status: 'success'
68949
+ /** Errors associated with the action attempt. Null for successful action attempts. */
68950
+ error: null
68951
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68952
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
68953
+ /** Result of the action. */
68954
+ result: {}
68955
+ }
68956
+ | {
68957
+ /** ID of the action attempt. */
68958
+ action_attempt_id: string
68959
+ status: 'error'
68960
+ /** Result of the action attempt. Null for failed action attempts. */
68961
+ result: null
68962
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
68963
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
68964
+ /** Error associated with the action. */
68965
+ error: {
68966
+ /** Type of the error. */
68967
+ type: string
68968
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
68969
+ message: string
68970
+ }
68971
+ }
68346
68972
  | {
68347
68973
  /** ID of the action attempt. */
68348
68974
  action_attempt_id: string
@@ -68849,7 +69475,7 @@ export type Routes = {
68849
69475
  | 'smartthings_thermostat'
68850
69476
  )
68851
69477
  | ('ios_phone' | 'android_phone')
68852
- | ('ring_camera' | 'tapo_camera')
69478
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
68853
69479
  /** IDs of the spaces the device is in. */
68854
69480
  space_ids: string[]
68855
69481
  /** Optional nickname to describe the device, settable through Seam. */
@@ -69657,6 +70283,24 @@ export type Routes = {
69657
70283
  | undefined
69658
70284
  )
69659
70285
  | undefined
70286
+ /** Metadata for an Arlo camera. */
70287
+ arlo_metadata?:
70288
+ | (
70289
+ | {
70290
+ /** Device ID reported by Arlo. */
70291
+ device_id?: (string | undefined) | undefined
70292
+ /** Device name reported by Arlo. */
70293
+ device_name?: (string | undefined) | undefined
70294
+ /** Model ID reported by Arlo. */
70295
+ model_id?: (string | undefined) | undefined
70296
+ /** Hardware version reported by Arlo. */
70297
+ hardware_version?: (string | undefined) | undefined
70298
+ /** Firmware version reported by Arlo. */
70299
+ firmware_version?: (string | undefined) | undefined
70300
+ }
70301
+ | undefined
70302
+ )
70303
+ | undefined
69660
70304
  /** Metadata for a Ring device. */
69661
70305
  ring_metadata?:
69662
70306
  | {
@@ -70675,6 +71319,8 @@ export type Routes = {
70675
71319
  can_hvac_heat_cool?: boolean | undefined
70676
71320
  /** Indicates whether the thermostat can be turned off. */
70677
71321
  can_turn_off_hvac?: boolean | undefined
71322
+ /** 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. */
71323
+ can_activate_weekly_program?: boolean | undefined
70678
71324
  /** Indicates whether the device supports simulating removal in a sandbox. */
70679
71325
  can_simulate_removal?: boolean | undefined
70680
71326
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -70751,7 +71397,7 @@ export type Routes = {
70751
71397
  | 'smartthings_thermostat'
70752
71398
  )
70753
71399
  | ('ios_phone' | 'android_phone')
70754
- | ('ring_camera' | 'tapo_camera')
71400
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
70755
71401
  /** IDs of the spaces the device is in. */
70756
71402
  space_ids: string[]
70757
71403
  /** Optional nickname to describe the device, settable through Seam. */
@@ -71559,6 +72205,24 @@ export type Routes = {
71559
72205
  | undefined
71560
72206
  )
71561
72207
  | undefined
72208
+ /** Metadata for an Arlo camera. */
72209
+ arlo_metadata?:
72210
+ | (
72211
+ | {
72212
+ /** Device ID reported by Arlo. */
72213
+ device_id?: (string | undefined) | undefined
72214
+ /** Device name reported by Arlo. */
72215
+ device_name?: (string | undefined) | undefined
72216
+ /** Model ID reported by Arlo. */
72217
+ model_id?: (string | undefined) | undefined
72218
+ /** Hardware version reported by Arlo. */
72219
+ hardware_version?: (string | undefined) | undefined
72220
+ /** Firmware version reported by Arlo. */
72221
+ firmware_version?: (string | undefined) | undefined
72222
+ }
72223
+ | undefined
72224
+ )
72225
+ | undefined
71562
72226
  /** Metadata for a Ring device. */
71563
72227
  ring_metadata?:
71564
72228
  | {
@@ -72577,6 +73241,8 @@ export type Routes = {
72577
73241
  can_hvac_heat_cool?: boolean | undefined
72578
73242
  /** Indicates whether the thermostat can be turned off. */
72579
73243
  can_turn_off_hvac?: boolean | undefined
73244
+ /** 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. */
73245
+ can_activate_weekly_program?: boolean | undefined
72580
73246
  /** Indicates whether the device supports simulating removal in a sandbox. */
72581
73247
  can_simulate_removal?: boolean | undefined
72582
73248
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -72782,7 +73448,7 @@ export type Routes = {
72782
73448
  | 'smartthings_thermostat'
72783
73449
  )
72784
73450
  | ('ios_phone' | 'android_phone')
72785
- | ('ring_camera' | 'tapo_camera')
73451
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
72786
73452
  /** IDs of the spaces the device is in. */
72787
73453
  space_ids: string[]
72788
73454
  /** Optional nickname to describe the device, settable through Seam. */
@@ -73590,6 +74256,24 @@ export type Routes = {
73590
74256
  | undefined
73591
74257
  )
73592
74258
  | undefined
74259
+ /** Metadata for an Arlo camera. */
74260
+ arlo_metadata?:
74261
+ | (
74262
+ | {
74263
+ /** Device ID reported by Arlo. */
74264
+ device_id?: (string | undefined) | undefined
74265
+ /** Device name reported by Arlo. */
74266
+ device_name?: (string | undefined) | undefined
74267
+ /** Model ID reported by Arlo. */
74268
+ model_id?: (string | undefined) | undefined
74269
+ /** Hardware version reported by Arlo. */
74270
+ hardware_version?: (string | undefined) | undefined
74271
+ /** Firmware version reported by Arlo. */
74272
+ firmware_version?: (string | undefined) | undefined
74273
+ }
74274
+ | undefined
74275
+ )
74276
+ | undefined
73593
74277
  /** Metadata for a Ring device. */
73594
74278
  ring_metadata?:
73595
74279
  | {
@@ -74608,6 +75292,8 @@ export type Routes = {
74608
75292
  can_hvac_heat_cool?: boolean | undefined
74609
75293
  /** Indicates whether the thermostat can be turned off. */
74610
75294
  can_turn_off_hvac?: boolean | undefined
75295
+ /** 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. */
75296
+ can_activate_weekly_program?: boolean | undefined
74611
75297
  /** Indicates whether the device supports simulating removal in a sandbox. */
74612
75298
  can_simulate_removal?: boolean | undefined
74613
75299
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -74683,7 +75369,7 @@ export type Routes = {
74683
75369
  | 'smartthings_thermostat'
74684
75370
  )
74685
75371
  | ('ios_phone' | 'android_phone')
74686
- | ('ring_camera' | 'tapo_camera')
75372
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
74687
75373
  /** IDs of the spaces the device is in. */
74688
75374
  space_ids: string[]
74689
75375
  /** Optional nickname to describe the device, settable through Seam. */
@@ -75491,6 +76177,24 @@ export type Routes = {
75491
76177
  | undefined
75492
76178
  )
75493
76179
  | undefined
76180
+ /** Metadata for an Arlo camera. */
76181
+ arlo_metadata?:
76182
+ | (
76183
+ | {
76184
+ /** Device ID reported by Arlo. */
76185
+ device_id?: (string | undefined) | undefined
76186
+ /** Device name reported by Arlo. */
76187
+ device_name?: (string | undefined) | undefined
76188
+ /** Model ID reported by Arlo. */
76189
+ model_id?: (string | undefined) | undefined
76190
+ /** Hardware version reported by Arlo. */
76191
+ hardware_version?: (string | undefined) | undefined
76192
+ /** Firmware version reported by Arlo. */
76193
+ firmware_version?: (string | undefined) | undefined
76194
+ }
76195
+ | undefined
76196
+ )
76197
+ | undefined
75494
76198
  /** Metadata for a Ring device. */
75495
76199
  ring_metadata?:
75496
76200
  | {
@@ -76509,6 +77213,8 @@ export type Routes = {
76509
77213
  can_hvac_heat_cool?: boolean | undefined
76510
77214
  /** Indicates whether the thermostat can be turned off. */
76511
77215
  can_turn_off_hvac?: boolean | undefined
77216
+ /** 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. */
77217
+ can_activate_weekly_program?: boolean | undefined
76512
77218
  /** Indicates whether the device supports simulating removal in a sandbox. */
76513
77219
  can_simulate_removal?: boolean | undefined
76514
77220
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -78213,6 +78919,44 @@ export type Routes = {
78213
78919
  message: string
78214
78920
  }
78215
78921
  }
78922
+ | {
78923
+ /** ID of the action attempt. */
78924
+ action_attempt_id: string
78925
+ status: 'pending'
78926
+ /** Result of the action attempt. Null for pending action attempts. */
78927
+ result: null
78928
+ /** Errors associated with the action attempt. Null for pending action attempts. */
78929
+ error: null
78930
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
78931
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
78932
+ }
78933
+ | {
78934
+ /** ID of the action attempt. */
78935
+ action_attempt_id: string
78936
+ status: 'success'
78937
+ /** Errors associated with the action attempt. Null for successful action attempts. */
78938
+ error: null
78939
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
78940
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
78941
+ /** Result of the action. */
78942
+ result: {}
78943
+ }
78944
+ | {
78945
+ /** ID of the action attempt. */
78946
+ action_attempt_id: string
78947
+ status: 'error'
78948
+ /** Result of the action attempt. Null for failed action attempts. */
78949
+ result: null
78950
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
78951
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
78952
+ /** Error associated with the action. */
78953
+ error: {
78954
+ /** Type of the error. */
78955
+ type: string
78956
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
78957
+ message: string
78958
+ }
78959
+ }
78216
78960
  | {
78217
78961
  /** ID of the action attempt. */
78218
78962
  action_attempt_id: string
@@ -80331,6 +81075,44 @@ export type Routes = {
80331
81075
  message: string
80332
81076
  }
80333
81077
  }
81078
+ | {
81079
+ /** ID of the action attempt. */
81080
+ action_attempt_id: string
81081
+ status: 'pending'
81082
+ /** Result of the action attempt. Null for pending action attempts. */
81083
+ result: null
81084
+ /** Errors associated with the action attempt. Null for pending action attempts. */
81085
+ error: null
81086
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
81087
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
81088
+ }
81089
+ | {
81090
+ /** ID of the action attempt. */
81091
+ action_attempt_id: string
81092
+ status: 'success'
81093
+ /** Errors associated with the action attempt. Null for successful action attempts. */
81094
+ error: null
81095
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
81096
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
81097
+ /** Result of the action. */
81098
+ result: {}
81099
+ }
81100
+ | {
81101
+ /** ID of the action attempt. */
81102
+ action_attempt_id: string
81103
+ status: 'error'
81104
+ /** Result of the action attempt. Null for failed action attempts. */
81105
+ result: null
81106
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
81107
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
81108
+ /** Error associated with the action. */
81109
+ error: {
81110
+ /** Type of the error. */
81111
+ type: string
81112
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
81113
+ message: string
81114
+ }
81115
+ }
80334
81116
  | {
80335
81117
  /** ID of the action attempt. */
80336
81118
  action_attempt_id: string
@@ -82447,6 +83229,44 @@ export type Routes = {
82447
83229
  message: string
82448
83230
  }
82449
83231
  }
83232
+ | {
83233
+ /** ID of the action attempt. */
83234
+ action_attempt_id: string
83235
+ status: 'pending'
83236
+ /** Result of the action attempt. Null for pending action attempts. */
83237
+ result: null
83238
+ /** Errors associated with the action attempt. Null for pending action attempts. */
83239
+ error: null
83240
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83241
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
83242
+ }
83243
+ | {
83244
+ /** ID of the action attempt. */
83245
+ action_attempt_id: string
83246
+ status: 'success'
83247
+ /** Errors associated with the action attempt. Null for successful action attempts. */
83248
+ error: null
83249
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83250
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
83251
+ /** Result of the action. */
83252
+ result: {}
83253
+ }
83254
+ | {
83255
+ /** ID of the action attempt. */
83256
+ action_attempt_id: string
83257
+ status: 'error'
83258
+ /** Result of the action attempt. Null for failed action attempts. */
83259
+ result: null
83260
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
83261
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
83262
+ /** Error associated with the action. */
83263
+ error: {
83264
+ /** Type of the error. */
83265
+ type: string
83266
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
83267
+ message: string
83268
+ }
83269
+ }
82450
83270
  | {
82451
83271
  /** ID of the action attempt. */
82452
83272
  action_attempt_id: string
@@ -84565,6 +85385,44 @@ export type Routes = {
84565
85385
  message: string
84566
85386
  }
84567
85387
  }
85388
+ | {
85389
+ /** ID of the action attempt. */
85390
+ action_attempt_id: string
85391
+ status: 'pending'
85392
+ /** Result of the action attempt. Null for pending action attempts. */
85393
+ result: null
85394
+ /** Errors associated with the action attempt. Null for pending action attempts. */
85395
+ error: null
85396
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
85397
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
85398
+ }
85399
+ | {
85400
+ /** ID of the action attempt. */
85401
+ action_attempt_id: string
85402
+ status: 'success'
85403
+ /** Errors associated with the action attempt. Null for successful action attempts. */
85404
+ error: null
85405
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
85406
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
85407
+ /** Result of the action. */
85408
+ result: {}
85409
+ }
85410
+ | {
85411
+ /** ID of the action attempt. */
85412
+ action_attempt_id: string
85413
+ status: 'error'
85414
+ /** Result of the action attempt. Null for failed action attempts. */
85415
+ result: null
85416
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
85417
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
85418
+ /** Error associated with the action. */
85419
+ error: {
85420
+ /** Type of the error. */
85421
+ type: string
85422
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
85423
+ message: string
85424
+ }
85425
+ }
84568
85426
  | {
84569
85427
  /** ID of the action attempt. */
84570
85428
  action_attempt_id: string
@@ -85078,7 +85936,7 @@ export type Routes = {
85078
85936
  | 'smartthings_thermostat'
85079
85937
  )
85080
85938
  | ('ios_phone' | 'android_phone')
85081
- | ('ring_camera' | 'tapo_camera')
85939
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
85082
85940
  /** IDs of the spaces the device is in. */
85083
85941
  space_ids: string[]
85084
85942
  /** Optional nickname to describe the device, settable through Seam. */
@@ -85886,6 +86744,24 @@ export type Routes = {
85886
86744
  | undefined
85887
86745
  )
85888
86746
  | undefined
86747
+ /** Metadata for an Arlo camera. */
86748
+ arlo_metadata?:
86749
+ | (
86750
+ | {
86751
+ /** Device ID reported by Arlo. */
86752
+ device_id?: (string | undefined) | undefined
86753
+ /** Device name reported by Arlo. */
86754
+ device_name?: (string | undefined) | undefined
86755
+ /** Model ID reported by Arlo. */
86756
+ model_id?: (string | undefined) | undefined
86757
+ /** Hardware version reported by Arlo. */
86758
+ hardware_version?: (string | undefined) | undefined
86759
+ /** Firmware version reported by Arlo. */
86760
+ firmware_version?: (string | undefined) | undefined
86761
+ }
86762
+ | undefined
86763
+ )
86764
+ | undefined
85889
86765
  /** Metadata for a Ring device. */
85890
86766
  ring_metadata?:
85891
86767
  | {
@@ -86904,6 +87780,8 @@ export type Routes = {
86904
87780
  can_hvac_heat_cool?: boolean | undefined
86905
87781
  /** Indicates whether the thermostat can be turned off. */
86906
87782
  can_turn_off_hvac?: boolean | undefined
87783
+ /** 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. */
87784
+ can_activate_weekly_program?: boolean | undefined
86907
87785
  /** Indicates whether the device supports simulating removal in a sandbox. */
86908
87786
  can_simulate_removal?: boolean | undefined
86909
87787
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -86979,7 +87857,7 @@ export type Routes = {
86979
87857
  | 'smartthings_thermostat'
86980
87858
  )
86981
87859
  | ('ios_phone' | 'android_phone')
86982
- | ('ring_camera' | 'tapo_camera')
87860
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
86983
87861
  /** IDs of the spaces the device is in. */
86984
87862
  space_ids: string[]
86985
87863
  /** Optional nickname to describe the device, settable through Seam. */
@@ -87787,6 +88665,24 @@ export type Routes = {
87787
88665
  | undefined
87788
88666
  )
87789
88667
  | undefined
88668
+ /** Metadata for an Arlo camera. */
88669
+ arlo_metadata?:
88670
+ | (
88671
+ | {
88672
+ /** Device ID reported by Arlo. */
88673
+ device_id?: (string | undefined) | undefined
88674
+ /** Device name reported by Arlo. */
88675
+ device_name?: (string | undefined) | undefined
88676
+ /** Model ID reported by Arlo. */
88677
+ model_id?: (string | undefined) | undefined
88678
+ /** Hardware version reported by Arlo. */
88679
+ hardware_version?: (string | undefined) | undefined
88680
+ /** Firmware version reported by Arlo. */
88681
+ firmware_version?: (string | undefined) | undefined
88682
+ }
88683
+ | undefined
88684
+ )
88685
+ | undefined
87790
88686
  /** Metadata for a Ring device. */
87791
88687
  ring_metadata?:
87792
88688
  | {
@@ -88805,6 +89701,8 @@ export type Routes = {
88805
89701
  can_hvac_heat_cool?: boolean | undefined
88806
89702
  /** Indicates whether the thermostat can be turned off. */
88807
89703
  can_turn_off_hvac?: boolean | undefined
89704
+ /** 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. */
89705
+ can_activate_weekly_program?: boolean | undefined
88808
89706
  /** Indicates whether the device supports simulating removal in a sandbox. */
88809
89707
  can_simulate_removal?: boolean | undefined
88810
89708
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -90519,6 +91417,44 @@ export type Routes = {
90519
91417
  message: string
90520
91418
  }
90521
91419
  }
91420
+ | {
91421
+ /** ID of the action attempt. */
91422
+ action_attempt_id: string
91423
+ status: 'pending'
91424
+ /** Result of the action attempt. Null for pending action attempts. */
91425
+ result: null
91426
+ /** Errors associated with the action attempt. Null for pending action attempts. */
91427
+ error: null
91428
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
91429
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
91430
+ }
91431
+ | {
91432
+ /** ID of the action attempt. */
91433
+ action_attempt_id: string
91434
+ status: 'success'
91435
+ /** Errors associated with the action attempt. Null for successful action attempts. */
91436
+ error: null
91437
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
91438
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
91439
+ /** Result of the action. */
91440
+ result: {}
91441
+ }
91442
+ | {
91443
+ /** ID of the action attempt. */
91444
+ action_attempt_id: string
91445
+ status: 'error'
91446
+ /** Result of the action attempt. Null for failed action attempts. */
91447
+ result: null
91448
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
91449
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
91450
+ /** Error associated with the action. */
91451
+ error: {
91452
+ /** Type of the error. */
91453
+ type: string
91454
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
91455
+ message: string
91456
+ }
91457
+ }
90522
91458
  | {
90523
91459
  /** ID of the action attempt. */
90524
91460
  action_attempt_id: string
@@ -92656,6 +93592,44 @@ export type Routes = {
92656
93592
  message: string
92657
93593
  }
92658
93594
  }
93595
+ | {
93596
+ /** ID of the action attempt. */
93597
+ action_attempt_id: string
93598
+ status: 'pending'
93599
+ /** Result of the action attempt. Null for pending action attempts. */
93600
+ result: null
93601
+ /** Errors associated with the action attempt. Null for pending action attempts. */
93602
+ error: null
93603
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
93604
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
93605
+ }
93606
+ | {
93607
+ /** ID of the action attempt. */
93608
+ action_attempt_id: string
93609
+ status: 'success'
93610
+ /** Errors associated with the action attempt. Null for successful action attempts. */
93611
+ error: null
93612
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
93613
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
93614
+ /** Result of the action. */
93615
+ result: {}
93616
+ }
93617
+ | {
93618
+ /** ID of the action attempt. */
93619
+ action_attempt_id: string
93620
+ status: 'error'
93621
+ /** Result of the action attempt. Null for failed action attempts. */
93622
+ result: null
93623
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
93624
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
93625
+ /** Error associated with the action. */
93626
+ error: {
93627
+ /** Type of the error. */
93628
+ type: string
93629
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
93630
+ message: string
93631
+ }
93632
+ }
92659
93633
  | {
92660
93634
  /** ID of the action attempt. */
92661
93635
  action_attempt_id: string
@@ -94849,6 +95823,44 @@ export type Routes = {
94849
95823
  message: string
94850
95824
  }
94851
95825
  }
95826
+ | {
95827
+ /** ID of the action attempt. */
95828
+ action_attempt_id: string
95829
+ status: 'pending'
95830
+ /** Result of the action attempt. Null for pending action attempts. */
95831
+ result: null
95832
+ /** Errors associated with the action attempt. Null for pending action attempts. */
95833
+ error: null
95834
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
95835
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
95836
+ }
95837
+ | {
95838
+ /** ID of the action attempt. */
95839
+ action_attempt_id: string
95840
+ status: 'success'
95841
+ /** Errors associated with the action attempt. Null for successful action attempts. */
95842
+ error: null
95843
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
95844
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
95845
+ /** Result of the action. */
95846
+ result: {}
95847
+ }
95848
+ | {
95849
+ /** ID of the action attempt. */
95850
+ action_attempt_id: string
95851
+ status: 'error'
95852
+ /** Result of the action attempt. Null for failed action attempts. */
95853
+ result: null
95854
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
95855
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
95856
+ /** Error associated with the action. */
95857
+ error: {
95858
+ /** Type of the error. */
95859
+ type: string
95860
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
95861
+ message: string
95862
+ }
95863
+ }
94852
95864
  | {
94853
95865
  /** ID of the action attempt. */
94854
95866
  action_attempt_id: string
@@ -98936,6 +99948,44 @@ export type Routes = {
98936
99948
  message: string
98937
99949
  }
98938
99950
  }
99951
+ | {
99952
+ /** ID of the action attempt. */
99953
+ action_attempt_id: string
99954
+ status: 'pending'
99955
+ /** Result of the action attempt. Null for pending action attempts. */
99956
+ result: null
99957
+ /** Errors associated with the action attempt. Null for pending action attempts. */
99958
+ error: null
99959
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99960
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
99961
+ }
99962
+ | {
99963
+ /** ID of the action attempt. */
99964
+ action_attempt_id: string
99965
+ status: 'success'
99966
+ /** Errors associated with the action attempt. Null for successful action attempts. */
99967
+ error: null
99968
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99969
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
99970
+ /** Result of the action. */
99971
+ result: {}
99972
+ }
99973
+ | {
99974
+ /** ID of the action attempt. */
99975
+ action_attempt_id: string
99976
+ status: 'error'
99977
+ /** Result of the action attempt. Null for failed action attempts. */
99978
+ result: null
99979
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
99980
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
99981
+ /** Error associated with the action. */
99982
+ error: {
99983
+ /** Type of the error. */
99984
+ type: string
99985
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
99986
+ message: string
99987
+ }
99988
+ }
98939
99989
  | {
98940
99990
  /** ID of the action attempt. */
98941
99991
  action_attempt_id: string
@@ -111634,7 +112684,7 @@ export type Routes = {
111634
112684
  | 'smartthings_thermostat'
111635
112685
  )
111636
112686
  | ('ios_phone' | 'android_phone')
111637
- | ('ring_camera' | 'tapo_camera')
112687
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
111638
112688
  /** IDs of the spaces the device is in. */
111639
112689
  space_ids: string[]
111640
112690
  /** Optional nickname to describe the device, settable through Seam. */
@@ -112467,6 +113517,24 @@ export type Routes = {
112467
113517
  | undefined
112468
113518
  )
112469
113519
  | undefined
113520
+ /** Metadata for an Arlo camera. */
113521
+ arlo_metadata?:
113522
+ | (
113523
+ | {
113524
+ /** Device ID reported by Arlo. */
113525
+ device_id?: (string | undefined) | undefined
113526
+ /** Device name reported by Arlo. */
113527
+ device_name?: (string | undefined) | undefined
113528
+ /** Model ID reported by Arlo. */
113529
+ model_id?: (string | undefined) | undefined
113530
+ /** Hardware version reported by Arlo. */
113531
+ hardware_version?: (string | undefined) | undefined
113532
+ /** Firmware version reported by Arlo. */
113533
+ firmware_version?: (string | undefined) | undefined
113534
+ }
113535
+ | undefined
113536
+ )
113537
+ | undefined
112470
113538
  /** Metadata for a Ring device. */
112471
113539
  ring_metadata?:
112472
113540
  | {
@@ -113511,6 +114579,8 @@ export type Routes = {
113511
114579
  can_hvac_heat_cool?: boolean | undefined
113512
114580
  /** Indicates whether the thermostat can be turned off. */
113513
114581
  can_turn_off_hvac?: boolean | undefined
114582
+ /** 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. */
114583
+ can_activate_weekly_program?: boolean | undefined
113514
114584
  /** Indicates whether the device supports simulating removal in a sandbox. */
113515
114585
  can_simulate_removal?: boolean | undefined
113516
114586
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -116290,6 +117360,2200 @@ export type Routes = {
116290
117360
  message: string
116291
117361
  }
116292
117362
  }
117363
+ | {
117364
+ /** ID of the action attempt. */
117365
+ action_attempt_id: string
117366
+ status: 'pending'
117367
+ /** Result of the action attempt. Null for pending action attempts. */
117368
+ result: null
117369
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117370
+ error: null
117371
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117372
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
117373
+ }
117374
+ | {
117375
+ /** ID of the action attempt. */
117376
+ action_attempt_id: string
117377
+ status: 'success'
117378
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117379
+ error: null
117380
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117381
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
117382
+ /** Result of the action. */
117383
+ result: {}
117384
+ }
117385
+ | {
117386
+ /** ID of the action attempt. */
117387
+ action_attempt_id: string
117388
+ status: 'error'
117389
+ /** Result of the action attempt. Null for failed action attempts. */
117390
+ result: null
117391
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
117392
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
117393
+ /** Error associated with the action. */
117394
+ error: {
117395
+ /** Type of the error. */
117396
+ type: string
117397
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117398
+ message: string
117399
+ }
117400
+ }
117401
+ | {
117402
+ /** ID of the action attempt. */
117403
+ action_attempt_id: string
117404
+ status: 'pending'
117405
+ /** Result of the action attempt. Null for pending action attempts. */
117406
+ result: null
117407
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117408
+ error: null
117409
+ /** Action attempt to track the status of simulating a keypad code entry. */
117410
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
117411
+ }
117412
+ | {
117413
+ /** ID of the action attempt. */
117414
+ action_attempt_id: string
117415
+ status: 'success'
117416
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117417
+ error: null
117418
+ /** Action attempt to track the status of simulating a keypad code entry. */
117419
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
117420
+ /** Result of the action. */
117421
+ result: {}
117422
+ }
117423
+ | {
117424
+ /** ID of the action attempt. */
117425
+ action_attempt_id: string
117426
+ status: 'error'
117427
+ /** Result of the action attempt. Null for failed action attempts. */
117428
+ result: null
117429
+ /** Action attempt to track the status of simulating a keypad code entry. */
117430
+ action_type: 'SIMULATE_KEYPAD_CODE_ENTRY'
117431
+ /** Error associated with the action. */
117432
+ error: {
117433
+ /** Type of the error. */
117434
+ type: string
117435
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117436
+ message: string
117437
+ }
117438
+ }
117439
+ | {
117440
+ /** ID of the action attempt. */
117441
+ action_attempt_id: string
117442
+ status: 'pending'
117443
+ /** Result of the action attempt. Null for pending action attempts. */
117444
+ result: null
117445
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117446
+ error: null
117447
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
117448
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
117449
+ }
117450
+ | {
117451
+ /** ID of the action attempt. */
117452
+ action_attempt_id: string
117453
+ status: 'success'
117454
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117455
+ error: null
117456
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
117457
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
117458
+ /** Result of the action. */
117459
+ result: {}
117460
+ }
117461
+ | {
117462
+ /** ID of the action attempt. */
117463
+ action_attempt_id: string
117464
+ status: 'error'
117465
+ /** Result of the action attempt. Null for failed action attempts. */
117466
+ result: null
117467
+ /** Action attempt to track the status of simulating a manual lock action using a keypad. */
117468
+ action_type: 'SIMULATE_MANUAL_LOCK_VIA_KEYPAD'
117469
+ /** Error associated with the action. */
117470
+ error: {
117471
+ /** Type of the error. */
117472
+ type: string
117473
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117474
+ message: string
117475
+ }
117476
+ }
117477
+ | {
117478
+ /** ID of the action attempt. */
117479
+ action_attempt_id: string
117480
+ status: 'pending'
117481
+ /** Result of the action attempt. Null for pending action attempts. */
117482
+ result: null
117483
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117484
+ error: null
117485
+ /** Action attempt to track the status of pushing thermostat programs. */
117486
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
117487
+ }
117488
+ | {
117489
+ /** ID of the action attempt. */
117490
+ action_attempt_id: string
117491
+ status: 'success'
117492
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117493
+ error: null
117494
+ /** Action attempt to track the status of pushing thermostat programs. */
117495
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
117496
+ /** Result of the action. */
117497
+ result: {}
117498
+ }
117499
+ | {
117500
+ /** ID of the action attempt. */
117501
+ action_attempt_id: string
117502
+ status: 'error'
117503
+ /** Result of the action attempt. Null for failed action attempts. */
117504
+ result: null
117505
+ /** Action attempt to track the status of pushing thermostat programs. */
117506
+ action_type: 'PUSH_THERMOSTAT_PROGRAMS'
117507
+ /** Error associated with the action. */
117508
+ error: {
117509
+ /** Type of the error. */
117510
+ type: string
117511
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117512
+ message: string
117513
+ }
117514
+ }
117515
+ | {
117516
+ /** ID of the action attempt. */
117517
+ action_attempt_id: string
117518
+ status: 'pending'
117519
+ /** Result of the action attempt. Null for pending action attempts. */
117520
+ result: null
117521
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117522
+ error: null
117523
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
117524
+ action_type: 'CONFIGURE_AUTO_LOCK'
117525
+ }
117526
+ | {
117527
+ /** ID of the action attempt. */
117528
+ action_attempt_id: string
117529
+ status: 'success'
117530
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117531
+ error: null
117532
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
117533
+ action_type: 'CONFIGURE_AUTO_LOCK'
117534
+ /** Result of the action. */
117535
+ result: {}
117536
+ }
117537
+ | {
117538
+ /** ID of the action attempt. */
117539
+ action_attempt_id: string
117540
+ status: 'error'
117541
+ /** Result of the action attempt. Null for failed action attempts. */
117542
+ result: null
117543
+ /** Action attempt to track the status of configuring the auto-lock on a lock. */
117544
+ action_type: 'CONFIGURE_AUTO_LOCK'
117545
+ /** Error associated with the action. */
117546
+ error: {
117547
+ /** Type of the error. */
117548
+ type: string
117549
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117550
+ message: string
117551
+ }
117552
+ }
117553
+ | {
117554
+ /** ID of the action attempt. */
117555
+ action_attempt_id: string
117556
+ status: 'pending'
117557
+ /** Result of the action attempt. Null for pending action attempts. */
117558
+ result: null
117559
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117560
+ error: null
117561
+ /** Syncing access codes is pending. */
117562
+ action_type: 'SYNC_ACCESS_CODES'
117563
+ }
117564
+ | {
117565
+ /** ID of the action attempt. */
117566
+ action_attempt_id: string
117567
+ status: 'success'
117568
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117569
+ error: null
117570
+ /** Syncing access codes succeeded. */
117571
+ action_type: 'SYNC_ACCESS_CODES'
117572
+ /** Result of the action. */
117573
+ result: {}
117574
+ }
117575
+ | {
117576
+ /** ID of the action attempt. */
117577
+ action_attempt_id: string
117578
+ status: 'error'
117579
+ /** Result of the action attempt. Null for failed action attempts. */
117580
+ result: null
117581
+ /** Syncing access codes failed. */
117582
+ action_type: 'SYNC_ACCESS_CODES'
117583
+ /** Error associated with the action. */
117584
+ error: {
117585
+ /** Type of the error. */
117586
+ type: string
117587
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117588
+ message: string
117589
+ }
117590
+ }
117591
+ | {
117592
+ /** ID of the action attempt. */
117593
+ action_attempt_id: string
117594
+ status: 'pending'
117595
+ /** Result of the action attempt. Null for pending action attempts. */
117596
+ result: null
117597
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117598
+ error: null
117599
+ /** Creating an access code is pending. */
117600
+ action_type: 'CREATE_ACCESS_CODE'
117601
+ }
117602
+ | {
117603
+ /** ID of the action attempt. */
117604
+ action_attempt_id: string
117605
+ status: 'success'
117606
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117607
+ error: null
117608
+ /** Creating an access code succeeded. */
117609
+ action_type: 'CREATE_ACCESS_CODE'
117610
+ /** Result of the action. */
117611
+ result: {
117612
+ /** Created access code. */
117613
+ access_code: {
117614
+ [x: string]: any
117615
+ }
117616
+ }
117617
+ }
117618
+ | {
117619
+ /** ID of the action attempt. */
117620
+ action_attempt_id: string
117621
+ status: 'error'
117622
+ /** Result of the action attempt. Null for failed action attempts. */
117623
+ result: null
117624
+ /** Creating an access code failed. */
117625
+ action_type: 'CREATE_ACCESS_CODE'
117626
+ /** Error associated with the action. */
117627
+ error: {
117628
+ /** Type of the error. */
117629
+ type: string
117630
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117631
+ message: string
117632
+ }
117633
+ }
117634
+ | {
117635
+ /** ID of the action attempt. */
117636
+ action_attempt_id: string
117637
+ status: 'pending'
117638
+ /** Result of the action attempt. Null for pending action attempts. */
117639
+ result: null
117640
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117641
+ error: null
117642
+ /** Deleting an access code is pending. */
117643
+ action_type: 'DELETE_ACCESS_CODE'
117644
+ }
117645
+ | {
117646
+ /** ID of the action attempt. */
117647
+ action_attempt_id: string
117648
+ status: 'success'
117649
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117650
+ error: null
117651
+ /** Deleting an access code succeeded. */
117652
+ action_type: 'DELETE_ACCESS_CODE'
117653
+ /** Result of the action. */
117654
+ result: {}
117655
+ }
117656
+ | {
117657
+ /** ID of the action attempt. */
117658
+ action_attempt_id: string
117659
+ status: 'error'
117660
+ /** Result of the action attempt. Null for failed action attempts. */
117661
+ result: null
117662
+ /** Deleting an access code failed. */
117663
+ action_type: 'DELETE_ACCESS_CODE'
117664
+ /** Error associated with the action. */
117665
+ error: {
117666
+ /** Type of the error. */
117667
+ type: string
117668
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117669
+ message: string
117670
+ }
117671
+ }
117672
+ | {
117673
+ /** ID of the action attempt. */
117674
+ action_attempt_id: string
117675
+ status: 'pending'
117676
+ /** Result of the action attempt. Null for pending action attempts. */
117677
+ result: null
117678
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117679
+ error: null
117680
+ /** Updating an access code is pending. */
117681
+ action_type: 'UPDATE_ACCESS_CODE'
117682
+ }
117683
+ | {
117684
+ /** ID of the action attempt. */
117685
+ action_attempt_id: string
117686
+ status: 'success'
117687
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117688
+ error: null
117689
+ /** Updating an access code succeeded. */
117690
+ action_type: 'UPDATE_ACCESS_CODE'
117691
+ /** Result of the action. */
117692
+ result: {
117693
+ /** Updated access code. */
117694
+ access_code?:
117695
+ | {
117696
+ [x: string]: any
117697
+ }
117698
+ | undefined
117699
+ }
117700
+ }
117701
+ | {
117702
+ /** ID of the action attempt. */
117703
+ action_attempt_id: string
117704
+ status: 'error'
117705
+ /** Result of the action attempt. Null for failed action attempts. */
117706
+ result: null
117707
+ /** Updating an access code failed. */
117708
+ action_type: 'UPDATE_ACCESS_CODE'
117709
+ /** Error associated with the action. */
117710
+ error: {
117711
+ /** Type of the error. */
117712
+ type: string
117713
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117714
+ message: string
117715
+ }
117716
+ }
117717
+ | {
117718
+ /** ID of the action attempt. */
117719
+ action_attempt_id: string
117720
+ status: 'pending'
117721
+ /** Result of the action attempt. Null for pending action attempts. */
117722
+ result: null
117723
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117724
+ error: null
117725
+ /** Creating a noise threshold is pending. */
117726
+ action_type: 'CREATE_NOISE_THRESHOLD'
117727
+ }
117728
+ | {
117729
+ /** ID of the action attempt. */
117730
+ action_attempt_id: string
117731
+ status: 'success'
117732
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117733
+ error: null
117734
+ /** Creating a noise threshold succeeded. */
117735
+ action_type: 'CREATE_NOISE_THRESHOLD'
117736
+ /** Result of the action. */
117737
+ result: {
117738
+ /** Created noise threshold. */
117739
+ noise_threshold: {
117740
+ [x: string]: any
117741
+ }
117742
+ }
117743
+ }
117744
+ | {
117745
+ /** ID of the action attempt. */
117746
+ action_attempt_id: string
117747
+ status: 'error'
117748
+ /** Result of the action attempt. Null for failed action attempts. */
117749
+ result: null
117750
+ /** Creating a noise threshold failed. */
117751
+ action_type: 'CREATE_NOISE_THRESHOLD'
117752
+ /** Error associated with the action. */
117753
+ error: {
117754
+ /** Type of the error. */
117755
+ type: string
117756
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117757
+ message: string
117758
+ }
117759
+ }
117760
+ | {
117761
+ /** ID of the action attempt. */
117762
+ action_attempt_id: string
117763
+ status: 'pending'
117764
+ /** Result of the action attempt. Null for pending action attempts. */
117765
+ result: null
117766
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117767
+ error: null
117768
+ /** Deleting a noise threshold is pending. */
117769
+ action_type: 'DELETE_NOISE_THRESHOLD'
117770
+ }
117771
+ | {
117772
+ /** ID of the action attempt. */
117773
+ action_attempt_id: string
117774
+ status: 'success'
117775
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117776
+ error: null
117777
+ /** Deleting a noise threshold succeeded. */
117778
+ action_type: 'DELETE_NOISE_THRESHOLD'
117779
+ /** Result of the action. */
117780
+ result: {}
117781
+ }
117782
+ | {
117783
+ /** ID of the action attempt. */
117784
+ action_attempt_id: string
117785
+ status: 'error'
117786
+ /** Result of the action attempt. Null for failed action attempts. */
117787
+ result: null
117788
+ /** Deleting a noise threshold failed. */
117789
+ action_type: 'DELETE_NOISE_THRESHOLD'
117790
+ /** Error associated with the action. */
117791
+ error: {
117792
+ /** Type of the error. */
117793
+ type: string
117794
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117795
+ message: string
117796
+ }
117797
+ }
117798
+ | {
117799
+ /** ID of the action attempt. */
117800
+ action_attempt_id: string
117801
+ status: 'pending'
117802
+ /** Result of the action attempt. Null for pending action attempts. */
117803
+ result: null
117804
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117805
+ error: null
117806
+ /** Updating a noise threshold is pending. */
117807
+ action_type: 'UPDATE_NOISE_THRESHOLD'
117808
+ }
117809
+ | {
117810
+ /** ID of the action attempt. */
117811
+ action_attempt_id: string
117812
+ status: 'success'
117813
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117814
+ error: null
117815
+ /** Updating a noise threshold succeeded. */
117816
+ action_type: 'UPDATE_NOISE_THRESHOLD'
117817
+ /** Result of the action. */
117818
+ result: {
117819
+ /** Updated noise threshold. */
117820
+ noise_threshold: {
117821
+ [x: string]: any
117822
+ }
117823
+ }
117824
+ }
117825
+ | {
117826
+ /** ID of the action attempt. */
117827
+ action_attempt_id: string
117828
+ status: 'error'
117829
+ /** Result of the action attempt. Null for failed action attempts. */
117830
+ result: null
117831
+ /** Updating a noise threshold failed. */
117832
+ action_type: 'UPDATE_NOISE_THRESHOLD'
117833
+ /** Error associated with the action. */
117834
+ error: {
117835
+ /** Type of the error. */
117836
+ type: string
117837
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117838
+ message: string
117839
+ }
117840
+ }
117841
+ }
117842
+ maxDuration: undefined
117843
+ }
117844
+ '/thermostats/activate_weekly_program': {
117845
+ route: '/thermostats/activate_weekly_program'
117846
+ method: 'POST'
117847
+ queryParams: {}
117848
+ jsonBody: {
117849
+ /** ID of the thermostat device that you want to return to its weekly program. */
117850
+ device_id: string
117851
+ /** */
117852
+ sync?: boolean
117853
+ }
117854
+ commonParams: {}
117855
+ formData: {}
117856
+ jsonResponse: {
117857
+ /** 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.
117858
+
117859
+ 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.
117860
+
117861
+ See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts). */
117862
+ action_attempt:
117863
+ | {
117864
+ /** ID of the action attempt. */
117865
+ action_attempt_id: string
117866
+ status: 'pending'
117867
+ /** Result of the action attempt. Null for pending action attempts. */
117868
+ result: null
117869
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117870
+ error: null
117871
+ /** Action attempt to track the status of locking a door. */
117872
+ action_type: 'LOCK_DOOR'
117873
+ }
117874
+ | {
117875
+ /** ID of the action attempt. */
117876
+ action_attempt_id: string
117877
+ status: 'success'
117878
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117879
+ error: null
117880
+ /** Action attempt to track the status of locking a door. */
117881
+ action_type: 'LOCK_DOOR'
117882
+ /** Result of the action. */
117883
+ result: {
117884
+ /** Indicates whether the device confirmed that the lock action occurred. */
117885
+ was_confirmed_by_device?: boolean | undefined
117886
+ }
117887
+ }
117888
+ | {
117889
+ /** ID of the action attempt. */
117890
+ action_attempt_id: string
117891
+ status: 'error'
117892
+ /** Result of the action attempt. Null for failed action attempts. */
117893
+ result: null
117894
+ /** Action attempt to track the status of locking a door. */
117895
+ action_type: 'LOCK_DOOR'
117896
+ /** Error associated with the action. */
117897
+ error: {
117898
+ /** Type of the error. */
117899
+ type: string
117900
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117901
+ message: string
117902
+ }
117903
+ }
117904
+ | {
117905
+ /** ID of the action attempt. */
117906
+ action_attempt_id: string
117907
+ status: 'pending'
117908
+ /** Result of the action attempt. Null for pending action attempts. */
117909
+ result: null
117910
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117911
+ error: null
117912
+ /** Action attempt to track the status of unlocking a door. */
117913
+ action_type: 'UNLOCK_DOOR'
117914
+ }
117915
+ | {
117916
+ /** ID of the action attempt. */
117917
+ action_attempt_id: string
117918
+ status: 'success'
117919
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117920
+ error: null
117921
+ /** Action attempt to track the status of unlocking a door. */
117922
+ action_type: 'UNLOCK_DOOR'
117923
+ /** Result of the action. */
117924
+ result: {
117925
+ /** Indicates whether the device confirmed that the unlock action occurred. */
117926
+ was_confirmed_by_device?: boolean | undefined
117927
+ }
117928
+ }
117929
+ | {
117930
+ /** ID of the action attempt. */
117931
+ action_attempt_id: string
117932
+ status: 'error'
117933
+ /** Result of the action attempt. Null for failed action attempts. */
117934
+ result: null
117935
+ /** Action attempt to track the status of unlocking a door. */
117936
+ action_type: 'UNLOCK_DOOR'
117937
+ /** Error associated with the action. */
117938
+ error: {
117939
+ /** Type of the error. */
117940
+ type: string
117941
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
117942
+ message: string
117943
+ }
117944
+ }
117945
+ | {
117946
+ /** ID of the action attempt. */
117947
+ action_attempt_id: string
117948
+ status: 'pending'
117949
+ /** Result of the action attempt. Null for pending action attempts. */
117950
+ result: null
117951
+ /** Errors associated with the action attempt. Null for pending action attempts. */
117952
+ error: null
117953
+ /** Action attempt to track the status of scanning a credential. */
117954
+ action_type: 'SCAN_CREDENTIAL'
117955
+ }
117956
+ | {
117957
+ /** ID of the action attempt. */
117958
+ action_attempt_id: string
117959
+ status: 'success'
117960
+ /** Errors associated with the action attempt. Null for successful action attempts. */
117961
+ error: null
117962
+ /** Action attempt to track the status of scanning a credential. */
117963
+ action_type: 'SCAN_CREDENTIAL'
117964
+ /** 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. */
117965
+ result: {
117966
+ /** Snapshot of credential data read from the physical encoder. */
117967
+ acs_credential_on_encoder: {
117968
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
117969
+ created_at: string | null
117970
+ /** Indicates whether the credential has been issued (encoded onto a card). */
117971
+ is_issued: boolean | null
117972
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */
117973
+ starts_at: string | null
117974
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */
117975
+ ends_at: string | null
117976
+ /** 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). */
117977
+ card_number: string | null
117978
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
117979
+ visionline_metadata?:
117980
+ | {
117981
+ /** Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
117982
+ card_id?: (string | undefined) | undefined
117983
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */
117984
+ cancelled?: (boolean | undefined) | undefined
117985
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded. */
117986
+ discarded?: (boolean | undefined) | undefined
117987
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */
117988
+ expired?: (boolean | undefined) | undefined
117989
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */
117990
+ overwritten?: (boolean | undefined) | undefined
117991
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */
117992
+ overridden?: (boolean | undefined) | undefined
117993
+ /** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */
117994
+ pending_auto_update?: (boolean | undefined) | undefined
117995
+ /** Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
117996
+ card_format?:
117997
+ (('TLCode' | 'rfid48') | undefined) | undefined
117998
+ /** Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
117999
+ card_holder?: (string | undefined) | undefined
118000
+ /** Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118001
+ number_of_issued_cards?: (number | undefined) | undefined
118002
+ /** 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). */
118003
+ guest_acs_entrance_ids?:
118004
+ (string[] | undefined) | undefined
118005
+ /** 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). */
118006
+ common_acs_entrance_ids?:
118007
+ (string[] | undefined) | undefined
118008
+ }
118009
+ | undefined
118010
+ } | null
118011
+ /** Corresponding credential data as stored on Seam and the access system. */
118012
+ acs_credential_on_seam:
118013
+ | (
118014
+ | {
118015
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118016
+ acs_credential_id: string
118017
+ /** 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. */
118018
+ acs_user_id?: string | undefined
118019
+ /** 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. */
118020
+ user_identity_id?: string | undefined
118021
+ /** 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. */
118022
+ connected_account_id: string
118023
+ /** ID of the credential pool to which the credential belongs. */
118024
+ acs_credential_pool_id?: string | undefined
118025
+ /** 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). */
118026
+ acs_system_id: string
118027
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118028
+ parent_acs_credential_id?: string | undefined
118029
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
118030
+ display_name: string
118031
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118032
+ code?: (string | undefined) | null
118033
+ /** 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. */
118034
+ is_one_time_use?: boolean | undefined
118035
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118036
+ card_number?: (string | undefined) | null
118037
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
118038
+ is_issued?: boolean | undefined
118039
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
118040
+ issued_at?: (string | undefined) | null
118041
+ /** 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`. */
118042
+ access_method:
118043
+ 'code' | 'card' | 'mobile_key' | 'cloud_key'
118044
+ /** 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`. */
118045
+ external_type?:
118046
+ | (
118047
+ | 'pti_card'
118048
+ | 'brivo_credential'
118049
+ | 'hid_credential'
118050
+ | 'visionline_card'
118051
+ | 'salto_ks_credential'
118052
+ | 'assa_abloy_vostio_key'
118053
+ | 'salto_space_key'
118054
+ | 'latch_access'
118055
+ | 'dormakaba_ambiance_credential'
118056
+ | 'hotek_card'
118057
+ | 'salto_ks_tag'
118058
+ | 'avigilon_alta_credential'
118059
+ | 'kisi_credential'
118060
+ | 'akiles_credential'
118061
+ )
118062
+ | undefined
118063
+ /** 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. */
118064
+ external_type_display_name?: string | undefined
118065
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
118066
+ created_at: string
118067
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118068
+ workspace_id: string
118069
+ /** 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. */
118070
+ starts_at?: string | undefined
118071
+ /** 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`. */
118072
+ ends_at?: string | undefined
118073
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118074
+ errors: {
118075
+ error_code: string
118076
+ message: string
118077
+ /** Date and time at which Seam created the error. */
118078
+ created_at: string
118079
+ }[]
118080
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118081
+ warnings: (
118082
+ | {
118083
+ /** Date and time at which Seam created the warning. */
118084
+ created_at: string
118085
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118086
+ message: string
118087
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118088
+ warning_code: 'waiting_to_be_issued'
118089
+ }
118090
+ | {
118091
+ /** Date and time at which Seam created the warning. */
118092
+ created_at: string
118093
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118094
+ message: string
118095
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118096
+ warning_code: 'schedule_externally_modified'
118097
+ }
118098
+ | {
118099
+ /** Date and time at which Seam created the warning. */
118100
+ created_at: string
118101
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118102
+ message: string
118103
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118104
+ warning_code: 'schedule_modified'
118105
+ }
118106
+ | {
118107
+ /** Date and time at which Seam created the warning. */
118108
+ created_at: string
118109
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118110
+ message: string
118111
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118112
+ warning_code: 'being_deleted'
118113
+ }
118114
+ | {
118115
+ /** Date and time at which Seam created the warning. */
118116
+ created_at: string
118117
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118118
+ message: string
118119
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118120
+ warning_code: 'unknown_issue_with_acs_credential'
118121
+ }
118122
+ | {
118123
+ /** Date and time at which Seam created the warning. */
118124
+ created_at: string
118125
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118126
+ message: string
118127
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118128
+ warning_code: 'needs_to_be_reissued'
118129
+ }
118130
+ | {
118131
+ /** Date and time at which Seam created the warning. */
118132
+ created_at: string
118133
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118134
+ message: string
118135
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118136
+ warning_code: 'requested_code_unavailable'
118137
+ /** The originally requested PIN code that could not be used. */
118138
+ original_code: string
118139
+ /** The PIN code that was assigned instead. */
118140
+ new_code: string
118141
+ }
118142
+ )[]
118143
+ /** 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). */
118144
+ is_multi_phone_sync_credential?: boolean | undefined
118145
+ /** 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. */
118146
+ is_latest_desired_state_synced_with_provider?:
118147
+ (boolean | null) | undefined
118148
+ /** 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. */
118149
+ latest_desired_state_synced_with_provider_at?:
118150
+ (string | null) | undefined
118151
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118152
+ visionline_metadata?:
118153
+ | {
118154
+ /** Card function type in the Visionline access system. */
118155
+ card_function_type?:
118156
+ (('guest' | 'staff') | undefined) | undefined
118157
+ /** IDs of the credentials to which you want to join. */
118158
+ joiner_acs_credential_ids?:
118159
+ (string[] | undefined) | undefined
118160
+ /** Guest entrance IDs in the Visionline access system. */
118161
+ guest_acs_entrance_ids?:
118162
+ (string[] | undefined) | undefined
118163
+ /** Common entrance IDs in the Visionline access system. */
118164
+ common_acs_entrance_ids?:
118165
+ (string[] | undefined) | undefined
118166
+ /** Indicates whether the credential is valid. */
118167
+ is_valid?: (boolean | undefined) | undefined
118168
+ /** 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. */
118169
+ auto_join?: (boolean | undefined) | undefined
118170
+ /** ID of the card in the Visionline access system. */
118171
+ card_id?: (string | undefined) | undefined
118172
+ /** ID of the credential in the Visionline access system. */
118173
+ credential_id?: (string | undefined) | undefined
118174
+ }
118175
+ | undefined
118176
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118177
+ assa_abloy_vostio_metadata?:
118178
+ | {
118179
+ /** 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. */
118180
+ auto_join?: (boolean | undefined) | undefined
118181
+ /** IDs of the guest entrances to override in the Vostio access system. */
118182
+ override_guest_acs_entrance_ids?:
118183
+ (string[] | undefined) | undefined
118184
+ /** Key ID in the Vostio access system. */
118185
+ key_id?: (string | undefined) | undefined
118186
+ /** Key issuing request ID in the Vostio access system. */
118187
+ key_issuing_request_id?:
118188
+ (string | undefined) | undefined
118189
+ /** Names of the doors to which to grant access in the Vostio access system. */
118190
+ door_names?: (string[] | undefined) | undefined
118191
+ /** Endpoint ID in the Vostio access system. */
118192
+ endpoint_id?: (string | undefined) | undefined
118193
+ }
118194
+ | undefined
118195
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118196
+ akiles_metadata?:
118197
+ | {
118198
+ /** ID of the Akiles member PIN. */
118199
+ member_pin_id?: (string | undefined) | undefined
118200
+ }
118201
+ | undefined
118202
+ /** Indicates whether Seam manages the credential. */
118203
+ is_managed: true
118204
+ }
118205
+ | {
118206
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118207
+ acs_credential_id: string
118208
+ /** 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. */
118209
+ acs_user_id?: string | undefined
118210
+ /** 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. */
118211
+ user_identity_id?: string | undefined
118212
+ /** 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. */
118213
+ connected_account_id: string
118214
+ /** ID of the credential pool to which the credential belongs. */
118215
+ acs_credential_pool_id?: string | undefined
118216
+ /** 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). */
118217
+ acs_system_id: string
118218
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118219
+ parent_acs_credential_id?: string | undefined
118220
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
118221
+ display_name: string
118222
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118223
+ code?: (string | undefined) | null
118224
+ /** 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. */
118225
+ is_one_time_use?: boolean | undefined
118226
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118227
+ card_number?: (string | undefined) | null
118228
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
118229
+ is_issued?: boolean | undefined
118230
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
118231
+ issued_at?: (string | undefined) | null
118232
+ /** 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`. */
118233
+ access_method:
118234
+ 'code' | 'card' | 'mobile_key' | 'cloud_key'
118235
+ /** 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`. */
118236
+ external_type?:
118237
+ | (
118238
+ | 'pti_card'
118239
+ | 'brivo_credential'
118240
+ | 'hid_credential'
118241
+ | 'visionline_card'
118242
+ | 'salto_ks_credential'
118243
+ | 'assa_abloy_vostio_key'
118244
+ | 'salto_space_key'
118245
+ | 'latch_access'
118246
+ | 'dormakaba_ambiance_credential'
118247
+ | 'hotek_card'
118248
+ | 'salto_ks_tag'
118249
+ | 'avigilon_alta_credential'
118250
+ | 'kisi_credential'
118251
+ | 'akiles_credential'
118252
+ )
118253
+ | undefined
118254
+ /** 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. */
118255
+ external_type_display_name?: string | undefined
118256
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
118257
+ created_at: string
118258
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118259
+ workspace_id: string
118260
+ /** 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. */
118261
+ starts_at?: string | undefined
118262
+ /** 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`. */
118263
+ ends_at?: string | undefined
118264
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118265
+ errors: {
118266
+ error_code: string
118267
+ message: string
118268
+ /** Date and time at which Seam created the error. */
118269
+ created_at: string
118270
+ }[]
118271
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118272
+ warnings: (
118273
+ | {
118274
+ /** Date and time at which Seam created the warning. */
118275
+ created_at: string
118276
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118277
+ message: string
118278
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118279
+ warning_code: 'waiting_to_be_issued'
118280
+ }
118281
+ | {
118282
+ /** Date and time at which Seam created the warning. */
118283
+ created_at: string
118284
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118285
+ message: string
118286
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118287
+ warning_code: 'schedule_externally_modified'
118288
+ }
118289
+ | {
118290
+ /** Date and time at which Seam created the warning. */
118291
+ created_at: string
118292
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118293
+ message: string
118294
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118295
+ warning_code: 'schedule_modified'
118296
+ }
118297
+ | {
118298
+ /** Date and time at which Seam created the warning. */
118299
+ created_at: string
118300
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118301
+ message: string
118302
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118303
+ warning_code: 'being_deleted'
118304
+ }
118305
+ | {
118306
+ /** Date and time at which Seam created the warning. */
118307
+ created_at: string
118308
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118309
+ message: string
118310
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118311
+ warning_code: 'unknown_issue_with_acs_credential'
118312
+ }
118313
+ | {
118314
+ /** Date and time at which Seam created the warning. */
118315
+ created_at: string
118316
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118317
+ message: string
118318
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118319
+ warning_code: 'needs_to_be_reissued'
118320
+ }
118321
+ | {
118322
+ /** Date and time at which Seam created the warning. */
118323
+ created_at: string
118324
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118325
+ message: string
118326
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118327
+ warning_code: 'requested_code_unavailable'
118328
+ /** The originally requested PIN code that could not be used. */
118329
+ original_code: string
118330
+ /** The PIN code that was assigned instead. */
118331
+ new_code: string
118332
+ }
118333
+ )[]
118334
+ /** 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). */
118335
+ is_multi_phone_sync_credential?: boolean | undefined
118336
+ /** 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. */
118337
+ is_latest_desired_state_synced_with_provider?:
118338
+ (boolean | null) | undefined
118339
+ /** 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. */
118340
+ latest_desired_state_synced_with_provider_at?:
118341
+ (string | null) | undefined
118342
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118343
+ visionline_metadata?:
118344
+ | {
118345
+ /** Card function type in the Visionline access system. */
118346
+ card_function_type?:
118347
+ (('guest' | 'staff') | undefined) | undefined
118348
+ /** IDs of the credentials to which you want to join. */
118349
+ joiner_acs_credential_ids?:
118350
+ (string[] | undefined) | undefined
118351
+ /** Guest entrance IDs in the Visionline access system. */
118352
+ guest_acs_entrance_ids?:
118353
+ (string[] | undefined) | undefined
118354
+ /** Common entrance IDs in the Visionline access system. */
118355
+ common_acs_entrance_ids?:
118356
+ (string[] | undefined) | undefined
118357
+ /** Indicates whether the credential is valid. */
118358
+ is_valid?: (boolean | undefined) | undefined
118359
+ /** 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. */
118360
+ auto_join?: (boolean | undefined) | undefined
118361
+ /** ID of the card in the Visionline access system. */
118362
+ card_id?: (string | undefined) | undefined
118363
+ /** ID of the credential in the Visionline access system. */
118364
+ credential_id?: (string | undefined) | undefined
118365
+ }
118366
+ | undefined
118367
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118368
+ assa_abloy_vostio_metadata?:
118369
+ | {
118370
+ /** 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. */
118371
+ auto_join?: (boolean | undefined) | undefined
118372
+ /** IDs of the guest entrances to override in the Vostio access system. */
118373
+ override_guest_acs_entrance_ids?:
118374
+ (string[] | undefined) | undefined
118375
+ /** Key ID in the Vostio access system. */
118376
+ key_id?: (string | undefined) | undefined
118377
+ /** Key issuing request ID in the Vostio access system. */
118378
+ key_issuing_request_id?:
118379
+ (string | undefined) | undefined
118380
+ /** Names of the doors to which to grant access in the Vostio access system. */
118381
+ door_names?: (string[] | undefined) | undefined
118382
+ /** Endpoint ID in the Vostio access system. */
118383
+ endpoint_id?: (string | undefined) | undefined
118384
+ }
118385
+ | undefined
118386
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118387
+ akiles_metadata?:
118388
+ | {
118389
+ /** ID of the Akiles member PIN. */
118390
+ member_pin_id?: (string | undefined) | undefined
118391
+ }
118392
+ | undefined
118393
+ is_managed: false
118394
+ }
118395
+ )
118396
+ | null
118397
+ /** 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. */
118398
+ warnings: {
118399
+ /** Indicates a warning related to scanning a credential. */
118400
+ warning_code:
118401
+ | 'acs_credential_on_encoder_out_of_sync'
118402
+ | 'acs_credential_on_seam_not_found'
118403
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118404
+ warning_message: string
118405
+ }[]
118406
+ }
118407
+ }
118408
+ | {
118409
+ /** ID of the action attempt. */
118410
+ action_attempt_id: string
118411
+ status: 'error'
118412
+ /** Result of the action attempt. Null for failed action attempts. */
118413
+ result: null
118414
+ /** Action attempt to track the status of scanning a credential. */
118415
+ action_type: 'SCAN_CREDENTIAL'
118416
+ error:
118417
+ | {
118418
+ /** Type of the error associated with the action attempt. */
118419
+ type: 'uncategorized_error'
118420
+ /** Message for the error associated with the action attempt. */
118421
+ message: string
118422
+ }
118423
+ | {
118424
+ /** Type of the error associated with the action attempt. */
118425
+ type: 'action_attempt_expired'
118426
+ /** Message for the error associated with the action attempt. */
118427
+ message: string
118428
+ }
118429
+ | {
118430
+ /** Error type to indicate that there is no credential on the encoder. */
118431
+ type: 'no_credential_on_encoder'
118432
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118433
+ message: string
118434
+ }
118435
+ | {
118436
+ /** Error type to indicate that the encoder is not online. */
118437
+ type: 'encoder_not_online'
118438
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118439
+ message: string
118440
+ }
118441
+ | {
118442
+ /** Error type to indicate that communication with the encoder timed out. */
118443
+ type: 'encoder_communication_timeout'
118444
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118445
+ message: string
118446
+ }
118447
+ | {
118448
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
118449
+ type: 'bridge_disconnected'
118450
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118451
+ message: string
118452
+ }
118453
+ }
118454
+ | {
118455
+ /** ID of the action attempt. */
118456
+ action_attempt_id: string
118457
+ status: 'pending'
118458
+ /** Result of the action attempt. Null for pending action attempts. */
118459
+ result: null
118460
+ /** Errors associated with the action attempt. Null for pending action attempts. */
118461
+ error: null
118462
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
118463
+ action_type: 'ENCODE_CREDENTIAL'
118464
+ }
118465
+ | {
118466
+ /** ID of the action attempt. */
118467
+ action_attempt_id: string
118468
+ status: 'success'
118469
+ /** Errors associated with the action attempt. Null for successful action attempts. */
118470
+ error: null
118471
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
118472
+ action_type: 'ENCODE_CREDENTIAL'
118473
+ /** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
118474
+ result:
118475
+ | {
118476
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118477
+ acs_credential_id: string
118478
+ /** 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. */
118479
+ acs_user_id?: string | undefined
118480
+ /** 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. */
118481
+ user_identity_id?: string | undefined
118482
+ /** 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. */
118483
+ connected_account_id: string
118484
+ /** ID of the credential pool to which the credential belongs. */
118485
+ acs_credential_pool_id?: string | undefined
118486
+ /** 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). */
118487
+ acs_system_id: string
118488
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118489
+ parent_acs_credential_id?: string | undefined
118490
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
118491
+ display_name: string
118492
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118493
+ code?: (string | undefined) | null
118494
+ /** 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. */
118495
+ is_one_time_use?: boolean | undefined
118496
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118497
+ card_number?: (string | undefined) | null
118498
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
118499
+ is_issued?: boolean | undefined
118500
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
118501
+ issued_at?: (string | undefined) | null
118502
+ /** 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`. */
118503
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
118504
+ /** 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`. */
118505
+ external_type?:
118506
+ | (
118507
+ | 'pti_card'
118508
+ | 'brivo_credential'
118509
+ | 'hid_credential'
118510
+ | 'visionline_card'
118511
+ | 'salto_ks_credential'
118512
+ | 'assa_abloy_vostio_key'
118513
+ | 'salto_space_key'
118514
+ | 'latch_access'
118515
+ | 'dormakaba_ambiance_credential'
118516
+ | 'hotek_card'
118517
+ | 'salto_ks_tag'
118518
+ | 'avigilon_alta_credential'
118519
+ | 'kisi_credential'
118520
+ | 'akiles_credential'
118521
+ )
118522
+ | undefined
118523
+ /** 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. */
118524
+ external_type_display_name?: string | undefined
118525
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
118526
+ created_at: string
118527
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118528
+ workspace_id: string
118529
+ /** 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. */
118530
+ starts_at?: string | undefined
118531
+ /** 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`. */
118532
+ ends_at?: string | undefined
118533
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118534
+ errors: {
118535
+ error_code: string
118536
+ message: string
118537
+ /** Date and time at which Seam created the error. */
118538
+ created_at: string
118539
+ }[]
118540
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118541
+ warnings: (
118542
+ | {
118543
+ /** Date and time at which Seam created the warning. */
118544
+ created_at: string
118545
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118546
+ message: string
118547
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118548
+ warning_code: 'waiting_to_be_issued'
118549
+ }
118550
+ | {
118551
+ /** Date and time at which Seam created the warning. */
118552
+ created_at: string
118553
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118554
+ message: string
118555
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118556
+ warning_code: 'schedule_externally_modified'
118557
+ }
118558
+ | {
118559
+ /** Date and time at which Seam created the warning. */
118560
+ created_at: string
118561
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118562
+ message: string
118563
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118564
+ warning_code: 'schedule_modified'
118565
+ }
118566
+ | {
118567
+ /** Date and time at which Seam created the warning. */
118568
+ created_at: string
118569
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118570
+ message: string
118571
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118572
+ warning_code: 'being_deleted'
118573
+ }
118574
+ | {
118575
+ /** Date and time at which Seam created the warning. */
118576
+ created_at: string
118577
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118578
+ message: string
118579
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118580
+ warning_code: 'unknown_issue_with_acs_credential'
118581
+ }
118582
+ | {
118583
+ /** Date and time at which Seam created the warning. */
118584
+ created_at: string
118585
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118586
+ message: string
118587
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118588
+ warning_code: 'needs_to_be_reissued'
118589
+ }
118590
+ | {
118591
+ /** Date and time at which Seam created the warning. */
118592
+ created_at: string
118593
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118594
+ message: string
118595
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118596
+ warning_code: 'requested_code_unavailable'
118597
+ /** The originally requested PIN code that could not be used. */
118598
+ original_code: string
118599
+ /** The PIN code that was assigned instead. */
118600
+ new_code: string
118601
+ }
118602
+ )[]
118603
+ /** 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). */
118604
+ is_multi_phone_sync_credential?: boolean | undefined
118605
+ /** 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. */
118606
+ is_latest_desired_state_synced_with_provider?:
118607
+ (boolean | null) | undefined
118608
+ /** 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. */
118609
+ latest_desired_state_synced_with_provider_at?:
118610
+ (string | null) | undefined
118611
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118612
+ visionline_metadata?:
118613
+ | {
118614
+ /** Card function type in the Visionline access system. */
118615
+ card_function_type?:
118616
+ (('guest' | 'staff') | undefined) | undefined
118617
+ /** IDs of the credentials to which you want to join. */
118618
+ joiner_acs_credential_ids?:
118619
+ (string[] | undefined) | undefined
118620
+ /** Guest entrance IDs in the Visionline access system. */
118621
+ guest_acs_entrance_ids?:
118622
+ (string[] | undefined) | undefined
118623
+ /** Common entrance IDs in the Visionline access system. */
118624
+ common_acs_entrance_ids?:
118625
+ (string[] | undefined) | undefined
118626
+ /** Indicates whether the credential is valid. */
118627
+ is_valid?: (boolean | undefined) | undefined
118628
+ /** 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. */
118629
+ auto_join?: (boolean | undefined) | undefined
118630
+ /** ID of the card in the Visionline access system. */
118631
+ card_id?: (string | undefined) | undefined
118632
+ /** ID of the credential in the Visionline access system. */
118633
+ credential_id?: (string | undefined) | undefined
118634
+ }
118635
+ | undefined
118636
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118637
+ assa_abloy_vostio_metadata?:
118638
+ | {
118639
+ /** 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. */
118640
+ auto_join?: (boolean | undefined) | undefined
118641
+ /** IDs of the guest entrances to override in the Vostio access system. */
118642
+ override_guest_acs_entrance_ids?:
118643
+ (string[] | undefined) | undefined
118644
+ /** Key ID in the Vostio access system. */
118645
+ key_id?: (string | undefined) | undefined
118646
+ /** Key issuing request ID in the Vostio access system. */
118647
+ key_issuing_request_id?:
118648
+ (string | undefined) | undefined
118649
+ /** Names of the doors to which to grant access in the Vostio access system. */
118650
+ door_names?: (string[] | undefined) | undefined
118651
+ /** Endpoint ID in the Vostio access system. */
118652
+ endpoint_id?: (string | undefined) | undefined
118653
+ }
118654
+ | undefined
118655
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118656
+ akiles_metadata?:
118657
+ | {
118658
+ /** ID of the Akiles member PIN. */
118659
+ member_pin_id?: (string | undefined) | undefined
118660
+ }
118661
+ | undefined
118662
+ /** Indicates whether Seam manages the credential. */
118663
+ is_managed: true
118664
+ }
118665
+ | {
118666
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118667
+ acs_credential_id: string
118668
+ /** 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. */
118669
+ acs_user_id?: string | undefined
118670
+ /** 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. */
118671
+ user_identity_id?: string | undefined
118672
+ /** 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. */
118673
+ connected_account_id: string
118674
+ /** ID of the credential pool to which the credential belongs. */
118675
+ acs_credential_pool_id?: string | undefined
118676
+ /** 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). */
118677
+ acs_system_id: string
118678
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118679
+ parent_acs_credential_id?: string | undefined
118680
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
118681
+ display_name: string
118682
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118683
+ code?: (string | undefined) | null
118684
+ /** 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. */
118685
+ is_one_time_use?: boolean | undefined
118686
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118687
+ card_number?: (string | undefined) | null
118688
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
118689
+ is_issued?: boolean | undefined
118690
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
118691
+ issued_at?: (string | undefined) | null
118692
+ /** 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`. */
118693
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
118694
+ /** 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`. */
118695
+ external_type?:
118696
+ | (
118697
+ | 'pti_card'
118698
+ | 'brivo_credential'
118699
+ | 'hid_credential'
118700
+ | 'visionline_card'
118701
+ | 'salto_ks_credential'
118702
+ | 'assa_abloy_vostio_key'
118703
+ | 'salto_space_key'
118704
+ | 'latch_access'
118705
+ | 'dormakaba_ambiance_credential'
118706
+ | 'hotek_card'
118707
+ | 'salto_ks_tag'
118708
+ | 'avigilon_alta_credential'
118709
+ | 'kisi_credential'
118710
+ | 'akiles_credential'
118711
+ )
118712
+ | undefined
118713
+ /** 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. */
118714
+ external_type_display_name?: string | undefined
118715
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
118716
+ created_at: string
118717
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118718
+ workspace_id: string
118719
+ /** 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. */
118720
+ starts_at?: string | undefined
118721
+ /** 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`. */
118722
+ ends_at?: string | undefined
118723
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118724
+ errors: {
118725
+ error_code: string
118726
+ message: string
118727
+ /** Date and time at which Seam created the error. */
118728
+ created_at: string
118729
+ }[]
118730
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118731
+ warnings: (
118732
+ | {
118733
+ /** Date and time at which Seam created the warning. */
118734
+ created_at: string
118735
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118736
+ message: string
118737
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118738
+ warning_code: 'waiting_to_be_issued'
118739
+ }
118740
+ | {
118741
+ /** Date and time at which Seam created the warning. */
118742
+ created_at: string
118743
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118744
+ message: string
118745
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118746
+ warning_code: 'schedule_externally_modified'
118747
+ }
118748
+ | {
118749
+ /** Date and time at which Seam created the warning. */
118750
+ created_at: string
118751
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118752
+ message: string
118753
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118754
+ warning_code: 'schedule_modified'
118755
+ }
118756
+ | {
118757
+ /** Date and time at which Seam created the warning. */
118758
+ created_at: string
118759
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118760
+ message: string
118761
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118762
+ warning_code: 'being_deleted'
118763
+ }
118764
+ | {
118765
+ /** Date and time at which Seam created the warning. */
118766
+ created_at: string
118767
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118768
+ message: string
118769
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118770
+ warning_code: 'unknown_issue_with_acs_credential'
118771
+ }
118772
+ | {
118773
+ /** Date and time at which Seam created the warning. */
118774
+ created_at: string
118775
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118776
+ message: string
118777
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118778
+ warning_code: 'needs_to_be_reissued'
118779
+ }
118780
+ | {
118781
+ /** Date and time at which Seam created the warning. */
118782
+ created_at: string
118783
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
118784
+ message: string
118785
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
118786
+ warning_code: 'requested_code_unavailable'
118787
+ /** The originally requested PIN code that could not be used. */
118788
+ original_code: string
118789
+ /** The PIN code that was assigned instead. */
118790
+ new_code: string
118791
+ }
118792
+ )[]
118793
+ /** 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). */
118794
+ is_multi_phone_sync_credential?: boolean | undefined
118795
+ /** 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. */
118796
+ is_latest_desired_state_synced_with_provider?:
118797
+ (boolean | null) | undefined
118798
+ /** 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. */
118799
+ latest_desired_state_synced_with_provider_at?:
118800
+ (string | null) | undefined
118801
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118802
+ visionline_metadata?:
118803
+ | {
118804
+ /** Card function type in the Visionline access system. */
118805
+ card_function_type?:
118806
+ (('guest' | 'staff') | undefined) | undefined
118807
+ /** IDs of the credentials to which you want to join. */
118808
+ joiner_acs_credential_ids?:
118809
+ (string[] | undefined) | undefined
118810
+ /** Guest entrance IDs in the Visionline access system. */
118811
+ guest_acs_entrance_ids?:
118812
+ (string[] | undefined) | undefined
118813
+ /** Common entrance IDs in the Visionline access system. */
118814
+ common_acs_entrance_ids?:
118815
+ (string[] | undefined) | undefined
118816
+ /** Indicates whether the credential is valid. */
118817
+ is_valid?: (boolean | undefined) | undefined
118818
+ /** 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. */
118819
+ auto_join?: (boolean | undefined) | undefined
118820
+ /** ID of the card in the Visionline access system. */
118821
+ card_id?: (string | undefined) | undefined
118822
+ /** ID of the credential in the Visionline access system. */
118823
+ credential_id?: (string | undefined) | undefined
118824
+ }
118825
+ | undefined
118826
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118827
+ assa_abloy_vostio_metadata?:
118828
+ | {
118829
+ /** 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. */
118830
+ auto_join?: (boolean | undefined) | undefined
118831
+ /** IDs of the guest entrances to override in the Vostio access system. */
118832
+ override_guest_acs_entrance_ids?:
118833
+ (string[] | undefined) | undefined
118834
+ /** Key ID in the Vostio access system. */
118835
+ key_id?: (string | undefined) | undefined
118836
+ /** Key issuing request ID in the Vostio access system. */
118837
+ key_issuing_request_id?:
118838
+ (string | undefined) | undefined
118839
+ /** Names of the doors to which to grant access in the Vostio access system. */
118840
+ door_names?: (string[] | undefined) | undefined
118841
+ /** Endpoint ID in the Vostio access system. */
118842
+ endpoint_id?: (string | undefined) | undefined
118843
+ }
118844
+ | undefined
118845
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118846
+ akiles_metadata?:
118847
+ | {
118848
+ /** ID of the Akiles member PIN. */
118849
+ member_pin_id?: (string | undefined) | undefined
118850
+ }
118851
+ | undefined
118852
+ is_managed: false
118853
+ }
118854
+ }
118855
+ | {
118856
+ /** ID of the action attempt. */
118857
+ action_attempt_id: string
118858
+ status: 'error'
118859
+ /** Result of the action attempt. Null for failed action attempts. */
118860
+ result: null
118861
+ /** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
118862
+ action_type: 'ENCODE_CREDENTIAL'
118863
+ error:
118864
+ | {
118865
+ /** Type of the error associated with the action attempt. */
118866
+ type: 'uncategorized_error'
118867
+ /** Message for the error associated with the action attempt. */
118868
+ message: string
118869
+ }
118870
+ | {
118871
+ /** Type of the error associated with the action attempt. */
118872
+ type: 'action_attempt_expired'
118873
+ /** Message for the error associated with the action attempt. */
118874
+ message: string
118875
+ }
118876
+ | {
118877
+ /** Error type to indicate that there is no credential on the encoder. */
118878
+ type: 'no_credential_on_encoder'
118879
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118880
+ message: string
118881
+ }
118882
+ | {
118883
+ /** Error type to indicate an incompatible card format. */
118884
+ type: 'incompatible_card_format'
118885
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118886
+ message: string
118887
+ }
118888
+ | {
118889
+ /** Error type to indicate that the affected credential cannot be reissued. */
118890
+ type: 'credential_cannot_be_reissued'
118891
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118892
+ message: string
118893
+ }
118894
+ | {
118895
+ /** Error type to indicate that the encoder is not online. */
118896
+ type: 'encoder_not_online'
118897
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118898
+ message: string
118899
+ }
118900
+ | {
118901
+ /** Error type to indicate that communication with the encoder timed out. */
118902
+ type: 'encoder_communication_timeout'
118903
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118904
+ message: string
118905
+ }
118906
+ | {
118907
+ /** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
118908
+ type: 'bridge_disconnected'
118909
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118910
+ message: string
118911
+ }
118912
+ | {
118913
+ /** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
118914
+ type: 'encoding_interrupted'
118915
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118916
+ message: string
118917
+ }
118918
+ | {
118919
+ /** Error type to indicate that the credential was deleted and can no longer be encoded. */
118920
+ type: 'credential_deleted'
118921
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
118922
+ message: string
118923
+ }
118924
+ }
118925
+ | {
118926
+ /** ID of the action attempt. */
118927
+ action_attempt_id: string
118928
+ status: 'pending'
118929
+ /** Result of the action attempt. Null for pending action attempts. */
118930
+ result: null
118931
+ /** Errors associated with the action attempt. Null for pending action attempts. */
118932
+ error: null
118933
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
118934
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
118935
+ }
118936
+ | {
118937
+ /** ID of the action attempt. */
118938
+ action_attempt_id: string
118939
+ status: 'success'
118940
+ /** Errors associated with the action attempt. Null for successful action attempts. */
118941
+ error: null
118942
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
118943
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
118944
+ /** Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. */
118945
+ result: {
118946
+ /** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118947
+ acs_credential_id: string
118948
+ /** 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. */
118949
+ acs_user_id?: string | undefined
118950
+ /** 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. */
118951
+ user_identity_id?: string | undefined
118952
+ /** 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. */
118953
+ connected_account_id: string
118954
+ /** ID of the credential pool to which the credential belongs. */
118955
+ acs_credential_pool_id?: string | undefined
118956
+ /** 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). */
118957
+ acs_system_id: string
118958
+ /** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118959
+ parent_acs_credential_id?: string | undefined
118960
+ /** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
118961
+ display_name: string
118962
+ /** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118963
+ code?: (string | undefined) | null
118964
+ /** 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. */
118965
+ is_one_time_use?: boolean | undefined
118966
+ /** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118967
+ card_number?: (string | undefined) | null
118968
+ /** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
118969
+ is_issued?: boolean | undefined
118970
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
118971
+ issued_at?: (string | undefined) | null
118972
+ /** 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`. */
118973
+ access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
118974
+ /** 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`. */
118975
+ external_type?:
118976
+ | (
118977
+ | 'pti_card'
118978
+ | 'brivo_credential'
118979
+ | 'hid_credential'
118980
+ | 'visionline_card'
118981
+ | 'salto_ks_credential'
118982
+ | 'assa_abloy_vostio_key'
118983
+ | 'salto_space_key'
118984
+ | 'latch_access'
118985
+ | 'dormakaba_ambiance_credential'
118986
+ | 'hotek_card'
118987
+ | 'salto_ks_tag'
118988
+ | 'avigilon_alta_credential'
118989
+ | 'kisi_credential'
118990
+ | 'akiles_credential'
118991
+ )
118992
+ | undefined
118993
+ /** 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. */
118994
+ external_type_display_name?: string | undefined
118995
+ /** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
118996
+ created_at: string
118997
+ /** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
118998
+ workspace_id: string
118999
+ /** 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. */
119000
+ starts_at?: string | undefined
119001
+ /** 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`. */
119002
+ ends_at?: string | undefined
119003
+ /** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
119004
+ errors: {
119005
+ error_code: string
119006
+ message: string
119007
+ /** Date and time at which Seam created the error. */
119008
+ created_at: string
119009
+ }[]
119010
+ /** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
119011
+ warnings: (
119012
+ | {
119013
+ /** Date and time at which Seam created the warning. */
119014
+ created_at: string
119015
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119016
+ message: string
119017
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119018
+ warning_code: 'waiting_to_be_issued'
119019
+ }
119020
+ | {
119021
+ /** Date and time at which Seam created the warning. */
119022
+ created_at: string
119023
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119024
+ message: string
119025
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119026
+ warning_code: 'schedule_externally_modified'
119027
+ }
119028
+ | {
119029
+ /** Date and time at which Seam created the warning. */
119030
+ created_at: string
119031
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119032
+ message: string
119033
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119034
+ warning_code: 'schedule_modified'
119035
+ }
119036
+ | {
119037
+ /** Date and time at which Seam created the warning. */
119038
+ created_at: string
119039
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119040
+ message: string
119041
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119042
+ warning_code: 'being_deleted'
119043
+ }
119044
+ | {
119045
+ /** Date and time at which Seam created the warning. */
119046
+ created_at: string
119047
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119048
+ message: string
119049
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119050
+ warning_code: 'unknown_issue_with_acs_credential'
119051
+ }
119052
+ | {
119053
+ /** Date and time at which Seam created the warning. */
119054
+ created_at: string
119055
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119056
+ message: string
119057
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119058
+ warning_code: 'needs_to_be_reissued'
119059
+ }
119060
+ | {
119061
+ /** Date and time at which Seam created the warning. */
119062
+ created_at: string
119063
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119064
+ message: string
119065
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119066
+ warning_code: 'requested_code_unavailable'
119067
+ /** The originally requested PIN code that could not be used. */
119068
+ original_code: string
119069
+ /** The PIN code that was assigned instead. */
119070
+ new_code: string
119071
+ }
119072
+ )[]
119073
+ /** 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). */
119074
+ is_multi_phone_sync_credential?: boolean | undefined
119075
+ /** 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. */
119076
+ is_latest_desired_state_synced_with_provider?:
119077
+ (boolean | null) | undefined
119078
+ /** 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. */
119079
+ latest_desired_state_synced_with_provider_at?:
119080
+ (string | null) | undefined
119081
+ /** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
119082
+ visionline_metadata?:
119083
+ | {
119084
+ /** Card function type in the Visionline access system. */
119085
+ card_function_type?:
119086
+ (('guest' | 'staff') | undefined) | undefined
119087
+ /** IDs of the credentials to which you want to join. */
119088
+ joiner_acs_credential_ids?:
119089
+ (string[] | undefined) | undefined
119090
+ /** Guest entrance IDs in the Visionline access system. */
119091
+ guest_acs_entrance_ids?: (string[] | undefined) | undefined
119092
+ /** Common entrance IDs in the Visionline access system. */
119093
+ common_acs_entrance_ids?: (string[] | undefined) | undefined
119094
+ /** Indicates whether the credential is valid. */
119095
+ is_valid?: (boolean | undefined) | undefined
119096
+ /** 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. */
119097
+ auto_join?: (boolean | undefined) | undefined
119098
+ /** ID of the card in the Visionline access system. */
119099
+ card_id?: (string | undefined) | undefined
119100
+ /** ID of the credential in the Visionline access system. */
119101
+ credential_id?: (string | undefined) | undefined
119102
+ }
119103
+ | undefined
119104
+ /** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
119105
+ assa_abloy_vostio_metadata?:
119106
+ | {
119107
+ /** 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. */
119108
+ auto_join?: (boolean | undefined) | undefined
119109
+ /** IDs of the guest entrances to override in the Vostio access system. */
119110
+ override_guest_acs_entrance_ids?:
119111
+ (string[] | undefined) | undefined
119112
+ /** Key ID in the Vostio access system. */
119113
+ key_id?: (string | undefined) | undefined
119114
+ /** Key issuing request ID in the Vostio access system. */
119115
+ key_issuing_request_id?: (string | undefined) | undefined
119116
+ /** Names of the doors to which to grant access in the Vostio access system. */
119117
+ door_names?: (string[] | undefined) | undefined
119118
+ /** Endpoint ID in the Vostio access system. */
119119
+ endpoint_id?: (string | undefined) | undefined
119120
+ }
119121
+ | undefined
119122
+ /** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
119123
+ akiles_metadata?:
119124
+ | {
119125
+ /** ID of the Akiles member PIN. */
119126
+ member_pin_id?: (string | undefined) | undefined
119127
+ }
119128
+ | undefined
119129
+ /** Indicates whether Seam manages the credential. */
119130
+ is_managed: true
119131
+ }
119132
+ }
119133
+ | {
119134
+ /** ID of the action attempt. */
119135
+ action_attempt_id: string
119136
+ status: 'error'
119137
+ /** Result of the action attempt. Null for failed action attempts. */
119138
+ result: null
119139
+ /** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
119140
+ action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
119141
+ error:
119142
+ | {
119143
+ /** Type of the error associated with the action attempt. */
119144
+ type: 'uncategorized_error'
119145
+ /** Message for the error associated with the action attempt. */
119146
+ message: string
119147
+ }
119148
+ | {
119149
+ /** Type of the error associated with the action attempt. */
119150
+ type: 'action_attempt_expired'
119151
+ /** Message for the error associated with the action attempt. */
119152
+ message: string
119153
+ }
119154
+ | {
119155
+ /** Error type to indicate that there is no credential on the encoder. */
119156
+ type: 'no_credential_on_encoder'
119157
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119158
+ message: string
119159
+ }
119160
+ }
119161
+ | {
119162
+ /** ID of the action attempt. */
119163
+ action_attempt_id: string
119164
+ status: 'pending'
119165
+ /** Result of the action attempt. Null for pending action attempts. */
119166
+ result: null
119167
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119168
+ error: null
119169
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
119170
+ action_type: 'ASSIGN_CREDENTIAL'
119171
+ }
119172
+ | {
119173
+ /** ID of the action attempt. */
119174
+ action_attempt_id: string
119175
+ status: 'success'
119176
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119177
+ error: null
119178
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
119179
+ action_type: 'ASSIGN_CREDENTIAL'
119180
+ /** Result of assigning a credential. If successful, includes the updated access method with the assigned credential. */
119181
+ result: {
119182
+ /** ID of the Seam workspace associated with the access method. */
119183
+ workspace_id: string
119184
+ /** ID of the access method. */
119185
+ access_method_id: string
119186
+ /** Display name of the access method. */
119187
+ display_name: string
119188
+ /** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
119189
+ mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
119190
+ /** Date and time at which the access method was created. */
119191
+ created_at: string
119192
+ /** Date and time at which the access method was issued. */
119193
+ issued_at: string | null
119194
+ /** Indicates whether the access method has been issued. */
119195
+ is_issued: boolean
119196
+ /** 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`. */
119197
+ display_status: string
119198
+ /** URL of the Instant Key for mobile key access methods. */
119199
+ instant_key_url?: string | undefined
119200
+ /** Token of the client session associated with the access method. */
119201
+ client_session_token?: string | undefined
119202
+ /** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
119203
+ is_encoding_required?: boolean | undefined
119204
+ /** 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. */
119205
+ is_ready_for_encoding?: boolean | undefined
119206
+ /** 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. */
119207
+ is_assignment_required?: boolean | undefined
119208
+ /** 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. */
119209
+ is_ready_for_assignment?: boolean | undefined
119210
+ /** The actual PIN code for code access methods. */
119211
+ code?: (string | null) | undefined
119212
+ /** Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
119213
+ warnings: (
119214
+ | {
119215
+ /** Date and time at which Seam created the warning. */
119216
+ created_at: string
119217
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119218
+ message: string
119219
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119220
+ warning_code: 'being_deleted'
119221
+ }
119222
+ | {
119223
+ /** Date and time at which Seam created the warning. */
119224
+ created_at: string
119225
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119226
+ message: string
119227
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119228
+ warning_code: 'updating_access_times'
119229
+ }
119230
+ | {
119231
+ /** Date and time at which Seam created the warning. */
119232
+ created_at: string
119233
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119234
+ message: string
119235
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119236
+ warning_code: 'pulled_backup_access_code'
119237
+ /** ID of the original access method from which this backup access method was split, if applicable. */
119238
+ original_access_method_id?: string | undefined
119239
+ }
119240
+ | {
119241
+ /** Date and time at which Seam created the warning. */
119242
+ created_at: string
119243
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119244
+ message: string
119245
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119246
+ warning_code: 'delay_in_issuing'
119247
+ }
119248
+ | {
119249
+ /** Date and time at which Seam created the warning. */
119250
+ created_at: string
119251
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119252
+ message: string
119253
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119254
+ warning_code: 'user_identity_missing_email_address'
119255
+ }
119256
+ | {
119257
+ /** Date and time at which Seam created the warning. */
119258
+ created_at: string
119259
+ /** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
119260
+ message: string
119261
+ /** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
119262
+ warning_code: 'user_identity_missing_phone_number'
119263
+ }
119264
+ )[]
119265
+ /** Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
119266
+ errors: {
119267
+ /** Date and time at which Seam created the error. */
119268
+ created_at: string
119269
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119270
+ message: string
119271
+ /** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
119272
+ error_code: 'failed_to_issue'
119273
+ }[]
119274
+ /** 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. */
119275
+ pending_mutations: (
119276
+ | {
119277
+ /** Date and time at which the mutation was created. */
119278
+ created_at: string
119279
+ /** Detailed description of the mutation. */
119280
+ message: string
119281
+ /** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
119282
+ mutation_code: 'provisioning_access'
119283
+ /** Previous device configuration. */
119284
+ from: {
119285
+ /** Previous device IDs where access was provisioned. */
119286
+ device_ids: string[]
119287
+ }
119288
+ /** New device configuration. */
119289
+ to: {
119290
+ /** New device IDs where access is being provisioned. */
119291
+ device_ids: string[]
119292
+ }
119293
+ }
119294
+ | {
119295
+ /** Date and time at which the mutation was created. */
119296
+ created_at: string
119297
+ /** Detailed description of the mutation. */
119298
+ message: string
119299
+ /** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
119300
+ mutation_code: 'revoking_access'
119301
+ /** Previous device configuration. */
119302
+ from: {
119303
+ /** Previous device IDs where access existed. */
119304
+ device_ids: string[]
119305
+ }
119306
+ /** New device configuration. */
119307
+ to: {
119308
+ /** New device IDs where access should remain. */
119309
+ device_ids: string[]
119310
+ }
119311
+ }
119312
+ | {
119313
+ /** Date and time at which the mutation was created. */
119314
+ created_at: string
119315
+ /** Detailed description of the mutation. */
119316
+ message: string
119317
+ /** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
119318
+ mutation_code: 'updating_access_times'
119319
+ /** Previous access time configuration. */
119320
+ from: {
119321
+ /** Previous start time for access. */
119322
+ starts_at: string | null
119323
+ /** Previous end time for access. */
119324
+ ends_at: string | null
119325
+ }
119326
+ /** New access time configuration. */
119327
+ to: {
119328
+ /** New start time for access. */
119329
+ starts_at: string | null
119330
+ /** New end time for access. */
119331
+ ends_at: string | null
119332
+ }
119333
+ }
119334
+ )[]
119335
+ /** ID of the customization profile associated with the access method. */
119336
+ customization_profile_id?: string | undefined
119337
+ }
119338
+ }
119339
+ | {
119340
+ /** ID of the action attempt. */
119341
+ action_attempt_id: string
119342
+ status: 'error'
119343
+ /** Result of the action attempt. Null for failed action attempts. */
119344
+ result: null
119345
+ /** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
119346
+ action_type: 'ASSIGN_CREDENTIAL'
119347
+ error:
119348
+ | {
119349
+ /** Type of the error associated with the action attempt. */
119350
+ type: 'uncategorized_error'
119351
+ /** Message for the error associated with the action attempt. */
119352
+ message: string
119353
+ }
119354
+ | {
119355
+ /** Type of the error associated with the action attempt. */
119356
+ type: 'action_attempt_expired'
119357
+ /** Message for the error associated with the action attempt. */
119358
+ message: string
119359
+ }
119360
+ | {
119361
+ /** Error type to indicate that no matching credential was found. */
119362
+ type: 'credential_not_found'
119363
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119364
+ message: string
119365
+ }
119366
+ }
119367
+ | {
119368
+ /** ID of the action attempt. */
119369
+ action_attempt_id: string
119370
+ status: 'pending'
119371
+ /** Result of the action attempt. Null for pending action attempts. */
119372
+ result: null
119373
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119374
+ error: null
119375
+ /** Action attempt to track the status of resetting a sandbox workspace. */
119376
+ action_type: 'RESET_SANDBOX_WORKSPACE'
119377
+ }
119378
+ | {
119379
+ /** ID of the action attempt. */
119380
+ action_attempt_id: string
119381
+ status: 'success'
119382
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119383
+ error: null
119384
+ /** Action attempt to track the status of resetting a sandbox workspace. */
119385
+ action_type: 'RESET_SANDBOX_WORKSPACE'
119386
+ /** Result of the action. */
119387
+ result: {}
119388
+ }
119389
+ | {
119390
+ /** ID of the action attempt. */
119391
+ action_attempt_id: string
119392
+ status: 'error'
119393
+ /** Result of the action attempt. Null for failed action attempts. */
119394
+ result: null
119395
+ /** Action attempt to track the status of resetting a sandbox workspace. */
119396
+ action_type: 'RESET_SANDBOX_WORKSPACE'
119397
+ /** Error associated with the action. */
119398
+ error: {
119399
+ /** Type of the error. */
119400
+ type: string
119401
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119402
+ message: string
119403
+ }
119404
+ }
119405
+ | {
119406
+ /** ID of the action attempt. */
119407
+ action_attempt_id: string
119408
+ status: 'pending'
119409
+ /** Result of the action attempt. Null for pending action attempts. */
119410
+ result: null
119411
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119412
+ error: null
119413
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
119414
+ action_type: 'SET_FAN_MODE'
119415
+ }
119416
+ | {
119417
+ /** ID of the action attempt. */
119418
+ action_attempt_id: string
119419
+ status: 'success'
119420
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119421
+ error: null
119422
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
119423
+ action_type: 'SET_FAN_MODE'
119424
+ /** Result of the action. */
119425
+ result: {}
119426
+ }
119427
+ | {
119428
+ /** ID of the action attempt. */
119429
+ action_attempt_id: string
119430
+ status: 'error'
119431
+ /** Result of the action attempt. Null for failed action attempts. */
119432
+ result: null
119433
+ /** Action attempt to track the status of setting the fan mode on a thermostat. */
119434
+ action_type: 'SET_FAN_MODE'
119435
+ /** Error associated with the action. */
119436
+ error: {
119437
+ /** Type of the error. */
119438
+ type: string
119439
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119440
+ message: string
119441
+ }
119442
+ }
119443
+ | {
119444
+ /** ID of the action attempt. */
119445
+ action_attempt_id: string
119446
+ status: 'pending'
119447
+ /** Result of the action attempt. Null for pending action attempts. */
119448
+ result: null
119449
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119450
+ error: null
119451
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
119452
+ action_type: 'SET_HVAC_MODE'
119453
+ }
119454
+ | {
119455
+ /** ID of the action attempt. */
119456
+ action_attempt_id: string
119457
+ status: 'success'
119458
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119459
+ error: null
119460
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
119461
+ action_type: 'SET_HVAC_MODE'
119462
+ /** Result of the action. */
119463
+ result: {}
119464
+ }
119465
+ | {
119466
+ /** ID of the action attempt. */
119467
+ action_attempt_id: string
119468
+ status: 'error'
119469
+ /** Result of the action attempt. Null for failed action attempts. */
119470
+ result: null
119471
+ /** Action attempt to track the status of setting the HVAC mode on a thermostat. */
119472
+ action_type: 'SET_HVAC_MODE'
119473
+ /** Error associated with the action. */
119474
+ error: {
119475
+ /** Type of the error. */
119476
+ type: string
119477
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119478
+ message: string
119479
+ }
119480
+ }
119481
+ | {
119482
+ /** ID of the action attempt. */
119483
+ action_attempt_id: string
119484
+ status: 'pending'
119485
+ /** Result of the action attempt. Null for pending action attempts. */
119486
+ result: null
119487
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119488
+ error: null
119489
+ /** Action attempt to track the status of a climate preset activation. */
119490
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
119491
+ }
119492
+ | {
119493
+ /** ID of the action attempt. */
119494
+ action_attempt_id: string
119495
+ status: 'success'
119496
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119497
+ error: null
119498
+ /** Action attempt to track the status of a climate preset activation. */
119499
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
119500
+ /** Result of the action. */
119501
+ result: {}
119502
+ }
119503
+ | {
119504
+ /** ID of the action attempt. */
119505
+ action_attempt_id: string
119506
+ status: 'error'
119507
+ /** Result of the action attempt. Null for failed action attempts. */
119508
+ result: null
119509
+ /** Action attempt to track the status of a climate preset activation. */
119510
+ action_type: 'ACTIVATE_CLIMATE_PRESET'
119511
+ /** Error associated with the action. */
119512
+ error: {
119513
+ /** Type of the error. */
119514
+ type: string
119515
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119516
+ message: string
119517
+ }
119518
+ }
119519
+ | {
119520
+ /** ID of the action attempt. */
119521
+ action_attempt_id: string
119522
+ status: 'pending'
119523
+ /** Result of the action attempt. Null for pending action attempts. */
119524
+ result: null
119525
+ /** Errors associated with the action attempt. Null for pending action attempts. */
119526
+ error: null
119527
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119528
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
119529
+ }
119530
+ | {
119531
+ /** ID of the action attempt. */
119532
+ action_attempt_id: string
119533
+ status: 'success'
119534
+ /** Errors associated with the action attempt. Null for successful action attempts. */
119535
+ error: null
119536
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119537
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
119538
+ /** Result of the action. */
119539
+ result: {}
119540
+ }
119541
+ | {
119542
+ /** ID of the action attempt. */
119543
+ action_attempt_id: string
119544
+ status: 'error'
119545
+ /** Result of the action attempt. Null for failed action attempts. */
119546
+ result: null
119547
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
119548
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
119549
+ /** Error associated with the action. */
119550
+ error: {
119551
+ /** Type of the error. */
119552
+ type: string
119553
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
119554
+ message: string
119555
+ }
119556
+ }
116293
119557
  | {
116294
119558
  /** ID of the action attempt. */
116295
119559
  action_attempt_id: string
@@ -118412,6 +121676,44 @@ export type Routes = {
118412
121676
  message: string
118413
121677
  }
118414
121678
  }
121679
+ | {
121680
+ /** ID of the action attempt. */
121681
+ action_attempt_id: string
121682
+ status: 'pending'
121683
+ /** Result of the action attempt. Null for pending action attempts. */
121684
+ result: null
121685
+ /** Errors associated with the action attempt. Null for pending action attempts. */
121686
+ error: null
121687
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
121688
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
121689
+ }
121690
+ | {
121691
+ /** ID of the action attempt. */
121692
+ action_attempt_id: string
121693
+ status: 'success'
121694
+ /** Errors associated with the action attempt. Null for successful action attempts. */
121695
+ error: null
121696
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
121697
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
121698
+ /** Result of the action. */
121699
+ result: {}
121700
+ }
121701
+ | {
121702
+ /** ID of the action attempt. */
121703
+ action_attempt_id: string
121704
+ status: 'error'
121705
+ /** Result of the action attempt. Null for failed action attempts. */
121706
+ result: null
121707
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
121708
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
121709
+ /** Error associated with the action. */
121710
+ error: {
121711
+ /** Type of the error. */
121712
+ type: string
121713
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
121714
+ message: string
121715
+ }
121716
+ }
118415
121717
  | {
118416
121718
  /** ID of the action attempt. */
118417
121719
  action_attempt_id: string
@@ -120645,6 +123947,44 @@ export type Routes = {
120645
123947
  message: string
120646
123948
  }
120647
123949
  }
123950
+ | {
123951
+ /** ID of the action attempt. */
123952
+ action_attempt_id: string
123953
+ status: 'pending'
123954
+ /** Result of the action attempt. Null for pending action attempts. */
123955
+ result: null
123956
+ /** Errors associated with the action attempt. Null for pending action attempts. */
123957
+ error: null
123958
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
123959
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
123960
+ }
123961
+ | {
123962
+ /** ID of the action attempt. */
123963
+ action_attempt_id: string
123964
+ status: 'success'
123965
+ /** Errors associated with the action attempt. Null for successful action attempts. */
123966
+ error: null
123967
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
123968
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
123969
+ /** Result of the action. */
123970
+ result: {}
123971
+ }
123972
+ | {
123973
+ /** ID of the action attempt. */
123974
+ action_attempt_id: string
123975
+ status: 'error'
123976
+ /** Result of the action attempt. Null for failed action attempts. */
123977
+ result: null
123978
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
123979
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
123980
+ /** Error associated with the action. */
123981
+ error: {
123982
+ /** Type of the error. */
123983
+ type: string
123984
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
123985
+ message: string
123986
+ }
123987
+ }
120648
123988
  | {
120649
123989
  /** ID of the action attempt. */
120650
123990
  action_attempt_id: string
@@ -121166,7 +124506,7 @@ export type Routes = {
121166
124506
  | 'smartthings_thermostat'
121167
124507
  )
121168
124508
  | ('ios_phone' | 'android_phone')
121169
- | ('ring_camera' | 'tapo_camera')
124509
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
121170
124510
  /** IDs of the spaces the device is in. */
121171
124511
  space_ids: string[]
121172
124512
  /** Optional nickname to describe the device, settable through Seam. */
@@ -121974,6 +125314,24 @@ export type Routes = {
121974
125314
  | undefined
121975
125315
  )
121976
125316
  | undefined
125317
+ /** Metadata for an Arlo camera. */
125318
+ arlo_metadata?:
125319
+ | (
125320
+ | {
125321
+ /** Device ID reported by Arlo. */
125322
+ device_id?: (string | undefined) | undefined
125323
+ /** Device name reported by Arlo. */
125324
+ device_name?: (string | undefined) | undefined
125325
+ /** Model ID reported by Arlo. */
125326
+ model_id?: (string | undefined) | undefined
125327
+ /** Hardware version reported by Arlo. */
125328
+ hardware_version?: (string | undefined) | undefined
125329
+ /** Firmware version reported by Arlo. */
125330
+ firmware_version?: (string | undefined) | undefined
125331
+ }
125332
+ | undefined
125333
+ )
125334
+ | undefined
121977
125335
  /** Metadata for a Ring device. */
121978
125336
  ring_metadata?:
121979
125337
  | {
@@ -122992,6 +126350,8 @@ export type Routes = {
122992
126350
  can_hvac_heat_cool?: boolean | undefined
122993
126351
  /** Indicates whether the thermostat can be turned off. */
122994
126352
  can_turn_off_hvac?: boolean | undefined
126353
+ /** 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. */
126354
+ can_activate_weekly_program?: boolean | undefined
122995
126355
  /** Indicates whether the device supports simulating removal in a sandbox. */
122996
126356
  can_simulate_removal?: boolean | undefined
122997
126357
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -124700,6 +128060,44 @@ export type Routes = {
124700
128060
  message: string
124701
128061
  }
124702
128062
  }
128063
+ | {
128064
+ /** ID of the action attempt. */
128065
+ action_attempt_id: string
128066
+ status: 'pending'
128067
+ /** Result of the action attempt. Null for pending action attempts. */
128068
+ result: null
128069
+ /** Errors associated with the action attempt. Null for pending action attempts. */
128070
+ error: null
128071
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128072
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
128073
+ }
128074
+ | {
128075
+ /** ID of the action attempt. */
128076
+ action_attempt_id: string
128077
+ status: 'success'
128078
+ /** Errors associated with the action attempt. Null for successful action attempts. */
128079
+ error: null
128080
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128081
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
128082
+ /** Result of the action. */
128083
+ result: {}
128084
+ }
128085
+ | {
128086
+ /** ID of the action attempt. */
128087
+ action_attempt_id: string
128088
+ status: 'error'
128089
+ /** Result of the action attempt. Null for failed action attempts. */
128090
+ result: null
128091
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
128092
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
128093
+ /** Error associated with the action. */
128094
+ error: {
128095
+ /** Type of the error. */
128096
+ type: string
128097
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
128098
+ message: string
128099
+ }
128100
+ }
124703
128101
  | {
124704
128102
  /** ID of the action attempt. */
124705
128103
  action_attempt_id: string
@@ -126826,6 +130224,44 @@ export type Routes = {
126826
130224
  message: string
126827
130225
  }
126828
130226
  }
130227
+ | {
130228
+ /** ID of the action attempt. */
130229
+ action_attempt_id: string
130230
+ status: 'pending'
130231
+ /** Result of the action attempt. Null for pending action attempts. */
130232
+ result: null
130233
+ /** Errors associated with the action attempt. Null for pending action attempts. */
130234
+ error: null
130235
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
130236
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
130237
+ }
130238
+ | {
130239
+ /** ID of the action attempt. */
130240
+ action_attempt_id: string
130241
+ status: 'success'
130242
+ /** Errors associated with the action attempt. Null for successful action attempts. */
130243
+ error: null
130244
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
130245
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
130246
+ /** Result of the action. */
130247
+ result: {}
130248
+ }
130249
+ | {
130250
+ /** ID of the action attempt. */
130251
+ action_attempt_id: string
130252
+ status: 'error'
130253
+ /** Result of the action attempt. Null for failed action attempts. */
130254
+ result: null
130255
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
130256
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
130257
+ /** Error associated with the action. */
130258
+ error: {
130259
+ /** Type of the error. */
130260
+ type: string
130261
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
130262
+ message: string
130263
+ }
130264
+ }
126829
130265
  | {
126830
130266
  /** ID of the action attempt. */
126831
130267
  action_attempt_id: string
@@ -127366,7 +130802,7 @@ export type Routes = {
127366
130802
  | 'smartthings_thermostat'
127367
130803
  )
127368
130804
  | ('ios_phone' | 'android_phone')
127369
- | ('ring_camera' | 'tapo_camera')
130805
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
127370
130806
  /** IDs of the spaces the device is in. */
127371
130807
  space_ids: string[]
127372
130808
  /** Optional nickname to describe the device, settable through Seam. */
@@ -128174,6 +131610,24 @@ export type Routes = {
128174
131610
  | undefined
128175
131611
  )
128176
131612
  | undefined
131613
+ /** Metadata for an Arlo camera. */
131614
+ arlo_metadata?:
131615
+ | (
131616
+ | {
131617
+ /** Device ID reported by Arlo. */
131618
+ device_id?: (string | undefined) | undefined
131619
+ /** Device name reported by Arlo. */
131620
+ device_name?: (string | undefined) | undefined
131621
+ /** Model ID reported by Arlo. */
131622
+ model_id?: (string | undefined) | undefined
131623
+ /** Hardware version reported by Arlo. */
131624
+ hardware_version?: (string | undefined) | undefined
131625
+ /** Firmware version reported by Arlo. */
131626
+ firmware_version?: (string | undefined) | undefined
131627
+ }
131628
+ | undefined
131629
+ )
131630
+ | undefined
128177
131631
  /** Metadata for a Ring device. */
128178
131632
  ring_metadata?:
128179
131633
  | {
@@ -129192,6 +132646,8 @@ export type Routes = {
129192
132646
  can_hvac_heat_cool?: boolean | undefined
129193
132647
  /** Indicates whether the thermostat can be turned off. */
129194
132648
  can_turn_off_hvac?: boolean | undefined
132649
+ /** 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. */
132650
+ can_activate_weekly_program?: boolean | undefined
129195
132651
  /** Indicates whether the device supports simulating removal in a sandbox. */
129196
132652
  can_simulate_removal?: boolean | undefined
129197
132653
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -129267,7 +132723,7 @@ export type Routes = {
129267
132723
  | 'smartthings_thermostat'
129268
132724
  )
129269
132725
  | ('ios_phone' | 'android_phone')
129270
- | ('ring_camera' | 'tapo_camera')
132726
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
129271
132727
  /** IDs of the spaces the device is in. */
129272
132728
  space_ids: string[]
129273
132729
  /** Optional nickname to describe the device, settable through Seam. */
@@ -130075,6 +133531,24 @@ export type Routes = {
130075
133531
  | undefined
130076
133532
  )
130077
133533
  | undefined
133534
+ /** Metadata for an Arlo camera. */
133535
+ arlo_metadata?:
133536
+ | (
133537
+ | {
133538
+ /** Device ID reported by Arlo. */
133539
+ device_id?: (string | undefined) | undefined
133540
+ /** Device name reported by Arlo. */
133541
+ device_name?: (string | undefined) | undefined
133542
+ /** Model ID reported by Arlo. */
133543
+ model_id?: (string | undefined) | undefined
133544
+ /** Hardware version reported by Arlo. */
133545
+ hardware_version?: (string | undefined) | undefined
133546
+ /** Firmware version reported by Arlo. */
133547
+ firmware_version?: (string | undefined) | undefined
133548
+ }
133549
+ | undefined
133550
+ )
133551
+ | undefined
130078
133552
  /** Metadata for a Ring device. */
130079
133553
  ring_metadata?:
130080
133554
  | {
@@ -131093,6 +134567,8 @@ export type Routes = {
131093
134567
  can_hvac_heat_cool?: boolean | undefined
131094
134568
  /** Indicates whether the thermostat can be turned off. */
131095
134569
  can_turn_off_hvac?: boolean | undefined
134570
+ /** 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. */
134571
+ can_activate_weekly_program?: boolean | undefined
131096
134572
  /** Indicates whether the device supports simulating removal in a sandbox. */
131097
134573
  can_simulate_removal?: boolean | undefined
131098
134574
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -132797,6 +136273,44 @@ export type Routes = {
132797
136273
  message: string
132798
136274
  }
132799
136275
  }
136276
+ | {
136277
+ /** ID of the action attempt. */
136278
+ action_attempt_id: string
136279
+ status: 'pending'
136280
+ /** Result of the action attempt. Null for pending action attempts. */
136281
+ result: null
136282
+ /** Errors associated with the action attempt. Null for pending action attempts. */
136283
+ error: null
136284
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
136285
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
136286
+ }
136287
+ | {
136288
+ /** ID of the action attempt. */
136289
+ action_attempt_id: string
136290
+ status: 'success'
136291
+ /** Errors associated with the action attempt. Null for successful action attempts. */
136292
+ error: null
136293
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
136294
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
136295
+ /** Result of the action. */
136296
+ result: {}
136297
+ }
136298
+ | {
136299
+ /** ID of the action attempt. */
136300
+ action_attempt_id: string
136301
+ status: 'error'
136302
+ /** Result of the action attempt. Null for failed action attempts. */
136303
+ result: null
136304
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
136305
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
136306
+ /** Error associated with the action. */
136307
+ error: {
136308
+ /** Type of the error. */
136309
+ type: string
136310
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
136311
+ message: string
136312
+ }
136313
+ }
132800
136314
  | {
132801
136315
  /** ID of the action attempt. */
132802
136316
  action_attempt_id: string
@@ -135124,6 +138638,44 @@ export type Routes = {
135124
138638
  message: string
135125
138639
  }
135126
138640
  }
138641
+ | {
138642
+ /** ID of the action attempt. */
138643
+ action_attempt_id: string
138644
+ status: 'pending'
138645
+ /** Result of the action attempt. Null for pending action attempts. */
138646
+ result: null
138647
+ /** Errors associated with the action attempt. Null for pending action attempts. */
138648
+ error: null
138649
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
138650
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
138651
+ }
138652
+ | {
138653
+ /** ID of the action attempt. */
138654
+ action_attempt_id: string
138655
+ status: 'success'
138656
+ /** Errors associated with the action attempt. Null for successful action attempts. */
138657
+ error: null
138658
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
138659
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
138660
+ /** Result of the action. */
138661
+ result: {}
138662
+ }
138663
+ | {
138664
+ /** ID of the action attempt. */
138665
+ action_attempt_id: string
138666
+ status: 'error'
138667
+ /** Result of the action attempt. Null for failed action attempts. */
138668
+ result: null
138669
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
138670
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
138671
+ /** Error associated with the action. */
138672
+ error: {
138673
+ /** Type of the error. */
138674
+ type: string
138675
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
138676
+ message: string
138677
+ }
138678
+ }
135127
138679
  | {
135128
138680
  /** ID of the action attempt. */
135129
138681
  action_attempt_id: string
@@ -137278,6 +140830,44 @@ export type Routes = {
137278
140830
  message: string
137279
140831
  }
137280
140832
  }
140833
+ | {
140834
+ /** ID of the action attempt. */
140835
+ action_attempt_id: string
140836
+ status: 'pending'
140837
+ /** Result of the action attempt. Null for pending action attempts. */
140838
+ result: null
140839
+ /** Errors associated with the action attempt. Null for pending action attempts. */
140840
+ error: null
140841
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
140842
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
140843
+ }
140844
+ | {
140845
+ /** ID of the action attempt. */
140846
+ action_attempt_id: string
140847
+ status: 'success'
140848
+ /** Errors associated with the action attempt. Null for successful action attempts. */
140849
+ error: null
140850
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
140851
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
140852
+ /** Result of the action. */
140853
+ result: {}
140854
+ }
140855
+ | {
140856
+ /** ID of the action attempt. */
140857
+ action_attempt_id: string
140858
+ status: 'error'
140859
+ /** Result of the action attempt. Null for failed action attempts. */
140860
+ result: null
140861
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
140862
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
140863
+ /** Error associated with the action. */
140864
+ error: {
140865
+ /** Type of the error. */
140866
+ type: string
140867
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
140868
+ message: string
140869
+ }
140870
+ }
137281
140871
  | {
137282
140872
  /** ID of the action attempt. */
137283
140873
  action_attempt_id: string
@@ -139548,6 +143138,44 @@ export type Routes = {
139548
143138
  message: string
139549
143139
  }
139550
143140
  }
143141
+ | {
143142
+ /** ID of the action attempt. */
143143
+ action_attempt_id: string
143144
+ status: 'pending'
143145
+ /** Result of the action attempt. Null for pending action attempts. */
143146
+ result: null
143147
+ /** Errors associated with the action attempt. Null for pending action attempts. */
143148
+ error: null
143149
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
143150
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
143151
+ }
143152
+ | {
143153
+ /** ID of the action attempt. */
143154
+ action_attempt_id: string
143155
+ status: 'success'
143156
+ /** Errors associated with the action attempt. Null for successful action attempts. */
143157
+ error: null
143158
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
143159
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
143160
+ /** Result of the action. */
143161
+ result: {}
143162
+ }
143163
+ | {
143164
+ /** ID of the action attempt. */
143165
+ action_attempt_id: string
143166
+ status: 'error'
143167
+ /** Result of the action attempt. Null for failed action attempts. */
143168
+ result: null
143169
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
143170
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
143171
+ /** Error associated with the action. */
143172
+ error: {
143173
+ /** Type of the error. */
143174
+ type: string
143175
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
143176
+ message: string
143177
+ }
143178
+ }
139551
143179
  | {
139552
143180
  /** ID of the action attempt. */
139553
143181
  action_attempt_id: string
@@ -140686,7 +144314,7 @@ export type Routes = {
140686
144314
  | 'smartthings_thermostat'
140687
144315
  )
140688
144316
  | ('ios_phone' | 'android_phone')
140689
- | ('ring_camera' | 'tapo_camera')
144317
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
140690
144318
  /** IDs of the spaces the device is in. */
140691
144319
  space_ids: string[]
140692
144320
  /** Optional nickname to describe the device, settable through Seam. */
@@ -141494,6 +145122,24 @@ export type Routes = {
141494
145122
  | undefined
141495
145123
  )
141496
145124
  | undefined
145125
+ /** Metadata for an Arlo camera. */
145126
+ arlo_metadata?:
145127
+ | (
145128
+ | {
145129
+ /** Device ID reported by Arlo. */
145130
+ device_id?: (string | undefined) | undefined
145131
+ /** Device name reported by Arlo. */
145132
+ device_name?: (string | undefined) | undefined
145133
+ /** Model ID reported by Arlo. */
145134
+ model_id?: (string | undefined) | undefined
145135
+ /** Hardware version reported by Arlo. */
145136
+ hardware_version?: (string | undefined) | undefined
145137
+ /** Firmware version reported by Arlo. */
145138
+ firmware_version?: (string | undefined) | undefined
145139
+ }
145140
+ | undefined
145141
+ )
145142
+ | undefined
141497
145143
  /** Metadata for a Ring device. */
141498
145144
  ring_metadata?:
141499
145145
  | {
@@ -142512,6 +146158,8 @@ export type Routes = {
142512
146158
  can_hvac_heat_cool?: boolean | undefined
142513
146159
  /** Indicates whether the thermostat can be turned off. */
142514
146160
  can_turn_off_hvac?: boolean | undefined
146161
+ /** 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. */
146162
+ can_activate_weekly_program?: boolean | undefined
142515
146163
  /** Indicates whether the device supports simulating removal in a sandbox. */
142516
146164
  can_simulate_removal?: boolean | undefined
142517
146165
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -142589,7 +146237,7 @@ export type Routes = {
142589
146237
  | 'smartthings_thermostat'
142590
146238
  )
142591
146239
  | ('ios_phone' | 'android_phone')
142592
- | ('ring_camera' | 'tapo_camera')
146240
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
142593
146241
  /** IDs of the spaces the device is in. */
142594
146242
  space_ids: string[]
142595
146243
  /** Optional nickname to describe the device, settable through Seam. */
@@ -143397,6 +147045,24 @@ export type Routes = {
143397
147045
  | undefined
143398
147046
  )
143399
147047
  | undefined
147048
+ /** Metadata for an Arlo camera. */
147049
+ arlo_metadata?:
147050
+ | (
147051
+ | {
147052
+ /** Device ID reported by Arlo. */
147053
+ device_id?: (string | undefined) | undefined
147054
+ /** Device name reported by Arlo. */
147055
+ device_name?: (string | undefined) | undefined
147056
+ /** Model ID reported by Arlo. */
147057
+ model_id?: (string | undefined) | undefined
147058
+ /** Hardware version reported by Arlo. */
147059
+ hardware_version?: (string | undefined) | undefined
147060
+ /** Firmware version reported by Arlo. */
147061
+ firmware_version?: (string | undefined) | undefined
147062
+ }
147063
+ | undefined
147064
+ )
147065
+ | undefined
143400
147066
  /** Metadata for a Ring device. */
143401
147067
  ring_metadata?:
143402
147068
  | {
@@ -144415,6 +148081,8 @@ export type Routes = {
144415
148081
  can_hvac_heat_cool?: boolean | undefined
144416
148082
  /** Indicates whether the thermostat can be turned off. */
144417
148083
  can_turn_off_hvac?: boolean | undefined
148084
+ /** 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. */
148085
+ can_activate_weekly_program?: boolean | undefined
144418
148086
  /** Indicates whether the device supports simulating removal in a sandbox. */
144419
148087
  can_simulate_removal?: boolean | undefined
144420
148088
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -146030,7 +149698,7 @@ export type Routes = {
146030
149698
  | 'smartthings_thermostat'
146031
149699
  )
146032
149700
  | ('ios_phone' | 'android_phone')
146033
- | ('ring_camera' | 'tapo_camera')
149701
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
146034
149702
  /** IDs of the spaces the device is in. */
146035
149703
  space_ids: string[]
146036
149704
  /** Optional nickname to describe the device, settable through Seam. */
@@ -146863,6 +150531,24 @@ export type Routes = {
146863
150531
  | undefined
146864
150532
  )
146865
150533
  | undefined
150534
+ /** Metadata for an Arlo camera. */
150535
+ arlo_metadata?:
150536
+ | (
150537
+ | {
150538
+ /** Device ID reported by Arlo. */
150539
+ device_id?: (string | undefined) | undefined
150540
+ /** Device name reported by Arlo. */
150541
+ device_name?: (string | undefined) | undefined
150542
+ /** Model ID reported by Arlo. */
150543
+ model_id?: (string | undefined) | undefined
150544
+ /** Hardware version reported by Arlo. */
150545
+ hardware_version?: (string | undefined) | undefined
150546
+ /** Firmware version reported by Arlo. */
150547
+ firmware_version?: (string | undefined) | undefined
150548
+ }
150549
+ | undefined
150550
+ )
150551
+ | undefined
146866
150552
  /** Metadata for a Ring device. */
146867
150553
  ring_metadata?:
146868
150554
  | {
@@ -147907,6 +151593,8 @@ export type Routes = {
147907
151593
  can_hvac_heat_cool?: boolean | undefined
147908
151594
  /** Indicates whether the thermostat can be turned off. */
147909
151595
  can_turn_off_hvac?: boolean | undefined
151596
+ /** 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. */
151597
+ can_activate_weekly_program?: boolean | undefined
147910
151598
  /** Indicates whether the device supports simulating removal in a sandbox. */
147911
151599
  can_simulate_removal?: boolean | undefined
147912
151600
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -150636,6 +154324,44 @@ export type Routes = {
150636
154324
  message: string
150637
154325
  }
150638
154326
  }
154327
+ | {
154328
+ /** ID of the action attempt. */
154329
+ action_attempt_id: string
154330
+ status: 'pending'
154331
+ /** Result of the action attempt. Null for pending action attempts. */
154332
+ result: null
154333
+ /** Errors associated with the action attempt. Null for pending action attempts. */
154334
+ error: null
154335
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
154336
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
154337
+ }
154338
+ | {
154339
+ /** ID of the action attempt. */
154340
+ action_attempt_id: string
154341
+ status: 'success'
154342
+ /** Errors associated with the action attempt. Null for successful action attempts. */
154343
+ error: null
154344
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
154345
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
154346
+ /** Result of the action. */
154347
+ result: {}
154348
+ }
154349
+ | {
154350
+ /** ID of the action attempt. */
154351
+ action_attempt_id: string
154352
+ status: 'error'
154353
+ /** Result of the action attempt. Null for failed action attempts. */
154354
+ result: null
154355
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
154356
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
154357
+ /** Error associated with the action. */
154358
+ error: {
154359
+ /** Type of the error. */
154360
+ type: string
154361
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
154362
+ message: string
154363
+ }
154364
+ }
150639
154365
  | {
150640
154366
  /** ID of the action attempt. */
150641
154367
  action_attempt_id: string
@@ -151669,7 +155395,7 @@ export type Routes = {
151669
155395
  | 'smartthings_thermostat'
151670
155396
  )
151671
155397
  | ('ios_phone' | 'android_phone')
151672
- | ('ring_camera' | 'tapo_camera')
155398
+ | ('ring_camera' | 'tapo_camera' | 'arlo_camera')
151673
155399
  /** Unique identifier for the account associated with the device. */
151674
155400
  connected_account_id: string
151675
155401
  /** Location information for the device. */
@@ -152188,6 +155914,8 @@ export type Routes = {
152188
155914
  can_hvac_heat_cool?: boolean | undefined
152189
155915
  /** Indicates whether the thermostat can be turned off. */
152190
155916
  can_turn_off_hvac?: boolean | undefined
155917
+ /** 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. */
155918
+ can_activate_weekly_program?: boolean | undefined
152191
155919
  /** Indicates whether the device supports simulating removal in a sandbox. */
152192
155920
  can_simulate_removal?: boolean | undefined
152193
155921
  /** Indicates whether the device supports simulating connection in a sandbox. */
@@ -160157,6 +163885,44 @@ export type Routes = {
160157
163885
  message: string
160158
163886
  }
160159
163887
  }
163888
+ | {
163889
+ /** ID of the action attempt. */
163890
+ action_attempt_id: string
163891
+ status: 'pending'
163892
+ /** Result of the action attempt. Null for pending action attempts. */
163893
+ result: null
163894
+ /** Errors associated with the action attempt. Null for pending action attempts. */
163895
+ error: null
163896
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
163897
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
163898
+ }
163899
+ | {
163900
+ /** ID of the action attempt. */
163901
+ action_attempt_id: string
163902
+ status: 'success'
163903
+ /** Errors associated with the action attempt. Null for successful action attempts. */
163904
+ error: null
163905
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
163906
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
163907
+ /** Result of the action. */
163908
+ result: {}
163909
+ }
163910
+ | {
163911
+ /** ID of the action attempt. */
163912
+ action_attempt_id: string
163913
+ status: 'error'
163914
+ /** Result of the action attempt. Null for failed action attempts. */
163915
+ result: null
163916
+ /** Action attempt to track the status of returning a thermostat to its weekly program. */
163917
+ action_type: 'ACTIVATE_WEEKLY_PROGRAM'
163918
+ /** Error associated with the action. */
163919
+ error: {
163920
+ /** Type of the error. */
163921
+ type: string
163922
+ /** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
163923
+ message: string
163924
+ }
163925
+ }
160160
163926
  | {
160161
163927
  /** ID of the action attempt. */
160162
163928
  action_attempt_id: string