@seamapi/types 1.324.0 → 1.325.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: {
@@ -9327,13 +9683,191 @@ export default {
9327
9683
  items: {
9328
9684
  oneOf: [
9329
9685
  {
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',
9686
+ description: 'Error associated with the `device`.',
9687
+ oneOf: [
9688
+ {
9689
+ description: 'Device is offline',
9690
+ properties: {
9691
+ error_code: {
9692
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9693
+ enum: ['device_offline'],
9694
+ type: 'string',
9695
+ },
9696
+ is_device_error: { enum: [true], type: 'boolean' },
9697
+ message: { type: 'string' },
9698
+ },
9699
+ required: ['message', 'is_device_error', 'error_code'],
9700
+ type: 'object',
9701
+ },
9702
+ {
9703
+ description: 'Device has been removed',
9704
+ properties: {
9705
+ error_code: {
9706
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9707
+ enum: ['device_removed'],
9708
+ type: 'string',
9709
+ },
9710
+ is_device_error: { enum: [true], type: 'boolean' },
9711
+ message: { type: 'string' },
9712
+ },
9713
+ required: ['message', 'is_device_error', 'error_code'],
9714
+ type: 'object',
9715
+ },
9716
+ {
9717
+ description: 'Account is disconnected',
9718
+ properties: {
9719
+ error_code: {
9720
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9721
+ enum: ['account_disconnected'],
9722
+ type: 'string',
9723
+ },
9724
+ is_device_error: { enum: [true], type: 'boolean' },
9725
+ message: { type: 'string' },
9726
+ },
9727
+ required: ['message', 'is_device_error', 'error_code'],
9728
+ type: 'object',
9729
+ },
9730
+ {
9731
+ description: 'Hub is disconnected',
9732
+ properties: {
9733
+ error_code: {
9734
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9735
+ enum: ['hub_disconnected'],
9736
+ type: 'string',
9737
+ },
9738
+ is_device_error: { enum: [true], type: 'boolean' },
9739
+ message: { type: 'string' },
9740
+ },
9741
+ required: ['message', 'is_device_error', 'error_code'],
9742
+ type: 'object',
9743
+ },
9744
+ {
9745
+ description: 'Device is disconnected',
9746
+ properties: {
9747
+ error_code: {
9748
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9749
+ enum: ['device_disconnected'],
9750
+ type: 'string',
9751
+ },
9752
+ is_device_error: { enum: [true], type: 'boolean' },
9753
+ message: { type: 'string' },
9754
+ },
9755
+ required: ['message', 'is_device_error', 'error_code'],
9756
+ type: 'object',
9757
+ },
9758
+ {
9759
+ description: 'The backup access code pool is empty.',
9760
+ properties: {
9761
+ error_code: {
9762
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9763
+ enum: ['empty_backup_access_code_pool'],
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: 'User is not authorized to use the August Lock.',
9774
+ properties: {
9775
+ error_code: {
9776
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9777
+ enum: ['august_lock_not_authorized'],
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: 'Lock is not connected to the Seam Bridge.',
9788
+ properties: {
9789
+ error_code: {
9790
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9791
+ enum: ['august_lock_missing_bridge'],
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: 'Salto site user limit reached.',
9802
+ properties: {
9803
+ error_code: {
9804
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9805
+ enum: ['salto_site_user_limit_reached'],
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: 'Lock is not paired with a Gateway.',
9816
+ properties: {
9817
+ error_code: {
9818
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9819
+ enum: ['ttlock_lock_not_paired_to_gateway'],
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: 'Missing device credentials.',
9830
+ properties: {
9831
+ error_code: {
9832
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9833
+ enum: ['missing_device_credentials'],
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: 'The auxiliary heat is running.',
9844
+ properties: {
9845
+ error_code: {
9846
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9847
+ enum: ['auxiliary_heat_running'],
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: 'Subscription required to connect.',
9858
+ properties: {
9859
+ error_code: {
9860
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
9861
+ enum: ['subscription_required'],
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
+ ],
9337
9871
  },
9338
9872
  {
9339
9873
  properties: {
@@ -9558,13 +10092,191 @@ export default {
9558
10092
  type: 'object',
9559
10093
  },
9560
10094
  {
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',
10095
+ description: 'Error associated with the `device`.',
10096
+ oneOf: [
10097
+ {
10098
+ description: 'Device is offline',
10099
+ properties: {
10100
+ error_code: {
10101
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10102
+ enum: ['device_offline'],
10103
+ type: 'string',
10104
+ },
10105
+ is_device_error: { enum: [true], type: 'boolean' },
10106
+ message: { type: 'string' },
10107
+ },
10108
+ required: ['message', 'is_device_error', 'error_code'],
10109
+ type: 'object',
10110
+ },
10111
+ {
10112
+ description: 'Device has been removed',
10113
+ properties: {
10114
+ error_code: {
10115
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10116
+ enum: ['device_removed'],
10117
+ type: 'string',
10118
+ },
10119
+ is_device_error: { enum: [true], type: 'boolean' },
10120
+ message: { type: 'string' },
10121
+ },
10122
+ required: ['message', 'is_device_error', 'error_code'],
10123
+ type: 'object',
10124
+ },
10125
+ {
10126
+ description: 'Account is disconnected',
10127
+ properties: {
10128
+ error_code: {
10129
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10130
+ enum: ['account_disconnected'],
10131
+ type: 'string',
10132
+ },
10133
+ is_device_error: { enum: [true], type: 'boolean' },
10134
+ message: { type: 'string' },
10135
+ },
10136
+ required: ['message', 'is_device_error', 'error_code'],
10137
+ type: 'object',
10138
+ },
10139
+ {
10140
+ description: 'Hub is disconnected',
10141
+ properties: {
10142
+ error_code: {
10143
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10144
+ enum: ['hub_disconnected'],
10145
+ type: 'string',
10146
+ },
10147
+ is_device_error: { enum: [true], type: 'boolean' },
10148
+ message: { type: 'string' },
10149
+ },
10150
+ required: ['message', 'is_device_error', 'error_code'],
10151
+ type: 'object',
10152
+ },
10153
+ {
10154
+ description: 'Device is disconnected',
10155
+ properties: {
10156
+ error_code: {
10157
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10158
+ enum: ['device_disconnected'],
10159
+ type: 'string',
10160
+ },
10161
+ is_device_error: { enum: [true], type: 'boolean' },
10162
+ message: { type: 'string' },
10163
+ },
10164
+ required: ['message', 'is_device_error', 'error_code'],
10165
+ type: 'object',
10166
+ },
10167
+ {
10168
+ description: 'The backup access code pool is empty.',
10169
+ properties: {
10170
+ error_code: {
10171
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10172
+ enum: ['empty_backup_access_code_pool'],
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: 'User is not authorized to use the August Lock.',
10183
+ properties: {
10184
+ error_code: {
10185
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10186
+ enum: ['august_lock_not_authorized'],
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: 'Lock is not connected to the Seam Bridge.',
10197
+ properties: {
10198
+ error_code: {
10199
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10200
+ enum: ['august_lock_missing_bridge'],
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: 'Salto site user limit reached.',
10211
+ properties: {
10212
+ error_code: {
10213
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10214
+ enum: ['salto_site_user_limit_reached'],
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: 'Lock is not paired with a Gateway.',
10225
+ properties: {
10226
+ error_code: {
10227
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10228
+ enum: ['ttlock_lock_not_paired_to_gateway'],
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: 'Missing device credentials.',
10239
+ properties: {
10240
+ error_code: {
10241
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10242
+ enum: ['missing_device_credentials'],
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: 'The auxiliary heat is running.',
10253
+ properties: {
10254
+ error_code: {
10255
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10256
+ enum: ['auxiliary_heat_running'],
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: 'Subscription required to connect.',
10267
+ properties: {
10268
+ error_code: {
10269
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10270
+ enum: ['subscription_required'],
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
+ ],
9568
10280
  },
9569
10281
  {
9570
10282
  properties: {
@@ -9730,13 +10442,191 @@ export default {
9730
10442
  items: {
9731
10443
  oneOf: [
9732
10444
  {
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',
10445
+ description: 'Error associated with the `device`.',
10446
+ oneOf: [
10447
+ {
10448
+ description: 'Device is offline',
10449
+ properties: {
10450
+ error_code: {
10451
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10452
+ enum: ['device_offline'],
10453
+ type: 'string',
10454
+ },
10455
+ is_device_error: { enum: [true], type: 'boolean' },
10456
+ message: { type: 'string' },
10457
+ },
10458
+ required: ['message', 'is_device_error', 'error_code'],
10459
+ type: 'object',
10460
+ },
10461
+ {
10462
+ description: 'Device has been removed',
10463
+ properties: {
10464
+ error_code: {
10465
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10466
+ enum: ['device_removed'],
10467
+ type: 'string',
10468
+ },
10469
+ is_device_error: { enum: [true], type: 'boolean' },
10470
+ message: { type: 'string' },
10471
+ },
10472
+ required: ['message', 'is_device_error', 'error_code'],
10473
+ type: 'object',
10474
+ },
10475
+ {
10476
+ description: 'Account is disconnected',
10477
+ properties: {
10478
+ error_code: {
10479
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10480
+ enum: ['account_disconnected'],
10481
+ type: 'string',
10482
+ },
10483
+ is_device_error: { enum: [true], type: 'boolean' },
10484
+ message: { type: 'string' },
10485
+ },
10486
+ required: ['message', 'is_device_error', 'error_code'],
10487
+ type: 'object',
10488
+ },
10489
+ {
10490
+ description: 'Hub is disconnected',
10491
+ properties: {
10492
+ error_code: {
10493
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10494
+ enum: ['hub_disconnected'],
10495
+ type: 'string',
10496
+ },
10497
+ is_device_error: { enum: [true], type: 'boolean' },
10498
+ message: { type: 'string' },
10499
+ },
10500
+ required: ['message', 'is_device_error', 'error_code'],
10501
+ type: 'object',
10502
+ },
10503
+ {
10504
+ description: 'Device is disconnected',
10505
+ properties: {
10506
+ error_code: {
10507
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10508
+ enum: ['device_disconnected'],
10509
+ type: 'string',
10510
+ },
10511
+ is_device_error: { enum: [true], type: 'boolean' },
10512
+ message: { type: 'string' },
10513
+ },
10514
+ required: ['message', 'is_device_error', 'error_code'],
10515
+ type: 'object',
10516
+ },
10517
+ {
10518
+ description: 'The backup access code pool is empty.',
10519
+ properties: {
10520
+ error_code: {
10521
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10522
+ enum: ['empty_backup_access_code_pool'],
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: 'User is not authorized to use the August Lock.',
10533
+ properties: {
10534
+ error_code: {
10535
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10536
+ enum: ['august_lock_not_authorized'],
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: 'Lock is not connected to the Seam Bridge.',
10547
+ properties: {
10548
+ error_code: {
10549
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10550
+ enum: ['august_lock_missing_bridge'],
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: 'Salto site user limit reached.',
10561
+ properties: {
10562
+ error_code: {
10563
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10564
+ enum: ['salto_site_user_limit_reached'],
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: 'Lock is not paired with a Gateway.',
10575
+ properties: {
10576
+ error_code: {
10577
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10578
+ enum: ['ttlock_lock_not_paired_to_gateway'],
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: 'Missing device credentials.',
10589
+ properties: {
10590
+ error_code: {
10591
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10592
+ enum: ['missing_device_credentials'],
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: 'The auxiliary heat is running.',
10603
+ properties: {
10604
+ error_code: {
10605
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10606
+ enum: ['auxiliary_heat_running'],
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: 'Subscription required to connect.',
10617
+ properties: {
10618
+ error_code: {
10619
+ description: 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10620
+ enum: ['subscription_required'],
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
+ ],
9740
10630
  },
9741
10631
  {
9742
10632
  properties: {