@seamapi/types 1.1081.0 → 1.1082.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +75 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js +2 -0
- package/lib/seam/connect/models/action-attempts/action-attempt.js.map +1 -1
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.d.ts +77 -0
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.js +31 -0
- package/lib/seam/connect/models/action-attempts/activate-weekly-program.js.map +1 -0
- package/lib/seam/connect/models/devices/device-provider.d.ts +3 -0
- package/lib/seam/connect/models/devices/device.d.ts +6 -0
- package/lib/seam/connect/models/devices/device.js +3 -0
- package/lib/seam/connect/models/devices/device.js.map +1 -1
- package/lib/seam/connect/models/devices/unmanaged-device.d.ts +4 -0
- package/lib/seam/connect/openapi.js +184 -0
- package/lib/seam/connect/openapi.js.map +1 -1
- package/lib/seam/connect/route-types.d.ts +3258 -214
- package/package.json +1 -1
- package/src/lib/seam/connect/models/action-attempts/action-attempt.ts +2 -0
- package/src/lib/seam/connect/models/action-attempts/activate-weekly-program.ts +46 -0
- package/src/lib/seam/connect/models/devices/device.ts +5 -0
- package/src/lib/seam/connect/openapi.ts +197 -0
- package/src/lib/seam/connect/route-types.ts +3674 -218
|
@@ -1710,6 +1710,44 @@ export type Routes = {
|
|
|
1710
1710
|
message: string
|
|
1711
1711
|
}
|
|
1712
1712
|
}
|
|
1713
|
+
| {
|
|
1714
|
+
/** ID of the action attempt. */
|
|
1715
|
+
action_attempt_id: string
|
|
1716
|
+
status: 'pending'
|
|
1717
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
1718
|
+
result: null
|
|
1719
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
1720
|
+
error: null
|
|
1721
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
1722
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
1723
|
+
}
|
|
1724
|
+
| {
|
|
1725
|
+
/** ID of the action attempt. */
|
|
1726
|
+
action_attempt_id: string
|
|
1727
|
+
status: 'success'
|
|
1728
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
1729
|
+
error: null
|
|
1730
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
1731
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
1732
|
+
/** Result of the action. */
|
|
1733
|
+
result: {}
|
|
1734
|
+
}
|
|
1735
|
+
| {
|
|
1736
|
+
/** ID of the action attempt. */
|
|
1737
|
+
action_attempt_id: string
|
|
1738
|
+
status: 'error'
|
|
1739
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
1740
|
+
result: null
|
|
1741
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
1742
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
1743
|
+
/** Error associated with the action. */
|
|
1744
|
+
error: {
|
|
1745
|
+
/** Type of the error. */
|
|
1746
|
+
type: string
|
|
1747
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
1748
|
+
message: string
|
|
1749
|
+
}
|
|
1750
|
+
}
|
|
1713
1751
|
| {
|
|
1714
1752
|
/** ID of the action attempt. */
|
|
1715
1753
|
action_attempt_id: string
|
|
@@ -4970,6 +5008,44 @@ export type Routes = {
|
|
|
4970
5008
|
message: string
|
|
4971
5009
|
}
|
|
4972
5010
|
}
|
|
5011
|
+
| {
|
|
5012
|
+
/** ID of the action attempt. */
|
|
5013
|
+
action_attempt_id: string
|
|
5014
|
+
status: 'pending'
|
|
5015
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
5016
|
+
result: null
|
|
5017
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
5018
|
+
error: null
|
|
5019
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
5020
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
5021
|
+
}
|
|
5022
|
+
| {
|
|
5023
|
+
/** ID of the action attempt. */
|
|
5024
|
+
action_attempt_id: string
|
|
5025
|
+
status: 'success'
|
|
5026
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
5027
|
+
error: null
|
|
5028
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
5029
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
5030
|
+
/** Result of the action. */
|
|
5031
|
+
result: {}
|
|
5032
|
+
}
|
|
5033
|
+
| {
|
|
5034
|
+
/** ID of the action attempt. */
|
|
5035
|
+
action_attempt_id: string
|
|
5036
|
+
status: 'error'
|
|
5037
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
5038
|
+
result: null
|
|
5039
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
5040
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
5041
|
+
/** Error associated with the action. */
|
|
5042
|
+
error: {
|
|
5043
|
+
/** Type of the error. */
|
|
5044
|
+
type: string
|
|
5045
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
5046
|
+
message: string
|
|
5047
|
+
}
|
|
5048
|
+
}
|
|
4973
5049
|
| {
|
|
4974
5050
|
/** ID of the action attempt. */
|
|
4975
5051
|
action_attempt_id: string
|
|
@@ -10019,6 +10095,44 @@ export type Routes = {
|
|
|
10019
10095
|
message: string
|
|
10020
10096
|
}
|
|
10021
10097
|
}
|
|
10098
|
+
| {
|
|
10099
|
+
/** ID of the action attempt. */
|
|
10100
|
+
action_attempt_id: string
|
|
10101
|
+
status: 'pending'
|
|
10102
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
10103
|
+
result: null
|
|
10104
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
10105
|
+
error: null
|
|
10106
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
10107
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
10108
|
+
}
|
|
10109
|
+
| {
|
|
10110
|
+
/** ID of the action attempt. */
|
|
10111
|
+
action_attempt_id: string
|
|
10112
|
+
status: 'success'
|
|
10113
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
10114
|
+
error: null
|
|
10115
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
10116
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
10117
|
+
/** Result of the action. */
|
|
10118
|
+
result: {}
|
|
10119
|
+
}
|
|
10120
|
+
| {
|
|
10121
|
+
/** ID of the action attempt. */
|
|
10122
|
+
action_attempt_id: string
|
|
10123
|
+
status: 'error'
|
|
10124
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
10125
|
+
result: null
|
|
10126
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
10127
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
10128
|
+
/** Error associated with the action. */
|
|
10129
|
+
error: {
|
|
10130
|
+
/** Type of the error. */
|
|
10131
|
+
type: string
|
|
10132
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
10133
|
+
message: string
|
|
10134
|
+
}
|
|
10135
|
+
}
|
|
10022
10136
|
| {
|
|
10023
10137
|
/** ID of the action attempt. */
|
|
10024
10138
|
action_attempt_id: string
|
|
@@ -13130,6 +13244,44 @@ export type Routes = {
|
|
|
13130
13244
|
message: string
|
|
13131
13245
|
}
|
|
13132
13246
|
}
|
|
13247
|
+
| {
|
|
13248
|
+
/** ID of the action attempt. */
|
|
13249
|
+
action_attempt_id: string
|
|
13250
|
+
status: 'pending'
|
|
13251
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
13252
|
+
result: null
|
|
13253
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
13254
|
+
error: null
|
|
13255
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
13256
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
13257
|
+
}
|
|
13258
|
+
| {
|
|
13259
|
+
/** ID of the action attempt. */
|
|
13260
|
+
action_attempt_id: string
|
|
13261
|
+
status: 'success'
|
|
13262
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
13263
|
+
error: null
|
|
13264
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
13265
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
13266
|
+
/** Result of the action. */
|
|
13267
|
+
result: {}
|
|
13268
|
+
}
|
|
13269
|
+
| {
|
|
13270
|
+
/** ID of the action attempt. */
|
|
13271
|
+
action_attempt_id: string
|
|
13272
|
+
status: 'error'
|
|
13273
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
13274
|
+
result: null
|
|
13275
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
13276
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
13277
|
+
/** Error associated with the action. */
|
|
13278
|
+
error: {
|
|
13279
|
+
/** Type of the error. */
|
|
13280
|
+
type: string
|
|
13281
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
13282
|
+
message: string
|
|
13283
|
+
}
|
|
13284
|
+
}
|
|
13133
13285
|
| {
|
|
13134
13286
|
/** ID of the action attempt. */
|
|
13135
13287
|
action_attempt_id: string
|
|
@@ -16133,6 +16285,8 @@ export type Routes = {
|
|
|
16133
16285
|
can_hvac_heat_cool?: boolean | undefined
|
|
16134
16286
|
/** Indicates whether the thermostat can be turned off. */
|
|
16135
16287
|
can_turn_off_hvac?: boolean | undefined
|
|
16288
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
16289
|
+
can_activate_weekly_program?: boolean | undefined
|
|
16136
16290
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
16137
16291
|
can_simulate_removal?: boolean | undefined
|
|
16138
16292
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -19886,6 +20040,44 @@ export type Routes = {
|
|
|
19886
20040
|
message: string
|
|
19887
20041
|
}
|
|
19888
20042
|
}
|
|
20043
|
+
| {
|
|
20044
|
+
/** ID of the action attempt. */
|
|
20045
|
+
action_attempt_id: string
|
|
20046
|
+
status: 'pending'
|
|
20047
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
20048
|
+
result: null
|
|
20049
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
20050
|
+
error: null
|
|
20051
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
20052
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
20053
|
+
}
|
|
20054
|
+
| {
|
|
20055
|
+
/** ID of the action attempt. */
|
|
20056
|
+
action_attempt_id: string
|
|
20057
|
+
status: 'success'
|
|
20058
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
20059
|
+
error: null
|
|
20060
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
20061
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
20062
|
+
/** Result of the action. */
|
|
20063
|
+
result: {}
|
|
20064
|
+
}
|
|
20065
|
+
| {
|
|
20066
|
+
/** ID of the action attempt. */
|
|
20067
|
+
action_attempt_id: string
|
|
20068
|
+
status: 'error'
|
|
20069
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
20070
|
+
result: null
|
|
20071
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
20072
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
20073
|
+
/** Error associated with the action. */
|
|
20074
|
+
error: {
|
|
20075
|
+
/** Type of the error. */
|
|
20076
|
+
type: string
|
|
20077
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
20078
|
+
message: string
|
|
20079
|
+
}
|
|
20080
|
+
}
|
|
19889
20081
|
| {
|
|
19890
20082
|
/** ID of the action attempt. */
|
|
19891
20083
|
action_attempt_id: string
|
|
@@ -22026,6 +22218,44 @@ export type Routes = {
|
|
|
22026
22218
|
message: string
|
|
22027
22219
|
}
|
|
22028
22220
|
}
|
|
22221
|
+
| {
|
|
22222
|
+
/** ID of the action attempt. */
|
|
22223
|
+
action_attempt_id: string
|
|
22224
|
+
status: 'pending'
|
|
22225
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
22226
|
+
result: null
|
|
22227
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
22228
|
+
error: null
|
|
22229
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
22230
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
22231
|
+
}
|
|
22232
|
+
| {
|
|
22233
|
+
/** ID of the action attempt. */
|
|
22234
|
+
action_attempt_id: string
|
|
22235
|
+
status: 'success'
|
|
22236
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
22237
|
+
error: null
|
|
22238
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
22239
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
22240
|
+
/** Result of the action. */
|
|
22241
|
+
result: {}
|
|
22242
|
+
}
|
|
22243
|
+
| {
|
|
22244
|
+
/** ID of the action attempt. */
|
|
22245
|
+
action_attempt_id: string
|
|
22246
|
+
status: 'error'
|
|
22247
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
22248
|
+
result: null
|
|
22249
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
22250
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
22251
|
+
/** Error associated with the action. */
|
|
22252
|
+
error: {
|
|
22253
|
+
/** Type of the error. */
|
|
22254
|
+
type: string
|
|
22255
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
22256
|
+
message: string
|
|
22257
|
+
}
|
|
22258
|
+
}
|
|
22029
22259
|
| {
|
|
22030
22260
|
/** ID of the action attempt. */
|
|
22031
22261
|
action_attempt_id: string
|
|
@@ -24671,6 +24901,8 @@ export type Routes = {
|
|
|
24671
24901
|
can_hvac_heat_cool?: boolean | undefined
|
|
24672
24902
|
/** Indicates whether the thermostat can be turned off. */
|
|
24673
24903
|
can_turn_off_hvac?: boolean | undefined
|
|
24904
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
24905
|
+
can_activate_weekly_program?: boolean | undefined
|
|
24674
24906
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
24675
24907
|
can_simulate_removal?: boolean | undefined
|
|
24676
24908
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -27449,6 +27681,44 @@ export type Routes = {
|
|
|
27449
27681
|
message: string
|
|
27450
27682
|
}
|
|
27451
27683
|
}
|
|
27684
|
+
| {
|
|
27685
|
+
/** ID of the action attempt. */
|
|
27686
|
+
action_attempt_id: string
|
|
27687
|
+
status: 'pending'
|
|
27688
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
27689
|
+
result: null
|
|
27690
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
27691
|
+
error: null
|
|
27692
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
27693
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
27694
|
+
}
|
|
27695
|
+
| {
|
|
27696
|
+
/** ID of the action attempt. */
|
|
27697
|
+
action_attempt_id: string
|
|
27698
|
+
status: 'success'
|
|
27699
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
27700
|
+
error: null
|
|
27701
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
27702
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
27703
|
+
/** Result of the action. */
|
|
27704
|
+
result: {}
|
|
27705
|
+
}
|
|
27706
|
+
| {
|
|
27707
|
+
/** ID of the action attempt. */
|
|
27708
|
+
action_attempt_id: string
|
|
27709
|
+
status: 'error'
|
|
27710
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
27711
|
+
result: null
|
|
27712
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
27713
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
27714
|
+
/** Error associated with the action. */
|
|
27715
|
+
error: {
|
|
27716
|
+
/** Type of the error. */
|
|
27717
|
+
type: string
|
|
27718
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
27719
|
+
message: string
|
|
27720
|
+
}
|
|
27721
|
+
}
|
|
27452
27722
|
| {
|
|
27453
27723
|
/** ID of the action attempt. */
|
|
27454
27724
|
action_attempt_id: string
|
|
@@ -33705,6 +33975,44 @@ export type Routes = {
|
|
|
33705
33975
|
message: string
|
|
33706
33976
|
}
|
|
33707
33977
|
}
|
|
33978
|
+
| {
|
|
33979
|
+
/** ID of the action attempt. */
|
|
33980
|
+
action_attempt_id: string
|
|
33981
|
+
status: 'pending'
|
|
33982
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
33983
|
+
result: null
|
|
33984
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
33985
|
+
error: null
|
|
33986
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
33987
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
33988
|
+
}
|
|
33989
|
+
| {
|
|
33990
|
+
/** ID of the action attempt. */
|
|
33991
|
+
action_attempt_id: string
|
|
33992
|
+
status: 'success'
|
|
33993
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
33994
|
+
error: null
|
|
33995
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
33996
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
33997
|
+
/** Result of the action. */
|
|
33998
|
+
result: {}
|
|
33999
|
+
}
|
|
34000
|
+
| {
|
|
34001
|
+
/** ID of the action attempt. */
|
|
34002
|
+
action_attempt_id: string
|
|
34003
|
+
status: 'error'
|
|
34004
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
34005
|
+
result: null
|
|
34006
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
34007
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
34008
|
+
/** Error associated with the action. */
|
|
34009
|
+
error: {
|
|
34010
|
+
/** Type of the error. */
|
|
34011
|
+
type: string
|
|
34012
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
34013
|
+
message: string
|
|
34014
|
+
}
|
|
34015
|
+
}
|
|
33708
34016
|
| {
|
|
33709
34017
|
/** ID of the action attempt. */
|
|
33710
34018
|
action_attempt_id: string
|
|
@@ -35933,6 +36241,44 @@ export type Routes = {
|
|
|
35933
36241
|
message: string
|
|
35934
36242
|
}
|
|
35935
36243
|
}
|
|
36244
|
+
| {
|
|
36245
|
+
/** ID of the action attempt. */
|
|
36246
|
+
action_attempt_id: string
|
|
36247
|
+
status: 'pending'
|
|
36248
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
36249
|
+
result: null
|
|
36250
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
36251
|
+
error: null
|
|
36252
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
36253
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
36254
|
+
}
|
|
36255
|
+
| {
|
|
36256
|
+
/** ID of the action attempt. */
|
|
36257
|
+
action_attempt_id: string
|
|
36258
|
+
status: 'success'
|
|
36259
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
36260
|
+
error: null
|
|
36261
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
36262
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
36263
|
+
/** Result of the action. */
|
|
36264
|
+
result: {}
|
|
36265
|
+
}
|
|
36266
|
+
| {
|
|
36267
|
+
/** ID of the action attempt. */
|
|
36268
|
+
action_attempt_id: string
|
|
36269
|
+
status: 'error'
|
|
36270
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
36271
|
+
result: null
|
|
36272
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
36273
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
36274
|
+
/** Error associated with the action. */
|
|
36275
|
+
error: {
|
|
36276
|
+
/** Type of the error. */
|
|
36277
|
+
type: string
|
|
36278
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
36279
|
+
message: string
|
|
36280
|
+
}
|
|
36281
|
+
}
|
|
35936
36282
|
| {
|
|
35937
36283
|
/** ID of the action attempt. */
|
|
35938
36284
|
action_attempt_id: string
|
|
@@ -38060,6 +38406,44 @@ export type Routes = {
|
|
|
38060
38406
|
message: string
|
|
38061
38407
|
}
|
|
38062
38408
|
}
|
|
38409
|
+
| {
|
|
38410
|
+
/** ID of the action attempt. */
|
|
38411
|
+
action_attempt_id: string
|
|
38412
|
+
status: 'pending'
|
|
38413
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
38414
|
+
result: null
|
|
38415
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
38416
|
+
error: null
|
|
38417
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
38418
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
38419
|
+
}
|
|
38420
|
+
| {
|
|
38421
|
+
/** ID of the action attempt. */
|
|
38422
|
+
action_attempt_id: string
|
|
38423
|
+
status: 'success'
|
|
38424
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
38425
|
+
error: null
|
|
38426
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
38427
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
38428
|
+
/** Result of the action. */
|
|
38429
|
+
result: {}
|
|
38430
|
+
}
|
|
38431
|
+
| {
|
|
38432
|
+
/** ID of the action attempt. */
|
|
38433
|
+
action_attempt_id: string
|
|
38434
|
+
status: 'error'
|
|
38435
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
38436
|
+
result: null
|
|
38437
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
38438
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
38439
|
+
/** Error associated with the action. */
|
|
38440
|
+
error: {
|
|
38441
|
+
/** Type of the error. */
|
|
38442
|
+
type: string
|
|
38443
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
38444
|
+
message: string
|
|
38445
|
+
}
|
|
38446
|
+
}
|
|
38063
38447
|
| {
|
|
38064
38448
|
/** ID of the action attempt. */
|
|
38065
38449
|
action_attempt_id: string
|
|
@@ -41072,6 +41456,44 @@ export type Routes = {
|
|
|
41072
41456
|
message: string
|
|
41073
41457
|
}
|
|
41074
41458
|
}
|
|
41459
|
+
| {
|
|
41460
|
+
/** ID of the action attempt. */
|
|
41461
|
+
action_attempt_id: string
|
|
41462
|
+
status: 'pending'
|
|
41463
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
41464
|
+
result: null
|
|
41465
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
41466
|
+
error: null
|
|
41467
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
41468
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
41469
|
+
}
|
|
41470
|
+
| {
|
|
41471
|
+
/** ID of the action attempt. */
|
|
41472
|
+
action_attempt_id: string
|
|
41473
|
+
status: 'success'
|
|
41474
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
41475
|
+
error: null
|
|
41476
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
41477
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
41478
|
+
/** Result of the action. */
|
|
41479
|
+
result: {}
|
|
41480
|
+
}
|
|
41481
|
+
| {
|
|
41482
|
+
/** ID of the action attempt. */
|
|
41483
|
+
action_attempt_id: string
|
|
41484
|
+
status: 'error'
|
|
41485
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
41486
|
+
result: null
|
|
41487
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
41488
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
41489
|
+
/** Error associated with the action. */
|
|
41490
|
+
error: {
|
|
41491
|
+
/** Type of the error. */
|
|
41492
|
+
type: string
|
|
41493
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
41494
|
+
message: string
|
|
41495
|
+
}
|
|
41496
|
+
}
|
|
41075
41497
|
| {
|
|
41076
41498
|
/** ID of the action attempt. */
|
|
41077
41499
|
action_attempt_id: string
|
|
@@ -45998,6 +46420,44 @@ export type Routes = {
|
|
|
45998
46420
|
message: string
|
|
45999
46421
|
}
|
|
46000
46422
|
}
|
|
46423
|
+
| {
|
|
46424
|
+
/** ID of the action attempt. */
|
|
46425
|
+
action_attempt_id: string
|
|
46426
|
+
status: 'pending'
|
|
46427
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
46428
|
+
result: null
|
|
46429
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
46430
|
+
error: null
|
|
46431
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
46432
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
46433
|
+
}
|
|
46434
|
+
| {
|
|
46435
|
+
/** ID of the action attempt. */
|
|
46436
|
+
action_attempt_id: string
|
|
46437
|
+
status: 'success'
|
|
46438
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
46439
|
+
error: null
|
|
46440
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
46441
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
46442
|
+
/** Result of the action. */
|
|
46443
|
+
result: {}
|
|
46444
|
+
}
|
|
46445
|
+
| {
|
|
46446
|
+
/** ID of the action attempt. */
|
|
46447
|
+
action_attempt_id: string
|
|
46448
|
+
status: 'error'
|
|
46449
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
46450
|
+
result: null
|
|
46451
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
46452
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
46453
|
+
/** Error associated with the action. */
|
|
46454
|
+
error: {
|
|
46455
|
+
/** Type of the error. */
|
|
46456
|
+
type: string
|
|
46457
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
46458
|
+
message: string
|
|
46459
|
+
}
|
|
46460
|
+
}
|
|
46001
46461
|
| {
|
|
46002
46462
|
/** ID of the action attempt. */
|
|
46003
46463
|
action_attempt_id: string
|
|
@@ -48115,6 +48575,44 @@ export type Routes = {
|
|
|
48115
48575
|
message: string
|
|
48116
48576
|
}
|
|
48117
48577
|
}
|
|
48578
|
+
| {
|
|
48579
|
+
/** ID of the action attempt. */
|
|
48580
|
+
action_attempt_id: string
|
|
48581
|
+
status: 'pending'
|
|
48582
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
48583
|
+
result: null
|
|
48584
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
48585
|
+
error: null
|
|
48586
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
48587
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
48588
|
+
}
|
|
48589
|
+
| {
|
|
48590
|
+
/** ID of the action attempt. */
|
|
48591
|
+
action_attempt_id: string
|
|
48592
|
+
status: 'success'
|
|
48593
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
48594
|
+
error: null
|
|
48595
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
48596
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
48597
|
+
/** Result of the action. */
|
|
48598
|
+
result: {}
|
|
48599
|
+
}
|
|
48600
|
+
| {
|
|
48601
|
+
/** ID of the action attempt. */
|
|
48602
|
+
action_attempt_id: string
|
|
48603
|
+
status: 'error'
|
|
48604
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
48605
|
+
result: null
|
|
48606
|
+
/** Action attempt to track the status of returning a thermostat to its weekly program. */
|
|
48607
|
+
action_type: 'ACTIVATE_WEEKLY_PROGRAM'
|
|
48608
|
+
/** Error associated with the action. */
|
|
48609
|
+
error: {
|
|
48610
|
+
/** Type of the error. */
|
|
48611
|
+
type: string
|
|
48612
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
48613
|
+
message: string
|
|
48614
|
+
}
|
|
48615
|
+
}
|
|
48118
48616
|
| {
|
|
48119
48617
|
/** ID of the action attempt. */
|
|
48120
48618
|
action_attempt_id: string
|
|
@@ -53059,6 +53557,8 @@ export type Routes = {
|
|
|
53059
53557
|
can_hvac_heat_cool?: boolean | undefined
|
|
53060
53558
|
/** Indicates whether the thermostat can be turned off. */
|
|
53061
53559
|
can_turn_off_hvac?: boolean | undefined
|
|
53560
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
53561
|
+
can_activate_weekly_program?: boolean | undefined
|
|
53062
53562
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
53063
53563
|
can_simulate_removal?: boolean | undefined
|
|
53064
53564
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -53290,6 +53790,7 @@ export type Routes = {
|
|
|
53290
53790
|
| 'can_hvac_cool'
|
|
53291
53791
|
| 'can_hvac_heat_cool'
|
|
53292
53792
|
| 'can_turn_off_hvac'
|
|
53793
|
+
| 'can_activate_weekly_program'
|
|
53293
53794
|
| 'can_simulate_removal'
|
|
53294
53795
|
| 'can_simulate_connection'
|
|
53295
53796
|
| 'can_simulate_disconnection'
|
|
@@ -53315,6 +53816,7 @@ export type Routes = {
|
|
|
53315
53816
|
| 'can_hvac_cool'
|
|
53316
53817
|
| 'can_hvac_heat_cool'
|
|
53317
53818
|
| 'can_turn_off_hvac'
|
|
53819
|
+
| 'can_activate_weekly_program'
|
|
53318
53820
|
| 'can_simulate_removal'
|
|
53319
53821
|
| 'can_simulate_connection'
|
|
53320
53822
|
| 'can_simulate_disconnection'
|
|
@@ -55232,6 +55734,8 @@ export type Routes = {
|
|
|
55232
55734
|
can_hvac_heat_cool?: boolean | undefined
|
|
55233
55735
|
/** Indicates whether the thermostat can be turned off. */
|
|
55234
55736
|
can_turn_off_hvac?: boolean | undefined
|
|
55737
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
55738
|
+
can_activate_weekly_program?: boolean | undefined
|
|
55235
55739
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
55236
55740
|
can_simulate_removal?: boolean | undefined
|
|
55237
55741
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -55393,6 +55897,8 @@ export type Routes = {
|
|
|
55393
55897
|
can_hvac_heat_cool?: boolean | undefined
|
|
55394
55898
|
/** Indicates whether the thermostat can be turned off. */
|
|
55395
55899
|
can_turn_off_hvac?: boolean | undefined
|
|
55900
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
55901
|
+
can_activate_weekly_program?: boolean | undefined
|
|
55396
55902
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
55397
55903
|
can_simulate_removal?: boolean | undefined
|
|
55398
55904
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -57406,6 +57912,8 @@ export type Routes = {
|
|
|
57406
57912
|
can_hvac_heat_cool?: boolean | undefined
|
|
57407
57913
|
/** Indicates whether the thermostat can be turned off. */
|
|
57408
57914
|
can_turn_off_hvac?: boolean | undefined
|
|
57915
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
57916
|
+
can_activate_weekly_program?: boolean | undefined
|
|
57409
57917
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
57410
57918
|
can_simulate_removal?: boolean | undefined
|
|
57411
57919
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -57627,6 +58135,7 @@ export type Routes = {
|
|
|
57627
58135
|
| 'can_hvac_cool'
|
|
57628
58136
|
| 'can_hvac_heat_cool'
|
|
57629
58137
|
| 'can_turn_off_hvac'
|
|
58138
|
+
| 'can_activate_weekly_program'
|
|
57630
58139
|
| 'can_simulate_removal'
|
|
57631
58140
|
| 'can_simulate_connection'
|
|
57632
58141
|
| 'can_simulate_disconnection'
|
|
@@ -57652,6 +58161,7 @@ export type Routes = {
|
|
|
57652
58161
|
| 'can_hvac_cool'
|
|
57653
58162
|
| 'can_hvac_heat_cool'
|
|
57654
58163
|
| 'can_turn_off_hvac'
|
|
58164
|
+
| 'can_activate_weekly_program'
|
|
57655
58165
|
| 'can_simulate_removal'
|
|
57656
58166
|
| 'can_simulate_connection'
|
|
57657
58167
|
| 'can_simulate_disconnection'
|
|
@@ -58241,6 +58751,8 @@ export type Routes = {
|
|
|
58241
58751
|
can_hvac_heat_cool?: boolean | undefined
|
|
58242
58752
|
/** Indicates whether the thermostat can be turned off. */
|
|
58243
58753
|
can_turn_off_hvac?: boolean | undefined
|
|
58754
|
+
/** Indicates whether the thermostat can be returned to its weekly program, the schedule that is configured on the device itself, releasing any hold that Seam has set. */
|
|
58755
|
+
can_activate_weekly_program?: boolean | undefined
|
|
58244
58756
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
58245
58757
|
can_simulate_removal?: boolean | undefined
|
|
58246
58758
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -68419,6 +68931,44 @@ export type Routes = {
|
|
|
68419
68931
|
message: string
|
|
68420
68932
|
}
|
|
68421
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
|
+
}
|
|
68422
68972
|
| {
|
|
68423
68973
|
/** ID of the action attempt. */
|
|
68424
68974
|
action_attempt_id: string
|
|
@@ -70769,6 +71319,8 @@ export type Routes = {
|
|
|
70769
71319
|
can_hvac_heat_cool?: boolean | undefined
|
|
70770
71320
|
/** Indicates whether the thermostat can be turned off. */
|
|
70771
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
|
|
70772
71324
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
70773
71325
|
can_simulate_removal?: boolean | undefined
|
|
70774
71326
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -72689,6 +73241,8 @@ export type Routes = {
|
|
|
72689
73241
|
can_hvac_heat_cool?: boolean | undefined
|
|
72690
73242
|
/** Indicates whether the thermostat can be turned off. */
|
|
72691
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
|
|
72692
73246
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
72693
73247
|
can_simulate_removal?: boolean | undefined
|
|
72694
73248
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -74738,6 +75292,8 @@ export type Routes = {
|
|
|
74738
75292
|
can_hvac_heat_cool?: boolean | undefined
|
|
74739
75293
|
/** Indicates whether the thermostat can be turned off. */
|
|
74740
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
|
|
74741
75297
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
74742
75298
|
can_simulate_removal?: boolean | undefined
|
|
74743
75299
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -76657,6 +77213,8 @@ export type Routes = {
|
|
|
76657
77213
|
can_hvac_heat_cool?: boolean | undefined
|
|
76658
77214
|
/** Indicates whether the thermostat can be turned off. */
|
|
76659
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
|
|
76660
77218
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
76661
77219
|
can_simulate_removal?: boolean | undefined
|
|
76662
77220
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -78361,6 +78919,44 @@ export type Routes = {
|
|
|
78361
78919
|
message: string
|
|
78362
78920
|
}
|
|
78363
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
|
+
}
|
|
78364
78960
|
| {
|
|
78365
78961
|
/** ID of the action attempt. */
|
|
78366
78962
|
action_attempt_id: string
|
|
@@ -80479,6 +81075,44 @@ export type Routes = {
|
|
|
80479
81075
|
message: string
|
|
80480
81076
|
}
|
|
80481
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
|
+
}
|
|
80482
81116
|
| {
|
|
80483
81117
|
/** ID of the action attempt. */
|
|
80484
81118
|
action_attempt_id: string
|
|
@@ -82595,6 +83229,44 @@ export type Routes = {
|
|
|
82595
83229
|
message: string
|
|
82596
83230
|
}
|
|
82597
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
|
+
}
|
|
82598
83270
|
| {
|
|
82599
83271
|
/** ID of the action attempt. */
|
|
82600
83272
|
action_attempt_id: string
|
|
@@ -84713,6 +85385,44 @@ export type Routes = {
|
|
|
84713
85385
|
message: string
|
|
84714
85386
|
}
|
|
84715
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
|
+
}
|
|
84716
85426
|
| {
|
|
84717
85427
|
/** ID of the action attempt. */
|
|
84718
85428
|
action_attempt_id: string
|
|
@@ -87070,6 +87780,8 @@ export type Routes = {
|
|
|
87070
87780
|
can_hvac_heat_cool?: boolean | undefined
|
|
87071
87781
|
/** Indicates whether the thermostat can be turned off. */
|
|
87072
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
|
|
87073
87785
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
87074
87786
|
can_simulate_removal?: boolean | undefined
|
|
87075
87787
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -88989,6 +89701,8 @@ export type Routes = {
|
|
|
88989
89701
|
can_hvac_heat_cool?: boolean | undefined
|
|
88990
89702
|
/** Indicates whether the thermostat can be turned off. */
|
|
88991
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
|
|
88992
89706
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
88993
89707
|
can_simulate_removal?: boolean | undefined
|
|
88994
89708
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -90703,6 +91417,44 @@ export type Routes = {
|
|
|
90703
91417
|
message: string
|
|
90704
91418
|
}
|
|
90705
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
|
+
}
|
|
90706
91458
|
| {
|
|
90707
91459
|
/** ID of the action attempt. */
|
|
90708
91460
|
action_attempt_id: string
|
|
@@ -92840,6 +93592,44 @@ export type Routes = {
|
|
|
92840
93592
|
message: string
|
|
92841
93593
|
}
|
|
92842
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
|
+
}
|
|
92843
93633
|
| {
|
|
92844
93634
|
/** ID of the action attempt. */
|
|
92845
93635
|
action_attempt_id: string
|
|
@@ -95033,6 +95823,44 @@ export type Routes = {
|
|
|
95033
95823
|
message: string
|
|
95034
95824
|
}
|
|
95035
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
|
+
}
|
|
95036
95864
|
| {
|
|
95037
95865
|
/** ID of the action attempt. */
|
|
95038
95866
|
action_attempt_id: string
|
|
@@ -99120,6 +99948,44 @@ export type Routes = {
|
|
|
99120
99948
|
message: string
|
|
99121
99949
|
}
|
|
99122
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
|
+
}
|
|
99123
99989
|
| {
|
|
99124
99990
|
/** ID of the action attempt. */
|
|
99125
99991
|
action_attempt_id: string
|
|
@@ -113713,6 +114579,8 @@ export type Routes = {
|
|
|
113713
114579
|
can_hvac_heat_cool?: boolean | undefined
|
|
113714
114580
|
/** Indicates whether the thermostat can be turned off. */
|
|
113715
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
|
|
113716
114584
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
113717
114585
|
can_simulate_removal?: boolean | undefined
|
|
113718
114586
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -114597,235 +115465,2391 @@ export type Routes = {
|
|
|
114597
115465
|
)[]
|
|
114598
115466
|
/** ID of the customization profile associated with the access method. */
|
|
114599
115467
|
customization_profile_id?: string | undefined
|
|
114600
|
-
}[]
|
|
114601
|
-
| undefined
|
|
114602
|
-
}
|
|
114603
|
-
}
|
|
114604
|
-
maxDuration: undefined
|
|
114605
|
-
}
|
|
114606
|
-
'/spaces/list': {
|
|
114607
|
-
route: '/spaces/list'
|
|
114608
|
-
method: 'GET' | 'POST'
|
|
114609
|
-
queryParams: {}
|
|
114610
|
-
jsonBody: {}
|
|
114611
|
-
commonParams: {
|
|
114612
|
-
/** Customer key for which you want to list spaces. */
|
|
114613
|
-
customer_key?: string | undefined
|
|
114614
|
-
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
|
|
114615
|
-
search?: string | undefined
|
|
114616
|
-
/** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
|
|
114617
|
-
connected_account_id?: string | undefined
|
|
114618
|
-
/** Filter spaces by space_key. */
|
|
114619
|
-
space_key?: string | undefined
|
|
114620
|
-
/** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
|
|
114621
|
-
parent_space_id?: string | undefined
|
|
114622
|
-
/** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
|
|
114623
|
-
parent_space_key?: string | undefined
|
|
114624
|
-
/** Maximum number of records to return per page. */
|
|
114625
|
-
limit?: number
|
|
114626
|
-
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
114627
|
-
page_cursor?: (string | undefined) | null
|
|
114628
|
-
}
|
|
114629
|
-
formData: {}
|
|
114630
|
-
jsonResponse: {
|
|
114631
|
-
spaces: {
|
|
114632
|
-
/** ID of the space. */
|
|
114633
|
-
space_id: string
|
|
114634
|
-
/** ID of the workspace associated with the space. */
|
|
114635
|
-
workspace_id: string
|
|
114636
|
-
/** Unique key for the space within the workspace. */
|
|
114637
|
-
space_key?: string | undefined
|
|
114638
|
-
/** Name of the space. */
|
|
114639
|
-
name: string
|
|
114640
|
-
/** Display name for the space. */
|
|
114641
|
-
display_name: string
|
|
114642
|
-
/** Date and time at which the space was created. */
|
|
114643
|
-
created_at: string
|
|
114644
|
-
/** Number of devices in the space. */
|
|
114645
|
-
device_count: number
|
|
114646
|
-
/** Number of entrances in the space. */
|
|
114647
|
-
acs_entrance_count: number
|
|
114648
|
-
/** Customer key associated with the space. */
|
|
114649
|
-
customer_key?: string | undefined
|
|
114650
|
-
/** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
|
|
114651
|
-
customer_data?:
|
|
114652
|
-
| {
|
|
114653
|
-
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
114654
|
-
time_zone?: (string | null) | undefined
|
|
114655
|
-
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
114656
|
-
default_checkin_time?: (string | null) | undefined
|
|
114657
|
-
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
114658
|
-
default_checkout_time?: (string | null) | undefined
|
|
114659
|
-
/** Postal address for the space. */
|
|
114660
|
-
address?: (string | null) | undefined
|
|
115468
|
+
}[]
|
|
115469
|
+
| undefined
|
|
115470
|
+
}
|
|
115471
|
+
}
|
|
115472
|
+
maxDuration: undefined
|
|
115473
|
+
}
|
|
115474
|
+
'/spaces/list': {
|
|
115475
|
+
route: '/spaces/list'
|
|
115476
|
+
method: 'GET' | 'POST'
|
|
115477
|
+
queryParams: {}
|
|
115478
|
+
jsonBody: {}
|
|
115479
|
+
commonParams: {
|
|
115480
|
+
/** Customer key for which you want to list spaces. */
|
|
115481
|
+
customer_key?: string | undefined
|
|
115482
|
+
/** String for which to search. Filters returned spaces to include all records that satisfy a partial match using `name`, `space_key`, or `customer_key`. */
|
|
115483
|
+
search?: string | undefined
|
|
115484
|
+
/** Filter spaces to only include those that contain devices or access control systems belonging to the specified connected account. */
|
|
115485
|
+
connected_account_id?: string | undefined
|
|
115486
|
+
/** Filter spaces by space_key. */
|
|
115487
|
+
space_key?: string | undefined
|
|
115488
|
+
/** Filter spaces to only include those whose parent space has the specified `parent_space_id`. */
|
|
115489
|
+
parent_space_id?: string | undefined
|
|
115490
|
+
/** Filter spaces to only include those whose parent space has the specified `parent_space_key`. */
|
|
115491
|
+
parent_space_key?: string | undefined
|
|
115492
|
+
/** Maximum number of records to return per page. */
|
|
115493
|
+
limit?: number
|
|
115494
|
+
/** Identifies the specific page of results to return, obtained from the previous page's `next_page_cursor`. */
|
|
115495
|
+
page_cursor?: (string | undefined) | null
|
|
115496
|
+
}
|
|
115497
|
+
formData: {}
|
|
115498
|
+
jsonResponse: {
|
|
115499
|
+
spaces: {
|
|
115500
|
+
/** ID of the space. */
|
|
115501
|
+
space_id: string
|
|
115502
|
+
/** ID of the workspace associated with the space. */
|
|
115503
|
+
workspace_id: string
|
|
115504
|
+
/** Unique key for the space within the workspace. */
|
|
115505
|
+
space_key?: string | undefined
|
|
115506
|
+
/** Name of the space. */
|
|
115507
|
+
name: string
|
|
115508
|
+
/** Display name for the space. */
|
|
115509
|
+
display_name: string
|
|
115510
|
+
/** Date and time at which the space was created. */
|
|
115511
|
+
created_at: string
|
|
115512
|
+
/** Number of devices in the space. */
|
|
115513
|
+
device_count: number
|
|
115514
|
+
/** Number of entrances in the space. */
|
|
115515
|
+
acs_entrance_count: number
|
|
115516
|
+
/** Customer key associated with the space. */
|
|
115517
|
+
customer_key?: string | undefined
|
|
115518
|
+
/** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
|
|
115519
|
+
customer_data?:
|
|
115520
|
+
| {
|
|
115521
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
115522
|
+
time_zone?: (string | null) | undefined
|
|
115523
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
115524
|
+
default_checkin_time?: (string | null) | undefined
|
|
115525
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
115526
|
+
default_checkout_time?: (string | null) | undefined
|
|
115527
|
+
/** Postal address for the space. */
|
|
115528
|
+
address?: (string | null) | undefined
|
|
115529
|
+
}
|
|
115530
|
+
| undefined
|
|
115531
|
+
/** Geographic coordinates (latitude and longitude) of the space. */
|
|
115532
|
+
geolocation?:
|
|
115533
|
+
| ({
|
|
115534
|
+
/** Latitude of the space, in decimal degrees. */
|
|
115535
|
+
latitude: number
|
|
115536
|
+
/** Longitude of the space, in decimal degrees. */
|
|
115537
|
+
longitude: number
|
|
115538
|
+
} | null)
|
|
115539
|
+
| undefined
|
|
115540
|
+
/** */
|
|
115541
|
+
parent_space_id?: string | undefined
|
|
115542
|
+
/** */
|
|
115543
|
+
parent_space_key?: string | undefined
|
|
115544
|
+
}[]
|
|
115545
|
+
/** Information about the current page of results. */
|
|
115546
|
+
pagination: {
|
|
115547
|
+
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
115548
|
+
next_page_cursor: string | null
|
|
115549
|
+
/** Indicates whether there is another page of results after this one. */
|
|
115550
|
+
has_next_page: boolean
|
|
115551
|
+
/** URL to get the next page of results. */
|
|
115552
|
+
next_page_url: string | null
|
|
115553
|
+
}
|
|
115554
|
+
}
|
|
115555
|
+
maxDuration: undefined
|
|
115556
|
+
}
|
|
115557
|
+
'/spaces/remove_acs_entrances': {
|
|
115558
|
+
route: '/spaces/remove_acs_entrances'
|
|
115559
|
+
method: 'POST' | 'DELETE'
|
|
115560
|
+
queryParams: {}
|
|
115561
|
+
jsonBody: {}
|
|
115562
|
+
commonParams: {
|
|
115563
|
+
/** ID of the space from which you want to remove entrances. */
|
|
115564
|
+
space_id: string
|
|
115565
|
+
/** IDs of the entrances that you want to remove from the space. */
|
|
115566
|
+
acs_entrance_ids: string[]
|
|
115567
|
+
}
|
|
115568
|
+
formData: {}
|
|
115569
|
+
jsonResponse: {}
|
|
115570
|
+
maxDuration: undefined
|
|
115571
|
+
}
|
|
115572
|
+
'/spaces/remove_connected_account': {
|
|
115573
|
+
route: '/spaces/remove_connected_account'
|
|
115574
|
+
method: 'POST' | 'DELETE'
|
|
115575
|
+
queryParams: {}
|
|
115576
|
+
jsonBody: {}
|
|
115577
|
+
commonParams: {
|
|
115578
|
+
/** ID of the space from which you want to remove the connected account. */
|
|
115579
|
+
space_id: string
|
|
115580
|
+
/** ID of the connected account that you want to remove from the space. */
|
|
115581
|
+
connected_account_id: string
|
|
115582
|
+
}
|
|
115583
|
+
formData: {}
|
|
115584
|
+
jsonResponse: {}
|
|
115585
|
+
maxDuration: undefined
|
|
115586
|
+
}
|
|
115587
|
+
'/spaces/remove_devices': {
|
|
115588
|
+
route: '/spaces/remove_devices'
|
|
115589
|
+
method: 'POST' | 'DELETE'
|
|
115590
|
+
queryParams: {}
|
|
115591
|
+
jsonBody: {}
|
|
115592
|
+
commonParams: {
|
|
115593
|
+
/** ID of the space from which you want to remove devices. */
|
|
115594
|
+
space_id: string
|
|
115595
|
+
/** IDs of the devices that you want to remove from the space. */
|
|
115596
|
+
device_ids: string[]
|
|
115597
|
+
}
|
|
115598
|
+
formData: {}
|
|
115599
|
+
jsonResponse: {}
|
|
115600
|
+
maxDuration: undefined
|
|
115601
|
+
}
|
|
115602
|
+
'/spaces/update': {
|
|
115603
|
+
route: '/spaces/update'
|
|
115604
|
+
method: 'POST' | 'PATCH'
|
|
115605
|
+
queryParams: {}
|
|
115606
|
+
jsonBody: {
|
|
115607
|
+
/** Name of the space. */
|
|
115608
|
+
name?: string | undefined
|
|
115609
|
+
/** ID of the space that you want to update. */
|
|
115610
|
+
space_id?: string | undefined
|
|
115611
|
+
/** Unique key of the space that you want to update. */
|
|
115612
|
+
space_key?: string | undefined
|
|
115613
|
+
/** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
|
|
115614
|
+
device_ids?: string[] | undefined
|
|
115615
|
+
/** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
|
|
115616
|
+
acs_entrance_ids?: string[] | undefined
|
|
115617
|
+
/** Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it. */
|
|
115618
|
+
customer_data?:
|
|
115619
|
+
| {
|
|
115620
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
115621
|
+
time_zone?: (string | null) | undefined
|
|
115622
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
115623
|
+
default_checkin_time?: (string | null) | undefined
|
|
115624
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
115625
|
+
default_checkout_time?: (string | null) | undefined
|
|
115626
|
+
/** Postal address for the space. */
|
|
115627
|
+
address?: (string | null) | undefined
|
|
115628
|
+
}
|
|
115629
|
+
| undefined
|
|
115630
|
+
/** Reassign this space to the parent space (site) with this `parent_space_id`. */
|
|
115631
|
+
parent_space_id?: string | undefined
|
|
115632
|
+
/** Reassign this space to the parent space (site) with this `parent_space_key`. */
|
|
115633
|
+
parent_space_key?: string | undefined
|
|
115634
|
+
}
|
|
115635
|
+
commonParams: {}
|
|
115636
|
+
formData: {}
|
|
115637
|
+
jsonResponse: {
|
|
115638
|
+
/** Represents a space that is a logical grouping of devices and entrances. You can assign access to an entire space, thereby making granting access more efficient. */
|
|
115639
|
+
space: {
|
|
115640
|
+
/** ID of the space. */
|
|
115641
|
+
space_id: string
|
|
115642
|
+
/** ID of the workspace associated with the space. */
|
|
115643
|
+
workspace_id: string
|
|
115644
|
+
/** Unique key for the space within the workspace. */
|
|
115645
|
+
space_key?: string | undefined
|
|
115646
|
+
/** Name of the space. */
|
|
115647
|
+
name: string
|
|
115648
|
+
/** Display name for the space. */
|
|
115649
|
+
display_name: string
|
|
115650
|
+
/** Date and time at which the space was created. */
|
|
115651
|
+
created_at: string
|
|
115652
|
+
/** Number of devices in the space. */
|
|
115653
|
+
device_count: number
|
|
115654
|
+
/** Number of entrances in the space. */
|
|
115655
|
+
acs_entrance_count: number
|
|
115656
|
+
/** Customer key associated with the space. */
|
|
115657
|
+
customer_key?: string | undefined
|
|
115658
|
+
/** Reservation/stay-related defaults for the space. Also carries the provider/PMS-supplied name under a `<connector_type>_name` key (e.g. `guesty_name`), which Seam preserves when you rename the space (read-only — managed by Seam). */
|
|
115659
|
+
customer_data?:
|
|
115660
|
+
| {
|
|
115661
|
+
/** IANA time zone for the space, e.g. America/Los_Angeles. */
|
|
115662
|
+
time_zone?: (string | null) | undefined
|
|
115663
|
+
/** Default check-in time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
115664
|
+
default_checkin_time?: (string | null) | undefined
|
|
115665
|
+
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
115666
|
+
default_checkout_time?: (string | null) | undefined
|
|
115667
|
+
/** Postal address for the space. */
|
|
115668
|
+
address?: (string | null) | undefined
|
|
115669
|
+
}
|
|
115670
|
+
| undefined
|
|
115671
|
+
/** Geographic coordinates (latitude and longitude) of the space. */
|
|
115672
|
+
geolocation?:
|
|
115673
|
+
| ({
|
|
115674
|
+
/** Latitude of the space, in decimal degrees. */
|
|
115675
|
+
latitude: number
|
|
115676
|
+
/** Longitude of the space, in decimal degrees. */
|
|
115677
|
+
longitude: number
|
|
115678
|
+
} | null)
|
|
115679
|
+
| undefined
|
|
115680
|
+
/** */
|
|
115681
|
+
parent_space_id?: string | undefined
|
|
115682
|
+
/** */
|
|
115683
|
+
parent_space_key?: string | undefined
|
|
115684
|
+
}
|
|
115685
|
+
}
|
|
115686
|
+
maxDuration: undefined
|
|
115687
|
+
}
|
|
115688
|
+
'/thermostats/activate_climate_preset': {
|
|
115689
|
+
route: '/thermostats/activate_climate_preset'
|
|
115690
|
+
method: 'POST'
|
|
115691
|
+
queryParams: {}
|
|
115692
|
+
jsonBody: {
|
|
115693
|
+
/** ID of the thermostat device for which you want to activate a climate preset. */
|
|
115694
|
+
device_id: string
|
|
115695
|
+
/** Climate preset key of the climate preset that you want to activate. */
|
|
115696
|
+
climate_preset_key: string
|
|
115697
|
+
}
|
|
115698
|
+
commonParams: {}
|
|
115699
|
+
formData: {}
|
|
115700
|
+
jsonResponse: {
|
|
115701
|
+
/** 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.
|
|
115702
|
+
|
|
115703
|
+
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.
|
|
115704
|
+
|
|
115705
|
+
See also [Action Attempts](https://www.seam.co/docs/core-concepts/action-attempts). */
|
|
115706
|
+
action_attempt:
|
|
115707
|
+
| {
|
|
115708
|
+
/** ID of the action attempt. */
|
|
115709
|
+
action_attempt_id: string
|
|
115710
|
+
status: 'pending'
|
|
115711
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
115712
|
+
result: null
|
|
115713
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
115714
|
+
error: null
|
|
115715
|
+
/** Action attempt to track the status of locking a door. */
|
|
115716
|
+
action_type: 'LOCK_DOOR'
|
|
115717
|
+
}
|
|
115718
|
+
| {
|
|
115719
|
+
/** ID of the action attempt. */
|
|
115720
|
+
action_attempt_id: string
|
|
115721
|
+
status: 'success'
|
|
115722
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
115723
|
+
error: null
|
|
115724
|
+
/** Action attempt to track the status of locking a door. */
|
|
115725
|
+
action_type: 'LOCK_DOOR'
|
|
115726
|
+
/** Result of the action. */
|
|
115727
|
+
result: {
|
|
115728
|
+
/** Indicates whether the device confirmed that the lock action occurred. */
|
|
115729
|
+
was_confirmed_by_device?: boolean | undefined
|
|
115730
|
+
}
|
|
115731
|
+
}
|
|
115732
|
+
| {
|
|
115733
|
+
/** ID of the action attempt. */
|
|
115734
|
+
action_attempt_id: string
|
|
115735
|
+
status: 'error'
|
|
115736
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
115737
|
+
result: null
|
|
115738
|
+
/** Action attempt to track the status of locking a door. */
|
|
115739
|
+
action_type: 'LOCK_DOOR'
|
|
115740
|
+
/** Error associated with the action. */
|
|
115741
|
+
error: {
|
|
115742
|
+
/** Type of the error. */
|
|
115743
|
+
type: string
|
|
115744
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
115745
|
+
message: string
|
|
115746
|
+
}
|
|
115747
|
+
}
|
|
115748
|
+
| {
|
|
115749
|
+
/** ID of the action attempt. */
|
|
115750
|
+
action_attempt_id: string
|
|
115751
|
+
status: 'pending'
|
|
115752
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
115753
|
+
result: null
|
|
115754
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
115755
|
+
error: null
|
|
115756
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
115757
|
+
action_type: 'UNLOCK_DOOR'
|
|
115758
|
+
}
|
|
115759
|
+
| {
|
|
115760
|
+
/** ID of the action attempt. */
|
|
115761
|
+
action_attempt_id: string
|
|
115762
|
+
status: 'success'
|
|
115763
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
115764
|
+
error: null
|
|
115765
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
115766
|
+
action_type: 'UNLOCK_DOOR'
|
|
115767
|
+
/** Result of the action. */
|
|
115768
|
+
result: {
|
|
115769
|
+
/** Indicates whether the device confirmed that the unlock action occurred. */
|
|
115770
|
+
was_confirmed_by_device?: boolean | undefined
|
|
115771
|
+
}
|
|
115772
|
+
}
|
|
115773
|
+
| {
|
|
115774
|
+
/** ID of the action attempt. */
|
|
115775
|
+
action_attempt_id: string
|
|
115776
|
+
status: 'error'
|
|
115777
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
115778
|
+
result: null
|
|
115779
|
+
/** Action attempt to track the status of unlocking a door. */
|
|
115780
|
+
action_type: 'UNLOCK_DOOR'
|
|
115781
|
+
/** Error associated with the action. */
|
|
115782
|
+
error: {
|
|
115783
|
+
/** Type of the error. */
|
|
115784
|
+
type: string
|
|
115785
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
115786
|
+
message: string
|
|
115787
|
+
}
|
|
115788
|
+
}
|
|
115789
|
+
| {
|
|
115790
|
+
/** ID of the action attempt. */
|
|
115791
|
+
action_attempt_id: string
|
|
115792
|
+
status: 'pending'
|
|
115793
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
115794
|
+
result: null
|
|
115795
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
115796
|
+
error: null
|
|
115797
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
115798
|
+
action_type: 'SCAN_CREDENTIAL'
|
|
115799
|
+
}
|
|
115800
|
+
| {
|
|
115801
|
+
/** ID of the action attempt. */
|
|
115802
|
+
action_attempt_id: string
|
|
115803
|
+
status: 'success'
|
|
115804
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
115805
|
+
error: null
|
|
115806
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
115807
|
+
action_type: 'SCAN_CREDENTIAL'
|
|
115808
|
+
/** 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. */
|
|
115809
|
+
result: {
|
|
115810
|
+
/** Snapshot of credential data read from the physical encoder. */
|
|
115811
|
+
acs_credential_on_encoder: {
|
|
115812
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
115813
|
+
created_at: string | null
|
|
115814
|
+
/** Indicates whether the credential has been issued (encoded onto a card). */
|
|
115815
|
+
is_issued: boolean | null
|
|
115816
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) becomes usable. */
|
|
115817
|
+
starts_at: string | null
|
|
115818
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) will stop being usable. */
|
|
115819
|
+
ends_at: string | null
|
|
115820
|
+
/** 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). */
|
|
115821
|
+
card_number: string | null
|
|
115822
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115823
|
+
visionline_metadata?:
|
|
115824
|
+
| {
|
|
115825
|
+
/** Card ID for the Visionline card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115826
|
+
card_id?: (string | undefined) | undefined
|
|
115827
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is cancelled. */
|
|
115828
|
+
cancelled?: (boolean | undefined) | undefined
|
|
115829
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is discarded. */
|
|
115830
|
+
discarded?: (boolean | undefined) | undefined
|
|
115831
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is expired. */
|
|
115832
|
+
expired?: (boolean | undefined) | undefined
|
|
115833
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overwritten. */
|
|
115834
|
+
overwritten?: (boolean | undefined) | undefined
|
|
115835
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is overridden. */
|
|
115836
|
+
overridden?: (boolean | undefined) | undefined
|
|
115837
|
+
/** Indicates whether the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) is pending auto-update. */
|
|
115838
|
+
pending_auto_update?: (boolean | undefined) | undefined
|
|
115839
|
+
/** Format of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115840
|
+
card_format?:
|
|
115841
|
+
(('TLCode' | 'rfid48') | undefined) | undefined
|
|
115842
|
+
/** Holder of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115843
|
+
card_holder?: (string | undefined) | undefined
|
|
115844
|
+
/** Number of issued cards associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115845
|
+
number_of_issued_cards?: (number | undefined) | undefined
|
|
115846
|
+
/** 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). */
|
|
115847
|
+
guest_acs_entrance_ids?:
|
|
115848
|
+
(string[] | undefined) | undefined
|
|
115849
|
+
/** 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). */
|
|
115850
|
+
common_acs_entrance_ids?:
|
|
115851
|
+
(string[] | undefined) | undefined
|
|
115852
|
+
}
|
|
115853
|
+
| undefined
|
|
115854
|
+
} | null
|
|
115855
|
+
/** Corresponding credential data as stored on Seam and the access system. */
|
|
115856
|
+
acs_credential_on_seam:
|
|
115857
|
+
| (
|
|
115858
|
+
| {
|
|
115859
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115860
|
+
acs_credential_id: string
|
|
115861
|
+
/** 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. */
|
|
115862
|
+
acs_user_id?: string | undefined
|
|
115863
|
+
/** 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. */
|
|
115864
|
+
user_identity_id?: string | undefined
|
|
115865
|
+
/** 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. */
|
|
115866
|
+
connected_account_id: string
|
|
115867
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
115868
|
+
acs_credential_pool_id?: string | undefined
|
|
115869
|
+
/** 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). */
|
|
115870
|
+
acs_system_id: string
|
|
115871
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115872
|
+
parent_acs_credential_id?: string | undefined
|
|
115873
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
115874
|
+
display_name: string
|
|
115875
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115876
|
+
code?: (string | undefined) | null
|
|
115877
|
+
/** 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. */
|
|
115878
|
+
is_one_time_use?: boolean | undefined
|
|
115879
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115880
|
+
card_number?: (string | undefined) | null
|
|
115881
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
115882
|
+
is_issued?: boolean | undefined
|
|
115883
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
115884
|
+
issued_at?: (string | undefined) | null
|
|
115885
|
+
/** 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`. */
|
|
115886
|
+
access_method:
|
|
115887
|
+
'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
115888
|
+
/** 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`. */
|
|
115889
|
+
external_type?:
|
|
115890
|
+
| (
|
|
115891
|
+
| 'pti_card'
|
|
115892
|
+
| 'brivo_credential'
|
|
115893
|
+
| 'hid_credential'
|
|
115894
|
+
| 'visionline_card'
|
|
115895
|
+
| 'salto_ks_credential'
|
|
115896
|
+
| 'assa_abloy_vostio_key'
|
|
115897
|
+
| 'salto_space_key'
|
|
115898
|
+
| 'latch_access'
|
|
115899
|
+
| 'dormakaba_ambiance_credential'
|
|
115900
|
+
| 'hotek_card'
|
|
115901
|
+
| 'salto_ks_tag'
|
|
115902
|
+
| 'avigilon_alta_credential'
|
|
115903
|
+
| 'kisi_credential'
|
|
115904
|
+
| 'akiles_credential'
|
|
115905
|
+
)
|
|
115906
|
+
| undefined
|
|
115907
|
+
/** 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. */
|
|
115908
|
+
external_type_display_name?: string | undefined
|
|
115909
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
115910
|
+
created_at: string
|
|
115911
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115912
|
+
workspace_id: string
|
|
115913
|
+
/** 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. */
|
|
115914
|
+
starts_at?: string | undefined
|
|
115915
|
+
/** 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`. */
|
|
115916
|
+
ends_at?: string | undefined
|
|
115917
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115918
|
+
errors: {
|
|
115919
|
+
error_code: string
|
|
115920
|
+
message: string
|
|
115921
|
+
/** Date and time at which Seam created the error. */
|
|
115922
|
+
created_at: string
|
|
115923
|
+
}[]
|
|
115924
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115925
|
+
warnings: (
|
|
115926
|
+
| {
|
|
115927
|
+
/** Date and time at which Seam created the warning. */
|
|
115928
|
+
created_at: string
|
|
115929
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
115930
|
+
message: string
|
|
115931
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
115932
|
+
warning_code: 'waiting_to_be_issued'
|
|
115933
|
+
}
|
|
115934
|
+
| {
|
|
115935
|
+
/** Date and time at which Seam created the warning. */
|
|
115936
|
+
created_at: string
|
|
115937
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
115938
|
+
message: string
|
|
115939
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
115940
|
+
warning_code: 'schedule_externally_modified'
|
|
115941
|
+
}
|
|
115942
|
+
| {
|
|
115943
|
+
/** Date and time at which Seam created the warning. */
|
|
115944
|
+
created_at: string
|
|
115945
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
115946
|
+
message: string
|
|
115947
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
115948
|
+
warning_code: 'schedule_modified'
|
|
115949
|
+
}
|
|
115950
|
+
| {
|
|
115951
|
+
/** Date and time at which Seam created the warning. */
|
|
115952
|
+
created_at: string
|
|
115953
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
115954
|
+
message: string
|
|
115955
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
115956
|
+
warning_code: 'being_deleted'
|
|
115957
|
+
}
|
|
115958
|
+
| {
|
|
115959
|
+
/** Date and time at which Seam created the warning. */
|
|
115960
|
+
created_at: string
|
|
115961
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
115962
|
+
message: string
|
|
115963
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
115964
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
115965
|
+
}
|
|
115966
|
+
| {
|
|
115967
|
+
/** Date and time at which Seam created the warning. */
|
|
115968
|
+
created_at: string
|
|
115969
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
115970
|
+
message: string
|
|
115971
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
115972
|
+
warning_code: 'needs_to_be_reissued'
|
|
115973
|
+
}
|
|
115974
|
+
| {
|
|
115975
|
+
/** Date and time at which Seam created the warning. */
|
|
115976
|
+
created_at: string
|
|
115977
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
115978
|
+
message: string
|
|
115979
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
115980
|
+
warning_code: 'requested_code_unavailable'
|
|
115981
|
+
/** The originally requested PIN code that could not be used. */
|
|
115982
|
+
original_code: string
|
|
115983
|
+
/** The PIN code that was assigned instead. */
|
|
115984
|
+
new_code: string
|
|
115985
|
+
}
|
|
115986
|
+
)[]
|
|
115987
|
+
/** 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). */
|
|
115988
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
115989
|
+
/** 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. */
|
|
115990
|
+
is_latest_desired_state_synced_with_provider?:
|
|
115991
|
+
(boolean | null) | undefined
|
|
115992
|
+
/** 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. */
|
|
115993
|
+
latest_desired_state_synced_with_provider_at?:
|
|
115994
|
+
(string | null) | undefined
|
|
115995
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
115996
|
+
visionline_metadata?:
|
|
115997
|
+
| {
|
|
115998
|
+
/** Card function type in the Visionline access system. */
|
|
115999
|
+
card_function_type?:
|
|
116000
|
+
(('guest' | 'staff') | undefined) | undefined
|
|
116001
|
+
/** IDs of the credentials to which you want to join. */
|
|
116002
|
+
joiner_acs_credential_ids?:
|
|
116003
|
+
(string[] | undefined) | undefined
|
|
116004
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
116005
|
+
guest_acs_entrance_ids?:
|
|
116006
|
+
(string[] | undefined) | undefined
|
|
116007
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
116008
|
+
common_acs_entrance_ids?:
|
|
116009
|
+
(string[] | undefined) | undefined
|
|
116010
|
+
/** Indicates whether the credential is valid. */
|
|
116011
|
+
is_valid?: (boolean | undefined) | undefined
|
|
116012
|
+
/** 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. */
|
|
116013
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116014
|
+
/** ID of the card in the Visionline access system. */
|
|
116015
|
+
card_id?: (string | undefined) | undefined
|
|
116016
|
+
/** ID of the credential in the Visionline access system. */
|
|
116017
|
+
credential_id?: (string | undefined) | undefined
|
|
116018
|
+
}
|
|
116019
|
+
| undefined
|
|
116020
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116021
|
+
assa_abloy_vostio_metadata?:
|
|
116022
|
+
| {
|
|
116023
|
+
/** 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. */
|
|
116024
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116025
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
116026
|
+
override_guest_acs_entrance_ids?:
|
|
116027
|
+
(string[] | undefined) | undefined
|
|
116028
|
+
/** Key ID in the Vostio access system. */
|
|
116029
|
+
key_id?: (string | undefined) | undefined
|
|
116030
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
116031
|
+
key_issuing_request_id?:
|
|
116032
|
+
(string | undefined) | undefined
|
|
116033
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
116034
|
+
door_names?: (string[] | undefined) | undefined
|
|
116035
|
+
/** Endpoint ID in the Vostio access system. */
|
|
116036
|
+
endpoint_id?: (string | undefined) | undefined
|
|
116037
|
+
}
|
|
116038
|
+
| undefined
|
|
116039
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116040
|
+
akiles_metadata?:
|
|
116041
|
+
| {
|
|
116042
|
+
/** ID of the Akiles member PIN. */
|
|
116043
|
+
member_pin_id?: (string | undefined) | undefined
|
|
116044
|
+
}
|
|
116045
|
+
| undefined
|
|
116046
|
+
/** Indicates whether Seam manages the credential. */
|
|
116047
|
+
is_managed: true
|
|
116048
|
+
}
|
|
116049
|
+
| {
|
|
116050
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116051
|
+
acs_credential_id: string
|
|
116052
|
+
/** 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. */
|
|
116053
|
+
acs_user_id?: string | undefined
|
|
116054
|
+
/** 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. */
|
|
116055
|
+
user_identity_id?: string | undefined
|
|
116056
|
+
/** 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. */
|
|
116057
|
+
connected_account_id: string
|
|
116058
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
116059
|
+
acs_credential_pool_id?: string | undefined
|
|
116060
|
+
/** 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). */
|
|
116061
|
+
acs_system_id: string
|
|
116062
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116063
|
+
parent_acs_credential_id?: string | undefined
|
|
116064
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
116065
|
+
display_name: string
|
|
116066
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116067
|
+
code?: (string | undefined) | null
|
|
116068
|
+
/** 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. */
|
|
116069
|
+
is_one_time_use?: boolean | undefined
|
|
116070
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116071
|
+
card_number?: (string | undefined) | null
|
|
116072
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
116073
|
+
is_issued?: boolean | undefined
|
|
116074
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
116075
|
+
issued_at?: (string | undefined) | null
|
|
116076
|
+
/** 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`. */
|
|
116077
|
+
access_method:
|
|
116078
|
+
'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
116079
|
+
/** 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`. */
|
|
116080
|
+
external_type?:
|
|
116081
|
+
| (
|
|
116082
|
+
| 'pti_card'
|
|
116083
|
+
| 'brivo_credential'
|
|
116084
|
+
| 'hid_credential'
|
|
116085
|
+
| 'visionline_card'
|
|
116086
|
+
| 'salto_ks_credential'
|
|
116087
|
+
| 'assa_abloy_vostio_key'
|
|
116088
|
+
| 'salto_space_key'
|
|
116089
|
+
| 'latch_access'
|
|
116090
|
+
| 'dormakaba_ambiance_credential'
|
|
116091
|
+
| 'hotek_card'
|
|
116092
|
+
| 'salto_ks_tag'
|
|
116093
|
+
| 'avigilon_alta_credential'
|
|
116094
|
+
| 'kisi_credential'
|
|
116095
|
+
| 'akiles_credential'
|
|
116096
|
+
)
|
|
116097
|
+
| undefined
|
|
116098
|
+
/** 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. */
|
|
116099
|
+
external_type_display_name?: string | undefined
|
|
116100
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
116101
|
+
created_at: string
|
|
116102
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116103
|
+
workspace_id: string
|
|
116104
|
+
/** 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. */
|
|
116105
|
+
starts_at?: string | undefined
|
|
116106
|
+
/** 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`. */
|
|
116107
|
+
ends_at?: string | undefined
|
|
116108
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116109
|
+
errors: {
|
|
116110
|
+
error_code: string
|
|
116111
|
+
message: string
|
|
116112
|
+
/** Date and time at which Seam created the error. */
|
|
116113
|
+
created_at: string
|
|
116114
|
+
}[]
|
|
116115
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116116
|
+
warnings: (
|
|
116117
|
+
| {
|
|
116118
|
+
/** Date and time at which Seam created the warning. */
|
|
116119
|
+
created_at: string
|
|
116120
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116121
|
+
message: string
|
|
116122
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116123
|
+
warning_code: 'waiting_to_be_issued'
|
|
116124
|
+
}
|
|
116125
|
+
| {
|
|
116126
|
+
/** Date and time at which Seam created the warning. */
|
|
116127
|
+
created_at: string
|
|
116128
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116129
|
+
message: string
|
|
116130
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116131
|
+
warning_code: 'schedule_externally_modified'
|
|
116132
|
+
}
|
|
116133
|
+
| {
|
|
116134
|
+
/** Date and time at which Seam created the warning. */
|
|
116135
|
+
created_at: string
|
|
116136
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116137
|
+
message: string
|
|
116138
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116139
|
+
warning_code: 'schedule_modified'
|
|
116140
|
+
}
|
|
116141
|
+
| {
|
|
116142
|
+
/** Date and time at which Seam created the warning. */
|
|
116143
|
+
created_at: string
|
|
116144
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116145
|
+
message: string
|
|
116146
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116147
|
+
warning_code: 'being_deleted'
|
|
116148
|
+
}
|
|
116149
|
+
| {
|
|
116150
|
+
/** Date and time at which Seam created the warning. */
|
|
116151
|
+
created_at: string
|
|
116152
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116153
|
+
message: string
|
|
116154
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116155
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
116156
|
+
}
|
|
116157
|
+
| {
|
|
116158
|
+
/** Date and time at which Seam created the warning. */
|
|
116159
|
+
created_at: string
|
|
116160
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116161
|
+
message: string
|
|
116162
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116163
|
+
warning_code: 'needs_to_be_reissued'
|
|
116164
|
+
}
|
|
116165
|
+
| {
|
|
116166
|
+
/** Date and time at which Seam created the warning. */
|
|
116167
|
+
created_at: string
|
|
116168
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116169
|
+
message: string
|
|
116170
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116171
|
+
warning_code: 'requested_code_unavailable'
|
|
116172
|
+
/** The originally requested PIN code that could not be used. */
|
|
116173
|
+
original_code: string
|
|
116174
|
+
/** The PIN code that was assigned instead. */
|
|
116175
|
+
new_code: string
|
|
116176
|
+
}
|
|
116177
|
+
)[]
|
|
116178
|
+
/** 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). */
|
|
116179
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
116180
|
+
/** 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. */
|
|
116181
|
+
is_latest_desired_state_synced_with_provider?:
|
|
116182
|
+
(boolean | null) | undefined
|
|
116183
|
+
/** 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. */
|
|
116184
|
+
latest_desired_state_synced_with_provider_at?:
|
|
116185
|
+
(string | null) | undefined
|
|
116186
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116187
|
+
visionline_metadata?:
|
|
116188
|
+
| {
|
|
116189
|
+
/** Card function type in the Visionline access system. */
|
|
116190
|
+
card_function_type?:
|
|
116191
|
+
(('guest' | 'staff') | undefined) | undefined
|
|
116192
|
+
/** IDs of the credentials to which you want to join. */
|
|
116193
|
+
joiner_acs_credential_ids?:
|
|
116194
|
+
(string[] | undefined) | undefined
|
|
116195
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
116196
|
+
guest_acs_entrance_ids?:
|
|
116197
|
+
(string[] | undefined) | undefined
|
|
116198
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
116199
|
+
common_acs_entrance_ids?:
|
|
116200
|
+
(string[] | undefined) | undefined
|
|
116201
|
+
/** Indicates whether the credential is valid. */
|
|
116202
|
+
is_valid?: (boolean | undefined) | undefined
|
|
116203
|
+
/** 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. */
|
|
116204
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116205
|
+
/** ID of the card in the Visionline access system. */
|
|
116206
|
+
card_id?: (string | undefined) | undefined
|
|
116207
|
+
/** ID of the credential in the Visionline access system. */
|
|
116208
|
+
credential_id?: (string | undefined) | undefined
|
|
116209
|
+
}
|
|
116210
|
+
| undefined
|
|
116211
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116212
|
+
assa_abloy_vostio_metadata?:
|
|
116213
|
+
| {
|
|
116214
|
+
/** 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. */
|
|
116215
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116216
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
116217
|
+
override_guest_acs_entrance_ids?:
|
|
116218
|
+
(string[] | undefined) | undefined
|
|
116219
|
+
/** Key ID in the Vostio access system. */
|
|
116220
|
+
key_id?: (string | undefined) | undefined
|
|
116221
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
116222
|
+
key_issuing_request_id?:
|
|
116223
|
+
(string | undefined) | undefined
|
|
116224
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
116225
|
+
door_names?: (string[] | undefined) | undefined
|
|
116226
|
+
/** Endpoint ID in the Vostio access system. */
|
|
116227
|
+
endpoint_id?: (string | undefined) | undefined
|
|
116228
|
+
}
|
|
116229
|
+
| undefined
|
|
116230
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116231
|
+
akiles_metadata?:
|
|
116232
|
+
| {
|
|
116233
|
+
/** ID of the Akiles member PIN. */
|
|
116234
|
+
member_pin_id?: (string | undefined) | undefined
|
|
116235
|
+
}
|
|
116236
|
+
| undefined
|
|
116237
|
+
is_managed: false
|
|
116238
|
+
}
|
|
116239
|
+
)
|
|
116240
|
+
| null
|
|
116241
|
+
/** 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. */
|
|
116242
|
+
warnings: {
|
|
116243
|
+
/** Indicates a warning related to scanning a credential. */
|
|
116244
|
+
warning_code:
|
|
116245
|
+
| 'acs_credential_on_encoder_out_of_sync'
|
|
116246
|
+
| 'acs_credential_on_seam_not_found'
|
|
116247
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116248
|
+
warning_message: string
|
|
116249
|
+
}[]
|
|
116250
|
+
}
|
|
116251
|
+
}
|
|
116252
|
+
| {
|
|
116253
|
+
/** ID of the action attempt. */
|
|
116254
|
+
action_attempt_id: string
|
|
116255
|
+
status: 'error'
|
|
116256
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
116257
|
+
result: null
|
|
116258
|
+
/** Action attempt to track the status of scanning a credential. */
|
|
116259
|
+
action_type: 'SCAN_CREDENTIAL'
|
|
116260
|
+
error:
|
|
116261
|
+
| {
|
|
116262
|
+
/** Type of the error associated with the action attempt. */
|
|
116263
|
+
type: 'uncategorized_error'
|
|
116264
|
+
/** Message for the error associated with the action attempt. */
|
|
116265
|
+
message: string
|
|
116266
|
+
}
|
|
116267
|
+
| {
|
|
116268
|
+
/** Type of the error associated with the action attempt. */
|
|
116269
|
+
type: 'action_attempt_expired'
|
|
116270
|
+
/** Message for the error associated with the action attempt. */
|
|
116271
|
+
message: string
|
|
116272
|
+
}
|
|
116273
|
+
| {
|
|
116274
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
116275
|
+
type: 'no_credential_on_encoder'
|
|
116276
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116277
|
+
message: string
|
|
116278
|
+
}
|
|
116279
|
+
| {
|
|
116280
|
+
/** Error type to indicate that the encoder is not online. */
|
|
116281
|
+
type: 'encoder_not_online'
|
|
116282
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116283
|
+
message: string
|
|
116284
|
+
}
|
|
116285
|
+
| {
|
|
116286
|
+
/** Error type to indicate that communication with the encoder timed out. */
|
|
116287
|
+
type: 'encoder_communication_timeout'
|
|
116288
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116289
|
+
message: string
|
|
116290
|
+
}
|
|
116291
|
+
| {
|
|
116292
|
+
/** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
|
|
116293
|
+
type: 'bridge_disconnected'
|
|
116294
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116295
|
+
message: string
|
|
116296
|
+
}
|
|
116297
|
+
}
|
|
116298
|
+
| {
|
|
116299
|
+
/** ID of the action attempt. */
|
|
116300
|
+
action_attempt_id: string
|
|
116301
|
+
status: 'pending'
|
|
116302
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
116303
|
+
result: null
|
|
116304
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
116305
|
+
error: null
|
|
116306
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
116307
|
+
action_type: 'ENCODE_CREDENTIAL'
|
|
116308
|
+
}
|
|
116309
|
+
| {
|
|
116310
|
+
/** ID of the action attempt. */
|
|
116311
|
+
action_attempt_id: string
|
|
116312
|
+
status: 'success'
|
|
116313
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
116314
|
+
error: null
|
|
116315
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
116316
|
+
action_type: 'ENCODE_CREDENTIAL'
|
|
116317
|
+
/** Result of an encoding attempt. If the attempt was successful, includes the credential data that was encoded onto the card. */
|
|
116318
|
+
result:
|
|
116319
|
+
| {
|
|
116320
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116321
|
+
acs_credential_id: string
|
|
116322
|
+
/** 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. */
|
|
116323
|
+
acs_user_id?: string | undefined
|
|
116324
|
+
/** 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. */
|
|
116325
|
+
user_identity_id?: string | undefined
|
|
116326
|
+
/** 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. */
|
|
116327
|
+
connected_account_id: string
|
|
116328
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
116329
|
+
acs_credential_pool_id?: string | undefined
|
|
116330
|
+
/** 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). */
|
|
116331
|
+
acs_system_id: string
|
|
116332
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116333
|
+
parent_acs_credential_id?: string | undefined
|
|
116334
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
116335
|
+
display_name: string
|
|
116336
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116337
|
+
code?: (string | undefined) | null
|
|
116338
|
+
/** 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. */
|
|
116339
|
+
is_one_time_use?: boolean | undefined
|
|
116340
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116341
|
+
card_number?: (string | undefined) | null
|
|
116342
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
116343
|
+
is_issued?: boolean | undefined
|
|
116344
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
116345
|
+
issued_at?: (string | undefined) | null
|
|
116346
|
+
/** 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`. */
|
|
116347
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
116348
|
+
/** 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`. */
|
|
116349
|
+
external_type?:
|
|
116350
|
+
| (
|
|
116351
|
+
| 'pti_card'
|
|
116352
|
+
| 'brivo_credential'
|
|
116353
|
+
| 'hid_credential'
|
|
116354
|
+
| 'visionline_card'
|
|
116355
|
+
| 'salto_ks_credential'
|
|
116356
|
+
| 'assa_abloy_vostio_key'
|
|
116357
|
+
| 'salto_space_key'
|
|
116358
|
+
| 'latch_access'
|
|
116359
|
+
| 'dormakaba_ambiance_credential'
|
|
116360
|
+
| 'hotek_card'
|
|
116361
|
+
| 'salto_ks_tag'
|
|
116362
|
+
| 'avigilon_alta_credential'
|
|
116363
|
+
| 'kisi_credential'
|
|
116364
|
+
| 'akiles_credential'
|
|
116365
|
+
)
|
|
116366
|
+
| undefined
|
|
116367
|
+
/** 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. */
|
|
116368
|
+
external_type_display_name?: string | undefined
|
|
116369
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
116370
|
+
created_at: string
|
|
116371
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116372
|
+
workspace_id: string
|
|
116373
|
+
/** 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. */
|
|
116374
|
+
starts_at?: string | undefined
|
|
116375
|
+
/** 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`. */
|
|
116376
|
+
ends_at?: string | undefined
|
|
116377
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116378
|
+
errors: {
|
|
116379
|
+
error_code: string
|
|
116380
|
+
message: string
|
|
116381
|
+
/** Date and time at which Seam created the error. */
|
|
116382
|
+
created_at: string
|
|
116383
|
+
}[]
|
|
116384
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116385
|
+
warnings: (
|
|
116386
|
+
| {
|
|
116387
|
+
/** Date and time at which Seam created the warning. */
|
|
116388
|
+
created_at: string
|
|
116389
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116390
|
+
message: string
|
|
116391
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116392
|
+
warning_code: 'waiting_to_be_issued'
|
|
116393
|
+
}
|
|
116394
|
+
| {
|
|
116395
|
+
/** Date and time at which Seam created the warning. */
|
|
116396
|
+
created_at: string
|
|
116397
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116398
|
+
message: string
|
|
116399
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116400
|
+
warning_code: 'schedule_externally_modified'
|
|
116401
|
+
}
|
|
116402
|
+
| {
|
|
116403
|
+
/** Date and time at which Seam created the warning. */
|
|
116404
|
+
created_at: string
|
|
116405
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116406
|
+
message: string
|
|
116407
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116408
|
+
warning_code: 'schedule_modified'
|
|
116409
|
+
}
|
|
116410
|
+
| {
|
|
116411
|
+
/** Date and time at which Seam created the warning. */
|
|
116412
|
+
created_at: string
|
|
116413
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116414
|
+
message: string
|
|
116415
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116416
|
+
warning_code: 'being_deleted'
|
|
116417
|
+
}
|
|
116418
|
+
| {
|
|
116419
|
+
/** Date and time at which Seam created the warning. */
|
|
116420
|
+
created_at: string
|
|
116421
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116422
|
+
message: string
|
|
116423
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116424
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
116425
|
+
}
|
|
116426
|
+
| {
|
|
116427
|
+
/** Date and time at which Seam created the warning. */
|
|
116428
|
+
created_at: string
|
|
116429
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116430
|
+
message: string
|
|
116431
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116432
|
+
warning_code: 'needs_to_be_reissued'
|
|
116433
|
+
}
|
|
116434
|
+
| {
|
|
116435
|
+
/** Date and time at which Seam created the warning. */
|
|
116436
|
+
created_at: string
|
|
116437
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116438
|
+
message: string
|
|
116439
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116440
|
+
warning_code: 'requested_code_unavailable'
|
|
116441
|
+
/** The originally requested PIN code that could not be used. */
|
|
116442
|
+
original_code: string
|
|
116443
|
+
/** The PIN code that was assigned instead. */
|
|
116444
|
+
new_code: string
|
|
116445
|
+
}
|
|
116446
|
+
)[]
|
|
116447
|
+
/** 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). */
|
|
116448
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
116449
|
+
/** 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. */
|
|
116450
|
+
is_latest_desired_state_synced_with_provider?:
|
|
116451
|
+
(boolean | null) | undefined
|
|
116452
|
+
/** 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. */
|
|
116453
|
+
latest_desired_state_synced_with_provider_at?:
|
|
116454
|
+
(string | null) | undefined
|
|
116455
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116456
|
+
visionline_metadata?:
|
|
116457
|
+
| {
|
|
116458
|
+
/** Card function type in the Visionline access system. */
|
|
116459
|
+
card_function_type?:
|
|
116460
|
+
(('guest' | 'staff') | undefined) | undefined
|
|
116461
|
+
/** IDs of the credentials to which you want to join. */
|
|
116462
|
+
joiner_acs_credential_ids?:
|
|
116463
|
+
(string[] | undefined) | undefined
|
|
116464
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
116465
|
+
guest_acs_entrance_ids?:
|
|
116466
|
+
(string[] | undefined) | undefined
|
|
116467
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
116468
|
+
common_acs_entrance_ids?:
|
|
116469
|
+
(string[] | undefined) | undefined
|
|
116470
|
+
/** Indicates whether the credential is valid. */
|
|
116471
|
+
is_valid?: (boolean | undefined) | undefined
|
|
116472
|
+
/** 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. */
|
|
116473
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116474
|
+
/** ID of the card in the Visionline access system. */
|
|
116475
|
+
card_id?: (string | undefined) | undefined
|
|
116476
|
+
/** ID of the credential in the Visionline access system. */
|
|
116477
|
+
credential_id?: (string | undefined) | undefined
|
|
116478
|
+
}
|
|
116479
|
+
| undefined
|
|
116480
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116481
|
+
assa_abloy_vostio_metadata?:
|
|
116482
|
+
| {
|
|
116483
|
+
/** 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. */
|
|
116484
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116485
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
116486
|
+
override_guest_acs_entrance_ids?:
|
|
116487
|
+
(string[] | undefined) | undefined
|
|
116488
|
+
/** Key ID in the Vostio access system. */
|
|
116489
|
+
key_id?: (string | undefined) | undefined
|
|
116490
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
116491
|
+
key_issuing_request_id?:
|
|
116492
|
+
(string | undefined) | undefined
|
|
116493
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
116494
|
+
door_names?: (string[] | undefined) | undefined
|
|
116495
|
+
/** Endpoint ID in the Vostio access system. */
|
|
116496
|
+
endpoint_id?: (string | undefined) | undefined
|
|
116497
|
+
}
|
|
116498
|
+
| undefined
|
|
116499
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116500
|
+
akiles_metadata?:
|
|
116501
|
+
| {
|
|
116502
|
+
/** ID of the Akiles member PIN. */
|
|
116503
|
+
member_pin_id?: (string | undefined) | undefined
|
|
116504
|
+
}
|
|
116505
|
+
| undefined
|
|
116506
|
+
/** Indicates whether Seam manages the credential. */
|
|
116507
|
+
is_managed: true
|
|
116508
|
+
}
|
|
116509
|
+
| {
|
|
116510
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116511
|
+
acs_credential_id: string
|
|
116512
|
+
/** 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. */
|
|
116513
|
+
acs_user_id?: string | undefined
|
|
116514
|
+
/** 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. */
|
|
116515
|
+
user_identity_id?: string | undefined
|
|
116516
|
+
/** 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. */
|
|
116517
|
+
connected_account_id: string
|
|
116518
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
116519
|
+
acs_credential_pool_id?: string | undefined
|
|
116520
|
+
/** 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). */
|
|
116521
|
+
acs_system_id: string
|
|
116522
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116523
|
+
parent_acs_credential_id?: string | undefined
|
|
116524
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
116525
|
+
display_name: string
|
|
116526
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116527
|
+
code?: (string | undefined) | null
|
|
116528
|
+
/** 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. */
|
|
116529
|
+
is_one_time_use?: boolean | undefined
|
|
116530
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116531
|
+
card_number?: (string | undefined) | null
|
|
116532
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
116533
|
+
is_issued?: boolean | undefined
|
|
116534
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
116535
|
+
issued_at?: (string | undefined) | null
|
|
116536
|
+
/** 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`. */
|
|
116537
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
116538
|
+
/** 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`. */
|
|
116539
|
+
external_type?:
|
|
116540
|
+
| (
|
|
116541
|
+
| 'pti_card'
|
|
116542
|
+
| 'brivo_credential'
|
|
116543
|
+
| 'hid_credential'
|
|
116544
|
+
| 'visionline_card'
|
|
116545
|
+
| 'salto_ks_credential'
|
|
116546
|
+
| 'assa_abloy_vostio_key'
|
|
116547
|
+
| 'salto_space_key'
|
|
116548
|
+
| 'latch_access'
|
|
116549
|
+
| 'dormakaba_ambiance_credential'
|
|
116550
|
+
| 'hotek_card'
|
|
116551
|
+
| 'salto_ks_tag'
|
|
116552
|
+
| 'avigilon_alta_credential'
|
|
116553
|
+
| 'kisi_credential'
|
|
116554
|
+
| 'akiles_credential'
|
|
116555
|
+
)
|
|
116556
|
+
| undefined
|
|
116557
|
+
/** 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. */
|
|
116558
|
+
external_type_display_name?: string | undefined
|
|
116559
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
116560
|
+
created_at: string
|
|
116561
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116562
|
+
workspace_id: string
|
|
116563
|
+
/** 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. */
|
|
116564
|
+
starts_at?: string | undefined
|
|
116565
|
+
/** 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`. */
|
|
116566
|
+
ends_at?: string | undefined
|
|
116567
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116568
|
+
errors: {
|
|
116569
|
+
error_code: string
|
|
116570
|
+
message: string
|
|
116571
|
+
/** Date and time at which Seam created the error. */
|
|
116572
|
+
created_at: string
|
|
116573
|
+
}[]
|
|
116574
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116575
|
+
warnings: (
|
|
116576
|
+
| {
|
|
116577
|
+
/** Date and time at which Seam created the warning. */
|
|
116578
|
+
created_at: string
|
|
116579
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116580
|
+
message: string
|
|
116581
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116582
|
+
warning_code: 'waiting_to_be_issued'
|
|
116583
|
+
}
|
|
116584
|
+
| {
|
|
116585
|
+
/** Date and time at which Seam created the warning. */
|
|
116586
|
+
created_at: string
|
|
116587
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116588
|
+
message: string
|
|
116589
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116590
|
+
warning_code: 'schedule_externally_modified'
|
|
116591
|
+
}
|
|
116592
|
+
| {
|
|
116593
|
+
/** Date and time at which Seam created the warning. */
|
|
116594
|
+
created_at: string
|
|
116595
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116596
|
+
message: string
|
|
116597
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116598
|
+
warning_code: 'schedule_modified'
|
|
116599
|
+
}
|
|
116600
|
+
| {
|
|
116601
|
+
/** Date and time at which Seam created the warning. */
|
|
116602
|
+
created_at: string
|
|
116603
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116604
|
+
message: string
|
|
116605
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116606
|
+
warning_code: 'being_deleted'
|
|
116607
|
+
}
|
|
116608
|
+
| {
|
|
116609
|
+
/** Date and time at which Seam created the warning. */
|
|
116610
|
+
created_at: string
|
|
116611
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116612
|
+
message: string
|
|
116613
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116614
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
116615
|
+
}
|
|
116616
|
+
| {
|
|
116617
|
+
/** Date and time at which Seam created the warning. */
|
|
116618
|
+
created_at: string
|
|
116619
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116620
|
+
message: string
|
|
116621
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116622
|
+
warning_code: 'needs_to_be_reissued'
|
|
116623
|
+
}
|
|
116624
|
+
| {
|
|
116625
|
+
/** Date and time at which Seam created the warning. */
|
|
116626
|
+
created_at: string
|
|
116627
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116628
|
+
message: string
|
|
116629
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116630
|
+
warning_code: 'requested_code_unavailable'
|
|
116631
|
+
/** The originally requested PIN code that could not be used. */
|
|
116632
|
+
original_code: string
|
|
116633
|
+
/** The PIN code that was assigned instead. */
|
|
116634
|
+
new_code: string
|
|
116635
|
+
}
|
|
116636
|
+
)[]
|
|
116637
|
+
/** 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). */
|
|
116638
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
116639
|
+
/** 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. */
|
|
116640
|
+
is_latest_desired_state_synced_with_provider?:
|
|
116641
|
+
(boolean | null) | undefined
|
|
116642
|
+
/** 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. */
|
|
116643
|
+
latest_desired_state_synced_with_provider_at?:
|
|
116644
|
+
(string | null) | undefined
|
|
116645
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116646
|
+
visionline_metadata?:
|
|
116647
|
+
| {
|
|
116648
|
+
/** Card function type in the Visionline access system. */
|
|
116649
|
+
card_function_type?:
|
|
116650
|
+
(('guest' | 'staff') | undefined) | undefined
|
|
116651
|
+
/** IDs of the credentials to which you want to join. */
|
|
116652
|
+
joiner_acs_credential_ids?:
|
|
116653
|
+
(string[] | undefined) | undefined
|
|
116654
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
116655
|
+
guest_acs_entrance_ids?:
|
|
116656
|
+
(string[] | undefined) | undefined
|
|
116657
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
116658
|
+
common_acs_entrance_ids?:
|
|
116659
|
+
(string[] | undefined) | undefined
|
|
116660
|
+
/** Indicates whether the credential is valid. */
|
|
116661
|
+
is_valid?: (boolean | undefined) | undefined
|
|
116662
|
+
/** 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. */
|
|
116663
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116664
|
+
/** ID of the card in the Visionline access system. */
|
|
116665
|
+
card_id?: (string | undefined) | undefined
|
|
116666
|
+
/** ID of the credential in the Visionline access system. */
|
|
116667
|
+
credential_id?: (string | undefined) | undefined
|
|
116668
|
+
}
|
|
116669
|
+
| undefined
|
|
116670
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116671
|
+
assa_abloy_vostio_metadata?:
|
|
116672
|
+
| {
|
|
116673
|
+
/** 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. */
|
|
116674
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116675
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
116676
|
+
override_guest_acs_entrance_ids?:
|
|
116677
|
+
(string[] | undefined) | undefined
|
|
116678
|
+
/** Key ID in the Vostio access system. */
|
|
116679
|
+
key_id?: (string | undefined) | undefined
|
|
116680
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
116681
|
+
key_issuing_request_id?:
|
|
116682
|
+
(string | undefined) | undefined
|
|
116683
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
116684
|
+
door_names?: (string[] | undefined) | undefined
|
|
116685
|
+
/** Endpoint ID in the Vostio access system. */
|
|
116686
|
+
endpoint_id?: (string | undefined) | undefined
|
|
116687
|
+
}
|
|
116688
|
+
| undefined
|
|
116689
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116690
|
+
akiles_metadata?:
|
|
116691
|
+
| {
|
|
116692
|
+
/** ID of the Akiles member PIN. */
|
|
116693
|
+
member_pin_id?: (string | undefined) | undefined
|
|
116694
|
+
}
|
|
116695
|
+
| undefined
|
|
116696
|
+
is_managed: false
|
|
116697
|
+
}
|
|
116698
|
+
}
|
|
116699
|
+
| {
|
|
116700
|
+
/** ID of the action attempt. */
|
|
116701
|
+
action_attempt_id: string
|
|
116702
|
+
status: 'error'
|
|
116703
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
116704
|
+
result: null
|
|
116705
|
+
/** Action attempt to track the status of encoding credential data from the physical encoder onto a card. */
|
|
116706
|
+
action_type: 'ENCODE_CREDENTIAL'
|
|
116707
|
+
error:
|
|
116708
|
+
| {
|
|
116709
|
+
/** Type of the error associated with the action attempt. */
|
|
116710
|
+
type: 'uncategorized_error'
|
|
116711
|
+
/** Message for the error associated with the action attempt. */
|
|
116712
|
+
message: string
|
|
116713
|
+
}
|
|
116714
|
+
| {
|
|
116715
|
+
/** Type of the error associated with the action attempt. */
|
|
116716
|
+
type: 'action_attempt_expired'
|
|
116717
|
+
/** Message for the error associated with the action attempt. */
|
|
116718
|
+
message: string
|
|
116719
|
+
}
|
|
116720
|
+
| {
|
|
116721
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
116722
|
+
type: 'no_credential_on_encoder'
|
|
116723
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116724
|
+
message: string
|
|
116725
|
+
}
|
|
116726
|
+
| {
|
|
116727
|
+
/** Error type to indicate an incompatible card format. */
|
|
116728
|
+
type: 'incompatible_card_format'
|
|
116729
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116730
|
+
message: string
|
|
116731
|
+
}
|
|
116732
|
+
| {
|
|
116733
|
+
/** Error type to indicate that the affected credential cannot be reissued. */
|
|
116734
|
+
type: 'credential_cannot_be_reissued'
|
|
116735
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116736
|
+
message: string
|
|
116737
|
+
}
|
|
116738
|
+
| {
|
|
116739
|
+
/** Error type to indicate that the encoder is not online. */
|
|
116740
|
+
type: 'encoder_not_online'
|
|
116741
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116742
|
+
message: string
|
|
116743
|
+
}
|
|
116744
|
+
| {
|
|
116745
|
+
/** Error type to indicate that communication with the encoder timed out. */
|
|
116746
|
+
type: 'encoder_communication_timeout'
|
|
116747
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116748
|
+
message: string
|
|
116749
|
+
}
|
|
116750
|
+
| {
|
|
116751
|
+
/** Error type to indicate that the Seam Bridge is disconnected or cannot reach the access control system. */
|
|
116752
|
+
type: 'bridge_disconnected'
|
|
116753
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116754
|
+
message: string
|
|
116755
|
+
}
|
|
116756
|
+
| {
|
|
116757
|
+
/** Error type to indicate that encoding was interrupted, for example, if the card was removed from the encoder before writing was complete. */
|
|
116758
|
+
type: 'encoding_interrupted'
|
|
116759
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116760
|
+
message: string
|
|
116761
|
+
}
|
|
116762
|
+
| {
|
|
116763
|
+
/** Error type to indicate that the credential was deleted and can no longer be encoded. */
|
|
116764
|
+
type: 'credential_deleted'
|
|
116765
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
116766
|
+
message: string
|
|
116767
|
+
}
|
|
116768
|
+
}
|
|
116769
|
+
| {
|
|
116770
|
+
/** ID of the action attempt. */
|
|
116771
|
+
action_attempt_id: string
|
|
116772
|
+
status: 'pending'
|
|
116773
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
116774
|
+
result: null
|
|
116775
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
116776
|
+
error: null
|
|
116777
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
116778
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
|
|
116779
|
+
}
|
|
116780
|
+
| {
|
|
116781
|
+
/** ID of the action attempt. */
|
|
116782
|
+
action_attempt_id: string
|
|
116783
|
+
status: 'success'
|
|
116784
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
116785
|
+
error: null
|
|
116786
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
116787
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
|
|
116788
|
+
/** Result of a scan to assign attempt. If the attempt was successful, includes the credential data that was scanned and assigned. */
|
|
116789
|
+
result: {
|
|
116790
|
+
/** ID of the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116791
|
+
acs_credential_id: string
|
|
116792
|
+
/** 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. */
|
|
116793
|
+
acs_user_id?: string | undefined
|
|
116794
|
+
/** 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. */
|
|
116795
|
+
user_identity_id?: string | undefined
|
|
116796
|
+
/** 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. */
|
|
116797
|
+
connected_account_id: string
|
|
116798
|
+
/** ID of the credential pool to which the credential belongs. */
|
|
116799
|
+
acs_credential_pool_id?: string | undefined
|
|
116800
|
+
/** 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). */
|
|
116801
|
+
acs_system_id: string
|
|
116802
|
+
/** ID of the parent [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116803
|
+
parent_acs_credential_id?: string | undefined
|
|
116804
|
+
/** Display name that corresponds to the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) type. */
|
|
116805
|
+
display_name: string
|
|
116806
|
+
/** Access (PIN) code for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116807
|
+
code?: (string | undefined) | null
|
|
116808
|
+
/** 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. */
|
|
116809
|
+
is_one_time_use?: boolean | undefined
|
|
116810
|
+
/** Number of the card associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116811
|
+
card_number?: (string | undefined) | null
|
|
116812
|
+
/** Indicates whether the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) has been encoded onto a card. */
|
|
116813
|
+
is_issued?: boolean | undefined
|
|
116814
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was encoded onto a card. */
|
|
116815
|
+
issued_at?: (string | undefined) | null
|
|
116816
|
+
/** 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`. */
|
|
116817
|
+
access_method: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
116818
|
+
/** 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`. */
|
|
116819
|
+
external_type?:
|
|
116820
|
+
| (
|
|
116821
|
+
| 'pti_card'
|
|
116822
|
+
| 'brivo_credential'
|
|
116823
|
+
| 'hid_credential'
|
|
116824
|
+
| 'visionline_card'
|
|
116825
|
+
| 'salto_ks_credential'
|
|
116826
|
+
| 'assa_abloy_vostio_key'
|
|
116827
|
+
| 'salto_space_key'
|
|
116828
|
+
| 'latch_access'
|
|
116829
|
+
| 'dormakaba_ambiance_credential'
|
|
116830
|
+
| 'hotek_card'
|
|
116831
|
+
| 'salto_ks_tag'
|
|
116832
|
+
| 'avigilon_alta_credential'
|
|
116833
|
+
| 'kisi_credential'
|
|
116834
|
+
| 'akiles_credential'
|
|
116835
|
+
)
|
|
116836
|
+
| undefined
|
|
116837
|
+
/** 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. */
|
|
116838
|
+
external_type_display_name?: string | undefined
|
|
116839
|
+
/** Date and time at which the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials) was created. */
|
|
116840
|
+
created_at: string
|
|
116841
|
+
/** ID of the workspace that contains the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116842
|
+
workspace_id: string
|
|
116843
|
+
/** 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. */
|
|
116844
|
+
starts_at?: string | undefined
|
|
116845
|
+
/** 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`. */
|
|
116846
|
+
ends_at?: string | undefined
|
|
116847
|
+
/** Errors associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116848
|
+
errors: {
|
|
116849
|
+
error_code: string
|
|
116850
|
+
message: string
|
|
116851
|
+
/** Date and time at which Seam created the error. */
|
|
116852
|
+
created_at: string
|
|
116853
|
+
}[]
|
|
116854
|
+
/** Warnings associated with the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116855
|
+
warnings: (
|
|
116856
|
+
| {
|
|
116857
|
+
/** Date and time at which Seam created the warning. */
|
|
116858
|
+
created_at: string
|
|
116859
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116860
|
+
message: string
|
|
116861
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116862
|
+
warning_code: 'waiting_to_be_issued'
|
|
116863
|
+
}
|
|
116864
|
+
| {
|
|
116865
|
+
/** Date and time at which Seam created the warning. */
|
|
116866
|
+
created_at: string
|
|
116867
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116868
|
+
message: string
|
|
116869
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116870
|
+
warning_code: 'schedule_externally_modified'
|
|
116871
|
+
}
|
|
116872
|
+
| {
|
|
116873
|
+
/** Date and time at which Seam created the warning. */
|
|
116874
|
+
created_at: string
|
|
116875
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116876
|
+
message: string
|
|
116877
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116878
|
+
warning_code: 'schedule_modified'
|
|
116879
|
+
}
|
|
116880
|
+
| {
|
|
116881
|
+
/** Date and time at which Seam created the warning. */
|
|
116882
|
+
created_at: string
|
|
116883
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116884
|
+
message: string
|
|
116885
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116886
|
+
warning_code: 'being_deleted'
|
|
116887
|
+
}
|
|
116888
|
+
| {
|
|
116889
|
+
/** Date and time at which Seam created the warning. */
|
|
116890
|
+
created_at: string
|
|
116891
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116892
|
+
message: string
|
|
116893
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116894
|
+
warning_code: 'unknown_issue_with_acs_credential'
|
|
116895
|
+
}
|
|
116896
|
+
| {
|
|
116897
|
+
/** Date and time at which Seam created the warning. */
|
|
116898
|
+
created_at: string
|
|
116899
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116900
|
+
message: string
|
|
116901
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116902
|
+
warning_code: 'needs_to_be_reissued'
|
|
116903
|
+
}
|
|
116904
|
+
| {
|
|
116905
|
+
/** Date and time at which Seam created the warning. */
|
|
116906
|
+
created_at: string
|
|
116907
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
116908
|
+
message: string
|
|
116909
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
116910
|
+
warning_code: 'requested_code_unavailable'
|
|
116911
|
+
/** The originally requested PIN code that could not be used. */
|
|
116912
|
+
original_code: string
|
|
116913
|
+
/** The PIN code that was assigned instead. */
|
|
116914
|
+
new_code: string
|
|
116915
|
+
}
|
|
116916
|
+
)[]
|
|
116917
|
+
/** 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). */
|
|
116918
|
+
is_multi_phone_sync_credential?: boolean | undefined
|
|
116919
|
+
/** 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. */
|
|
116920
|
+
is_latest_desired_state_synced_with_provider?:
|
|
116921
|
+
(boolean | null) | undefined
|
|
116922
|
+
/** 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. */
|
|
116923
|
+
latest_desired_state_synced_with_provider_at?:
|
|
116924
|
+
(string | null) | undefined
|
|
116925
|
+
/** Visionline-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116926
|
+
visionline_metadata?:
|
|
116927
|
+
| {
|
|
116928
|
+
/** Card function type in the Visionline access system. */
|
|
116929
|
+
card_function_type?:
|
|
116930
|
+
(('guest' | 'staff') | undefined) | undefined
|
|
116931
|
+
/** IDs of the credentials to which you want to join. */
|
|
116932
|
+
joiner_acs_credential_ids?:
|
|
116933
|
+
(string[] | undefined) | undefined
|
|
116934
|
+
/** Guest entrance IDs in the Visionline access system. */
|
|
116935
|
+
guest_acs_entrance_ids?: (string[] | undefined) | undefined
|
|
116936
|
+
/** Common entrance IDs in the Visionline access system. */
|
|
116937
|
+
common_acs_entrance_ids?: (string[] | undefined) | undefined
|
|
116938
|
+
/** Indicates whether the credential is valid. */
|
|
116939
|
+
is_valid?: (boolean | undefined) | undefined
|
|
116940
|
+
/** 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. */
|
|
116941
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116942
|
+
/** ID of the card in the Visionline access system. */
|
|
116943
|
+
card_id?: (string | undefined) | undefined
|
|
116944
|
+
/** ID of the credential in the Visionline access system. */
|
|
116945
|
+
credential_id?: (string | undefined) | undefined
|
|
116946
|
+
}
|
|
116947
|
+
| undefined
|
|
116948
|
+
/** Vostio-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116949
|
+
assa_abloy_vostio_metadata?:
|
|
116950
|
+
| {
|
|
116951
|
+
/** 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. */
|
|
116952
|
+
auto_join?: (boolean | undefined) | undefined
|
|
116953
|
+
/** IDs of the guest entrances to override in the Vostio access system. */
|
|
116954
|
+
override_guest_acs_entrance_ids?:
|
|
116955
|
+
(string[] | undefined) | undefined
|
|
116956
|
+
/** Key ID in the Vostio access system. */
|
|
116957
|
+
key_id?: (string | undefined) | undefined
|
|
116958
|
+
/** Key issuing request ID in the Vostio access system. */
|
|
116959
|
+
key_issuing_request_id?: (string | undefined) | undefined
|
|
116960
|
+
/** Names of the doors to which to grant access in the Vostio access system. */
|
|
116961
|
+
door_names?: (string[] | undefined) | undefined
|
|
116962
|
+
/** Endpoint ID in the Vostio access system. */
|
|
116963
|
+
endpoint_id?: (string | undefined) | undefined
|
|
116964
|
+
}
|
|
116965
|
+
| undefined
|
|
116966
|
+
/** Akiles-specific metadata for the [credential](https://www.seam.co/docs/low-level-apis/access-systems/managing-credentials). */
|
|
116967
|
+
akiles_metadata?:
|
|
116968
|
+
| {
|
|
116969
|
+
/** ID of the Akiles member PIN. */
|
|
116970
|
+
member_pin_id?: (string | undefined) | undefined
|
|
116971
|
+
}
|
|
116972
|
+
| undefined
|
|
116973
|
+
/** Indicates whether Seam manages the credential. */
|
|
116974
|
+
is_managed: true
|
|
116975
|
+
}
|
|
116976
|
+
}
|
|
116977
|
+
| {
|
|
116978
|
+
/** ID of the action attempt. */
|
|
116979
|
+
action_attempt_id: string
|
|
116980
|
+
status: 'error'
|
|
116981
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
116982
|
+
result: null
|
|
116983
|
+
/** Action attempt to track the status of scanning a physical card and assigning the credential to an ACS user. */
|
|
116984
|
+
action_type: 'SCAN_TO_ASSIGN_CREDENTIAL'
|
|
116985
|
+
error:
|
|
116986
|
+
| {
|
|
116987
|
+
/** Type of the error associated with the action attempt. */
|
|
116988
|
+
type: 'uncategorized_error'
|
|
116989
|
+
/** Message for the error associated with the action attempt. */
|
|
116990
|
+
message: string
|
|
116991
|
+
}
|
|
116992
|
+
| {
|
|
116993
|
+
/** Type of the error associated with the action attempt. */
|
|
116994
|
+
type: 'action_attempt_expired'
|
|
116995
|
+
/** Message for the error associated with the action attempt. */
|
|
116996
|
+
message: string
|
|
116997
|
+
}
|
|
116998
|
+
| {
|
|
116999
|
+
/** Error type to indicate that there is no credential on the encoder. */
|
|
117000
|
+
type: 'no_credential_on_encoder'
|
|
117001
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117002
|
+
message: string
|
|
117003
|
+
}
|
|
117004
|
+
}
|
|
117005
|
+
| {
|
|
117006
|
+
/** ID of the action attempt. */
|
|
117007
|
+
action_attempt_id: string
|
|
117008
|
+
status: 'pending'
|
|
117009
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117010
|
+
result: null
|
|
117011
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
117012
|
+
error: null
|
|
117013
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
117014
|
+
action_type: 'ASSIGN_CREDENTIAL'
|
|
117015
|
+
}
|
|
117016
|
+
| {
|
|
117017
|
+
/** ID of the action attempt. */
|
|
117018
|
+
action_attempt_id: string
|
|
117019
|
+
status: 'success'
|
|
117020
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117021
|
+
error: null
|
|
117022
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
117023
|
+
action_type: 'ASSIGN_CREDENTIAL'
|
|
117024
|
+
/** Result of assigning a credential. If successful, includes the updated access method with the assigned credential. */
|
|
117025
|
+
result: {
|
|
117026
|
+
/** ID of the Seam workspace associated with the access method. */
|
|
117027
|
+
workspace_id: string
|
|
117028
|
+
/** ID of the access method. */
|
|
117029
|
+
access_method_id: string
|
|
117030
|
+
/** Display name of the access method. */
|
|
117031
|
+
display_name: string
|
|
117032
|
+
/** Access method mode. Supported values: `code`, `card`, `mobile_key`, `cloud_key`. */
|
|
117033
|
+
mode: 'code' | 'card' | 'mobile_key' | 'cloud_key'
|
|
117034
|
+
/** Date and time at which the access method was created. */
|
|
117035
|
+
created_at: string
|
|
117036
|
+
/** Date and time at which the access method was issued. */
|
|
117037
|
+
issued_at: string | null
|
|
117038
|
+
/** Indicates whether the access method has been issued. */
|
|
117039
|
+
is_issued: boolean
|
|
117040
|
+
/** 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`. */
|
|
117041
|
+
display_status: string
|
|
117042
|
+
/** URL of the Instant Key for mobile key access methods. */
|
|
117043
|
+
instant_key_url?: string | undefined
|
|
117044
|
+
/** Token of the client session associated with the access method. */
|
|
117045
|
+
client_session_token?: string | undefined
|
|
117046
|
+
/** Indicates whether encoding with an card encoder is required to issue or reissue the plastic card associated with the access method. */
|
|
117047
|
+
is_encoding_required?: boolean | undefined
|
|
117048
|
+
/** 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. */
|
|
117049
|
+
is_ready_for_encoding?: boolean | undefined
|
|
117050
|
+
/** 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. */
|
|
117051
|
+
is_assignment_required?: boolean | undefined
|
|
117052
|
+
/** 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. */
|
|
117053
|
+
is_ready_for_assignment?: boolean | undefined
|
|
117054
|
+
/** The actual PIN code for code access methods. */
|
|
117055
|
+
code?: (string | null) | undefined
|
|
117056
|
+
/** Warnings associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
|
|
117057
|
+
warnings: (
|
|
117058
|
+
| {
|
|
117059
|
+
/** Date and time at which Seam created the warning. */
|
|
117060
|
+
created_at: string
|
|
117061
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117062
|
+
message: string
|
|
117063
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117064
|
+
warning_code: 'being_deleted'
|
|
117065
|
+
}
|
|
117066
|
+
| {
|
|
117067
|
+
/** Date and time at which Seam created the warning. */
|
|
117068
|
+
created_at: string
|
|
117069
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117070
|
+
message: string
|
|
117071
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117072
|
+
warning_code: 'updating_access_times'
|
|
117073
|
+
}
|
|
117074
|
+
| {
|
|
117075
|
+
/** Date and time at which Seam created the warning. */
|
|
117076
|
+
created_at: string
|
|
117077
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117078
|
+
message: string
|
|
117079
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117080
|
+
warning_code: 'pulled_backup_access_code'
|
|
117081
|
+
/** ID of the original access method from which this backup access method was split, if applicable. */
|
|
117082
|
+
original_access_method_id?: string | undefined
|
|
117083
|
+
}
|
|
117084
|
+
| {
|
|
117085
|
+
/** Date and time at which Seam created the warning. */
|
|
117086
|
+
created_at: string
|
|
117087
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117088
|
+
message: string
|
|
117089
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117090
|
+
warning_code: 'delay_in_issuing'
|
|
117091
|
+
}
|
|
117092
|
+
| {
|
|
117093
|
+
/** Date and time at which Seam created the warning. */
|
|
117094
|
+
created_at: string
|
|
117095
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117096
|
+
message: string
|
|
117097
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117098
|
+
warning_code: 'user_identity_missing_email_address'
|
|
117099
|
+
}
|
|
117100
|
+
| {
|
|
117101
|
+
/** Date and time at which Seam created the warning. */
|
|
117102
|
+
created_at: string
|
|
117103
|
+
/** Detailed description of the warning. Provides insights into the issue and potentially how to rectify it. */
|
|
117104
|
+
message: string
|
|
117105
|
+
/** Unique identifier of the type of warning. Enables quick recognition and categorization of the issue. */
|
|
117106
|
+
warning_code: 'user_identity_missing_phone_number'
|
|
117107
|
+
}
|
|
117108
|
+
)[]
|
|
117109
|
+
/** Errors associated with the [access method](https://www.seam.co/docs/use-cases/granting-access/creating-an-access-grant). */
|
|
117110
|
+
errors: {
|
|
117111
|
+
/** Date and time at which Seam created the error. */
|
|
117112
|
+
created_at: string
|
|
117113
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117114
|
+
message: string
|
|
117115
|
+
/** Unique identifier of the type of error. Enables quick recognition and categorization of the issue. */
|
|
117116
|
+
error_code: 'failed_to_issue'
|
|
117117
|
+
}[]
|
|
117118
|
+
/** 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. */
|
|
117119
|
+
pending_mutations: (
|
|
117120
|
+
| {
|
|
117121
|
+
/** Date and time at which the mutation was created. */
|
|
117122
|
+
created_at: string
|
|
117123
|
+
/** Detailed description of the mutation. */
|
|
117124
|
+
message: string
|
|
117125
|
+
/** Mutation code to indicate that Seam is in the process of provisioning access for this access method on new devices. */
|
|
117126
|
+
mutation_code: 'provisioning_access'
|
|
117127
|
+
/** Previous device configuration. */
|
|
117128
|
+
from: {
|
|
117129
|
+
/** Previous device IDs where access was provisioned. */
|
|
117130
|
+
device_ids: string[]
|
|
117131
|
+
}
|
|
117132
|
+
/** New device configuration. */
|
|
117133
|
+
to: {
|
|
117134
|
+
/** New device IDs where access is being provisioned. */
|
|
117135
|
+
device_ids: string[]
|
|
117136
|
+
}
|
|
117137
|
+
}
|
|
117138
|
+
| {
|
|
117139
|
+
/** Date and time at which the mutation was created. */
|
|
117140
|
+
created_at: string
|
|
117141
|
+
/** Detailed description of the mutation. */
|
|
117142
|
+
message: string
|
|
117143
|
+
/** Mutation code to indicate that Seam is in the process of revoking access for this access method from devices. */
|
|
117144
|
+
mutation_code: 'revoking_access'
|
|
117145
|
+
/** Previous device configuration. */
|
|
117146
|
+
from: {
|
|
117147
|
+
/** Previous device IDs where access existed. */
|
|
117148
|
+
device_ids: string[]
|
|
117149
|
+
}
|
|
117150
|
+
/** New device configuration. */
|
|
117151
|
+
to: {
|
|
117152
|
+
/** New device IDs where access should remain. */
|
|
117153
|
+
device_ids: string[]
|
|
117154
|
+
}
|
|
117155
|
+
}
|
|
117156
|
+
| {
|
|
117157
|
+
/** Date and time at which the mutation was created. */
|
|
117158
|
+
created_at: string
|
|
117159
|
+
/** Detailed description of the mutation. */
|
|
117160
|
+
message: string
|
|
117161
|
+
/** Mutation code to indicate that Seam is in the process of updating the access times for this access method. */
|
|
117162
|
+
mutation_code: 'updating_access_times'
|
|
117163
|
+
/** Previous access time configuration. */
|
|
117164
|
+
from: {
|
|
117165
|
+
/** Previous start time for access. */
|
|
117166
|
+
starts_at: string | null
|
|
117167
|
+
/** Previous end time for access. */
|
|
117168
|
+
ends_at: string | null
|
|
117169
|
+
}
|
|
117170
|
+
/** New access time configuration. */
|
|
117171
|
+
to: {
|
|
117172
|
+
/** New start time for access. */
|
|
117173
|
+
starts_at: string | null
|
|
117174
|
+
/** New end time for access. */
|
|
117175
|
+
ends_at: string | null
|
|
117176
|
+
}
|
|
117177
|
+
}
|
|
117178
|
+
)[]
|
|
117179
|
+
/** ID of the customization profile associated with the access method. */
|
|
117180
|
+
customization_profile_id?: string | undefined
|
|
114661
117181
|
}
|
|
114662
|
-
|
|
114663
|
-
/** Geographic coordinates (latitude and longitude) of the space. */
|
|
114664
|
-
geolocation?:
|
|
114665
|
-
| ({
|
|
114666
|
-
/** Latitude of the space, in decimal degrees. */
|
|
114667
|
-
latitude: number
|
|
114668
|
-
/** Longitude of the space, in decimal degrees. */
|
|
114669
|
-
longitude: number
|
|
114670
|
-
} | null)
|
|
114671
|
-
| undefined
|
|
114672
|
-
/** */
|
|
114673
|
-
parent_space_id?: string | undefined
|
|
114674
|
-
/** */
|
|
114675
|
-
parent_space_key?: string | undefined
|
|
114676
|
-
}[]
|
|
114677
|
-
/** Information about the current page of results. */
|
|
114678
|
-
pagination: {
|
|
114679
|
-
/** Opaque value that can be used to select the next page of results via the `page_cursor` parameter. */
|
|
114680
|
-
next_page_cursor: string | null
|
|
114681
|
-
/** Indicates whether there is another page of results after this one. */
|
|
114682
|
-
has_next_page: boolean
|
|
114683
|
-
/** URL to get the next page of results. */
|
|
114684
|
-
next_page_url: string | null
|
|
114685
|
-
}
|
|
114686
|
-
}
|
|
114687
|
-
maxDuration: undefined
|
|
114688
|
-
}
|
|
114689
|
-
'/spaces/remove_acs_entrances': {
|
|
114690
|
-
route: '/spaces/remove_acs_entrances'
|
|
114691
|
-
method: 'POST' | 'DELETE'
|
|
114692
|
-
queryParams: {}
|
|
114693
|
-
jsonBody: {}
|
|
114694
|
-
commonParams: {
|
|
114695
|
-
/** ID of the space from which you want to remove entrances. */
|
|
114696
|
-
space_id: string
|
|
114697
|
-
/** IDs of the entrances that you want to remove from the space. */
|
|
114698
|
-
acs_entrance_ids: string[]
|
|
114699
|
-
}
|
|
114700
|
-
formData: {}
|
|
114701
|
-
jsonResponse: {}
|
|
114702
|
-
maxDuration: undefined
|
|
114703
|
-
}
|
|
114704
|
-
'/spaces/remove_connected_account': {
|
|
114705
|
-
route: '/spaces/remove_connected_account'
|
|
114706
|
-
method: 'POST' | 'DELETE'
|
|
114707
|
-
queryParams: {}
|
|
114708
|
-
jsonBody: {}
|
|
114709
|
-
commonParams: {
|
|
114710
|
-
/** ID of the space from which you want to remove the connected account. */
|
|
114711
|
-
space_id: string
|
|
114712
|
-
/** ID of the connected account that you want to remove from the space. */
|
|
114713
|
-
connected_account_id: string
|
|
114714
|
-
}
|
|
114715
|
-
formData: {}
|
|
114716
|
-
jsonResponse: {}
|
|
114717
|
-
maxDuration: undefined
|
|
114718
|
-
}
|
|
114719
|
-
'/spaces/remove_devices': {
|
|
114720
|
-
route: '/spaces/remove_devices'
|
|
114721
|
-
method: 'POST' | 'DELETE'
|
|
114722
|
-
queryParams: {}
|
|
114723
|
-
jsonBody: {}
|
|
114724
|
-
commonParams: {
|
|
114725
|
-
/** ID of the space from which you want to remove devices. */
|
|
114726
|
-
space_id: string
|
|
114727
|
-
/** IDs of the devices that you want to remove from the space. */
|
|
114728
|
-
device_ids: string[]
|
|
114729
|
-
}
|
|
114730
|
-
formData: {}
|
|
114731
|
-
jsonResponse: {}
|
|
114732
|
-
maxDuration: undefined
|
|
114733
|
-
}
|
|
114734
|
-
'/spaces/update': {
|
|
114735
|
-
route: '/spaces/update'
|
|
114736
|
-
method: 'POST' | 'PATCH'
|
|
114737
|
-
queryParams: {}
|
|
114738
|
-
jsonBody: {
|
|
114739
|
-
/** Name of the space. */
|
|
114740
|
-
name?: string | undefined
|
|
114741
|
-
/** ID of the space that you want to update. */
|
|
114742
|
-
space_id?: string | undefined
|
|
114743
|
-
/** Unique key of the space that you want to update. */
|
|
114744
|
-
space_key?: string | undefined
|
|
114745
|
-
/** IDs of the devices that you want to set for the space. If specified, this will replace all existing devices. */
|
|
114746
|
-
device_ids?: string[] | undefined
|
|
114747
|
-
/** IDs of the entrances that you want to set for the space. If specified, this will replace all existing entrances. */
|
|
114748
|
-
acs_entrance_ids?: string[] | undefined
|
|
114749
|
-
/** Reservation/stay-related defaults for the space. Only the keys you provide are updated; omit a key to leave it unchanged. Pass null on a key to clear it. */
|
|
114750
|
-
customer_data?:
|
|
117182
|
+
}
|
|
114751
117183
|
| {
|
|
114752
|
-
/**
|
|
114753
|
-
|
|
114754
|
-
|
|
114755
|
-
|
|
114756
|
-
|
|
114757
|
-
|
|
114758
|
-
|
|
114759
|
-
|
|
117184
|
+
/** ID of the action attempt. */
|
|
117185
|
+
action_attempt_id: string
|
|
117186
|
+
status: 'error'
|
|
117187
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117188
|
+
result: null
|
|
117189
|
+
/** Action attempt to track the status of assigning a pre-registered card credential to an access method. */
|
|
117190
|
+
action_type: 'ASSIGN_CREDENTIAL'
|
|
117191
|
+
error:
|
|
117192
|
+
| {
|
|
117193
|
+
/** Type of the error associated with the action attempt. */
|
|
117194
|
+
type: 'uncategorized_error'
|
|
117195
|
+
/** Message for the error associated with the action attempt. */
|
|
117196
|
+
message: string
|
|
117197
|
+
}
|
|
117198
|
+
| {
|
|
117199
|
+
/** Type of the error associated with the action attempt. */
|
|
117200
|
+
type: 'action_attempt_expired'
|
|
117201
|
+
/** Message for the error associated with the action attempt. */
|
|
117202
|
+
message: string
|
|
117203
|
+
}
|
|
117204
|
+
| {
|
|
117205
|
+
/** Error type to indicate that no matching credential was found. */
|
|
117206
|
+
type: 'credential_not_found'
|
|
117207
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117208
|
+
message: string
|
|
117209
|
+
}
|
|
114760
117210
|
}
|
|
114761
|
-
|
|
|
114762
|
-
|
|
114763
|
-
|
|
114764
|
-
|
|
114765
|
-
|
|
114766
|
-
|
|
114767
|
-
|
|
114768
|
-
|
|
114769
|
-
|
|
114770
|
-
|
|
114771
|
-
|
|
114772
|
-
|
|
114773
|
-
|
|
114774
|
-
|
|
114775
|
-
|
|
114776
|
-
|
|
114777
|
-
|
|
114778
|
-
|
|
114779
|
-
|
|
114780
|
-
|
|
114781
|
-
|
|
114782
|
-
|
|
114783
|
-
|
|
114784
|
-
|
|
114785
|
-
|
|
114786
|
-
|
|
114787
|
-
|
|
114788
|
-
|
|
114789
|
-
|
|
114790
|
-
|
|
114791
|
-
|
|
114792
|
-
|
|
114793
|
-
/**
|
|
114794
|
-
|
|
114795
|
-
/**
|
|
114796
|
-
|
|
114797
|
-
/** Default check-out time for reservations at the space, as HH:mm or HH:mm:ss. */
|
|
114798
|
-
default_checkout_time?: (string | null) | undefined
|
|
114799
|
-
/** Postal address for the space. */
|
|
114800
|
-
address?: (string | null) | undefined
|
|
117211
|
+
| {
|
|
117212
|
+
/** ID of the action attempt. */
|
|
117213
|
+
action_attempt_id: string
|
|
117214
|
+
status: 'pending'
|
|
117215
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117216
|
+
result: null
|
|
117217
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
117218
|
+
error: null
|
|
117219
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
117220
|
+
action_type: 'RESET_SANDBOX_WORKSPACE'
|
|
117221
|
+
}
|
|
117222
|
+
| {
|
|
117223
|
+
/** ID of the action attempt. */
|
|
117224
|
+
action_attempt_id: string
|
|
117225
|
+
status: 'success'
|
|
117226
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117227
|
+
error: null
|
|
117228
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
117229
|
+
action_type: 'RESET_SANDBOX_WORKSPACE'
|
|
117230
|
+
/** Result of the action. */
|
|
117231
|
+
result: {}
|
|
117232
|
+
}
|
|
117233
|
+
| {
|
|
117234
|
+
/** ID of the action attempt. */
|
|
117235
|
+
action_attempt_id: string
|
|
117236
|
+
status: 'error'
|
|
117237
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117238
|
+
result: null
|
|
117239
|
+
/** Action attempt to track the status of resetting a sandbox workspace. */
|
|
117240
|
+
action_type: 'RESET_SANDBOX_WORKSPACE'
|
|
117241
|
+
/** Error associated with the action. */
|
|
117242
|
+
error: {
|
|
117243
|
+
/** Type of the error. */
|
|
117244
|
+
type: string
|
|
117245
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117246
|
+
message: string
|
|
114801
117247
|
}
|
|
114802
|
-
|
|
114803
|
-
|
|
114804
|
-
|
|
114805
|
-
|
|
114806
|
-
|
|
114807
|
-
|
|
114808
|
-
|
|
114809
|
-
|
|
114810
|
-
|
|
114811
|
-
|
|
114812
|
-
|
|
114813
|
-
|
|
114814
|
-
|
|
114815
|
-
|
|
114816
|
-
|
|
117248
|
+
}
|
|
117249
|
+
| {
|
|
117250
|
+
/** ID of the action attempt. */
|
|
117251
|
+
action_attempt_id: string
|
|
117252
|
+
status: 'pending'
|
|
117253
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117254
|
+
result: null
|
|
117255
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
117256
|
+
error: null
|
|
117257
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
117258
|
+
action_type: 'SET_FAN_MODE'
|
|
117259
|
+
}
|
|
117260
|
+
| {
|
|
117261
|
+
/** ID of the action attempt. */
|
|
117262
|
+
action_attempt_id: string
|
|
117263
|
+
status: 'success'
|
|
117264
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117265
|
+
error: null
|
|
117266
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
117267
|
+
action_type: 'SET_FAN_MODE'
|
|
117268
|
+
/** Result of the action. */
|
|
117269
|
+
result: {}
|
|
117270
|
+
}
|
|
117271
|
+
| {
|
|
117272
|
+
/** ID of the action attempt. */
|
|
117273
|
+
action_attempt_id: string
|
|
117274
|
+
status: 'error'
|
|
117275
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117276
|
+
result: null
|
|
117277
|
+
/** Action attempt to track the status of setting the fan mode on a thermostat. */
|
|
117278
|
+
action_type: 'SET_FAN_MODE'
|
|
117279
|
+
/** Error associated with the action. */
|
|
117280
|
+
error: {
|
|
117281
|
+
/** Type of the error. */
|
|
117282
|
+
type: string
|
|
117283
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117284
|
+
message: string
|
|
117285
|
+
}
|
|
117286
|
+
}
|
|
117287
|
+
| {
|
|
117288
|
+
/** ID of the action attempt. */
|
|
117289
|
+
action_attempt_id: string
|
|
117290
|
+
status: 'pending'
|
|
117291
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117292
|
+
result: null
|
|
117293
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
117294
|
+
error: null
|
|
117295
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
117296
|
+
action_type: 'SET_HVAC_MODE'
|
|
117297
|
+
}
|
|
117298
|
+
| {
|
|
117299
|
+
/** ID of the action attempt. */
|
|
117300
|
+
action_attempt_id: string
|
|
117301
|
+
status: 'success'
|
|
117302
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117303
|
+
error: null
|
|
117304
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
117305
|
+
action_type: 'SET_HVAC_MODE'
|
|
117306
|
+
/** Result of the action. */
|
|
117307
|
+
result: {}
|
|
117308
|
+
}
|
|
117309
|
+
| {
|
|
117310
|
+
/** ID of the action attempt. */
|
|
117311
|
+
action_attempt_id: string
|
|
117312
|
+
status: 'error'
|
|
117313
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117314
|
+
result: null
|
|
117315
|
+
/** Action attempt to track the status of setting the HVAC mode on a thermostat. */
|
|
117316
|
+
action_type: 'SET_HVAC_MODE'
|
|
117317
|
+
/** Error associated with the action. */
|
|
117318
|
+
error: {
|
|
117319
|
+
/** Type of the error. */
|
|
117320
|
+
type: string
|
|
117321
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117322
|
+
message: string
|
|
117323
|
+
}
|
|
117324
|
+
}
|
|
117325
|
+
| {
|
|
117326
|
+
/** ID of the action attempt. */
|
|
117327
|
+
action_attempt_id: string
|
|
117328
|
+
status: 'pending'
|
|
117329
|
+
/** Result of the action attempt. Null for pending action attempts. */
|
|
117330
|
+
result: null
|
|
117331
|
+
/** Errors associated with the action attempt. Null for pending action attempts. */
|
|
117332
|
+
error: null
|
|
117333
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
117334
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET'
|
|
117335
|
+
}
|
|
117336
|
+
| {
|
|
117337
|
+
/** ID of the action attempt. */
|
|
117338
|
+
action_attempt_id: string
|
|
117339
|
+
status: 'success'
|
|
117340
|
+
/** Errors associated with the action attempt. Null for successful action attempts. */
|
|
117341
|
+
error: null
|
|
117342
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
117343
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET'
|
|
117344
|
+
/** Result of the action. */
|
|
117345
|
+
result: {}
|
|
117346
|
+
}
|
|
117347
|
+
| {
|
|
117348
|
+
/** ID of the action attempt. */
|
|
117349
|
+
action_attempt_id: string
|
|
117350
|
+
status: 'error'
|
|
117351
|
+
/** Result of the action attempt. Null for failed action attempts. */
|
|
117352
|
+
result: null
|
|
117353
|
+
/** Action attempt to track the status of a climate preset activation. */
|
|
117354
|
+
action_type: 'ACTIVATE_CLIMATE_PRESET'
|
|
117355
|
+
/** Error associated with the action. */
|
|
117356
|
+
error: {
|
|
117357
|
+
/** Type of the error. */
|
|
117358
|
+
type: string
|
|
117359
|
+
/** Detailed description of the error. Provides insights into the issue and potentially how to rectify it. */
|
|
117360
|
+
message: string
|
|
117361
|
+
}
|
|
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
|
+
}
|
|
114817
117841
|
}
|
|
114818
117842
|
maxDuration: undefined
|
|
114819
117843
|
}
|
|
114820
|
-
'/thermostats/
|
|
114821
|
-
route: '/thermostats/
|
|
117844
|
+
'/thermostats/activate_weekly_program': {
|
|
117845
|
+
route: '/thermostats/activate_weekly_program'
|
|
114822
117846
|
method: 'POST'
|
|
114823
117847
|
queryParams: {}
|
|
114824
117848
|
jsonBody: {
|
|
114825
|
-
/** ID of the thermostat device
|
|
117849
|
+
/** ID of the thermostat device that you want to return to its weekly program. */
|
|
114826
117850
|
device_id: string
|
|
114827
|
-
/**
|
|
114828
|
-
|
|
117851
|
+
/** */
|
|
117852
|
+
sync?: boolean
|
|
114829
117853
|
}
|
|
114830
117854
|
commonParams: {}
|
|
114831
117855
|
formData: {}
|
|
@@ -116492,6 +119516,44 @@ export type Routes = {
|
|
|
116492
119516
|
message: string
|
|
116493
119517
|
}
|
|
116494
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
|
+
}
|
|
116495
119557
|
| {
|
|
116496
119558
|
/** ID of the action attempt. */
|
|
116497
119559
|
action_attempt_id: string
|
|
@@ -118614,6 +121676,44 @@ export type Routes = {
|
|
|
118614
121676
|
message: string
|
|
118615
121677
|
}
|
|
118616
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
|
+
}
|
|
118617
121717
|
| {
|
|
118618
121718
|
/** ID of the action attempt. */
|
|
118619
121719
|
action_attempt_id: string
|
|
@@ -120847,6 +123947,44 @@ export type Routes = {
|
|
|
120847
123947
|
message: string
|
|
120848
123948
|
}
|
|
120849
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
|
+
}
|
|
120850
123988
|
| {
|
|
120851
123989
|
/** ID of the action attempt. */
|
|
120852
123990
|
action_attempt_id: string
|
|
@@ -123212,6 +126350,8 @@ export type Routes = {
|
|
|
123212
126350
|
can_hvac_heat_cool?: boolean | undefined
|
|
123213
126351
|
/** Indicates whether the thermostat can be turned off. */
|
|
123214
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
|
|
123215
126355
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
123216
126356
|
can_simulate_removal?: boolean | undefined
|
|
123217
126357
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -124920,6 +128060,44 @@ export type Routes = {
|
|
|
124920
128060
|
message: string
|
|
124921
128061
|
}
|
|
124922
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
|
+
}
|
|
124923
128101
|
| {
|
|
124924
128102
|
/** ID of the action attempt. */
|
|
124925
128103
|
action_attempt_id: string
|
|
@@ -127046,6 +130224,44 @@ export type Routes = {
|
|
|
127046
130224
|
message: string
|
|
127047
130225
|
}
|
|
127048
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
|
+
}
|
|
127049
130265
|
| {
|
|
127050
130266
|
/** ID of the action attempt. */
|
|
127051
130267
|
action_attempt_id: string
|
|
@@ -129430,6 +132646,8 @@ export type Routes = {
|
|
|
129430
132646
|
can_hvac_heat_cool?: boolean | undefined
|
|
129431
132647
|
/** Indicates whether the thermostat can be turned off. */
|
|
129432
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
|
|
129433
132651
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
129434
132652
|
can_simulate_removal?: boolean | undefined
|
|
129435
132653
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -131349,6 +134567,8 @@ export type Routes = {
|
|
|
131349
134567
|
can_hvac_heat_cool?: boolean | undefined
|
|
131350
134568
|
/** Indicates whether the thermostat can be turned off. */
|
|
131351
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
|
|
131352
134572
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
131353
134573
|
can_simulate_removal?: boolean | undefined
|
|
131354
134574
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -133053,6 +136273,44 @@ export type Routes = {
|
|
|
133053
136273
|
message: string
|
|
133054
136274
|
}
|
|
133055
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
|
+
}
|
|
133056
136314
|
| {
|
|
133057
136315
|
/** ID of the action attempt. */
|
|
133058
136316
|
action_attempt_id: string
|
|
@@ -135380,6 +138638,44 @@ export type Routes = {
|
|
|
135380
138638
|
message: string
|
|
135381
138639
|
}
|
|
135382
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
|
+
}
|
|
135383
138679
|
| {
|
|
135384
138680
|
/** ID of the action attempt. */
|
|
135385
138681
|
action_attempt_id: string
|
|
@@ -137534,6 +140830,44 @@ export type Routes = {
|
|
|
137534
140830
|
message: string
|
|
137535
140831
|
}
|
|
137536
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
|
+
}
|
|
137537
140871
|
| {
|
|
137538
140872
|
/** ID of the action attempt. */
|
|
137539
140873
|
action_attempt_id: string
|
|
@@ -139804,6 +143138,44 @@ export type Routes = {
|
|
|
139804
143138
|
message: string
|
|
139805
143139
|
}
|
|
139806
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
|
+
}
|
|
139807
143179
|
| {
|
|
139808
143180
|
/** ID of the action attempt. */
|
|
139809
143181
|
action_attempt_id: string
|
|
@@ -142786,6 +146158,8 @@ export type Routes = {
|
|
|
142786
146158
|
can_hvac_heat_cool?: boolean | undefined
|
|
142787
146159
|
/** Indicates whether the thermostat can be turned off. */
|
|
142788
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
|
|
142789
146163
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
142790
146164
|
can_simulate_removal?: boolean | undefined
|
|
142791
146165
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -144707,6 +148081,8 @@ export type Routes = {
|
|
|
144707
148081
|
can_hvac_heat_cool?: boolean | undefined
|
|
144708
148082
|
/** Indicates whether the thermostat can be turned off. */
|
|
144709
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
|
|
144710
148086
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
144711
148087
|
can_simulate_removal?: boolean | undefined
|
|
144712
148088
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -148217,6 +151593,8 @@ export type Routes = {
|
|
|
148217
151593
|
can_hvac_heat_cool?: boolean | undefined
|
|
148218
151594
|
/** Indicates whether the thermostat can be turned off. */
|
|
148219
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
|
|
148220
151598
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
148221
151599
|
can_simulate_removal?: boolean | undefined
|
|
148222
151600
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -150946,6 +154324,44 @@ export type Routes = {
|
|
|
150946
154324
|
message: string
|
|
150947
154325
|
}
|
|
150948
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
|
+
}
|
|
150949
154365
|
| {
|
|
150950
154366
|
/** ID of the action attempt. */
|
|
150951
154367
|
action_attempt_id: string
|
|
@@ -152498,6 +155914,8 @@ export type Routes = {
|
|
|
152498
155914
|
can_hvac_heat_cool?: boolean | undefined
|
|
152499
155915
|
/** Indicates whether the thermostat can be turned off. */
|
|
152500
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
|
|
152501
155919
|
/** Indicates whether the device supports simulating removal in a sandbox. */
|
|
152502
155920
|
can_simulate_removal?: boolean | undefined
|
|
152503
155921
|
/** Indicates whether the device supports simulating connection in a sandbox. */
|
|
@@ -160467,6 +163885,44 @@ export type Routes = {
|
|
|
160467
163885
|
message: string
|
|
160468
163886
|
}
|
|
160469
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
|
+
}
|
|
160470
163926
|
| {
|
|
160471
163927
|
/** ID of the action attempt. */
|
|
160472
163928
|
action_attempt_id: string
|