@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.
@@ -53,13 +53,205 @@ export default {
53
53
  type: 'object',
54
54
  },
55
55
  {
56
- properties: {
57
- error_code: { type: 'string' },
58
- is_device_error: { enum: [true], type: 'boolean' },
59
- message: { type: 'string' },
60
- },
61
- required: ['message', 'is_device_error', 'error_code'],
62
- type: 'object',
56
+ description: 'Error associated with the `device`.',
57
+ oneOf: [
58
+ {
59
+ description: 'Device is offline',
60
+ properties: {
61
+ error_code: {
62
+ description:
63
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
64
+ enum: ['device_offline'],
65
+ type: 'string',
66
+ },
67
+ is_device_error: { enum: [true], type: 'boolean' },
68
+ message: { type: 'string' },
69
+ },
70
+ required: ['message', 'is_device_error', 'error_code'],
71
+ type: 'object',
72
+ },
73
+ {
74
+ description: 'Device has been removed',
75
+ properties: {
76
+ error_code: {
77
+ description:
78
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
79
+ enum: ['device_removed'],
80
+ type: 'string',
81
+ },
82
+ is_device_error: { enum: [true], type: 'boolean' },
83
+ message: { type: 'string' },
84
+ },
85
+ required: ['message', 'is_device_error', 'error_code'],
86
+ type: 'object',
87
+ },
88
+ {
89
+ description: 'Account is disconnected',
90
+ properties: {
91
+ error_code: {
92
+ description:
93
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
94
+ enum: ['account_disconnected'],
95
+ type: 'string',
96
+ },
97
+ is_device_error: { enum: [true], type: 'boolean' },
98
+ message: { type: 'string' },
99
+ },
100
+ required: ['message', 'is_device_error', 'error_code'],
101
+ type: 'object',
102
+ },
103
+ {
104
+ description: 'Hub is disconnected',
105
+ properties: {
106
+ error_code: {
107
+ description:
108
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
109
+ enum: ['hub_disconnected'],
110
+ type: 'string',
111
+ },
112
+ is_device_error: { enum: [true], type: 'boolean' },
113
+ message: { type: 'string' },
114
+ },
115
+ required: ['message', 'is_device_error', 'error_code'],
116
+ type: 'object',
117
+ },
118
+ {
119
+ description: 'Device is disconnected',
120
+ properties: {
121
+ error_code: {
122
+ description:
123
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
124
+ enum: ['device_disconnected'],
125
+ type: 'string',
126
+ },
127
+ is_device_error: { enum: [true], type: 'boolean' },
128
+ message: { type: 'string' },
129
+ },
130
+ required: ['message', 'is_device_error', 'error_code'],
131
+ type: 'object',
132
+ },
133
+ {
134
+ description: 'The backup access code pool is empty.',
135
+ properties: {
136
+ error_code: {
137
+ description:
138
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
139
+ enum: ['empty_backup_access_code_pool'],
140
+ type: 'string',
141
+ },
142
+ is_device_error: { enum: [true], type: 'boolean' },
143
+ message: { type: 'string' },
144
+ },
145
+ required: ['message', 'is_device_error', 'error_code'],
146
+ type: 'object',
147
+ },
148
+ {
149
+ description:
150
+ 'User is not authorized to use the August Lock.',
151
+ properties: {
152
+ error_code: {
153
+ description:
154
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
155
+ enum: ['august_lock_not_authorized'],
156
+ type: 'string',
157
+ },
158
+ is_device_error: { enum: [true], type: 'boolean' },
159
+ message: { type: 'string' },
160
+ },
161
+ required: ['message', 'is_device_error', 'error_code'],
162
+ type: 'object',
163
+ },
164
+ {
165
+ description: 'Lock is not connected to the Seam Bridge.',
166
+ properties: {
167
+ error_code: {
168
+ description:
169
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
170
+ enum: ['august_lock_missing_bridge'],
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: 'Salto site user limit reached.',
181
+ properties: {
182
+ error_code: {
183
+ description:
184
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
185
+ enum: ['salto_site_user_limit_reached'],
186
+ type: 'string',
187
+ },
188
+ is_device_error: { enum: [true], type: 'boolean' },
189
+ message: { type: 'string' },
190
+ },
191
+ required: ['message', 'is_device_error', 'error_code'],
192
+ type: 'object',
193
+ },
194
+ {
195
+ description: 'Lock is not paired with a Gateway.',
196
+ properties: {
197
+ error_code: {
198
+ description:
199
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
200
+ enum: ['ttlock_lock_not_paired_to_gateway'],
201
+ type: 'string',
202
+ },
203
+ is_device_error: { enum: [true], type: 'boolean' },
204
+ message: { type: 'string' },
205
+ },
206
+ required: ['message', 'is_device_error', 'error_code'],
207
+ type: 'object',
208
+ },
209
+ {
210
+ description: 'Missing device credentials.',
211
+ properties: {
212
+ error_code: {
213
+ description:
214
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
215
+ enum: ['missing_device_credentials'],
216
+ type: 'string',
217
+ },
218
+ is_device_error: { enum: [true], type: 'boolean' },
219
+ message: { type: 'string' },
220
+ },
221
+ required: ['message', 'is_device_error', 'error_code'],
222
+ type: 'object',
223
+ },
224
+ {
225
+ description: 'The auxiliary heat is running.',
226
+ properties: {
227
+ error_code: {
228
+ description:
229
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
230
+ enum: ['auxiliary_heat_running'],
231
+ type: 'string',
232
+ },
233
+ is_device_error: { enum: [true], type: 'boolean' },
234
+ message: { type: 'string' },
235
+ },
236
+ required: ['message', 'is_device_error', 'error_code'],
237
+ type: 'object',
238
+ },
239
+ {
240
+ description: 'Subscription required to connect.',
241
+ properties: {
242
+ error_code: {
243
+ description:
244
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
245
+ enum: ['subscription_required'],
246
+ type: 'string',
247
+ },
248
+ is_device_error: { enum: [true], type: 'boolean' },
249
+ message: { type: 'string' },
250
+ },
251
+ required: ['message', 'is_device_error', 'error_code'],
252
+ type: 'object',
253
+ },
254
+ ],
63
255
  },
64
256
  {
65
257
  properties: {
@@ -4415,13 +4607,205 @@ export default {
4415
4607
  items: {
4416
4608
  oneOf: [
4417
4609
  {
4418
- properties: {
4419
- error_code: { type: 'string' },
4420
- is_device_error: { enum: [true], type: 'boolean' },
4421
- message: { type: 'string' },
4422
- },
4423
- required: ['message', 'is_device_error', 'error_code'],
4424
- type: 'object',
4610
+ description: 'Error associated with the `device`.',
4611
+ oneOf: [
4612
+ {
4613
+ description: 'Device is offline',
4614
+ properties: {
4615
+ error_code: {
4616
+ description:
4617
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4618
+ enum: ['device_offline'],
4619
+ type: 'string',
4620
+ },
4621
+ is_device_error: { enum: [true], type: 'boolean' },
4622
+ message: { type: 'string' },
4623
+ },
4624
+ required: ['message', 'is_device_error', 'error_code'],
4625
+ type: 'object',
4626
+ },
4627
+ {
4628
+ description: 'Device has been removed',
4629
+ properties: {
4630
+ error_code: {
4631
+ description:
4632
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4633
+ enum: ['device_removed'],
4634
+ type: 'string',
4635
+ },
4636
+ is_device_error: { enum: [true], type: 'boolean' },
4637
+ message: { type: 'string' },
4638
+ },
4639
+ required: ['message', 'is_device_error', 'error_code'],
4640
+ type: 'object',
4641
+ },
4642
+ {
4643
+ description: 'Account is disconnected',
4644
+ properties: {
4645
+ error_code: {
4646
+ description:
4647
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4648
+ enum: ['account_disconnected'],
4649
+ type: 'string',
4650
+ },
4651
+ is_device_error: { enum: [true], type: 'boolean' },
4652
+ message: { type: 'string' },
4653
+ },
4654
+ required: ['message', 'is_device_error', 'error_code'],
4655
+ type: 'object',
4656
+ },
4657
+ {
4658
+ description: 'Hub is disconnected',
4659
+ properties: {
4660
+ error_code: {
4661
+ description:
4662
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4663
+ enum: ['hub_disconnected'],
4664
+ type: 'string',
4665
+ },
4666
+ is_device_error: { enum: [true], type: 'boolean' },
4667
+ message: { type: 'string' },
4668
+ },
4669
+ required: ['message', 'is_device_error', 'error_code'],
4670
+ type: 'object',
4671
+ },
4672
+ {
4673
+ description: 'Device is disconnected',
4674
+ properties: {
4675
+ error_code: {
4676
+ description:
4677
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4678
+ enum: ['device_disconnected'],
4679
+ type: 'string',
4680
+ },
4681
+ is_device_error: { enum: [true], type: 'boolean' },
4682
+ message: { type: 'string' },
4683
+ },
4684
+ required: ['message', 'is_device_error', 'error_code'],
4685
+ type: 'object',
4686
+ },
4687
+ {
4688
+ description: 'The backup access code pool is empty.',
4689
+ properties: {
4690
+ error_code: {
4691
+ description:
4692
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4693
+ enum: ['empty_backup_access_code_pool'],
4694
+ type: 'string',
4695
+ },
4696
+ is_device_error: { enum: [true], type: 'boolean' },
4697
+ message: { type: 'string' },
4698
+ },
4699
+ required: ['message', 'is_device_error', 'error_code'],
4700
+ type: 'object',
4701
+ },
4702
+ {
4703
+ description:
4704
+ 'User is not authorized to use the August Lock.',
4705
+ properties: {
4706
+ error_code: {
4707
+ description:
4708
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4709
+ enum: ['august_lock_not_authorized'],
4710
+ type: 'string',
4711
+ },
4712
+ is_device_error: { enum: [true], type: 'boolean' },
4713
+ message: { type: 'string' },
4714
+ },
4715
+ required: ['message', 'is_device_error', 'error_code'],
4716
+ type: 'object',
4717
+ },
4718
+ {
4719
+ description: 'Lock is not connected to the Seam Bridge.',
4720
+ properties: {
4721
+ error_code: {
4722
+ description:
4723
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4724
+ enum: ['august_lock_missing_bridge'],
4725
+ type: 'string',
4726
+ },
4727
+ is_device_error: { enum: [true], type: 'boolean' },
4728
+ message: { type: 'string' },
4729
+ },
4730
+ required: ['message', 'is_device_error', 'error_code'],
4731
+ type: 'object',
4732
+ },
4733
+ {
4734
+ description: 'Salto site user limit reached.',
4735
+ properties: {
4736
+ error_code: {
4737
+ description:
4738
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4739
+ enum: ['salto_site_user_limit_reached'],
4740
+ type: 'string',
4741
+ },
4742
+ is_device_error: { enum: [true], type: 'boolean' },
4743
+ message: { type: 'string' },
4744
+ },
4745
+ required: ['message', 'is_device_error', 'error_code'],
4746
+ type: 'object',
4747
+ },
4748
+ {
4749
+ description: 'Lock is not paired with a Gateway.',
4750
+ properties: {
4751
+ error_code: {
4752
+ description:
4753
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4754
+ enum: ['ttlock_lock_not_paired_to_gateway'],
4755
+ type: 'string',
4756
+ },
4757
+ is_device_error: { enum: [true], type: 'boolean' },
4758
+ message: { type: 'string' },
4759
+ },
4760
+ required: ['message', 'is_device_error', 'error_code'],
4761
+ type: 'object',
4762
+ },
4763
+ {
4764
+ description: 'Missing device credentials.',
4765
+ properties: {
4766
+ error_code: {
4767
+ description:
4768
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4769
+ enum: ['missing_device_credentials'],
4770
+ type: 'string',
4771
+ },
4772
+ is_device_error: { enum: [true], type: 'boolean' },
4773
+ message: { type: 'string' },
4774
+ },
4775
+ required: ['message', 'is_device_error', 'error_code'],
4776
+ type: 'object',
4777
+ },
4778
+ {
4779
+ description: 'The auxiliary heat is running.',
4780
+ properties: {
4781
+ error_code: {
4782
+ description:
4783
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4784
+ enum: ['auxiliary_heat_running'],
4785
+ type: 'string',
4786
+ },
4787
+ is_device_error: { enum: [true], type: 'boolean' },
4788
+ message: { type: 'string' },
4789
+ },
4790
+ required: ['message', 'is_device_error', 'error_code'],
4791
+ type: 'object',
4792
+ },
4793
+ {
4794
+ description: 'Subscription required to connect.',
4795
+ properties: {
4796
+ error_code: {
4797
+ description:
4798
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
4799
+ enum: ['subscription_required'],
4800
+ type: 'string',
4801
+ },
4802
+ is_device_error: { enum: [true], type: 'boolean' },
4803
+ message: { type: 'string' },
4804
+ },
4805
+ required: ['message', 'is_device_error', 'error_code'],
4806
+ type: 'object',
4807
+ },
4808
+ ],
4425
4809
  },
4426
4810
  {
4427
4811
  properties: {
@@ -9842,17 +10226,32 @@ export default {
9842
10226
  type: 'object',
9843
10227
  },
9844
10228
  {
9845
- description:
9846
- '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.',
9847
10229
  properties: {
10230
+ connected_account_id: {
10231
+ description:
10232
+ 'ID of the [connected account](https://docs.seam.co/latest/core-concepts/connected-accounts).',
10233
+ format: 'uuid',
10234
+ type: 'string',
10235
+ },
9848
10236
  created_at: {
9849
10237
  description: 'Date and time at which the event was created.',
9850
10238
  format: 'date-time',
9851
10239
  type: 'string',
9852
10240
  },
9853
- enrollment_automation_id: {
10241
+ desired_temperature_celsius: {
9854
10242
  description:
9855
- 'ID of the [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).',
10243
+ "Desired temperature, in °C, set by the thermostat's cooling or heating set point.",
10244
+ format: 'float',
10245
+ type: 'number',
10246
+ },
10247
+ desired_temperature_fahrenheit: {
10248
+ description:
10249
+ "Desired temperature, in °F, set by the thermostat's cooling or heating set point.",
10250
+ format: 'float',
10251
+ type: 'number',
10252
+ },
10253
+ device_id: {
10254
+ description: 'ID of the device.',
9856
10255
  format: 'uuid',
9857
10256
  type: 'string',
9858
10257
  },
@@ -9862,7 +10261,7 @@ export default {
9862
10261
  type: 'string',
9863
10262
  },
9864
10263
  event_type: {
9865
- enum: ['enrollment_automation.deleted'],
10264
+ enum: ['thermostat.temperature_reached_set_point'],
9866
10265
  type: 'string',
9867
10266
  },
9868
10267
  occurred_at: {
@@ -9870,6 +10269,16 @@ export default {
9870
10269
  format: 'date-time',
9871
10270
  type: 'string',
9872
10271
  },
10272
+ temperature_celsius: {
10273
+ description: 'Temperature, in °C, reported by the thermostat.',
10274
+ format: 'float',
10275
+ type: 'number',
10276
+ },
10277
+ temperature_fahrenheit: {
10278
+ description: 'Temperature, in °F, reported by the thermostat.',
10279
+ format: 'float',
10280
+ type: 'number',
10281
+ },
9873
10282
  workspace_id: {
9874
10283
  description:
9875
10284
  'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
@@ -9882,22 +10291,26 @@ export default {
9882
10291
  'workspace_id',
9883
10292
  'created_at',
9884
10293
  'occurred_at',
9885
- 'enrollment_automation_id',
10294
+ 'device_id',
10295
+ 'connected_account_id',
9886
10296
  'event_type',
10297
+ 'temperature_celsius',
10298
+ 'temperature_fahrenheit',
9887
10299
  ],
9888
10300
  type: 'object',
9889
10301
  },
9890
10302
  {
9891
- description: 'A phone device was deactivated.',
10303
+ description:
10304
+ '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.',
9892
10305
  properties: {
9893
10306
  created_at: {
9894
10307
  description: 'Date and time at which the event was created.',
9895
10308
  format: 'date-time',
9896
10309
  type: 'string',
9897
10310
  },
9898
- device_id: {
10311
+ enrollment_automation_id: {
9899
10312
  description:
9900
- 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
10313
+ 'ID of the [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).',
9901
10314
  format: 'uuid',
9902
10315
  type: 'string',
9903
10316
  },
@@ -9906,7 +10319,10 @@ export default {
9906
10319
  format: 'uuid',
9907
10320
  type: 'string',
9908
10321
  },
9909
- event_type: { enum: ['phone.deactivated'], type: 'string' },
10322
+ event_type: {
10323
+ enum: ['enrollment_automation.deleted'],
10324
+ type: 'string',
10325
+ },
9910
10326
  occurred_at: {
9911
10327
  description: 'Date and time at which the event occurred.',
9912
10328
  format: 'date-time',
@@ -9924,24 +10340,66 @@ export default {
9924
10340
  'workspace_id',
9925
10341
  'created_at',
9926
10342
  'occurred_at',
9927
- 'device_id',
10343
+ 'enrollment_automation_id',
9928
10344
  'event_type',
9929
10345
  ],
9930
10346
  type: 'object',
9931
10347
  },
9932
- ],
9933
- },
9934
- network: {
9935
- properties: {
9936
- created_at: { format: 'date-time', type: 'string' },
9937
- display_name: { type: 'string' },
9938
- network_id: { format: 'uuid', type: 'string' },
9939
- workspace_id: { format: 'uuid', type: 'string' },
9940
- },
9941
- required: ['network_id', 'workspace_id', 'display_name', 'created_at'],
9942
- type: 'object',
9943
- },
9944
- noise_threshold: {
10348
+ {
10349
+ description: 'A phone device was deactivated.',
10350
+ properties: {
10351
+ created_at: {
10352
+ description: 'Date and time at which the event was created.',
10353
+ format: 'date-time',
10354
+ type: 'string',
10355
+ },
10356
+ device_id: {
10357
+ description:
10358
+ 'ID of the [device](https://docs.seam.co/latest/core-concepts/devices).',
10359
+ format: 'uuid',
10360
+ type: 'string',
10361
+ },
10362
+ event_id: {
10363
+ description: 'ID of the event.',
10364
+ format: 'uuid',
10365
+ type: 'string',
10366
+ },
10367
+ event_type: { enum: ['phone.deactivated'], type: 'string' },
10368
+ occurred_at: {
10369
+ description: 'Date and time at which the event occurred.',
10370
+ format: 'date-time',
10371
+ type: 'string',
10372
+ },
10373
+ workspace_id: {
10374
+ description:
10375
+ 'ID of the [workspace](https://docs.seam.co/latest/core-concepts/workspaces).',
10376
+ format: 'uuid',
10377
+ type: 'string',
10378
+ },
10379
+ },
10380
+ required: [
10381
+ 'event_id',
10382
+ 'workspace_id',
10383
+ 'created_at',
10384
+ 'occurred_at',
10385
+ 'device_id',
10386
+ 'event_type',
10387
+ ],
10388
+ type: 'object',
10389
+ },
10390
+ ],
10391
+ },
10392
+ network: {
10393
+ properties: {
10394
+ created_at: { format: 'date-time', type: 'string' },
10395
+ display_name: { type: 'string' },
10396
+ network_id: { format: 'uuid', type: 'string' },
10397
+ workspace_id: { format: 'uuid', type: 'string' },
10398
+ },
10399
+ required: ['network_id', 'workspace_id', 'display_name', 'created_at'],
10400
+ type: 'object',
10401
+ },
10402
+ noise_threshold: {
9945
10403
  properties: {
9946
10404
  device_id: { format: 'uuid', type: 'string' },
9947
10405
  ends_daily_at: { type: 'string' },
@@ -10019,13 +10477,205 @@ export default {
10019
10477
  items: {
10020
10478
  oneOf: [
10021
10479
  {
10022
- properties: {
10023
- error_code: { type: 'string' },
10024
- is_device_error: { enum: [true], type: 'boolean' },
10025
- message: { type: 'string' },
10026
- },
10027
- required: ['message', 'is_device_error', 'error_code'],
10028
- type: 'object',
10480
+ description: 'Error associated with the `device`.',
10481
+ oneOf: [
10482
+ {
10483
+ description: 'Device is offline',
10484
+ properties: {
10485
+ error_code: {
10486
+ description:
10487
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10488
+ enum: ['device_offline'],
10489
+ type: 'string',
10490
+ },
10491
+ is_device_error: { enum: [true], type: 'boolean' },
10492
+ message: { type: 'string' },
10493
+ },
10494
+ required: ['message', 'is_device_error', 'error_code'],
10495
+ type: 'object',
10496
+ },
10497
+ {
10498
+ description: 'Device has been removed',
10499
+ properties: {
10500
+ error_code: {
10501
+ description:
10502
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10503
+ enum: ['device_removed'],
10504
+ type: 'string',
10505
+ },
10506
+ is_device_error: { enum: [true], type: 'boolean' },
10507
+ message: { type: 'string' },
10508
+ },
10509
+ required: ['message', 'is_device_error', 'error_code'],
10510
+ type: 'object',
10511
+ },
10512
+ {
10513
+ description: 'Account is disconnected',
10514
+ properties: {
10515
+ error_code: {
10516
+ description:
10517
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10518
+ enum: ['account_disconnected'],
10519
+ type: 'string',
10520
+ },
10521
+ is_device_error: { enum: [true], type: 'boolean' },
10522
+ message: { type: 'string' },
10523
+ },
10524
+ required: ['message', 'is_device_error', 'error_code'],
10525
+ type: 'object',
10526
+ },
10527
+ {
10528
+ description: 'Hub is disconnected',
10529
+ properties: {
10530
+ error_code: {
10531
+ description:
10532
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10533
+ enum: ['hub_disconnected'],
10534
+ type: 'string',
10535
+ },
10536
+ is_device_error: { enum: [true], type: 'boolean' },
10537
+ message: { type: 'string' },
10538
+ },
10539
+ required: ['message', 'is_device_error', 'error_code'],
10540
+ type: 'object',
10541
+ },
10542
+ {
10543
+ description: 'Device is disconnected',
10544
+ properties: {
10545
+ error_code: {
10546
+ description:
10547
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10548
+ enum: ['device_disconnected'],
10549
+ type: 'string',
10550
+ },
10551
+ is_device_error: { enum: [true], type: 'boolean' },
10552
+ message: { type: 'string' },
10553
+ },
10554
+ required: ['message', 'is_device_error', 'error_code'],
10555
+ type: 'object',
10556
+ },
10557
+ {
10558
+ description: 'The backup access code pool is empty.',
10559
+ properties: {
10560
+ error_code: {
10561
+ description:
10562
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10563
+ enum: ['empty_backup_access_code_pool'],
10564
+ type: 'string',
10565
+ },
10566
+ is_device_error: { enum: [true], type: 'boolean' },
10567
+ message: { type: 'string' },
10568
+ },
10569
+ required: ['message', 'is_device_error', 'error_code'],
10570
+ type: 'object',
10571
+ },
10572
+ {
10573
+ description:
10574
+ 'User is not authorized to use the August Lock.',
10575
+ properties: {
10576
+ error_code: {
10577
+ description:
10578
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10579
+ enum: ['august_lock_not_authorized'],
10580
+ type: 'string',
10581
+ },
10582
+ is_device_error: { enum: [true], type: 'boolean' },
10583
+ message: { type: 'string' },
10584
+ },
10585
+ required: ['message', 'is_device_error', 'error_code'],
10586
+ type: 'object',
10587
+ },
10588
+ {
10589
+ description: 'Lock is not connected to the Seam Bridge.',
10590
+ properties: {
10591
+ error_code: {
10592
+ description:
10593
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10594
+ enum: ['august_lock_missing_bridge'],
10595
+ type: 'string',
10596
+ },
10597
+ is_device_error: { enum: [true], type: 'boolean' },
10598
+ message: { type: 'string' },
10599
+ },
10600
+ required: ['message', 'is_device_error', 'error_code'],
10601
+ type: 'object',
10602
+ },
10603
+ {
10604
+ description: 'Salto site user limit reached.',
10605
+ properties: {
10606
+ error_code: {
10607
+ description:
10608
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10609
+ enum: ['salto_site_user_limit_reached'],
10610
+ type: 'string',
10611
+ },
10612
+ is_device_error: { enum: [true], type: 'boolean' },
10613
+ message: { type: 'string' },
10614
+ },
10615
+ required: ['message', 'is_device_error', 'error_code'],
10616
+ type: 'object',
10617
+ },
10618
+ {
10619
+ description: 'Lock is not paired with a Gateway.',
10620
+ properties: {
10621
+ error_code: {
10622
+ description:
10623
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10624
+ enum: ['ttlock_lock_not_paired_to_gateway'],
10625
+ type: 'string',
10626
+ },
10627
+ is_device_error: { enum: [true], type: 'boolean' },
10628
+ message: { type: 'string' },
10629
+ },
10630
+ required: ['message', 'is_device_error', 'error_code'],
10631
+ type: 'object',
10632
+ },
10633
+ {
10634
+ description: 'Missing device credentials.',
10635
+ properties: {
10636
+ error_code: {
10637
+ description:
10638
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10639
+ enum: ['missing_device_credentials'],
10640
+ type: 'string',
10641
+ },
10642
+ is_device_error: { enum: [true], type: 'boolean' },
10643
+ message: { type: 'string' },
10644
+ },
10645
+ required: ['message', 'is_device_error', 'error_code'],
10646
+ type: 'object',
10647
+ },
10648
+ {
10649
+ description: 'The auxiliary heat is running.',
10650
+ properties: {
10651
+ error_code: {
10652
+ description:
10653
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10654
+ enum: ['auxiliary_heat_running'],
10655
+ type: 'string',
10656
+ },
10657
+ is_device_error: { enum: [true], type: 'boolean' },
10658
+ message: { type: 'string' },
10659
+ },
10660
+ required: ['message', 'is_device_error', 'error_code'],
10661
+ type: 'object',
10662
+ },
10663
+ {
10664
+ description: 'Subscription required to connect.',
10665
+ properties: {
10666
+ error_code: {
10667
+ description:
10668
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10669
+ enum: ['subscription_required'],
10670
+ type: 'string',
10671
+ },
10672
+ is_device_error: { enum: [true], type: 'boolean' },
10673
+ message: { type: 'string' },
10674
+ },
10675
+ required: ['message', 'is_device_error', 'error_code'],
10676
+ type: 'object',
10677
+ },
10678
+ ],
10029
10679
  },
10030
10680
  {
10031
10681
  properties: {
@@ -10266,13 +10916,205 @@ export default {
10266
10916
  type: 'object',
10267
10917
  },
10268
10918
  {
10269
- properties: {
10270
- error_code: { type: 'string' },
10271
- is_device_error: { enum: [true], type: 'boolean' },
10272
- message: { type: 'string' },
10273
- },
10274
- required: ['message', 'is_device_error', 'error_code'],
10275
- type: 'object',
10919
+ description: 'Error associated with the `device`.',
10920
+ oneOf: [
10921
+ {
10922
+ description: 'Device is offline',
10923
+ properties: {
10924
+ error_code: {
10925
+ description:
10926
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10927
+ enum: ['device_offline'],
10928
+ type: 'string',
10929
+ },
10930
+ is_device_error: { enum: [true], type: 'boolean' },
10931
+ message: { type: 'string' },
10932
+ },
10933
+ required: ['message', 'is_device_error', 'error_code'],
10934
+ type: 'object',
10935
+ },
10936
+ {
10937
+ description: 'Device has been removed',
10938
+ properties: {
10939
+ error_code: {
10940
+ description:
10941
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10942
+ enum: ['device_removed'],
10943
+ type: 'string',
10944
+ },
10945
+ is_device_error: { enum: [true], type: 'boolean' },
10946
+ message: { type: 'string' },
10947
+ },
10948
+ required: ['message', 'is_device_error', 'error_code'],
10949
+ type: 'object',
10950
+ },
10951
+ {
10952
+ description: 'Account is disconnected',
10953
+ properties: {
10954
+ error_code: {
10955
+ description:
10956
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10957
+ enum: ['account_disconnected'],
10958
+ type: 'string',
10959
+ },
10960
+ is_device_error: { enum: [true], type: 'boolean' },
10961
+ message: { type: 'string' },
10962
+ },
10963
+ required: ['message', 'is_device_error', 'error_code'],
10964
+ type: 'object',
10965
+ },
10966
+ {
10967
+ description: 'Hub is disconnected',
10968
+ properties: {
10969
+ error_code: {
10970
+ description:
10971
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10972
+ enum: ['hub_disconnected'],
10973
+ type: 'string',
10974
+ },
10975
+ is_device_error: { enum: [true], type: 'boolean' },
10976
+ message: { type: 'string' },
10977
+ },
10978
+ required: ['message', 'is_device_error', 'error_code'],
10979
+ type: 'object',
10980
+ },
10981
+ {
10982
+ description: 'Device is disconnected',
10983
+ properties: {
10984
+ error_code: {
10985
+ description:
10986
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
10987
+ enum: ['device_disconnected'],
10988
+ type: 'string',
10989
+ },
10990
+ is_device_error: { enum: [true], type: 'boolean' },
10991
+ message: { type: 'string' },
10992
+ },
10993
+ required: ['message', 'is_device_error', 'error_code'],
10994
+ type: 'object',
10995
+ },
10996
+ {
10997
+ description: 'The backup access code pool is empty.',
10998
+ properties: {
10999
+ error_code: {
11000
+ description:
11001
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11002
+ enum: ['empty_backup_access_code_pool'],
11003
+ type: 'string',
11004
+ },
11005
+ is_device_error: { enum: [true], type: 'boolean' },
11006
+ message: { type: 'string' },
11007
+ },
11008
+ required: ['message', 'is_device_error', 'error_code'],
11009
+ type: 'object',
11010
+ },
11011
+ {
11012
+ description:
11013
+ 'User is not authorized to use the August Lock.',
11014
+ properties: {
11015
+ error_code: {
11016
+ description:
11017
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11018
+ enum: ['august_lock_not_authorized'],
11019
+ type: 'string',
11020
+ },
11021
+ is_device_error: { enum: [true], type: 'boolean' },
11022
+ message: { type: 'string' },
11023
+ },
11024
+ required: ['message', 'is_device_error', 'error_code'],
11025
+ type: 'object',
11026
+ },
11027
+ {
11028
+ description: 'Lock is not connected to the Seam Bridge.',
11029
+ properties: {
11030
+ error_code: {
11031
+ description:
11032
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11033
+ enum: ['august_lock_missing_bridge'],
11034
+ type: 'string',
11035
+ },
11036
+ is_device_error: { enum: [true], type: 'boolean' },
11037
+ message: { type: 'string' },
11038
+ },
11039
+ required: ['message', 'is_device_error', 'error_code'],
11040
+ type: 'object',
11041
+ },
11042
+ {
11043
+ description: 'Salto site user limit reached.',
11044
+ properties: {
11045
+ error_code: {
11046
+ description:
11047
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11048
+ enum: ['salto_site_user_limit_reached'],
11049
+ type: 'string',
11050
+ },
11051
+ is_device_error: { enum: [true], type: 'boolean' },
11052
+ message: { type: 'string' },
11053
+ },
11054
+ required: ['message', 'is_device_error', 'error_code'],
11055
+ type: 'object',
11056
+ },
11057
+ {
11058
+ description: 'Lock is not paired with a Gateway.',
11059
+ properties: {
11060
+ error_code: {
11061
+ description:
11062
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11063
+ enum: ['ttlock_lock_not_paired_to_gateway'],
11064
+ type: 'string',
11065
+ },
11066
+ is_device_error: { enum: [true], type: 'boolean' },
11067
+ message: { type: 'string' },
11068
+ },
11069
+ required: ['message', 'is_device_error', 'error_code'],
11070
+ type: 'object',
11071
+ },
11072
+ {
11073
+ description: 'Missing device credentials.',
11074
+ properties: {
11075
+ error_code: {
11076
+ description:
11077
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11078
+ enum: ['missing_device_credentials'],
11079
+ type: 'string',
11080
+ },
11081
+ is_device_error: { enum: [true], type: 'boolean' },
11082
+ message: { type: 'string' },
11083
+ },
11084
+ required: ['message', 'is_device_error', 'error_code'],
11085
+ type: 'object',
11086
+ },
11087
+ {
11088
+ description: 'The auxiliary heat is running.',
11089
+ properties: {
11090
+ error_code: {
11091
+ description:
11092
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11093
+ enum: ['auxiliary_heat_running'],
11094
+ type: 'string',
11095
+ },
11096
+ is_device_error: { enum: [true], type: 'boolean' },
11097
+ message: { type: 'string' },
11098
+ },
11099
+ required: ['message', 'is_device_error', 'error_code'],
11100
+ type: 'object',
11101
+ },
11102
+ {
11103
+ description: 'Subscription required to connect.',
11104
+ properties: {
11105
+ error_code: {
11106
+ description:
11107
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11108
+ enum: ['subscription_required'],
11109
+ type: 'string',
11110
+ },
11111
+ is_device_error: { enum: [true], type: 'boolean' },
11112
+ message: { type: 'string' },
11113
+ },
11114
+ required: ['message', 'is_device_error', 'error_code'],
11115
+ type: 'object',
11116
+ },
11117
+ ],
10276
11118
  },
10277
11119
  {
10278
11120
  properties: {
@@ -10446,13 +11288,205 @@ export default {
10446
11288
  items: {
10447
11289
  oneOf: [
10448
11290
  {
10449
- properties: {
10450
- error_code: { type: 'string' },
10451
- is_device_error: { enum: [true], type: 'boolean' },
10452
- message: { type: 'string' },
10453
- },
10454
- required: ['message', 'is_device_error', 'error_code'],
10455
- type: 'object',
11291
+ description: 'Error associated with the `device`.',
11292
+ oneOf: [
11293
+ {
11294
+ description: 'Device is offline',
11295
+ properties: {
11296
+ error_code: {
11297
+ description:
11298
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11299
+ enum: ['device_offline'],
11300
+ type: 'string',
11301
+ },
11302
+ is_device_error: { enum: [true], type: 'boolean' },
11303
+ message: { type: 'string' },
11304
+ },
11305
+ required: ['message', 'is_device_error', 'error_code'],
11306
+ type: 'object',
11307
+ },
11308
+ {
11309
+ description: 'Device has been removed',
11310
+ properties: {
11311
+ error_code: {
11312
+ description:
11313
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11314
+ enum: ['device_removed'],
11315
+ type: 'string',
11316
+ },
11317
+ is_device_error: { enum: [true], type: 'boolean' },
11318
+ message: { type: 'string' },
11319
+ },
11320
+ required: ['message', 'is_device_error', 'error_code'],
11321
+ type: 'object',
11322
+ },
11323
+ {
11324
+ description: 'Account is disconnected',
11325
+ properties: {
11326
+ error_code: {
11327
+ description:
11328
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11329
+ enum: ['account_disconnected'],
11330
+ type: 'string',
11331
+ },
11332
+ is_device_error: { enum: [true], type: 'boolean' },
11333
+ message: { type: 'string' },
11334
+ },
11335
+ required: ['message', 'is_device_error', 'error_code'],
11336
+ type: 'object',
11337
+ },
11338
+ {
11339
+ description: 'Hub is disconnected',
11340
+ properties: {
11341
+ error_code: {
11342
+ description:
11343
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11344
+ enum: ['hub_disconnected'],
11345
+ type: 'string',
11346
+ },
11347
+ is_device_error: { enum: [true], type: 'boolean' },
11348
+ message: { type: 'string' },
11349
+ },
11350
+ required: ['message', 'is_device_error', 'error_code'],
11351
+ type: 'object',
11352
+ },
11353
+ {
11354
+ description: 'Device is disconnected',
11355
+ properties: {
11356
+ error_code: {
11357
+ description:
11358
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11359
+ enum: ['device_disconnected'],
11360
+ type: 'string',
11361
+ },
11362
+ is_device_error: { enum: [true], type: 'boolean' },
11363
+ message: { type: 'string' },
11364
+ },
11365
+ required: ['message', 'is_device_error', 'error_code'],
11366
+ type: 'object',
11367
+ },
11368
+ {
11369
+ description: 'The backup access code pool is empty.',
11370
+ properties: {
11371
+ error_code: {
11372
+ description:
11373
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11374
+ enum: ['empty_backup_access_code_pool'],
11375
+ type: 'string',
11376
+ },
11377
+ is_device_error: { enum: [true], type: 'boolean' },
11378
+ message: { type: 'string' },
11379
+ },
11380
+ required: ['message', 'is_device_error', 'error_code'],
11381
+ type: 'object',
11382
+ },
11383
+ {
11384
+ description:
11385
+ 'User is not authorized to use the August Lock.',
11386
+ properties: {
11387
+ error_code: {
11388
+ description:
11389
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11390
+ enum: ['august_lock_not_authorized'],
11391
+ type: 'string',
11392
+ },
11393
+ is_device_error: { enum: [true], type: 'boolean' },
11394
+ message: { type: 'string' },
11395
+ },
11396
+ required: ['message', 'is_device_error', 'error_code'],
11397
+ type: 'object',
11398
+ },
11399
+ {
11400
+ description: 'Lock is not connected to the Seam Bridge.',
11401
+ properties: {
11402
+ error_code: {
11403
+ description:
11404
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11405
+ enum: ['august_lock_missing_bridge'],
11406
+ type: 'string',
11407
+ },
11408
+ is_device_error: { enum: [true], type: 'boolean' },
11409
+ message: { type: 'string' },
11410
+ },
11411
+ required: ['message', 'is_device_error', 'error_code'],
11412
+ type: 'object',
11413
+ },
11414
+ {
11415
+ description: 'Salto site user limit reached.',
11416
+ properties: {
11417
+ error_code: {
11418
+ description:
11419
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11420
+ enum: ['salto_site_user_limit_reached'],
11421
+ type: 'string',
11422
+ },
11423
+ is_device_error: { enum: [true], type: 'boolean' },
11424
+ message: { type: 'string' },
11425
+ },
11426
+ required: ['message', 'is_device_error', 'error_code'],
11427
+ type: 'object',
11428
+ },
11429
+ {
11430
+ description: 'Lock is not paired with a Gateway.',
11431
+ properties: {
11432
+ error_code: {
11433
+ description:
11434
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11435
+ enum: ['ttlock_lock_not_paired_to_gateway'],
11436
+ type: 'string',
11437
+ },
11438
+ is_device_error: { enum: [true], type: 'boolean' },
11439
+ message: { type: 'string' },
11440
+ },
11441
+ required: ['message', 'is_device_error', 'error_code'],
11442
+ type: 'object',
11443
+ },
11444
+ {
11445
+ description: 'Missing device credentials.',
11446
+ properties: {
11447
+ error_code: {
11448
+ description:
11449
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11450
+ enum: ['missing_device_credentials'],
11451
+ type: 'string',
11452
+ },
11453
+ is_device_error: { enum: [true], type: 'boolean' },
11454
+ message: { type: 'string' },
11455
+ },
11456
+ required: ['message', 'is_device_error', 'error_code'],
11457
+ type: 'object',
11458
+ },
11459
+ {
11460
+ description: 'The auxiliary heat is running.',
11461
+ properties: {
11462
+ error_code: {
11463
+ description:
11464
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11465
+ enum: ['auxiliary_heat_running'],
11466
+ type: 'string',
11467
+ },
11468
+ is_device_error: { enum: [true], type: 'boolean' },
11469
+ message: { type: 'string' },
11470
+ },
11471
+ required: ['message', 'is_device_error', 'error_code'],
11472
+ type: 'object',
11473
+ },
11474
+ {
11475
+ description: 'Subscription required to connect.',
11476
+ properties: {
11477
+ error_code: {
11478
+ description:
11479
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11480
+ enum: ['subscription_required'],
11481
+ type: 'string',
11482
+ },
11483
+ is_device_error: { enum: [true], type: 'boolean' },
11484
+ message: { type: 'string' },
11485
+ },
11486
+ required: ['message', 'is_device_error', 'error_code'],
11487
+ type: 'object',
11488
+ },
11489
+ ],
10456
11490
  },
10457
11491
  {
10458
11492
  properties: {
@@ -19683,6 +20717,7 @@ export default {
19683
20717
  'thermostat.manually_adjusted',
19684
20718
  'thermostat.temperature_threshold_exceeded',
19685
20719
  'thermostat.temperature_threshold_no_longer_exceeded',
20720
+ 'thermostat.temperature_reached_set_point',
19686
20721
  ],
19687
20722
  type: 'string',
19688
20723
  },
@@ -19760,6 +20795,7 @@ export default {
19760
20795
  'thermostat.manually_adjusted',
19761
20796
  'thermostat.temperature_threshold_exceeded',
19762
20797
  'thermostat.temperature_threshold_no_longer_exceeded',
20798
+ 'thermostat.temperature_reached_set_point',
19763
20799
  ],
19764
20800
  type: 'string',
19765
20801
  },