@seamapi/types 1.324.0 → 1.326.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.
@@ -48,13 +48,191 @@ export default {
48
48
  type: 'object',
49
49
  },
50
50
  {
51
- properties: {
52
- error_code: { type: 'string' },
53
- is_device_error: { enum: [true], type: 'boolean' },
54
- message: { type: 'string' },
55
- },
56
- required: ['message', 'is_device_error', 'error_code'],
57
- type: 'object',
51
+ description: 'Error associated with the `device`.',
52
+ oneOf: [
53
+ {
54
+ description: 'Device is offline',
55
+ properties: {
56
+ error_code: {
57
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
58
+ enum: ['device_offline'],
59
+ type: 'string',
60
+ },
61
+ is_device_error: { enum: [true], type: 'boolean' },
62
+ message: { type: 'string' },
63
+ },
64
+ required: ['message', 'is_device_error', 'error_code'],
65
+ type: 'object',
66
+ },
67
+ {
68
+ description: 'Device has been removed',
69
+ properties: {
70
+ error_code: {
71
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
72
+ enum: ['device_removed'],
73
+ type: 'string',
74
+ },
75
+ is_device_error: { enum: [true], type: 'boolean' },
76
+ message: { type: 'string' },
77
+ },
78
+ required: ['message', 'is_device_error', 'error_code'],
79
+ type: 'object',
80
+ },
81
+ {
82
+ description: 'Account is disconnected',
83
+ properties: {
84
+ error_code: {
85
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
86
+ enum: ['account_disconnected'],
87
+ type: 'string',
88
+ },
89
+ is_device_error: { enum: [true], type: 'boolean' },
90
+ message: { type: 'string' },
91
+ },
92
+ required: ['message', 'is_device_error', 'error_code'],
93
+ type: 'object',
94
+ },
95
+ {
96
+ description: 'Hub is disconnected',
97
+ properties: {
98
+ error_code: {
99
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
100
+ enum: ['hub_disconnected'],
101
+ type: 'string',
102
+ },
103
+ is_device_error: { enum: [true], type: 'boolean' },
104
+ message: { type: 'string' },
105
+ },
106
+ required: ['message', 'is_device_error', 'error_code'],
107
+ type: 'object',
108
+ },
109
+ {
110
+ description: 'Device is disconnected',
111
+ properties: {
112
+ error_code: {
113
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
114
+ enum: ['device_disconnected'],
115
+ type: 'string',
116
+ },
117
+ is_device_error: { enum: [true], type: 'boolean' },
118
+ message: { type: 'string' },
119
+ },
120
+ required: ['message', 'is_device_error', 'error_code'],
121
+ type: 'object',
122
+ },
123
+ {
124
+ description: 'The backup access code pool is empty.',
125
+ properties: {
126
+ error_code: {
127
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
128
+ enum: ['empty_backup_access_code_pool'],
129
+ type: 'string',
130
+ },
131
+ is_device_error: { enum: [true], type: 'boolean' },
132
+ message: { type: 'string' },
133
+ },
134
+ required: ['message', 'is_device_error', 'error_code'],
135
+ type: 'object',
136
+ },
137
+ {
138
+ description: 'User is not authorized to use the August Lock.',
139
+ properties: {
140
+ error_code: {
141
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
142
+ enum: ['august_lock_not_authorized'],
143
+ type: 'string',
144
+ },
145
+ is_device_error: { enum: [true], type: 'boolean' },
146
+ message: { type: 'string' },
147
+ },
148
+ required: ['message', 'is_device_error', 'error_code'],
149
+ type: 'object',
150
+ },
151
+ {
152
+ description: 'Lock is not connected to the Seam Bridge.',
153
+ properties: {
154
+ error_code: {
155
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
156
+ enum: ['august_lock_missing_bridge'],
157
+ type: 'string',
158
+ },
159
+ is_device_error: { enum: [true], type: 'boolean' },
160
+ message: { type: 'string' },
161
+ },
162
+ required: ['message', 'is_device_error', 'error_code'],
163
+ type: 'object',
164
+ },
165
+ {
166
+ description: 'Salto site user limit reached.',
167
+ properties: {
168
+ error_code: {
169
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
170
+ enum: ['salto_site_user_limit_reached'],
171
+ type: 'string',
172
+ },
173
+ is_device_error: { enum: [true], type: 'boolean' },
174
+ message: { type: 'string' },
175
+ },
176
+ required: ['message', 'is_device_error', 'error_code'],
177
+ type: 'object',
178
+ },
179
+ {
180
+ description: 'Lock is not paired with a Gateway.',
181
+ properties: {
182
+ error_code: {
183
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
184
+ enum: ['ttlock_lock_not_paired_to_gateway'],
185
+ type: 'string',
186
+ },
187
+ is_device_error: { enum: [true], type: 'boolean' },
188
+ message: { type: 'string' },
189
+ },
190
+ required: ['message', 'is_device_error', 'error_code'],
191
+ type: 'object',
192
+ },
193
+ {
194
+ description: 'Missing device credentials.',
195
+ properties: {
196
+ error_code: {
197
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
198
+ enum: ['missing_device_credentials'],
199
+ type: 'string',
200
+ },
201
+ is_device_error: { enum: [true], type: 'boolean' },
202
+ message: { type: 'string' },
203
+ },
204
+ required: ['message', 'is_device_error', 'error_code'],
205
+ type: 'object',
206
+ },
207
+ {
208
+ description: 'The auxiliary heat is running.',
209
+ properties: {
210
+ error_code: {
211
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
212
+ enum: ['auxiliary_heat_running'],
213
+ type: 'string',
214
+ },
215
+ is_device_error: { enum: [true], type: 'boolean' },
216
+ message: { type: 'string' },
217
+ },
218
+ required: ['message', 'is_device_error', 'error_code'],
219
+ type: 'object',
220
+ },
221
+ {
222
+ description: 'Subscription required to connect.',
223
+ properties: {
224
+ error_code: {
225
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
226
+ enum: ['subscription_required'],
227
+ type: 'string',
228
+ },
229
+ is_device_error: { enum: [true], type: 'boolean' },
230
+ message: { type: 'string' },
231
+ },
232
+ required: ['message', 'is_device_error', 'error_code'],
233
+ type: 'object',
234
+ },
235
+ ],
58
236
  },
59
237
  {
60
238
  properties: {
@@ -4104,13 +4282,191 @@ export default {
4104
4282
  items: {
4105
4283
  oneOf: [
4106
4284
  {
4107
- properties: {
4108
- error_code: { type: 'string' },
4109
- is_device_error: { enum: [true], type: 'boolean' },
4110
- message: { type: 'string' },
4111
- },
4112
- required: ['message', 'is_device_error', 'error_code'],
4113
- type: 'object',
4285
+ description: 'Error associated with the `device`.',
4286
+ oneOf: [
4287
+ {
4288
+ description: 'Device is offline',
4289
+ properties: {
4290
+ error_code: {
4291
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4292
+ enum: ['device_offline'],
4293
+ type: 'string',
4294
+ },
4295
+ is_device_error: { enum: [true], type: 'boolean' },
4296
+ message: { type: 'string' },
4297
+ },
4298
+ required: ['message', 'is_device_error', 'error_code'],
4299
+ type: 'object',
4300
+ },
4301
+ {
4302
+ description: 'Device has been removed',
4303
+ properties: {
4304
+ error_code: {
4305
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4306
+ enum: ['device_removed'],
4307
+ type: 'string',
4308
+ },
4309
+ is_device_error: { enum: [true], type: 'boolean' },
4310
+ message: { type: 'string' },
4311
+ },
4312
+ required: ['message', 'is_device_error', 'error_code'],
4313
+ type: 'object',
4314
+ },
4315
+ {
4316
+ description: 'Account is disconnected',
4317
+ properties: {
4318
+ error_code: {
4319
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4320
+ enum: ['account_disconnected'],
4321
+ type: 'string',
4322
+ },
4323
+ is_device_error: { enum: [true], type: 'boolean' },
4324
+ message: { type: 'string' },
4325
+ },
4326
+ required: ['message', 'is_device_error', 'error_code'],
4327
+ type: 'object',
4328
+ },
4329
+ {
4330
+ description: 'Hub is disconnected',
4331
+ properties: {
4332
+ error_code: {
4333
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4334
+ enum: ['hub_disconnected'],
4335
+ type: 'string',
4336
+ },
4337
+ is_device_error: { enum: [true], type: 'boolean' },
4338
+ message: { type: 'string' },
4339
+ },
4340
+ required: ['message', 'is_device_error', 'error_code'],
4341
+ type: 'object',
4342
+ },
4343
+ {
4344
+ description: 'Device is disconnected',
4345
+ properties: {
4346
+ error_code: {
4347
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4348
+ enum: ['device_disconnected'],
4349
+ type: 'string',
4350
+ },
4351
+ is_device_error: { enum: [true], type: 'boolean' },
4352
+ message: { type: 'string' },
4353
+ },
4354
+ required: ['message', 'is_device_error', 'error_code'],
4355
+ type: 'object',
4356
+ },
4357
+ {
4358
+ description: 'The backup access code pool is empty.',
4359
+ properties: {
4360
+ error_code: {
4361
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4362
+ enum: ['empty_backup_access_code_pool'],
4363
+ type: 'string',
4364
+ },
4365
+ is_device_error: { enum: [true], type: 'boolean' },
4366
+ message: { type: 'string' },
4367
+ },
4368
+ required: ['message', 'is_device_error', 'error_code'],
4369
+ type: 'object',
4370
+ },
4371
+ {
4372
+ description: 'User is not authorized to use the August Lock.',
4373
+ properties: {
4374
+ error_code: {
4375
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4376
+ enum: ['august_lock_not_authorized'],
4377
+ type: 'string',
4378
+ },
4379
+ is_device_error: { enum: [true], type: 'boolean' },
4380
+ message: { type: 'string' },
4381
+ },
4382
+ required: ['message', 'is_device_error', 'error_code'],
4383
+ type: 'object',
4384
+ },
4385
+ {
4386
+ description: 'Lock is not connected to the Seam Bridge.',
4387
+ properties: {
4388
+ error_code: {
4389
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4390
+ enum: ['august_lock_missing_bridge'],
4391
+ type: 'string',
4392
+ },
4393
+ is_device_error: { enum: [true], type: 'boolean' },
4394
+ message: { type: 'string' },
4395
+ },
4396
+ required: ['message', 'is_device_error', 'error_code'],
4397
+ type: 'object',
4398
+ },
4399
+ {
4400
+ description: 'Salto site user limit reached.',
4401
+ properties: {
4402
+ error_code: {
4403
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4404
+ enum: ['salto_site_user_limit_reached'],
4405
+ type: 'string',
4406
+ },
4407
+ is_device_error: { enum: [true], type: 'boolean' },
4408
+ message: { type: 'string' },
4409
+ },
4410
+ required: ['message', 'is_device_error', 'error_code'],
4411
+ type: 'object',
4412
+ },
4413
+ {
4414
+ description: 'Lock is not paired with a Gateway.',
4415
+ properties: {
4416
+ error_code: {
4417
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4418
+ enum: ['ttlock_lock_not_paired_to_gateway'],
4419
+ type: 'string',
4420
+ },
4421
+ is_device_error: { enum: [true], type: 'boolean' },
4422
+ message: { type: 'string' },
4423
+ },
4424
+ required: ['message', 'is_device_error', 'error_code'],
4425
+ type: 'object',
4426
+ },
4427
+ {
4428
+ description: 'Missing device credentials.',
4429
+ properties: {
4430
+ error_code: {
4431
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4432
+ enum: ['missing_device_credentials'],
4433
+ type: 'string',
4434
+ },
4435
+ is_device_error: { enum: [true], type: 'boolean' },
4436
+ message: { type: 'string' },
4437
+ },
4438
+ required: ['message', 'is_device_error', 'error_code'],
4439
+ type: 'object',
4440
+ },
4441
+ {
4442
+ description: 'The auxiliary heat is running.',
4443
+ properties: {
4444
+ error_code: {
4445
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4446
+ enum: ['auxiliary_heat_running'],
4447
+ type: 'string',
4448
+ },
4449
+ is_device_error: { enum: [true], type: 'boolean' },
4450
+ message: { type: 'string' },
4451
+ },
4452
+ required: ['message', 'is_device_error', 'error_code'],
4453
+ type: 'object',
4454
+ },
4455
+ {
4456
+ description: 'Subscription required to connect.',
4457
+ properties: {
4458
+ error_code: {
4459
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4460
+ enum: ['subscription_required'],
4461
+ type: 'string',
4462
+ },
4463
+ is_device_error: { enum: [true], type: 'boolean' },
4464
+ message: { type: 'string' },
4465
+ },
4466
+ required: ['message', 'is_device_error', 'error_code'],
4467
+ type: 'object',
4468
+ },
4469
+ ],
4114
4470
  },
4115
4471
  {
4116
4472
  properties: {
@@ -9158,6 +9514,76 @@ export default {
9158
9514
  ],
9159
9515
  type: 'object',
9160
9516
  },
9517
+ {
9518
+ properties: {
9519
+ connected_account_id: {
9520
+ description: 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
9521
+ format: 'uuid',
9522
+ type: 'string',
9523
+ },
9524
+ created_at: {
9525
+ description: 'Date and time at which the event was created.',
9526
+ format: 'date-time',
9527
+ type: 'string',
9528
+ },
9529
+ desired_temperature_celsius: {
9530
+ description: "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
9531
+ format: 'float',
9532
+ type: 'number',
9533
+ },
9534
+ desired_temperature_fahrenheit: {
9535
+ description: "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
9536
+ format: 'float',
9537
+ type: 'number',
9538
+ },
9539
+ device_id: {
9540
+ description: 'ID of the device.',
9541
+ format: 'uuid',
9542
+ type: 'string',
9543
+ },
9544
+ event_id: {
9545
+ description: 'ID of the event.',
9546
+ format: 'uuid',
9547
+ type: 'string',
9548
+ },
9549
+ event_type: {
9550
+ enum: ['thermostat.temperature_reached_set_point'],
9551
+ type: 'string',
9552
+ },
9553
+ occurred_at: {
9554
+ description: 'Date and time at which the event occurred.',
9555
+ format: 'date-time',
9556
+ type: 'string',
9557
+ },
9558
+ temperature_celsius: {
9559
+ description: 'Temperature, in °C, reported by the thermostat.',
9560
+ format: 'float',
9561
+ type: 'number',
9562
+ },
9563
+ temperature_fahrenheit: {
9564
+ description: 'Temperature, in °F, reported by the thermostat.',
9565
+ format: 'float',
9566
+ type: 'number',
9567
+ },
9568
+ workspace_id: {
9569
+ description: 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
9570
+ format: 'uuid',
9571
+ type: 'string',
9572
+ },
9573
+ },
9574
+ required: [
9575
+ 'event_id',
9576
+ 'workspace_id',
9577
+ 'created_at',
9578
+ 'occurred_at',
9579
+ 'device_id',
9580
+ 'connected_account_id',
9581
+ 'event_type',
9582
+ 'temperature_celsius',
9583
+ 'temperature_fahrenheit',
9584
+ ],
9585
+ type: 'object',
9586
+ },
9161
9587
  {
9162
9588
  description: 'An [enrollment automation](https://docs.seam.co/latest/capability-guides/mobile-access/issuing-mobile-credentials-from-an-access-control-system#prepare-the-phones-for-a-user-identity-to-start-receiving-mobile-credentials-using-an-enrollment-aut) was deleted.',
9163
9589
  properties: {
@@ -9327,13 +9753,191 @@ export default {
9327
9753
  items: {
9328
9754
  oneOf: [
9329
9755
  {
9330
- properties: {
9331
- error_code: { type: 'string' },
9332
- is_device_error: { enum: [true], type: 'boolean' },
9333
- message: { type: 'string' },
9334
- },
9335
- required: ['message', 'is_device_error', 'error_code'],
9336
- type: 'object',
9756
+ description: 'Error associated with the `device`.',
9757
+ oneOf: [
9758
+ {
9759
+ description: 'Device is offline',
9760
+ properties: {
9761
+ error_code: {
9762
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9763
+ enum: ['device_offline'],
9764
+ type: 'string',
9765
+ },
9766
+ is_device_error: { enum: [true], type: 'boolean' },
9767
+ message: { type: 'string' },
9768
+ },
9769
+ required: ['message', 'is_device_error', 'error_code'],
9770
+ type: 'object',
9771
+ },
9772
+ {
9773
+ description: 'Device has been removed',
9774
+ properties: {
9775
+ error_code: {
9776
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9777
+ enum: ['device_removed'],
9778
+ type: 'string',
9779
+ },
9780
+ is_device_error: { enum: [true], type: 'boolean' },
9781
+ message: { type: 'string' },
9782
+ },
9783
+ required: ['message', 'is_device_error', 'error_code'],
9784
+ type: 'object',
9785
+ },
9786
+ {
9787
+ description: 'Account is disconnected',
9788
+ properties: {
9789
+ error_code: {
9790
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9791
+ enum: ['account_disconnected'],
9792
+ type: 'string',
9793
+ },
9794
+ is_device_error: { enum: [true], type: 'boolean' },
9795
+ message: { type: 'string' },
9796
+ },
9797
+ required: ['message', 'is_device_error', 'error_code'],
9798
+ type: 'object',
9799
+ },
9800
+ {
9801
+ description: 'Hub is disconnected',
9802
+ properties: {
9803
+ error_code: {
9804
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9805
+ enum: ['hub_disconnected'],
9806
+ type: 'string',
9807
+ },
9808
+ is_device_error: { enum: [true], type: 'boolean' },
9809
+ message: { type: 'string' },
9810
+ },
9811
+ required: ['message', 'is_device_error', 'error_code'],
9812
+ type: 'object',
9813
+ },
9814
+ {
9815
+ description: 'Device is disconnected',
9816
+ properties: {
9817
+ error_code: {
9818
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9819
+ enum: ['device_disconnected'],
9820
+ type: 'string',
9821
+ },
9822
+ is_device_error: { enum: [true], type: 'boolean' },
9823
+ message: { type: 'string' },
9824
+ },
9825
+ required: ['message', 'is_device_error', 'error_code'],
9826
+ type: 'object',
9827
+ },
9828
+ {
9829
+ description: 'The backup access code pool is empty.',
9830
+ properties: {
9831
+ error_code: {
9832
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9833
+ enum: ['empty_backup_access_code_pool'],
9834
+ type: 'string',
9835
+ },
9836
+ is_device_error: { enum: [true], type: 'boolean' },
9837
+ message: { type: 'string' },
9838
+ },
9839
+ required: ['message', 'is_device_error', 'error_code'],
9840
+ type: 'object',
9841
+ },
9842
+ {
9843
+ description: 'User is not authorized to use the August Lock.',
9844
+ properties: {
9845
+ error_code: {
9846
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9847
+ enum: ['august_lock_not_authorized'],
9848
+ type: 'string',
9849
+ },
9850
+ is_device_error: { enum: [true], type: 'boolean' },
9851
+ message: { type: 'string' },
9852
+ },
9853
+ required: ['message', 'is_device_error', 'error_code'],
9854
+ type: 'object',
9855
+ },
9856
+ {
9857
+ description: 'Lock is not connected to the Seam Bridge.',
9858
+ properties: {
9859
+ error_code: {
9860
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9861
+ enum: ['august_lock_missing_bridge'],
9862
+ type: 'string',
9863
+ },
9864
+ is_device_error: { enum: [true], type: 'boolean' },
9865
+ message: { type: 'string' },
9866
+ },
9867
+ required: ['message', 'is_device_error', 'error_code'],
9868
+ type: 'object',
9869
+ },
9870
+ {
9871
+ description: 'Salto site user limit reached.',
9872
+ properties: {
9873
+ error_code: {
9874
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9875
+ enum: ['salto_site_user_limit_reached'],
9876
+ type: 'string',
9877
+ },
9878
+ is_device_error: { enum: [true], type: 'boolean' },
9879
+ message: { type: 'string' },
9880
+ },
9881
+ required: ['message', 'is_device_error', 'error_code'],
9882
+ type: 'object',
9883
+ },
9884
+ {
9885
+ description: 'Lock is not paired with a Gateway.',
9886
+ properties: {
9887
+ error_code: {
9888
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9889
+ enum: ['ttlock_lock_not_paired_to_gateway'],
9890
+ type: 'string',
9891
+ },
9892
+ is_device_error: { enum: [true], type: 'boolean' },
9893
+ message: { type: 'string' },
9894
+ },
9895
+ required: ['message', 'is_device_error', 'error_code'],
9896
+ type: 'object',
9897
+ },
9898
+ {
9899
+ description: 'Missing device credentials.',
9900
+ properties: {
9901
+ error_code: {
9902
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9903
+ enum: ['missing_device_credentials'],
9904
+ type: 'string',
9905
+ },
9906
+ is_device_error: { enum: [true], type: 'boolean' },
9907
+ message: { type: 'string' },
9908
+ },
9909
+ required: ['message', 'is_device_error', 'error_code'],
9910
+ type: 'object',
9911
+ },
9912
+ {
9913
+ description: 'The auxiliary heat is running.',
9914
+ properties: {
9915
+ error_code: {
9916
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9917
+ enum: ['auxiliary_heat_running'],
9918
+ type: 'string',
9919
+ },
9920
+ is_device_error: { enum: [true], type: 'boolean' },
9921
+ message: { type: 'string' },
9922
+ },
9923
+ required: ['message', 'is_device_error', 'error_code'],
9924
+ type: 'object',
9925
+ },
9926
+ {
9927
+ description: 'Subscription required to connect.',
9928
+ properties: {
9929
+ error_code: {
9930
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9931
+ enum: ['subscription_required'],
9932
+ type: 'string',
9933
+ },
9934
+ is_device_error: { enum: [true], type: 'boolean' },
9935
+ message: { type: 'string' },
9936
+ },
9937
+ required: ['message', 'is_device_error', 'error_code'],
9938
+ type: 'object',
9939
+ },
9940
+ ],
9337
9941
  },
9338
9942
  {
9339
9943
  properties: {
@@ -9558,13 +10162,191 @@ export default {
9558
10162
  type: 'object',
9559
10163
  },
9560
10164
  {
9561
- properties: {
9562
- error_code: { type: 'string' },
9563
- is_device_error: { enum: [true], type: 'boolean' },
9564
- message: { type: 'string' },
9565
- },
9566
- required: ['message', 'is_device_error', 'error_code'],
9567
- type: 'object',
10165
+ description: 'Error associated with the `device`.',
10166
+ oneOf: [
10167
+ {
10168
+ description: 'Device is offline',
10169
+ properties: {
10170
+ error_code: {
10171
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10172
+ enum: ['device_offline'],
10173
+ type: 'string',
10174
+ },
10175
+ is_device_error: { enum: [true], type: 'boolean' },
10176
+ message: { type: 'string' },
10177
+ },
10178
+ required: ['message', 'is_device_error', 'error_code'],
10179
+ type: 'object',
10180
+ },
10181
+ {
10182
+ description: 'Device has been removed',
10183
+ properties: {
10184
+ error_code: {
10185
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10186
+ enum: ['device_removed'],
10187
+ type: 'string',
10188
+ },
10189
+ is_device_error: { enum: [true], type: 'boolean' },
10190
+ message: { type: 'string' },
10191
+ },
10192
+ required: ['message', 'is_device_error', 'error_code'],
10193
+ type: 'object',
10194
+ },
10195
+ {
10196
+ description: 'Account is disconnected',
10197
+ properties: {
10198
+ error_code: {
10199
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10200
+ enum: ['account_disconnected'],
10201
+ type: 'string',
10202
+ },
10203
+ is_device_error: { enum: [true], type: 'boolean' },
10204
+ message: { type: 'string' },
10205
+ },
10206
+ required: ['message', 'is_device_error', 'error_code'],
10207
+ type: 'object',
10208
+ },
10209
+ {
10210
+ description: 'Hub is disconnected',
10211
+ properties: {
10212
+ error_code: {
10213
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10214
+ enum: ['hub_disconnected'],
10215
+ type: 'string',
10216
+ },
10217
+ is_device_error: { enum: [true], type: 'boolean' },
10218
+ message: { type: 'string' },
10219
+ },
10220
+ required: ['message', 'is_device_error', 'error_code'],
10221
+ type: 'object',
10222
+ },
10223
+ {
10224
+ description: 'Device is disconnected',
10225
+ properties: {
10226
+ error_code: {
10227
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10228
+ enum: ['device_disconnected'],
10229
+ type: 'string',
10230
+ },
10231
+ is_device_error: { enum: [true], type: 'boolean' },
10232
+ message: { type: 'string' },
10233
+ },
10234
+ required: ['message', 'is_device_error', 'error_code'],
10235
+ type: 'object',
10236
+ },
10237
+ {
10238
+ description: 'The backup access code pool is empty.',
10239
+ properties: {
10240
+ error_code: {
10241
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10242
+ enum: ['empty_backup_access_code_pool'],
10243
+ type: 'string',
10244
+ },
10245
+ is_device_error: { enum: [true], type: 'boolean' },
10246
+ message: { type: 'string' },
10247
+ },
10248
+ required: ['message', 'is_device_error', 'error_code'],
10249
+ type: 'object',
10250
+ },
10251
+ {
10252
+ description: 'User is not authorized to use the August Lock.',
10253
+ properties: {
10254
+ error_code: {
10255
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10256
+ enum: ['august_lock_not_authorized'],
10257
+ type: 'string',
10258
+ },
10259
+ is_device_error: { enum: [true], type: 'boolean' },
10260
+ message: { type: 'string' },
10261
+ },
10262
+ required: ['message', 'is_device_error', 'error_code'],
10263
+ type: 'object',
10264
+ },
10265
+ {
10266
+ description: 'Lock is not connected to the Seam Bridge.',
10267
+ properties: {
10268
+ error_code: {
10269
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10270
+ enum: ['august_lock_missing_bridge'],
10271
+ type: 'string',
10272
+ },
10273
+ is_device_error: { enum: [true], type: 'boolean' },
10274
+ message: { type: 'string' },
10275
+ },
10276
+ required: ['message', 'is_device_error', 'error_code'],
10277
+ type: 'object',
10278
+ },
10279
+ {
10280
+ description: 'Salto site user limit reached.',
10281
+ properties: {
10282
+ error_code: {
10283
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10284
+ enum: ['salto_site_user_limit_reached'],
10285
+ type: 'string',
10286
+ },
10287
+ is_device_error: { enum: [true], type: 'boolean' },
10288
+ message: { type: 'string' },
10289
+ },
10290
+ required: ['message', 'is_device_error', 'error_code'],
10291
+ type: 'object',
10292
+ },
10293
+ {
10294
+ description: 'Lock is not paired with a Gateway.',
10295
+ properties: {
10296
+ error_code: {
10297
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10298
+ enum: ['ttlock_lock_not_paired_to_gateway'],
10299
+ type: 'string',
10300
+ },
10301
+ is_device_error: { enum: [true], type: 'boolean' },
10302
+ message: { type: 'string' },
10303
+ },
10304
+ required: ['message', 'is_device_error', 'error_code'],
10305
+ type: 'object',
10306
+ },
10307
+ {
10308
+ description: 'Missing device credentials.',
10309
+ properties: {
10310
+ error_code: {
10311
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10312
+ enum: ['missing_device_credentials'],
10313
+ type: 'string',
10314
+ },
10315
+ is_device_error: { enum: [true], type: 'boolean' },
10316
+ message: { type: 'string' },
10317
+ },
10318
+ required: ['message', 'is_device_error', 'error_code'],
10319
+ type: 'object',
10320
+ },
10321
+ {
10322
+ description: 'The auxiliary heat is running.',
10323
+ properties: {
10324
+ error_code: {
10325
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10326
+ enum: ['auxiliary_heat_running'],
10327
+ type: 'string',
10328
+ },
10329
+ is_device_error: { enum: [true], type: 'boolean' },
10330
+ message: { type: 'string' },
10331
+ },
10332
+ required: ['message', 'is_device_error', 'error_code'],
10333
+ type: 'object',
10334
+ },
10335
+ {
10336
+ description: 'Subscription required to connect.',
10337
+ properties: {
10338
+ error_code: {
10339
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10340
+ enum: ['subscription_required'],
10341
+ type: 'string',
10342
+ },
10343
+ is_device_error: { enum: [true], type: 'boolean' },
10344
+ message: { type: 'string' },
10345
+ },
10346
+ required: ['message', 'is_device_error', 'error_code'],
10347
+ type: 'object',
10348
+ },
10349
+ ],
9568
10350
  },
9569
10351
  {
9570
10352
  properties: {
@@ -9730,13 +10512,191 @@ export default {
9730
10512
  items: {
9731
10513
  oneOf: [
9732
10514
  {
9733
- properties: {
9734
- error_code: { type: 'string' },
9735
- is_device_error: { enum: [true], type: 'boolean' },
9736
- message: { type: 'string' },
9737
- },
9738
- required: ['message', 'is_device_error', 'error_code'],
9739
- type: 'object',
10515
+ description: 'Error associated with the `device`.',
10516
+ oneOf: [
10517
+ {
10518
+ description: 'Device is offline',
10519
+ properties: {
10520
+ error_code: {
10521
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10522
+ enum: ['device_offline'],
10523
+ type: 'string',
10524
+ },
10525
+ is_device_error: { enum: [true], type: 'boolean' },
10526
+ message: { type: 'string' },
10527
+ },
10528
+ required: ['message', 'is_device_error', 'error_code'],
10529
+ type: 'object',
10530
+ },
10531
+ {
10532
+ description: 'Device has been removed',
10533
+ properties: {
10534
+ error_code: {
10535
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10536
+ enum: ['device_removed'],
10537
+ type: 'string',
10538
+ },
10539
+ is_device_error: { enum: [true], type: 'boolean' },
10540
+ message: { type: 'string' },
10541
+ },
10542
+ required: ['message', 'is_device_error', 'error_code'],
10543
+ type: 'object',
10544
+ },
10545
+ {
10546
+ description: 'Account is disconnected',
10547
+ properties: {
10548
+ error_code: {
10549
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10550
+ enum: ['account_disconnected'],
10551
+ type: 'string',
10552
+ },
10553
+ is_device_error: { enum: [true], type: 'boolean' },
10554
+ message: { type: 'string' },
10555
+ },
10556
+ required: ['message', 'is_device_error', 'error_code'],
10557
+ type: 'object',
10558
+ },
10559
+ {
10560
+ description: 'Hub is disconnected',
10561
+ properties: {
10562
+ error_code: {
10563
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10564
+ enum: ['hub_disconnected'],
10565
+ type: 'string',
10566
+ },
10567
+ is_device_error: { enum: [true], type: 'boolean' },
10568
+ message: { type: 'string' },
10569
+ },
10570
+ required: ['message', 'is_device_error', 'error_code'],
10571
+ type: 'object',
10572
+ },
10573
+ {
10574
+ description: 'Device is disconnected',
10575
+ properties: {
10576
+ error_code: {
10577
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10578
+ enum: ['device_disconnected'],
10579
+ type: 'string',
10580
+ },
10581
+ is_device_error: { enum: [true], type: 'boolean' },
10582
+ message: { type: 'string' },
10583
+ },
10584
+ required: ['message', 'is_device_error', 'error_code'],
10585
+ type: 'object',
10586
+ },
10587
+ {
10588
+ description: 'The backup access code pool is empty.',
10589
+ properties: {
10590
+ error_code: {
10591
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10592
+ enum: ['empty_backup_access_code_pool'],
10593
+ type: 'string',
10594
+ },
10595
+ is_device_error: { enum: [true], type: 'boolean' },
10596
+ message: { type: 'string' },
10597
+ },
10598
+ required: ['message', 'is_device_error', 'error_code'],
10599
+ type: 'object',
10600
+ },
10601
+ {
10602
+ description: 'User is not authorized to use the August Lock.',
10603
+ properties: {
10604
+ error_code: {
10605
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10606
+ enum: ['august_lock_not_authorized'],
10607
+ type: 'string',
10608
+ },
10609
+ is_device_error: { enum: [true], type: 'boolean' },
10610
+ message: { type: 'string' },
10611
+ },
10612
+ required: ['message', 'is_device_error', 'error_code'],
10613
+ type: 'object',
10614
+ },
10615
+ {
10616
+ description: 'Lock is not connected to the Seam Bridge.',
10617
+ properties: {
10618
+ error_code: {
10619
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10620
+ enum: ['august_lock_missing_bridge'],
10621
+ type: 'string',
10622
+ },
10623
+ is_device_error: { enum: [true], type: 'boolean' },
10624
+ message: { type: 'string' },
10625
+ },
10626
+ required: ['message', 'is_device_error', 'error_code'],
10627
+ type: 'object',
10628
+ },
10629
+ {
10630
+ description: 'Salto site user limit reached.',
10631
+ properties: {
10632
+ error_code: {
10633
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10634
+ enum: ['salto_site_user_limit_reached'],
10635
+ type: 'string',
10636
+ },
10637
+ is_device_error: { enum: [true], type: 'boolean' },
10638
+ message: { type: 'string' },
10639
+ },
10640
+ required: ['message', 'is_device_error', 'error_code'],
10641
+ type: 'object',
10642
+ },
10643
+ {
10644
+ description: 'Lock is not paired with a Gateway.',
10645
+ properties: {
10646
+ error_code: {
10647
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10648
+ enum: ['ttlock_lock_not_paired_to_gateway'],
10649
+ type: 'string',
10650
+ },
10651
+ is_device_error: { enum: [true], type: 'boolean' },
10652
+ message: { type: 'string' },
10653
+ },
10654
+ required: ['message', 'is_device_error', 'error_code'],
10655
+ type: 'object',
10656
+ },
10657
+ {
10658
+ description: 'Missing device credentials.',
10659
+ properties: {
10660
+ error_code: {
10661
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10662
+ enum: ['missing_device_credentials'],
10663
+ type: 'string',
10664
+ },
10665
+ is_device_error: { enum: [true], type: 'boolean' },
10666
+ message: { type: 'string' },
10667
+ },
10668
+ required: ['message', 'is_device_error', 'error_code'],
10669
+ type: 'object',
10670
+ },
10671
+ {
10672
+ description: 'The auxiliary heat is running.',
10673
+ properties: {
10674
+ error_code: {
10675
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10676
+ enum: ['auxiliary_heat_running'],
10677
+ type: 'string',
10678
+ },
10679
+ is_device_error: { enum: [true], type: 'boolean' },
10680
+ message: { type: 'string' },
10681
+ },
10682
+ required: ['message', 'is_device_error', 'error_code'],
10683
+ type: 'object',
10684
+ },
10685
+ {
10686
+ description: 'Subscription required to connect.',
10687
+ properties: {
10688
+ error_code: {
10689
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10690
+ enum: ['subscription_required'],
10691
+ type: 'string',
10692
+ },
10693
+ is_device_error: { enum: [true], type: 'boolean' },
10694
+ message: { type: 'string' },
10695
+ },
10696
+ required: ['message', 'is_device_error', 'error_code'],
10697
+ type: 'object',
10698
+ },
10699
+ ],
9740
10700
  },
9741
10701
  {
9742
10702
  properties: {
@@ -18621,6 +19581,7 @@ export default {
18621
19581
  'thermostat.manually_adjusted',
18622
19582
  'thermostat.temperature_threshold_exceeded',
18623
19583
  'thermostat.temperature_threshold_no_longer_exceeded',
19584
+ 'thermostat.temperature_reached_set_point',
18624
19585
  ],
18625
19586
  type: 'string',
18626
19587
  },
@@ -18698,6 +19659,7 @@ export default {
18698
19659
  'thermostat.manually_adjusted',
18699
19660
  'thermostat.temperature_threshold_exceeded',
18700
19661
  'thermostat.temperature_threshold_no_longer_exceeded',
19662
+ 'thermostat.temperature_reached_set_point',
18701
19663
  ],
18702
19664
  type: 'string',
18703
19665
  },