@seamapi/types 1.344.0 → 1.344.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/dist/connect.cjs +1833 -2018
  2. package/dist/connect.cjs.map +1 -1
  3. package/dist/connect.d.cts +496 -633
  4. package/lib/seam/connect/models/access-codes/managed-access-code.d.ts +7 -28
  5. package/lib/seam/connect/models/access-codes/managed-access-code.js +7 -3
  6. package/lib/seam/connect/models/access-codes/managed-access-code.js.map +1 -1
  7. package/lib/seam/connect/models/access-codes/unmanaged-access-code.d.ts +5 -26
  8. package/lib/seam/connect/models/acs/acs-credential.d.ts +2 -2
  9. package/lib/seam/connect/models/acs/acs-credential.js +1 -1
  10. package/lib/seam/connect/models/acs/acs-credential.js.map +1 -1
  11. package/lib/seam/connect/models/acs/acs-system.d.ts +2 -2
  12. package/lib/seam/connect/models/acs/acs-system.js +2 -2
  13. package/lib/seam/connect/models/acs/acs-system.js.map +1 -1
  14. package/lib/seam/connect/models/acs/acs-user.d.ts +5 -5
  15. package/lib/seam/connect/models/acs/acs-user.js +2 -2
  16. package/lib/seam/connect/models/acs/acs-user.js.map +1 -1
  17. package/lib/seam/connect/models/action-attempts/action-attempt.d.ts +4 -4
  18. package/lib/seam/connect/models/action-attempts/encode-credential.d.ts +2 -2
  19. package/lib/seam/connect/models/action-attempts/scan-credential.d.ts +2 -2
  20. package/lib/seam/connect/models/connected-accounts/connected-account.d.ts +4 -4
  21. package/lib/seam/connect/models/connected-accounts/connected-account.js +6 -3
  22. package/lib/seam/connect/models/connected-accounts/connected-account.js.map +1 -1
  23. package/lib/seam/connect/models/devices/device.d.ts +6 -40
  24. package/lib/seam/connect/models/devices/device.js +6 -11
  25. package/lib/seam/connect/models/devices/device.js.map +1 -1
  26. package/lib/seam/connect/models/devices/phone.d.ts +4 -25
  27. package/lib/seam/connect/models/devices/unmanaged-device.d.ts +4 -25
  28. package/lib/seam/connect/openapi.d.ts +294 -223
  29. package/lib/seam/connect/openapi.js +1756 -1951
  30. package/lib/seam/connect/openapi.js.map +1 -1
  31. package/lib/seam/connect/route-types.d.ts +164 -275
  32. package/package.json +1 -1
  33. package/src/lib/seam/connect/models/access-codes/managed-access-code.ts +9 -3
  34. package/src/lib/seam/connect/models/acs/acs-credential.ts +1 -1
  35. package/src/lib/seam/connect/models/acs/acs-system.ts +2 -2
  36. package/src/lib/seam/connect/models/acs/acs-user.ts +2 -2
  37. package/src/lib/seam/connect/models/connected-accounts/connected-account.ts +6 -3
  38. package/src/lib/seam/connect/models/devices/device.ts +8 -12
  39. package/src/lib/seam/connect/openapi.ts +1649 -1840
  40. package/src/lib/seam/connect/route-types.ts +3235 -3494
@@ -42,632 +42,527 @@ export default {
42
42
  description:
43
43
  'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
44
44
  items: {
45
+ discriminator: { propertyName: 'error_code' },
45
46
  oneOf: [
46
47
  {
47
- oneOf: [
48
- {
49
- description: 'Failed to set code on Smart Things device.',
50
- properties: {
51
- error_code: {
52
- description:
53
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
54
- enum: ['smartthings_failed_to_set_access_code'],
55
- type: 'string',
56
- },
57
- is_access_code_error: { enum: [true], type: 'boolean' },
58
- message: { type: 'string' },
59
- },
60
- required: [
61
- 'message',
62
- 'is_access_code_error',
63
- 'error_code',
64
- ],
65
- type: 'object',
48
+ description: 'Failed to set code on Smart Things device.',
49
+ properties: {
50
+ error_code: {
51
+ description:
52
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
53
+ enum: ['smartthings_failed_to_set_access_code'],
54
+ type: 'string',
66
55
  },
67
- {
68
- description: 'Failed to set code after multiple retries.',
69
- properties: {
70
- error_code: {
71
- description:
72
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
73
- enum: [
74
- 'smartthings_failed_to_set_after_multiple_retries',
75
- ],
76
- type: 'string',
77
- },
78
- is_access_code_error: { enum: [true], type: 'boolean' },
79
- message: { type: 'string' },
80
- },
81
- required: [
82
- 'message',
83
- 'is_access_code_error',
84
- 'error_code',
56
+ is_access_code_error: { enum: [true], type: 'boolean' },
57
+ message: { type: 'string' },
58
+ },
59
+ required: ['message', 'is_access_code_error', 'error_code'],
60
+ type: 'object',
61
+ },
62
+ {
63
+ description: 'Failed to set code after multiple retries.',
64
+ properties: {
65
+ error_code: {
66
+ description:
67
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
68
+ enum: [
69
+ 'smartthings_failed_to_set_after_multiple_retries',
85
70
  ],
86
- type: 'object',
71
+ type: 'string',
87
72
  },
88
- {
89
- description: 'Failed to set code on device.',
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: ['failed_to_set_on_device'],
95
- type: 'string',
96
- },
97
- is_access_code_error: { enum: [true], type: 'boolean' },
98
- message: { type: 'string' },
99
- },
100
- required: [
101
- 'message',
102
- 'is_access_code_error',
103
- 'error_code',
104
- ],
105
- type: 'object',
73
+ is_access_code_error: { enum: [true], type: 'boolean' },
74
+ message: { type: 'string' },
75
+ },
76
+ required: ['message', 'is_access_code_error', 'error_code'],
77
+ type: 'object',
78
+ },
79
+ {
80
+ description: 'Failed to set code on device.',
81
+ properties: {
82
+ error_code: {
83
+ description:
84
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
85
+ enum: ['failed_to_set_on_device'],
86
+ type: 'string',
106
87
  },
107
- {
108
- description: 'Failed to remove code from device.',
109
- properties: {
110
- error_code: {
111
- description:
112
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
113
- enum: ['failed_to_remove_from_device'],
114
- type: 'string',
115
- },
116
- is_access_code_error: { enum: [true], type: 'boolean' },
117
- message: { type: 'string' },
118
- },
119
- required: [
120
- 'message',
121
- 'is_access_code_error',
122
- 'error_code',
123
- ],
124
- type: 'object',
88
+ is_access_code_error: { enum: [true], type: 'boolean' },
89
+ message: { type: 'string' },
90
+ },
91
+ required: ['message', 'is_access_code_error', 'error_code'],
92
+ type: 'object',
93
+ },
94
+ {
95
+ description: 'Failed to remove code from device.',
96
+ properties: {
97
+ error_code: {
98
+ description:
99
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
100
+ enum: ['failed_to_remove_from_device'],
101
+ type: 'string',
125
102
  },
126
- {
127
- description: 'Duplicate access code detected on device.',
128
- properties: {
129
- error_code: {
130
- description:
131
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
132
- enum: ['duplicate_code_on_device'],
133
- type: 'string',
134
- },
135
- is_access_code_error: { enum: [true], type: 'boolean' },
136
- message: { type: 'string' },
137
- },
138
- required: [
139
- 'message',
140
- 'is_access_code_error',
141
- 'error_code',
142
- ],
143
- type: 'object',
103
+ is_access_code_error: { enum: [true], type: 'boolean' },
104
+ message: { type: 'string' },
105
+ },
106
+ required: ['message', 'is_access_code_error', 'error_code'],
107
+ type: 'object',
108
+ },
109
+ {
110
+ description: 'Duplicate access code detected on device.',
111
+ properties: {
112
+ error_code: {
113
+ description:
114
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
115
+ enum: ['duplicate_code_on_device'],
116
+ type: 'string',
144
117
  },
145
- {
118
+ is_access_code_error: { enum: [true], type: 'boolean' },
119
+ message: { type: 'string' },
120
+ },
121
+ required: ['message', 'is_access_code_error', 'error_code'],
122
+ type: 'object',
123
+ },
124
+ {
125
+ description:
126
+ 'An attempt to modify this access code was prevented.',
127
+ properties: {
128
+ error_code: {
146
129
  description:
147
- 'An attempt to modify this access code was prevented.',
148
- properties: {
149
- error_code: {
150
- description:
151
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
152
- enum: ['duplicate_code_attempt_prevented'],
153
- type: 'string',
154
- },
155
- is_access_code_error: { enum: [true], type: 'boolean' },
156
- message: { type: 'string' },
157
- },
158
- required: [
159
- 'message',
160
- 'is_access_code_error',
161
- 'error_code',
162
- ],
163
- type: 'object',
130
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
131
+ enum: ['duplicate_code_attempt_prevented'],
132
+ type: 'string',
164
133
  },
165
- {
134
+ is_access_code_error: { enum: [true], type: 'boolean' },
135
+ message: { type: 'string' },
136
+ },
137
+ required: ['message', 'is_access_code_error', 'error_code'],
138
+ type: 'object',
139
+ },
140
+ {
141
+ description:
142
+ 'Igloohome bridge has too many pending jobs in the queue.',
143
+ properties: {
144
+ error_code: {
166
145
  description:
167
- 'Igloohome bridge has too many pending jobs in the queue.',
168
- properties: {
169
- error_code: {
170
- description:
171
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
172
- enum: ['igloohome_bridge_too_many_pending_jobs'],
173
- type: 'string',
174
- },
175
- is_access_code_error: { enum: [true], type: 'boolean' },
176
- message: { type: 'string' },
177
- },
178
- required: [
179
- 'message',
180
- 'is_access_code_error',
181
- 'error_code',
182
- ],
183
- type: 'object',
146
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
147
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
148
+ type: 'string',
184
149
  },
185
- {
186
- description: 'Igloohome bridge is offline.',
187
- properties: {
188
- error_code: {
189
- description:
190
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
191
- enum: ['igloohome_bridge_offline'],
192
- type: 'string',
193
- },
194
- is_access_code_error: { enum: [true], type: 'boolean' },
195
- message: { type: 'string' },
196
- },
197
- required: [
198
- 'message',
199
- 'is_access_code_error',
200
- 'error_code',
201
- ],
202
- type: 'object',
150
+ is_access_code_error: { enum: [true], type: 'boolean' },
151
+ message: { type: 'string' },
152
+ },
153
+ required: ['message', 'is_access_code_error', 'error_code'],
154
+ type: 'object',
155
+ },
156
+ {
157
+ description: 'Igloohome bridge is offline.',
158
+ properties: {
159
+ error_code: {
160
+ description:
161
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
162
+ enum: ['igloohome_bridge_offline'],
163
+ type: 'string',
203
164
  },
204
- {
205
- description: 'Lock as reached max amount of codes.',
206
- properties: {
207
- error_code: {
208
- description:
209
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
210
- enum: [
211
- 'igloohome_offline_access_code_no_variance_available',
212
- ],
213
- type: 'string',
214
- },
215
- is_access_code_error: { enum: [true], type: 'boolean' },
216
- message: { type: 'string' },
217
- },
218
- required: [
219
- 'message',
220
- 'is_access_code_error',
221
- 'error_code',
165
+ is_access_code_error: { enum: [true], type: 'boolean' },
166
+ message: { type: 'string' },
167
+ },
168
+ required: ['message', 'is_access_code_error', 'error_code'],
169
+ type: 'object',
170
+ },
171
+ {
172
+ description: 'Lock as reached max amount of codes.',
173
+ properties: {
174
+ error_code: {
175
+ description:
176
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
177
+ enum: [
178
+ 'igloohome_offline_access_code_no_variance_available',
222
179
  ],
223
- type: 'object',
180
+ type: 'string',
224
181
  },
225
- {
182
+ is_access_code_error: { enum: [true], type: 'boolean' },
183
+ message: { type: 'string' },
184
+ },
185
+ required: ['message', 'is_access_code_error', 'error_code'],
186
+ type: 'object',
187
+ },
188
+ {
189
+ description:
190
+ 'Unable to confirm the access code is set on Kwikset device.',
191
+ properties: {
192
+ error_code: {
226
193
  description:
227
- 'Unable to confirm the access code is set on Kwikset device.',
228
- properties: {
229
- error_code: {
230
- description:
231
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
232
- enum: ['kwikset_unable_to_confirm_code'],
233
- type: 'string',
234
- },
235
- is_access_code_error: { enum: [true], type: 'boolean' },
236
- message: { type: 'string' },
237
- },
238
- required: [
239
- 'message',
240
- 'is_access_code_error',
241
- 'error_code',
242
- ],
243
- type: 'object',
194
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
195
+ enum: ['kwikset_unable_to_confirm_code'],
196
+ type: 'string',
244
197
  },
245
- {
198
+ is_access_code_error: { enum: [true], type: 'boolean' },
199
+ message: { type: 'string' },
200
+ },
201
+ required: ['message', 'is_access_code_error', 'error_code'],
202
+ type: 'object',
203
+ },
204
+ {
205
+ description:
206
+ 'Unable to confirm the deletion of the access code on Kwikset device.',
207
+ properties: {
208
+ error_code: {
246
209
  description:
247
- 'Unable to confirm the deletion of the access code on Kwikset device.',
248
- properties: {
249
- error_code: {
250
- description:
251
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
252
- enum: ['kwikset_unable_to_confirm_deletion'],
253
- type: 'string',
254
- },
255
- is_access_code_error: { enum: [true], type: 'boolean' },
256
- message: { type: 'string' },
257
- },
258
- required: [
259
- 'message',
260
- 'is_access_code_error',
261
- 'error_code',
262
- ],
263
- type: 'object',
210
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
211
+ enum: ['kwikset_unable_to_confirm_deletion'],
212
+ type: 'string',
264
213
  },
265
- {
214
+ is_access_code_error: { enum: [true], type: 'boolean' },
215
+ message: { type: 'string' },
216
+ },
217
+ required: ['message', 'is_access_code_error', 'error_code'],
218
+ type: 'object',
219
+ },
220
+ {
221
+ description:
222
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
223
+ properties: {
224
+ error_code: {
266
225
  description:
267
- 'Code was modified or removed externally after Seam successfully set it on the device.',
268
- properties: {
269
- error_code: {
270
- description:
271
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
272
- enum: ['code_modified_external_to_seam'],
273
- type: 'string',
274
- },
275
- is_access_code_error: { enum: [true], type: 'boolean' },
276
- message: { type: 'string' },
277
- },
278
- required: [
279
- 'message',
280
- 'is_access_code_error',
281
- 'error_code',
282
- ],
283
- type: 'object',
226
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
227
+ enum: ['code_modified_external_to_seam'],
228
+ type: 'string',
284
229
  },
285
- {
286
- description: 'Invalid code length for August lock.',
287
- properties: {
288
- error_code: {
289
- description:
290
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
291
- enum: ['august_lock_invalid_code_length'],
292
- type: 'string',
293
- },
294
- is_access_code_error: { enum: [true], type: 'boolean' },
295
- message: { type: 'string' },
296
- },
297
- required: [
298
- 'message',
299
- 'is_access_code_error',
300
- 'error_code',
301
- ],
302
- type: 'object',
230
+ is_access_code_error: { enum: [true], type: 'boolean' },
231
+ message: { type: 'string' },
232
+ },
233
+ required: ['message', 'is_access_code_error', 'error_code'],
234
+ type: 'object',
235
+ },
236
+ {
237
+ description: 'Invalid code length for August lock.',
238
+ properties: {
239
+ error_code: {
240
+ description:
241
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
242
+ enum: ['august_lock_invalid_code_length'],
243
+ type: 'string',
303
244
  },
304
- {
245
+ is_access_code_error: { enum: [true], type: 'boolean' },
246
+ message: { type: 'string' },
247
+ },
248
+ required: ['message', 'is_access_code_error', 'error_code'],
249
+ type: 'object',
250
+ },
251
+ {
252
+ description:
253
+ 'Access code has not yet been fully moved to the device.',
254
+ properties: {
255
+ error_code: {
305
256
  description:
306
- 'Access code has not yet been fully moved to the device.',
307
- properties: {
308
- error_code: {
309
- description:
310
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
311
- enum: ['august_device_programming_delay'],
312
- type: 'string',
313
- },
314
- is_access_code_error: { enum: [true], type: 'boolean' },
315
- message: { type: 'string' },
316
- },
317
- required: [
318
- 'message',
319
- 'is_access_code_error',
320
- 'error_code',
321
- ],
322
- type: 'object',
257
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
258
+ enum: ['august_device_programming_delay'],
259
+ type: 'string',
323
260
  },
324
- {
261
+ is_access_code_error: { enum: [true], type: 'boolean' },
262
+ message: { type: 'string' },
263
+ },
264
+ required: ['message', 'is_access_code_error', 'error_code'],
265
+ type: 'object',
266
+ },
267
+ {
268
+ description: 'All access code slots on the device are full.',
269
+ properties: {
270
+ error_code: {
325
271
  description:
326
- 'All access code slots on the device are full.',
327
- properties: {
328
- error_code: {
329
- description:
330
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
331
- enum: ['august_device_slots_full'],
332
- type: 'string',
333
- },
334
- is_access_code_error: { enum: [true], type: 'boolean' },
335
- message: { type: 'string' },
336
- },
337
- required: [
338
- 'message',
339
- 'is_access_code_error',
340
- 'error_code',
341
- ],
342
- type: 'object',
272
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
273
+ enum: ['august_device_slots_full'],
274
+ type: 'string',
343
275
  },
344
- {
345
- description: 'August lock is missing a keypad.',
346
- properties: {
347
- error_code: {
348
- description:
349
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
350
- enum: ['august_lock_missing_keypad'],
351
- type: 'string',
352
- },
353
- is_access_code_error: { enum: [true], type: 'boolean' },
354
- message: { type: 'string' },
355
- },
356
- required: [
357
- 'message',
358
- 'is_access_code_error',
359
- 'error_code',
360
- ],
361
- type: 'object',
276
+ is_access_code_error: { enum: [true], type: 'boolean' },
277
+ message: { type: 'string' },
278
+ },
279
+ required: ['message', 'is_access_code_error', 'error_code'],
280
+ type: 'object',
281
+ },
282
+ {
283
+ description: 'August lock is missing a keypad.',
284
+ properties: {
285
+ error_code: {
286
+ description:
287
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
288
+ enum: ['august_lock_missing_keypad'],
289
+ type: 'string',
362
290
  },
363
- {
364
- description: 'Salto site user is not subscribed.',
365
- properties: {
366
- error_code: {
367
- description:
368
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
369
- enum: ['salto_site_user_not_subscribed'],
370
- type: 'string',
371
- },
372
- is_access_code_error: { enum: [true], type: 'boolean' },
373
- message: { type: 'string' },
374
- },
375
- required: [
376
- 'message',
377
- 'is_access_code_error',
378
- 'error_code',
379
- ],
380
- type: 'object',
291
+ is_access_code_error: { enum: [true], type: 'boolean' },
292
+ message: { type: 'string' },
293
+ },
294
+ required: ['message', 'is_access_code_error', 'error_code'],
295
+ type: 'object',
296
+ },
297
+ {
298
+ description: 'Salto site user is not subscribed.',
299
+ properties: {
300
+ error_code: {
301
+ description:
302
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
303
+ enum: ['salto_site_user_not_subscribed'],
304
+ type: 'string',
381
305
  },
382
- {
306
+ is_access_code_error: { enum: [true], type: 'boolean' },
307
+ message: { type: 'string' },
308
+ },
309
+ required: ['message', 'is_access_code_error', 'error_code'],
310
+ type: 'object',
311
+ },
312
+ {
313
+ description:
314
+ 'Access code has not yet been fully moved to the device.',
315
+ properties: {
316
+ error_code: {
383
317
  description:
384
- 'Access code has not yet been fully moved to the device.',
385
- properties: {
386
- error_code: {
387
- description:
388
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
389
- enum: ['hubitat_device_programming_delay'],
390
- type: 'string',
391
- },
392
- is_access_code_error: { enum: [true], type: 'boolean' },
393
- message: { type: 'string' },
394
- },
395
- required: [
396
- 'message',
397
- 'is_access_code_error',
398
- 'error_code',
399
- ],
400
- type: 'object',
318
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
319
+ enum: ['hubitat_device_programming_delay'],
320
+ type: 'string',
401
321
  },
402
- {
403
- description: 'No free positions available on the device.',
404
- properties: {
405
- error_code: {
406
- description:
407
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
408
- enum: ['hubitat_no_free_positions_available'],
409
- type: 'string',
410
- },
411
- is_access_code_error: { enum: [true], type: 'boolean' },
412
- message: { type: 'string' },
413
- },
414
- required: [
415
- 'message',
416
- 'is_access_code_error',
417
- 'error_code',
418
- ],
419
- type: 'object',
322
+ is_access_code_error: { enum: [true], type: 'boolean' },
323
+ message: { type: 'string' },
324
+ },
325
+ required: ['message', 'is_access_code_error', 'error_code'],
326
+ type: 'object',
327
+ },
328
+ {
329
+ description: 'No free positions available on the device.',
330
+ properties: {
331
+ error_code: {
332
+ description:
333
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
334
+ enum: ['hubitat_no_free_positions_available'],
335
+ type: 'string',
420
336
  },
421
- ],
337
+ is_access_code_error: { enum: [true], type: 'boolean' },
338
+ message: { type: 'string' },
339
+ },
340
+ required: ['message', 'is_access_code_error', 'error_code'],
341
+ type: 'object',
422
342
  },
423
343
  {
424
- description: 'Error associated with the `device`.',
425
- oneOf: [
426
- {
427
- description: 'Device is offline',
428
- properties: {
429
- error_code: {
430
- description:
431
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
432
- enum: ['device_offline'],
433
- type: 'string',
434
- },
435
- is_device_error: { enum: [true], type: 'boolean' },
436
- message: { type: 'string' },
437
- },
438
- required: ['message', 'is_device_error', 'error_code'],
439
- type: 'object',
344
+ description: 'Device is offline',
345
+ properties: {
346
+ error_code: {
347
+ description:
348
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
349
+ enum: ['device_offline'],
350
+ type: 'string',
440
351
  },
441
- {
442
- description: 'Device has been removed',
443
- properties: {
444
- error_code: {
445
- description:
446
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
447
- enum: ['device_removed'],
448
- type: 'string',
449
- },
450
- is_device_error: { enum: [true], type: 'boolean' },
451
- message: { type: 'string' },
452
- },
453
- required: ['message', 'is_device_error', 'error_code'],
454
- type: 'object',
352
+ is_device_error: { enum: [true], type: 'boolean' },
353
+ message: { type: 'string' },
354
+ },
355
+ required: ['message', 'is_device_error', 'error_code'],
356
+ type: 'object',
357
+ },
358
+ {
359
+ description: 'Device has been removed',
360
+ properties: {
361
+ error_code: {
362
+ description:
363
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
364
+ enum: ['device_removed'],
365
+ type: 'string',
455
366
  },
456
- {
457
- description: 'Account is disconnected',
458
- properties: {
459
- error_code: {
460
- description:
461
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
462
- enum: ['account_disconnected'],
463
- type: 'string',
464
- },
465
- is_device_error: { enum: [true], type: 'boolean' },
466
- message: { type: 'string' },
467
- },
468
- required: ['message', 'is_device_error', 'error_code'],
469
- type: 'object',
367
+ is_device_error: { enum: [true], type: 'boolean' },
368
+ message: { type: 'string' },
369
+ },
370
+ required: ['message', 'is_device_error', 'error_code'],
371
+ type: 'object',
372
+ },
373
+ {
374
+ description: 'Hub is disconnected',
375
+ properties: {
376
+ error_code: {
377
+ description:
378
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
379
+ enum: ['hub_disconnected'],
380
+ type: 'string',
470
381
  },
471
- {
472
- description: 'Hub is disconnected',
473
- properties: {
474
- error_code: {
475
- description:
476
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
477
- enum: ['hub_disconnected'],
478
- type: 'string',
479
- },
480
- is_device_error: { enum: [true], type: 'boolean' },
481
- message: { type: 'string' },
482
- },
483
- required: ['message', 'is_device_error', 'error_code'],
484
- type: 'object',
382
+ is_device_error: { enum: [true], type: 'boolean' },
383
+ message: { type: 'string' },
384
+ },
385
+ required: ['message', 'is_device_error', 'error_code'],
386
+ type: 'object',
387
+ },
388
+ {
389
+ description: 'Device is disconnected',
390
+ properties: {
391
+ error_code: {
392
+ description:
393
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
394
+ enum: ['device_disconnected'],
395
+ type: 'string',
485
396
  },
486
- {
487
- description: 'Device is disconnected',
488
- properties: {
489
- error_code: {
490
- description:
491
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
492
- enum: ['device_disconnected'],
493
- type: 'string',
494
- },
495
- is_device_error: { enum: [true], type: 'boolean' },
496
- message: { type: 'string' },
497
- },
498
- required: ['message', 'is_device_error', 'error_code'],
499
- type: 'object',
397
+ is_device_error: { enum: [true], type: 'boolean' },
398
+ message: { type: 'string' },
399
+ },
400
+ required: ['message', 'is_device_error', 'error_code'],
401
+ type: 'object',
402
+ },
403
+ {
404
+ description: 'The backup access code pool is empty.',
405
+ properties: {
406
+ error_code: {
407
+ description:
408
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
409
+ enum: ['empty_backup_access_code_pool'],
410
+ type: 'string',
500
411
  },
501
- {
502
- description: 'The backup access code pool is empty.',
503
- properties: {
504
- error_code: {
505
- description:
506
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
507
- enum: ['empty_backup_access_code_pool'],
508
- type: 'string',
509
- },
510
- is_device_error: { enum: [true], type: 'boolean' },
511
- message: { type: 'string' },
512
- },
513
- required: ['message', 'is_device_error', 'error_code'],
514
- type: 'object',
412
+ is_device_error: { enum: [true], type: 'boolean' },
413
+ message: { type: 'string' },
414
+ },
415
+ required: ['message', 'is_device_error', 'error_code'],
416
+ type: 'object',
417
+ },
418
+ {
419
+ description: 'User is not authorized to use the August Lock.',
420
+ properties: {
421
+ error_code: {
422
+ description:
423
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
424
+ enum: ['august_lock_not_authorized'],
425
+ type: 'string',
515
426
  },
516
- {
427
+ is_device_error: { enum: [true], type: 'boolean' },
428
+ message: { type: 'string' },
429
+ },
430
+ required: ['message', 'is_device_error', 'error_code'],
431
+ type: 'object',
432
+ },
433
+ {
434
+ description: 'Lock is not connected to the Seam Bridge.',
435
+ properties: {
436
+ error_code: {
517
437
  description:
518
- 'User is not authorized to use the August Lock.',
519
- properties: {
520
- error_code: {
521
- description:
522
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
523
- enum: ['august_lock_not_authorized'],
524
- type: 'string',
525
- },
526
- is_device_error: { enum: [true], type: 'boolean' },
527
- message: { type: 'string' },
528
- },
529
- required: ['message', 'is_device_error', 'error_code'],
530
- type: 'object',
438
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
439
+ enum: ['august_lock_missing_bridge'],
440
+ type: 'string',
531
441
  },
532
- {
533
- description: 'Lock is not connected to the Seam Bridge.',
534
- properties: {
535
- error_code: {
536
- description:
537
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
538
- enum: ['august_lock_missing_bridge'],
539
- type: 'string',
540
- },
541
- is_device_error: { enum: [true], type: 'boolean' },
542
- message: { type: 'string' },
543
- },
544
- required: ['message', 'is_device_error', 'error_code'],
545
- type: 'object',
442
+ is_device_error: { enum: [true], type: 'boolean' },
443
+ message: { type: 'string' },
444
+ },
445
+ required: ['message', 'is_device_error', 'error_code'],
446
+ type: 'object',
447
+ },
448
+ {
449
+ description: 'Salto site user limit reached.',
450
+ properties: {
451
+ error_code: {
452
+ description:
453
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
454
+ enum: ['salto_site_user_limit_reached'],
455
+ type: 'string',
456
+ },
457
+ is_device_error: { enum: [true], type: 'boolean' },
458
+ message: { type: 'string' },
459
+ },
460
+ required: ['message', 'is_device_error', 'error_code'],
461
+ type: 'object',
462
+ },
463
+ {
464
+ description: 'Lock is not paired with a Gateway.',
465
+ properties: {
466
+ error_code: {
467
+ description:
468
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
469
+ enum: ['ttlock_lock_not_paired_to_gateway'],
470
+ type: 'string',
546
471
  },
547
- {
548
- description: 'Salto site user limit reached.',
549
- properties: {
550
- error_code: {
551
- description:
552
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
553
- enum: ['salto_site_user_limit_reached'],
554
- type: 'string',
555
- },
556
- is_device_error: { enum: [true], type: 'boolean' },
557
- message: { type: 'string' },
558
- },
559
- required: ['message', 'is_device_error', 'error_code'],
560
- type: 'object',
472
+ is_device_error: { enum: [true], type: 'boolean' },
473
+ message: { type: 'string' },
474
+ },
475
+ required: ['message', 'is_device_error', 'error_code'],
476
+ type: 'object',
477
+ },
478
+ {
479
+ description: 'Missing device credentials.',
480
+ properties: {
481
+ error_code: {
482
+ description:
483
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
484
+ enum: ['missing_device_credentials'],
485
+ type: 'string',
561
486
  },
562
- {
563
- description: 'Lock is not paired with a Gateway.',
564
- properties: {
565
- error_code: {
566
- description:
567
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
568
- enum: ['ttlock_lock_not_paired_to_gateway'],
569
- type: 'string',
570
- },
571
- is_device_error: { enum: [true], type: 'boolean' },
572
- message: { type: 'string' },
573
- },
574
- required: ['message', 'is_device_error', 'error_code'],
575
- type: 'object',
487
+ is_device_error: { enum: [true], type: 'boolean' },
488
+ message: { type: 'string' },
489
+ },
490
+ required: ['message', 'is_device_error', 'error_code'],
491
+ type: 'object',
492
+ },
493
+ {
494
+ description: 'The auxiliary heat is running.',
495
+ properties: {
496
+ error_code: {
497
+ description:
498
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
499
+ enum: ['auxiliary_heat_running'],
500
+ type: 'string',
576
501
  },
577
- {
578
- description: 'Missing device credentials.',
579
- properties: {
580
- error_code: {
581
- description:
582
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
583
- enum: ['missing_device_credentials'],
584
- type: 'string',
585
- },
586
- is_device_error: { enum: [true], type: 'boolean' },
587
- message: { type: 'string' },
588
- },
589
- required: ['message', 'is_device_error', 'error_code'],
590
- type: 'object',
502
+ is_device_error: { enum: [true], type: 'boolean' },
503
+ message: { type: 'string' },
504
+ },
505
+ required: ['message', 'is_device_error', 'error_code'],
506
+ type: 'object',
507
+ },
508
+ {
509
+ description: 'Subscription required to connect.',
510
+ properties: {
511
+ error_code: {
512
+ description:
513
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
514
+ enum: ['subscription_required'],
515
+ type: 'string',
591
516
  },
592
- {
593
- description: 'The auxiliary heat is running.',
594
- properties: {
595
- error_code: {
596
- description:
597
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
598
- enum: ['auxiliary_heat_running'],
599
- type: 'string',
600
- },
601
- is_device_error: { enum: [true], type: 'boolean' },
602
- message: { type: 'string' },
603
- },
604
- required: ['message', 'is_device_error', 'error_code'],
605
- type: 'object',
517
+ is_device_error: { enum: [true], type: 'boolean' },
518
+ message: { type: 'string' },
519
+ },
520
+ required: ['message', 'is_device_error', 'error_code'],
521
+ type: 'object',
522
+ },
523
+ {
524
+ description: 'Account is disconnected.',
525
+ properties: {
526
+ error_code: {
527
+ description:
528
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
529
+ enum: ['account_disconnected'],
530
+ type: 'string',
606
531
  },
607
- {
608
- description: 'Subscription required to connect.',
609
- properties: {
610
- error_code: {
611
- description:
612
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
613
- enum: ['subscription_required'],
614
- type: 'string',
615
- },
616
- is_device_error: { enum: [true], type: 'boolean' },
617
- message: { type: 'string' },
618
- },
619
- required: ['message', 'is_device_error', 'error_code'],
620
- type: 'object',
532
+ is_connected_account_error: {
533
+ enum: [true],
534
+ type: 'boolean',
621
535
  },
536
+ message: { type: 'string' },
537
+ },
538
+ required: [
539
+ 'message',
540
+ 'is_connected_account_error',
541
+ 'error_code',
622
542
  ],
543
+ type: 'object',
623
544
  },
624
545
  {
625
- oneOf: [
626
- {
627
- description: 'Account is disconnected.',
628
- properties: {
629
- error_code: {
630
- description:
631
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
632
- enum: ['account_disconnected'],
633
- type: 'string',
634
- },
635
- is_connected_account_error: {
636
- enum: [true],
637
- type: 'boolean',
638
- },
639
- message: { type: 'string' },
640
- },
641
- required: [
642
- 'message',
643
- 'is_connected_account_error',
644
- 'error_code',
645
- ],
646
- type: 'object',
546
+ description: 'Credentials provided were invalid.',
547
+ properties: {
548
+ error_code: {
549
+ description:
550
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
551
+ enum: ['invalid_credentials'],
552
+ type: 'string',
647
553
  },
648
- {
649
- description: 'Credentials provided were invalid.',
650
- properties: {
651
- error_code: {
652
- description:
653
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
654
- enum: ['invalid_credentials'],
655
- type: 'string',
656
- },
657
- is_connected_account_error: {
658
- enum: [true],
659
- type: 'boolean',
660
- },
661
- message: { type: 'string' },
662
- },
663
- required: [
664
- 'message',
665
- 'is_connected_account_error',
666
- 'error_code',
667
- ],
668
- type: 'object',
554
+ is_connected_account_error: {
555
+ enum: [true],
556
+ type: 'boolean',
669
557
  },
558
+ message: { type: 'string' },
559
+ },
560
+ required: [
561
+ 'message',
562
+ 'is_connected_account_error',
563
+ 'error_code',
670
564
  ],
565
+ type: 'object',
671
566
  },
672
567
  ],
673
568
  },
@@ -748,6 +643,7 @@ export default {
748
643
  description:
749
644
  'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
750
645
  items: {
646
+ discriminator: { propertyName: 'warning_code' },
751
647
  oneOf: [
752
648
  {
753
649
  description: 'Failed to set code on Smart Things device.',
@@ -1188,6 +1084,7 @@ export default {
1188
1084
  description: 'Warnings associated with the `acs_credential`.',
1189
1085
  items: {
1190
1086
  description: 'Warning associated with the `acs_credential`.',
1087
+ discriminator: { propertyName: 'warning_code' },
1191
1088
  oneOf: [
1192
1089
  {
1193
1090
  description:
@@ -1677,6 +1574,7 @@ export default {
1677
1574
  description: 'Errors associated with the `acs_system`.',
1678
1575
  items: {
1679
1576
  description: 'Error associated with the `acs_system`.',
1577
+ discriminator: { propertyName: 'error_code' },
1680
1578
  oneOf: [
1681
1579
  {
1682
1580
  description:
@@ -1930,6 +1828,7 @@ export default {
1930
1828
  description: 'Warnings associated with the `acs_system`.',
1931
1829
  items: {
1932
1830
  description: 'Warning associated with the `acs_system`.',
1831
+ discriminator: { propertyName: 'warning_code' },
1933
1832
  oneOf: [
1934
1833
  {
1935
1834
  properties: {
@@ -2069,6 +1968,7 @@ export default {
2069
1968
  description: 'Errors associated with the `acs_user`.',
2070
1969
  items: {
2071
1970
  description: 'Error associated with the `acs_user`.',
1971
+ discriminator: { propertyName: 'error_code' },
2072
1972
  oneOf: [
2073
1973
  {
2074
1974
  description:
@@ -2261,6 +2161,7 @@ export default {
2261
2161
  description: 'Warnings associated with the `acs_user`.',
2262
2162
  items: {
2263
2163
  description: 'Warning associated with the `acs_user`.',
2164
+ discriminator: { propertyName: 'warning_code' },
2264
2165
  oneOf: [
2265
2166
  {
2266
2167
  description:
@@ -2784,6 +2685,7 @@ export default {
2784
2685
  items: {
2785
2686
  description:
2786
2687
  'Warning associated with the `acs_credential`.',
2688
+ discriminator: { propertyName: 'warning_code' },
2787
2689
  oneOf: [
2788
2690
  {
2789
2691
  description:
@@ -3165,6 +3067,7 @@ export default {
3165
3067
  items: {
3166
3068
  description:
3167
3069
  'Warning associated with the `acs_credential`.',
3070
+ discriminator: { propertyName: 'warning_code' },
3168
3071
  oneOf: [
3169
3072
  {
3170
3073
  description:
@@ -3680,6 +3583,7 @@ export default {
3680
3583
  items: {
3681
3584
  description:
3682
3585
  'Warning associated with the `acs_credential`.',
3586
+ discriminator: { propertyName: 'warning_code' },
3683
3587
  oneOf: [
3684
3588
  {
3685
3589
  description:
@@ -4058,6 +3962,7 @@ export default {
4058
3962
  items: {
4059
3963
  description:
4060
3964
  'Warning associated with the `acs_credential`.',
3965
+ discriminator: { propertyName: 'warning_code' },
4061
3966
  oneOf: [
4062
3967
  {
4063
3968
  description:
@@ -5318,13 +5223,14 @@ export default {
5318
5223
  },
5319
5224
  errors: {
5320
5225
  items: {
5226
+ discriminator: { propertyName: 'error_code' },
5321
5227
  oneOf: [
5322
5228
  {
5323
5229
  description: 'Account is disconnected.',
5324
5230
  properties: {
5325
5231
  error_code: {
5326
5232
  description:
5327
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5233
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5328
5234
  enum: ['account_disconnected'],
5329
5235
  type: 'string',
5330
5236
  },
@@ -5346,7 +5252,7 @@ export default {
5346
5252
  properties: {
5347
5253
  error_code: {
5348
5254
  description:
5349
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5255
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5350
5256
  enum: ['invalid_credentials'],
5351
5257
  type: 'string',
5352
5258
  },
@@ -5380,6 +5286,7 @@ export default {
5380
5286
  warnings: {
5381
5287
  items: {
5382
5288
  description: 'Warning associated with the `connected_account`.',
5289
+ discriminator: { propertyName: 'warning_code' },
5383
5290
  oneOf: [
5384
5291
  {
5385
5292
  description: 'Scheduled downtime for account planned.',
@@ -5537,255 +5444,231 @@ export default {
5537
5444
  description:
5538
5445
  'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
5539
5446
  items: {
5447
+ discriminator: { propertyName: 'error_code' },
5540
5448
  oneOf: [
5541
5449
  {
5542
- description: 'Error associated with the `device`.',
5543
- oneOf: [
5544
- {
5545
- description: 'Device is offline',
5546
- properties: {
5547
- error_code: {
5548
- description:
5549
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5550
- enum: ['device_offline'],
5551
- type: 'string',
5552
- },
5553
- is_device_error: { enum: [true], type: 'boolean' },
5554
- message: { type: 'string' },
5555
- },
5556
- required: ['message', 'is_device_error', 'error_code'],
5557
- type: 'object',
5450
+ description: 'Device is offline',
5451
+ properties: {
5452
+ error_code: {
5453
+ description:
5454
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5455
+ enum: ['device_offline'],
5456
+ type: 'string',
5558
5457
  },
5559
- {
5560
- description: 'Device has been removed',
5561
- properties: {
5562
- error_code: {
5563
- description:
5564
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5565
- enum: ['device_removed'],
5566
- type: 'string',
5567
- },
5568
- is_device_error: { enum: [true], type: 'boolean' },
5569
- message: { type: 'string' },
5570
- },
5571
- required: ['message', 'is_device_error', 'error_code'],
5572
- type: 'object',
5458
+ is_device_error: { enum: [true], type: 'boolean' },
5459
+ message: { type: 'string' },
5460
+ },
5461
+ required: ['message', 'is_device_error', 'error_code'],
5462
+ type: 'object',
5463
+ },
5464
+ {
5465
+ description: 'Device has been removed',
5466
+ properties: {
5467
+ error_code: {
5468
+ description:
5469
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5470
+ enum: ['device_removed'],
5471
+ type: 'string',
5573
5472
  },
5574
- {
5575
- description: 'Account is disconnected',
5576
- properties: {
5577
- error_code: {
5578
- description:
5579
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5580
- enum: ['account_disconnected'],
5581
- type: 'string',
5582
- },
5583
- is_device_error: { enum: [true], type: 'boolean' },
5584
- message: { type: 'string' },
5585
- },
5586
- required: ['message', 'is_device_error', 'error_code'],
5587
- type: 'object',
5473
+ is_device_error: { enum: [true], type: 'boolean' },
5474
+ message: { type: 'string' },
5475
+ },
5476
+ required: ['message', 'is_device_error', 'error_code'],
5477
+ type: 'object',
5478
+ },
5479
+ {
5480
+ description: 'Hub is disconnected',
5481
+ properties: {
5482
+ error_code: {
5483
+ description:
5484
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5485
+ enum: ['hub_disconnected'],
5486
+ type: 'string',
5588
5487
  },
5589
- {
5590
- description: 'Hub is disconnected',
5591
- properties: {
5592
- error_code: {
5593
- description:
5594
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5595
- enum: ['hub_disconnected'],
5596
- type: 'string',
5597
- },
5598
- is_device_error: { enum: [true], type: 'boolean' },
5599
- message: { type: 'string' },
5600
- },
5601
- required: ['message', 'is_device_error', 'error_code'],
5602
- type: 'object',
5488
+ is_device_error: { enum: [true], type: 'boolean' },
5489
+ message: { type: 'string' },
5490
+ },
5491
+ required: ['message', 'is_device_error', 'error_code'],
5492
+ type: 'object',
5493
+ },
5494
+ {
5495
+ description: 'Device is disconnected',
5496
+ properties: {
5497
+ error_code: {
5498
+ description:
5499
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5500
+ enum: ['device_disconnected'],
5501
+ type: 'string',
5603
5502
  },
5604
- {
5605
- description: 'Device is disconnected',
5606
- properties: {
5607
- error_code: {
5608
- description:
5609
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5610
- enum: ['device_disconnected'],
5611
- type: 'string',
5612
- },
5613
- is_device_error: { enum: [true], type: 'boolean' },
5614
- message: { type: 'string' },
5615
- },
5616
- required: ['message', 'is_device_error', 'error_code'],
5617
- type: 'object',
5503
+ is_device_error: { enum: [true], type: 'boolean' },
5504
+ message: { type: 'string' },
5505
+ },
5506
+ required: ['message', 'is_device_error', 'error_code'],
5507
+ type: 'object',
5508
+ },
5509
+ {
5510
+ description: 'The backup access code pool is empty.',
5511
+ properties: {
5512
+ error_code: {
5513
+ description:
5514
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5515
+ enum: ['empty_backup_access_code_pool'],
5516
+ type: 'string',
5618
5517
  },
5619
- {
5620
- description: 'The backup access code pool is empty.',
5621
- properties: {
5622
- error_code: {
5623
- description:
5624
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5625
- enum: ['empty_backup_access_code_pool'],
5626
- type: 'string',
5627
- },
5628
- is_device_error: { enum: [true], type: 'boolean' },
5629
- message: { type: 'string' },
5630
- },
5631
- required: ['message', 'is_device_error', 'error_code'],
5632
- type: 'object',
5518
+ is_device_error: { enum: [true], type: 'boolean' },
5519
+ message: { type: 'string' },
5520
+ },
5521
+ required: ['message', 'is_device_error', 'error_code'],
5522
+ type: 'object',
5523
+ },
5524
+ {
5525
+ description: 'User is not authorized to use the August Lock.',
5526
+ properties: {
5527
+ error_code: {
5528
+ description:
5529
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5530
+ enum: ['august_lock_not_authorized'],
5531
+ type: 'string',
5532
+ },
5533
+ is_device_error: { enum: [true], type: 'boolean' },
5534
+ message: { type: 'string' },
5535
+ },
5536
+ required: ['message', 'is_device_error', 'error_code'],
5537
+ type: 'object',
5538
+ },
5539
+ {
5540
+ description: 'Lock is not connected to the Seam Bridge.',
5541
+ properties: {
5542
+ error_code: {
5543
+ description:
5544
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5545
+ enum: ['august_lock_missing_bridge'],
5546
+ type: 'string',
5633
5547
  },
5634
- {
5548
+ is_device_error: { enum: [true], type: 'boolean' },
5549
+ message: { type: 'string' },
5550
+ },
5551
+ required: ['message', 'is_device_error', 'error_code'],
5552
+ type: 'object',
5553
+ },
5554
+ {
5555
+ description: 'Salto site user limit reached.',
5556
+ properties: {
5557
+ error_code: {
5635
5558
  description:
5636
- 'User is not authorized to use the August Lock.',
5637
- properties: {
5638
- error_code: {
5639
- description:
5640
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5641
- enum: ['august_lock_not_authorized'],
5642
- type: 'string',
5643
- },
5644
- is_device_error: { enum: [true], type: 'boolean' },
5645
- message: { type: 'string' },
5646
- },
5647
- required: ['message', 'is_device_error', 'error_code'],
5648
- type: 'object',
5559
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5560
+ enum: ['salto_site_user_limit_reached'],
5561
+ type: 'string',
5649
5562
  },
5650
- {
5651
- description: 'Lock is not connected to the Seam Bridge.',
5652
- properties: {
5653
- error_code: {
5654
- description:
5655
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5656
- enum: ['august_lock_missing_bridge'],
5657
- type: 'string',
5658
- },
5659
- is_device_error: { enum: [true], type: 'boolean' },
5660
- message: { type: 'string' },
5661
- },
5662
- required: ['message', 'is_device_error', 'error_code'],
5663
- type: 'object',
5563
+ is_device_error: { enum: [true], type: 'boolean' },
5564
+ message: { type: 'string' },
5565
+ },
5566
+ required: ['message', 'is_device_error', 'error_code'],
5567
+ type: 'object',
5568
+ },
5569
+ {
5570
+ description: 'Lock is not paired with a Gateway.',
5571
+ properties: {
5572
+ error_code: {
5573
+ description:
5574
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5575
+ enum: ['ttlock_lock_not_paired_to_gateway'],
5576
+ type: 'string',
5664
5577
  },
5665
- {
5666
- description: 'Salto site user limit reached.',
5667
- properties: {
5668
- error_code: {
5669
- description:
5670
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5671
- enum: ['salto_site_user_limit_reached'],
5672
- type: 'string',
5673
- },
5674
- is_device_error: { enum: [true], type: 'boolean' },
5675
- message: { type: 'string' },
5676
- },
5677
- required: ['message', 'is_device_error', 'error_code'],
5678
- type: 'object',
5578
+ is_device_error: { enum: [true], type: 'boolean' },
5579
+ message: { type: 'string' },
5580
+ },
5581
+ required: ['message', 'is_device_error', 'error_code'],
5582
+ type: 'object',
5583
+ },
5584
+ {
5585
+ description: 'Missing device credentials.',
5586
+ properties: {
5587
+ error_code: {
5588
+ description:
5589
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5590
+ enum: ['missing_device_credentials'],
5591
+ type: 'string',
5679
5592
  },
5680
- {
5681
- description: 'Lock is not paired with a Gateway.',
5682
- properties: {
5683
- error_code: {
5684
- description:
5685
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5686
- enum: ['ttlock_lock_not_paired_to_gateway'],
5687
- type: 'string',
5688
- },
5689
- is_device_error: { enum: [true], type: 'boolean' },
5690
- message: { type: 'string' },
5691
- },
5692
- required: ['message', 'is_device_error', 'error_code'],
5693
- type: 'object',
5593
+ is_device_error: { enum: [true], type: 'boolean' },
5594
+ message: { type: 'string' },
5595
+ },
5596
+ required: ['message', 'is_device_error', 'error_code'],
5597
+ type: 'object',
5598
+ },
5599
+ {
5600
+ description: 'The auxiliary heat is running.',
5601
+ properties: {
5602
+ error_code: {
5603
+ description:
5604
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5605
+ enum: ['auxiliary_heat_running'],
5606
+ type: 'string',
5694
5607
  },
5695
- {
5696
- description: 'Missing device credentials.',
5697
- properties: {
5698
- error_code: {
5699
- description:
5700
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5701
- enum: ['missing_device_credentials'],
5702
- type: 'string',
5703
- },
5704
- is_device_error: { enum: [true], type: 'boolean' },
5705
- message: { type: 'string' },
5706
- },
5707
- required: ['message', 'is_device_error', 'error_code'],
5708
- type: 'object',
5608
+ is_device_error: { enum: [true], type: 'boolean' },
5609
+ message: { type: 'string' },
5610
+ },
5611
+ required: ['message', 'is_device_error', 'error_code'],
5612
+ type: 'object',
5613
+ },
5614
+ {
5615
+ description: 'Subscription required to connect.',
5616
+ properties: {
5617
+ error_code: {
5618
+ description:
5619
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5620
+ enum: ['subscription_required'],
5621
+ type: 'string',
5709
5622
  },
5710
- {
5711
- description: 'The auxiliary heat is running.',
5712
- properties: {
5713
- error_code: {
5714
- description:
5715
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5716
- enum: ['auxiliary_heat_running'],
5717
- type: 'string',
5718
- },
5719
- is_device_error: { enum: [true], type: 'boolean' },
5720
- message: { type: 'string' },
5721
- },
5722
- required: ['message', 'is_device_error', 'error_code'],
5723
- type: 'object',
5623
+ is_device_error: { enum: [true], type: 'boolean' },
5624
+ message: { type: 'string' },
5625
+ },
5626
+ required: ['message', 'is_device_error', 'error_code'],
5627
+ type: 'object',
5628
+ },
5629
+ {
5630
+ description: 'Account is disconnected.',
5631
+ properties: {
5632
+ error_code: {
5633
+ description:
5634
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5635
+ enum: ['account_disconnected'],
5636
+ type: 'string',
5724
5637
  },
5725
- {
5726
- description: 'Subscription required to connect.',
5727
- properties: {
5728
- error_code: {
5729
- description:
5730
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5731
- enum: ['subscription_required'],
5732
- type: 'string',
5733
- },
5734
- is_device_error: { enum: [true], type: 'boolean' },
5735
- message: { type: 'string' },
5736
- },
5737
- required: ['message', 'is_device_error', 'error_code'],
5738
- type: 'object',
5638
+ is_connected_account_error: {
5639
+ enum: [true],
5640
+ type: 'boolean',
5739
5641
  },
5642
+ message: { type: 'string' },
5643
+ },
5644
+ required: [
5645
+ 'message',
5646
+ 'is_connected_account_error',
5647
+ 'error_code',
5740
5648
  ],
5649
+ type: 'object',
5741
5650
  },
5742
5651
  {
5743
- oneOf: [
5744
- {
5745
- description: 'Account is disconnected.',
5746
- properties: {
5747
- error_code: {
5748
- description:
5749
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5750
- enum: ['account_disconnected'],
5751
- type: 'string',
5752
- },
5753
- is_connected_account_error: {
5754
- enum: [true],
5755
- type: 'boolean',
5756
- },
5757
- message: { type: 'string' },
5758
- },
5759
- required: [
5760
- 'message',
5761
- 'is_connected_account_error',
5762
- 'error_code',
5763
- ],
5764
- type: 'object',
5652
+ description: 'Credentials provided were invalid.',
5653
+ properties: {
5654
+ error_code: {
5655
+ description:
5656
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
5657
+ enum: ['invalid_credentials'],
5658
+ type: 'string',
5765
5659
  },
5766
- {
5767
- description: 'Credentials provided were invalid.',
5768
- properties: {
5769
- error_code: {
5770
- description:
5771
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
5772
- enum: ['invalid_credentials'],
5773
- type: 'string',
5774
- },
5775
- is_connected_account_error: {
5776
- enum: [true],
5777
- type: 'boolean',
5778
- },
5779
- message: { type: 'string' },
5780
- },
5781
- required: [
5782
- 'message',
5783
- 'is_connected_account_error',
5784
- 'error_code',
5785
- ],
5786
- type: 'object',
5660
+ is_connected_account_error: {
5661
+ enum: [true],
5662
+ type: 'boolean',
5787
5663
  },
5664
+ message: { type: 'string' },
5665
+ },
5666
+ required: [
5667
+ 'message',
5668
+ 'is_connected_account_error',
5669
+ 'error_code',
5788
5670
  ],
5671
+ type: 'object',
5789
5672
  },
5790
5673
  ],
5791
5674
  },
@@ -7090,6 +6973,7 @@ export default {
7090
6973
  description:
7091
6974
  'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
7092
6975
  items: {
6976
+ discriminator: { propertyName: 'warning_code' },
7093
6977
  oneOf: [
7094
6978
  {
7095
6979
  description: 'Backup access code unhealthy.',
@@ -11927,255 +11811,231 @@ export default {
11927
11811
  description:
11928
11812
  'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
11929
11813
  items: {
11814
+ discriminator: { propertyName: 'error_code' },
11930
11815
  oneOf: [
11931
11816
  {
11932
- description: 'Error associated with the `device`.',
11933
- oneOf: [
11934
- {
11935
- description: 'Device is offline',
11936
- properties: {
11937
- error_code: {
11938
- description:
11939
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11940
- enum: ['device_offline'],
11941
- type: 'string',
11942
- },
11943
- is_device_error: { enum: [true], type: 'boolean' },
11944
- message: { type: 'string' },
11945
- },
11946
- required: ['message', 'is_device_error', 'error_code'],
11947
- type: 'object',
11817
+ description: 'Device is offline',
11818
+ properties: {
11819
+ error_code: {
11820
+ description:
11821
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11822
+ enum: ['device_offline'],
11823
+ type: 'string',
11948
11824
  },
11949
- {
11950
- description: 'Device has been removed',
11951
- properties: {
11952
- error_code: {
11953
- description:
11954
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11955
- enum: ['device_removed'],
11956
- type: 'string',
11957
- },
11958
- is_device_error: { enum: [true], type: 'boolean' },
11959
- message: { type: 'string' },
11960
- },
11961
- required: ['message', 'is_device_error', 'error_code'],
11962
- type: 'object',
11825
+ is_device_error: { enum: [true], type: 'boolean' },
11826
+ message: { type: 'string' },
11827
+ },
11828
+ required: ['message', 'is_device_error', 'error_code'],
11829
+ type: 'object',
11830
+ },
11831
+ {
11832
+ description: 'Device has been removed',
11833
+ properties: {
11834
+ error_code: {
11835
+ description:
11836
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11837
+ enum: ['device_removed'],
11838
+ type: 'string',
11963
11839
  },
11964
- {
11965
- description: 'Account is disconnected',
11966
- properties: {
11967
- error_code: {
11968
- description:
11969
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11970
- enum: ['account_disconnected'],
11971
- type: 'string',
11972
- },
11973
- is_device_error: { enum: [true], type: 'boolean' },
11974
- message: { type: 'string' },
11975
- },
11976
- required: ['message', 'is_device_error', 'error_code'],
11977
- type: 'object',
11840
+ is_device_error: { enum: [true], type: 'boolean' },
11841
+ message: { type: 'string' },
11842
+ },
11843
+ required: ['message', 'is_device_error', 'error_code'],
11844
+ type: 'object',
11845
+ },
11846
+ {
11847
+ description: 'Hub is disconnected',
11848
+ properties: {
11849
+ error_code: {
11850
+ description:
11851
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11852
+ enum: ['hub_disconnected'],
11853
+ type: 'string',
11978
11854
  },
11979
- {
11980
- description: 'Hub is disconnected',
11981
- properties: {
11982
- error_code: {
11983
- description:
11984
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11985
- enum: ['hub_disconnected'],
11986
- type: 'string',
11987
- },
11988
- is_device_error: { enum: [true], type: 'boolean' },
11989
- message: { type: 'string' },
11990
- },
11991
- required: ['message', 'is_device_error', 'error_code'],
11992
- type: 'object',
11855
+ is_device_error: { enum: [true], type: 'boolean' },
11856
+ message: { type: 'string' },
11857
+ },
11858
+ required: ['message', 'is_device_error', 'error_code'],
11859
+ type: 'object',
11860
+ },
11861
+ {
11862
+ description: 'Device is disconnected',
11863
+ properties: {
11864
+ error_code: {
11865
+ description:
11866
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11867
+ enum: ['device_disconnected'],
11868
+ type: 'string',
11993
11869
  },
11994
- {
11995
- description: 'Device is disconnected',
11996
- properties: {
11997
- error_code: {
11998
- description:
11999
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12000
- enum: ['device_disconnected'],
12001
- type: 'string',
12002
- },
12003
- is_device_error: { enum: [true], type: 'boolean' },
12004
- message: { type: 'string' },
12005
- },
12006
- required: ['message', 'is_device_error', 'error_code'],
12007
- type: 'object',
11870
+ is_device_error: { enum: [true], type: 'boolean' },
11871
+ message: { type: 'string' },
11872
+ },
11873
+ required: ['message', 'is_device_error', 'error_code'],
11874
+ type: 'object',
11875
+ },
11876
+ {
11877
+ description: 'The backup access code pool is empty.',
11878
+ properties: {
11879
+ error_code: {
11880
+ description:
11881
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11882
+ enum: ['empty_backup_access_code_pool'],
11883
+ type: 'string',
12008
11884
  },
12009
- {
12010
- description: 'The backup access code pool is empty.',
12011
- properties: {
12012
- error_code: {
12013
- description:
12014
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12015
- enum: ['empty_backup_access_code_pool'],
12016
- type: 'string',
12017
- },
12018
- is_device_error: { enum: [true], type: 'boolean' },
12019
- message: { type: 'string' },
12020
- },
12021
- required: ['message', 'is_device_error', 'error_code'],
12022
- type: 'object',
11885
+ is_device_error: { enum: [true], type: 'boolean' },
11886
+ message: { type: 'string' },
11887
+ },
11888
+ required: ['message', 'is_device_error', 'error_code'],
11889
+ type: 'object',
11890
+ },
11891
+ {
11892
+ description: 'User is not authorized to use the August Lock.',
11893
+ properties: {
11894
+ error_code: {
11895
+ description:
11896
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11897
+ enum: ['august_lock_not_authorized'],
11898
+ type: 'string',
12023
11899
  },
12024
- {
11900
+ is_device_error: { enum: [true], type: 'boolean' },
11901
+ message: { type: 'string' },
11902
+ },
11903
+ required: ['message', 'is_device_error', 'error_code'],
11904
+ type: 'object',
11905
+ },
11906
+ {
11907
+ description: 'Lock is not connected to the Seam Bridge.',
11908
+ properties: {
11909
+ error_code: {
12025
11910
  description:
12026
- 'User is not authorized to use the August Lock.',
12027
- properties: {
12028
- error_code: {
12029
- description:
12030
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12031
- enum: ['august_lock_not_authorized'],
12032
- type: 'string',
12033
- },
12034
- is_device_error: { enum: [true], type: 'boolean' },
12035
- message: { type: 'string' },
12036
- },
12037
- required: ['message', 'is_device_error', 'error_code'],
12038
- type: 'object',
11911
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11912
+ enum: ['august_lock_missing_bridge'],
11913
+ type: 'string',
12039
11914
  },
12040
- {
12041
- description: 'Lock is not connected to the Seam Bridge.',
12042
- properties: {
12043
- error_code: {
12044
- description:
12045
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12046
- enum: ['august_lock_missing_bridge'],
12047
- type: 'string',
12048
- },
12049
- is_device_error: { enum: [true], type: 'boolean' },
12050
- message: { type: 'string' },
12051
- },
12052
- required: ['message', 'is_device_error', 'error_code'],
12053
- type: 'object',
11915
+ is_device_error: { enum: [true], type: 'boolean' },
11916
+ message: { type: 'string' },
11917
+ },
11918
+ required: ['message', 'is_device_error', 'error_code'],
11919
+ type: 'object',
11920
+ },
11921
+ {
11922
+ description: 'Salto site user limit reached.',
11923
+ properties: {
11924
+ error_code: {
11925
+ description:
11926
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11927
+ enum: ['salto_site_user_limit_reached'],
11928
+ type: 'string',
12054
11929
  },
12055
- {
12056
- description: 'Salto site user limit reached.',
12057
- properties: {
12058
- error_code: {
12059
- description:
12060
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12061
- enum: ['salto_site_user_limit_reached'],
12062
- type: 'string',
12063
- },
12064
- is_device_error: { enum: [true], type: 'boolean' },
12065
- message: { type: 'string' },
12066
- },
12067
- required: ['message', 'is_device_error', 'error_code'],
12068
- type: 'object',
11930
+ is_device_error: { enum: [true], type: 'boolean' },
11931
+ message: { type: 'string' },
11932
+ },
11933
+ required: ['message', 'is_device_error', 'error_code'],
11934
+ type: 'object',
11935
+ },
11936
+ {
11937
+ description: 'Lock is not paired with a Gateway.',
11938
+ properties: {
11939
+ error_code: {
11940
+ description:
11941
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11942
+ enum: ['ttlock_lock_not_paired_to_gateway'],
11943
+ type: 'string',
12069
11944
  },
12070
- {
12071
- description: 'Lock is not paired with a Gateway.',
12072
- properties: {
12073
- error_code: {
12074
- description:
12075
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12076
- enum: ['ttlock_lock_not_paired_to_gateway'],
12077
- type: 'string',
12078
- },
12079
- is_device_error: { enum: [true], type: 'boolean' },
12080
- message: { type: 'string' },
12081
- },
12082
- required: ['message', 'is_device_error', 'error_code'],
12083
- type: 'object',
11945
+ is_device_error: { enum: [true], type: 'boolean' },
11946
+ message: { type: 'string' },
11947
+ },
11948
+ required: ['message', 'is_device_error', 'error_code'],
11949
+ type: 'object',
11950
+ },
11951
+ {
11952
+ description: 'Missing device credentials.',
11953
+ properties: {
11954
+ error_code: {
11955
+ description:
11956
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11957
+ enum: ['missing_device_credentials'],
11958
+ type: 'string',
12084
11959
  },
12085
- {
12086
- description: 'Missing device credentials.',
12087
- properties: {
12088
- error_code: {
12089
- description:
12090
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12091
- enum: ['missing_device_credentials'],
12092
- type: 'string',
12093
- },
12094
- is_device_error: { enum: [true], type: 'boolean' },
12095
- message: { type: 'string' },
12096
- },
12097
- required: ['message', 'is_device_error', 'error_code'],
12098
- type: 'object',
11960
+ is_device_error: { enum: [true], type: 'boolean' },
11961
+ message: { type: 'string' },
11962
+ },
11963
+ required: ['message', 'is_device_error', 'error_code'],
11964
+ type: 'object',
11965
+ },
11966
+ {
11967
+ description: 'The auxiliary heat is running.',
11968
+ properties: {
11969
+ error_code: {
11970
+ description:
11971
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11972
+ enum: ['auxiliary_heat_running'],
11973
+ type: 'string',
12099
11974
  },
12100
- {
12101
- description: 'The auxiliary heat is running.',
12102
- properties: {
12103
- error_code: {
12104
- description:
12105
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12106
- enum: ['auxiliary_heat_running'],
12107
- type: 'string',
12108
- },
12109
- is_device_error: { enum: [true], type: 'boolean' },
12110
- message: { type: 'string' },
12111
- },
12112
- required: ['message', 'is_device_error', 'error_code'],
12113
- type: 'object',
11975
+ is_device_error: { enum: [true], type: 'boolean' },
11976
+ message: { type: 'string' },
11977
+ },
11978
+ required: ['message', 'is_device_error', 'error_code'],
11979
+ type: 'object',
11980
+ },
11981
+ {
11982
+ description: 'Subscription required to connect.',
11983
+ properties: {
11984
+ error_code: {
11985
+ description:
11986
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
11987
+ enum: ['subscription_required'],
11988
+ type: 'string',
12114
11989
  },
12115
- {
12116
- description: 'Subscription required to connect.',
12117
- properties: {
12118
- error_code: {
12119
- description:
12120
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12121
- enum: ['subscription_required'],
12122
- type: 'string',
12123
- },
12124
- is_device_error: { enum: [true], type: 'boolean' },
12125
- message: { type: 'string' },
12126
- },
12127
- required: ['message', 'is_device_error', 'error_code'],
12128
- type: 'object',
11990
+ is_device_error: { enum: [true], type: 'boolean' },
11991
+ message: { type: 'string' },
11992
+ },
11993
+ required: ['message', 'is_device_error', 'error_code'],
11994
+ type: 'object',
11995
+ },
11996
+ {
11997
+ description: 'Account is disconnected.',
11998
+ properties: {
11999
+ error_code: {
12000
+ description:
12001
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12002
+ enum: ['account_disconnected'],
12003
+ type: 'string',
12004
+ },
12005
+ is_connected_account_error: {
12006
+ enum: [true],
12007
+ type: 'boolean',
12129
12008
  },
12009
+ message: { type: 'string' },
12010
+ },
12011
+ required: [
12012
+ 'message',
12013
+ 'is_connected_account_error',
12014
+ 'error_code',
12130
12015
  ],
12016
+ type: 'object',
12131
12017
  },
12132
12018
  {
12133
- oneOf: [
12134
- {
12135
- description: 'Account is disconnected.',
12136
- properties: {
12137
- error_code: {
12138
- description:
12139
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12140
- enum: ['account_disconnected'],
12141
- type: 'string',
12142
- },
12143
- is_connected_account_error: {
12144
- enum: [true],
12145
- type: 'boolean',
12146
- },
12147
- message: { type: 'string' },
12148
- },
12149
- required: [
12150
- 'message',
12151
- 'is_connected_account_error',
12152
- 'error_code',
12153
- ],
12154
- type: 'object',
12019
+ description: 'Credentials provided were invalid.',
12020
+ properties: {
12021
+ error_code: {
12022
+ description:
12023
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12024
+ enum: ['invalid_credentials'],
12025
+ type: 'string',
12155
12026
  },
12156
- {
12157
- description: 'Credentials provided were invalid.',
12158
- properties: {
12159
- error_code: {
12160
- description:
12161
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
12162
- enum: ['invalid_credentials'],
12163
- type: 'string',
12164
- },
12165
- is_connected_account_error: {
12166
- enum: [true],
12167
- type: 'boolean',
12168
- },
12169
- message: { type: 'string' },
12170
- },
12171
- required: [
12172
- 'message',
12173
- 'is_connected_account_error',
12174
- 'error_code',
12175
- ],
12176
- type: 'object',
12027
+ is_connected_account_error: {
12028
+ enum: [true],
12029
+ type: 'boolean',
12177
12030
  },
12031
+ message: { type: 'string' },
12032
+ },
12033
+ required: [
12034
+ 'message',
12035
+ 'is_connected_account_error',
12036
+ 'error_code',
12178
12037
  ],
12038
+ type: 'object',
12179
12039
  },
12180
12040
  ],
12181
12041
  },
@@ -12238,6 +12098,7 @@ export default {
12238
12098
  description:
12239
12099
  'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
12240
12100
  items: {
12101
+ discriminator: { propertyName: 'warning_code' },
12241
12102
  oneOf: [
12242
12103
  {
12243
12104
  description: 'Backup access code unhealthy.',
@@ -12622,632 +12483,527 @@ export default {
12622
12483
  description:
12623
12484
  'Collection of errors associated with the access code, structured in a dictionary format. A unique "error_code" keys each error. Each error entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the error. "created_at" is a date that indicates when the error was generated. This structure enables detailed tracking and timely response to critical issues.',
12624
12485
  items: {
12486
+ discriminator: { propertyName: 'error_code' },
12625
12487
  oneOf: [
12626
12488
  {
12627
- oneOf: [
12628
- {
12629
- description: 'Failed to set code on Smart Things device.',
12630
- properties: {
12631
- error_code: {
12632
- description:
12633
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12634
- enum: ['smartthings_failed_to_set_access_code'],
12635
- type: 'string',
12636
- },
12637
- is_access_code_error: { enum: [true], type: 'boolean' },
12638
- message: { type: 'string' },
12639
- },
12640
- required: [
12641
- 'message',
12642
- 'is_access_code_error',
12643
- 'error_code',
12644
- ],
12645
- type: 'object',
12489
+ description: 'Failed to set code on Smart Things device.',
12490
+ properties: {
12491
+ error_code: {
12492
+ description:
12493
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12494
+ enum: ['smartthings_failed_to_set_access_code'],
12495
+ type: 'string',
12646
12496
  },
12647
- {
12648
- description: 'Failed to set code after multiple retries.',
12649
- properties: {
12650
- error_code: {
12651
- description:
12652
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12653
- enum: [
12654
- 'smartthings_failed_to_set_after_multiple_retries',
12655
- ],
12656
- type: 'string',
12657
- },
12658
- is_access_code_error: { enum: [true], type: 'boolean' },
12659
- message: { type: 'string' },
12660
- },
12661
- required: [
12662
- 'message',
12663
- 'is_access_code_error',
12664
- 'error_code',
12497
+ is_access_code_error: { enum: [true], type: 'boolean' },
12498
+ message: { type: 'string' },
12499
+ },
12500
+ required: ['message', 'is_access_code_error', 'error_code'],
12501
+ type: 'object',
12502
+ },
12503
+ {
12504
+ description: 'Failed to set code after multiple retries.',
12505
+ properties: {
12506
+ error_code: {
12507
+ description:
12508
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12509
+ enum: [
12510
+ 'smartthings_failed_to_set_after_multiple_retries',
12665
12511
  ],
12666
- type: 'object',
12512
+ type: 'string',
12667
12513
  },
12668
- {
12669
- description: 'Failed to set code on device.',
12670
- properties: {
12671
- error_code: {
12672
- description:
12673
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12674
- enum: ['failed_to_set_on_device'],
12675
- type: 'string',
12676
- },
12677
- is_access_code_error: { enum: [true], type: 'boolean' },
12678
- message: { type: 'string' },
12679
- },
12680
- required: [
12681
- 'message',
12682
- 'is_access_code_error',
12683
- 'error_code',
12684
- ],
12685
- type: 'object',
12514
+ is_access_code_error: { enum: [true], type: 'boolean' },
12515
+ message: { type: 'string' },
12516
+ },
12517
+ required: ['message', 'is_access_code_error', 'error_code'],
12518
+ type: 'object',
12519
+ },
12520
+ {
12521
+ description: 'Failed to set code on device.',
12522
+ properties: {
12523
+ error_code: {
12524
+ description:
12525
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12526
+ enum: ['failed_to_set_on_device'],
12527
+ type: 'string',
12686
12528
  },
12687
- {
12688
- description: 'Failed to remove code from device.',
12689
- properties: {
12690
- error_code: {
12691
- description:
12692
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12693
- enum: ['failed_to_remove_from_device'],
12694
- type: 'string',
12695
- },
12696
- is_access_code_error: { enum: [true], type: 'boolean' },
12697
- message: { type: 'string' },
12698
- },
12699
- required: [
12700
- 'message',
12701
- 'is_access_code_error',
12702
- 'error_code',
12703
- ],
12704
- type: 'object',
12529
+ is_access_code_error: { enum: [true], type: 'boolean' },
12530
+ message: { type: 'string' },
12531
+ },
12532
+ required: ['message', 'is_access_code_error', 'error_code'],
12533
+ type: 'object',
12534
+ },
12535
+ {
12536
+ description: 'Failed to remove code from device.',
12537
+ properties: {
12538
+ error_code: {
12539
+ description:
12540
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12541
+ enum: ['failed_to_remove_from_device'],
12542
+ type: 'string',
12705
12543
  },
12706
- {
12707
- description: 'Duplicate access code detected on device.',
12708
- properties: {
12709
- error_code: {
12710
- description:
12711
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12712
- enum: ['duplicate_code_on_device'],
12713
- type: 'string',
12714
- },
12715
- is_access_code_error: { enum: [true], type: 'boolean' },
12716
- message: { type: 'string' },
12717
- },
12718
- required: [
12719
- 'message',
12720
- 'is_access_code_error',
12721
- 'error_code',
12722
- ],
12723
- type: 'object',
12544
+ is_access_code_error: { enum: [true], type: 'boolean' },
12545
+ message: { type: 'string' },
12546
+ },
12547
+ required: ['message', 'is_access_code_error', 'error_code'],
12548
+ type: 'object',
12549
+ },
12550
+ {
12551
+ description: 'Duplicate access code detected on device.',
12552
+ properties: {
12553
+ error_code: {
12554
+ description:
12555
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12556
+ enum: ['duplicate_code_on_device'],
12557
+ type: 'string',
12724
12558
  },
12725
- {
12559
+ is_access_code_error: { enum: [true], type: 'boolean' },
12560
+ message: { type: 'string' },
12561
+ },
12562
+ required: ['message', 'is_access_code_error', 'error_code'],
12563
+ type: 'object',
12564
+ },
12565
+ {
12566
+ description:
12567
+ 'An attempt to modify this access code was prevented.',
12568
+ properties: {
12569
+ error_code: {
12726
12570
  description:
12727
- 'An attempt to modify this access code was prevented.',
12728
- properties: {
12729
- error_code: {
12730
- description:
12731
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12732
- enum: ['duplicate_code_attempt_prevented'],
12733
- type: 'string',
12734
- },
12735
- is_access_code_error: { enum: [true], type: 'boolean' },
12736
- message: { type: 'string' },
12737
- },
12738
- required: [
12739
- 'message',
12740
- 'is_access_code_error',
12741
- 'error_code',
12742
- ],
12743
- type: 'object',
12571
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12572
+ enum: ['duplicate_code_attempt_prevented'],
12573
+ type: 'string',
12744
12574
  },
12745
- {
12575
+ is_access_code_error: { enum: [true], type: 'boolean' },
12576
+ message: { type: 'string' },
12577
+ },
12578
+ required: ['message', 'is_access_code_error', 'error_code'],
12579
+ type: 'object',
12580
+ },
12581
+ {
12582
+ description:
12583
+ 'Igloohome bridge has too many pending jobs in the queue.',
12584
+ properties: {
12585
+ error_code: {
12746
12586
  description:
12747
- 'Igloohome bridge has too many pending jobs in the queue.',
12748
- properties: {
12749
- error_code: {
12750
- description:
12751
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12752
- enum: ['igloohome_bridge_too_many_pending_jobs'],
12753
- type: 'string',
12754
- },
12755
- is_access_code_error: { enum: [true], type: 'boolean' },
12756
- message: { type: 'string' },
12757
- },
12758
- required: [
12759
- 'message',
12760
- 'is_access_code_error',
12761
- 'error_code',
12762
- ],
12763
- type: 'object',
12587
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12588
+ enum: ['igloohome_bridge_too_many_pending_jobs'],
12589
+ type: 'string',
12764
12590
  },
12765
- {
12766
- description: 'Igloohome bridge is offline.',
12767
- properties: {
12768
- error_code: {
12769
- description:
12770
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12771
- enum: ['igloohome_bridge_offline'],
12772
- type: 'string',
12773
- },
12774
- is_access_code_error: { enum: [true], type: 'boolean' },
12775
- message: { type: 'string' },
12776
- },
12777
- required: [
12778
- 'message',
12779
- 'is_access_code_error',
12780
- 'error_code',
12781
- ],
12782
- type: 'object',
12591
+ is_access_code_error: { enum: [true], type: 'boolean' },
12592
+ message: { type: 'string' },
12593
+ },
12594
+ required: ['message', 'is_access_code_error', 'error_code'],
12595
+ type: 'object',
12596
+ },
12597
+ {
12598
+ description: 'Igloohome bridge is offline.',
12599
+ properties: {
12600
+ error_code: {
12601
+ description:
12602
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12603
+ enum: ['igloohome_bridge_offline'],
12604
+ type: 'string',
12783
12605
  },
12784
- {
12785
- description: 'Lock as reached max amount of codes.',
12786
- properties: {
12787
- error_code: {
12788
- description:
12789
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12790
- enum: [
12791
- 'igloohome_offline_access_code_no_variance_available',
12792
- ],
12793
- type: 'string',
12794
- },
12795
- is_access_code_error: { enum: [true], type: 'boolean' },
12796
- message: { type: 'string' },
12797
- },
12798
- required: [
12799
- 'message',
12800
- 'is_access_code_error',
12801
- 'error_code',
12606
+ is_access_code_error: { enum: [true], type: 'boolean' },
12607
+ message: { type: 'string' },
12608
+ },
12609
+ required: ['message', 'is_access_code_error', 'error_code'],
12610
+ type: 'object',
12611
+ },
12612
+ {
12613
+ description: 'Lock as reached max amount of codes.',
12614
+ properties: {
12615
+ error_code: {
12616
+ description:
12617
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12618
+ enum: [
12619
+ 'igloohome_offline_access_code_no_variance_available',
12802
12620
  ],
12803
- type: 'object',
12621
+ type: 'string',
12804
12622
  },
12805
- {
12623
+ is_access_code_error: { enum: [true], type: 'boolean' },
12624
+ message: { type: 'string' },
12625
+ },
12626
+ required: ['message', 'is_access_code_error', 'error_code'],
12627
+ type: 'object',
12628
+ },
12629
+ {
12630
+ description:
12631
+ 'Unable to confirm the access code is set on Kwikset device.',
12632
+ properties: {
12633
+ error_code: {
12806
12634
  description:
12807
- 'Unable to confirm the access code is set on Kwikset device.',
12808
- properties: {
12809
- error_code: {
12810
- description:
12811
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12812
- enum: ['kwikset_unable_to_confirm_code'],
12813
- type: 'string',
12814
- },
12815
- is_access_code_error: { enum: [true], type: 'boolean' },
12816
- message: { type: 'string' },
12817
- },
12818
- required: [
12819
- 'message',
12820
- 'is_access_code_error',
12821
- 'error_code',
12822
- ],
12823
- type: 'object',
12635
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12636
+ enum: ['kwikset_unable_to_confirm_code'],
12637
+ type: 'string',
12824
12638
  },
12825
- {
12639
+ is_access_code_error: { enum: [true], type: 'boolean' },
12640
+ message: { type: 'string' },
12641
+ },
12642
+ required: ['message', 'is_access_code_error', 'error_code'],
12643
+ type: 'object',
12644
+ },
12645
+ {
12646
+ description:
12647
+ 'Unable to confirm the deletion of the access code on Kwikset device.',
12648
+ properties: {
12649
+ error_code: {
12826
12650
  description:
12827
- 'Unable to confirm the deletion of the access code on Kwikset device.',
12828
- properties: {
12829
- error_code: {
12830
- description:
12831
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12832
- enum: ['kwikset_unable_to_confirm_deletion'],
12833
- type: 'string',
12834
- },
12835
- is_access_code_error: { enum: [true], type: 'boolean' },
12836
- message: { type: 'string' },
12837
- },
12838
- required: [
12839
- 'message',
12840
- 'is_access_code_error',
12841
- 'error_code',
12842
- ],
12843
- type: 'object',
12651
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12652
+ enum: ['kwikset_unable_to_confirm_deletion'],
12653
+ type: 'string',
12844
12654
  },
12845
- {
12655
+ is_access_code_error: { enum: [true], type: 'boolean' },
12656
+ message: { type: 'string' },
12657
+ },
12658
+ required: ['message', 'is_access_code_error', 'error_code'],
12659
+ type: 'object',
12660
+ },
12661
+ {
12662
+ description:
12663
+ 'Code was modified or removed externally after Seam successfully set it on the device.',
12664
+ properties: {
12665
+ error_code: {
12846
12666
  description:
12847
- 'Code was modified or removed externally after Seam successfully set it on the device.',
12848
- properties: {
12849
- error_code: {
12850
- description:
12851
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12852
- enum: ['code_modified_external_to_seam'],
12853
- type: 'string',
12854
- },
12855
- is_access_code_error: { enum: [true], type: 'boolean' },
12856
- message: { type: 'string' },
12857
- },
12858
- required: [
12859
- 'message',
12860
- 'is_access_code_error',
12861
- 'error_code',
12862
- ],
12863
- type: 'object',
12667
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12668
+ enum: ['code_modified_external_to_seam'],
12669
+ type: 'string',
12864
12670
  },
12865
- {
12866
- description: 'Invalid code length for August lock.',
12867
- properties: {
12868
- error_code: {
12869
- description:
12870
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12871
- enum: ['august_lock_invalid_code_length'],
12872
- type: 'string',
12873
- },
12874
- is_access_code_error: { enum: [true], type: 'boolean' },
12875
- message: { type: 'string' },
12876
- },
12877
- required: [
12878
- 'message',
12879
- 'is_access_code_error',
12880
- 'error_code',
12881
- ],
12882
- type: 'object',
12671
+ is_access_code_error: { enum: [true], type: 'boolean' },
12672
+ message: { type: 'string' },
12673
+ },
12674
+ required: ['message', 'is_access_code_error', 'error_code'],
12675
+ type: 'object',
12676
+ },
12677
+ {
12678
+ description: 'Invalid code length for August lock.',
12679
+ properties: {
12680
+ error_code: {
12681
+ description:
12682
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12683
+ enum: ['august_lock_invalid_code_length'],
12684
+ type: 'string',
12883
12685
  },
12884
- {
12686
+ is_access_code_error: { enum: [true], type: 'boolean' },
12687
+ message: { type: 'string' },
12688
+ },
12689
+ required: ['message', 'is_access_code_error', 'error_code'],
12690
+ type: 'object',
12691
+ },
12692
+ {
12693
+ description:
12694
+ 'Access code has not yet been fully moved to the device.',
12695
+ properties: {
12696
+ error_code: {
12885
12697
  description:
12886
- 'Access code has not yet been fully moved to the device.',
12887
- properties: {
12888
- error_code: {
12889
- description:
12890
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12891
- enum: ['august_device_programming_delay'],
12892
- type: 'string',
12893
- },
12894
- is_access_code_error: { enum: [true], type: 'boolean' },
12895
- message: { type: 'string' },
12896
- },
12897
- required: [
12898
- 'message',
12899
- 'is_access_code_error',
12900
- 'error_code',
12901
- ],
12902
- type: 'object',
12698
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12699
+ enum: ['august_device_programming_delay'],
12700
+ type: 'string',
12903
12701
  },
12904
- {
12702
+ is_access_code_error: { enum: [true], type: 'boolean' },
12703
+ message: { type: 'string' },
12704
+ },
12705
+ required: ['message', 'is_access_code_error', 'error_code'],
12706
+ type: 'object',
12707
+ },
12708
+ {
12709
+ description: 'All access code slots on the device are full.',
12710
+ properties: {
12711
+ error_code: {
12905
12712
  description:
12906
- 'All access code slots on the device are full.',
12907
- properties: {
12908
- error_code: {
12909
- description:
12910
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12911
- enum: ['august_device_slots_full'],
12912
- type: 'string',
12913
- },
12914
- is_access_code_error: { enum: [true], type: 'boolean' },
12915
- message: { type: 'string' },
12916
- },
12917
- required: [
12918
- 'message',
12919
- 'is_access_code_error',
12920
- 'error_code',
12921
- ],
12922
- type: 'object',
12713
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12714
+ enum: ['august_device_slots_full'],
12715
+ type: 'string',
12923
12716
  },
12924
- {
12925
- description: 'August lock is missing a keypad.',
12926
- properties: {
12927
- error_code: {
12928
- description:
12929
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12930
- enum: ['august_lock_missing_keypad'],
12931
- type: 'string',
12932
- },
12933
- is_access_code_error: { enum: [true], type: 'boolean' },
12934
- message: { type: 'string' },
12935
- },
12936
- required: [
12937
- 'message',
12938
- 'is_access_code_error',
12939
- 'error_code',
12940
- ],
12941
- type: 'object',
12717
+ is_access_code_error: { enum: [true], type: 'boolean' },
12718
+ message: { type: 'string' },
12719
+ },
12720
+ required: ['message', 'is_access_code_error', 'error_code'],
12721
+ type: 'object',
12722
+ },
12723
+ {
12724
+ description: 'August lock is missing a keypad.',
12725
+ properties: {
12726
+ error_code: {
12727
+ description:
12728
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12729
+ enum: ['august_lock_missing_keypad'],
12730
+ type: 'string',
12942
12731
  },
12943
- {
12944
- description: 'Salto site user is not subscribed.',
12945
- properties: {
12946
- error_code: {
12947
- description:
12948
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12949
- enum: ['salto_site_user_not_subscribed'],
12950
- type: 'string',
12951
- },
12952
- is_access_code_error: { enum: [true], type: 'boolean' },
12953
- message: { type: 'string' },
12954
- },
12955
- required: [
12956
- 'message',
12957
- 'is_access_code_error',
12958
- 'error_code',
12959
- ],
12960
- type: 'object',
12732
+ is_access_code_error: { enum: [true], type: 'boolean' },
12733
+ message: { type: 'string' },
12734
+ },
12735
+ required: ['message', 'is_access_code_error', 'error_code'],
12736
+ type: 'object',
12737
+ },
12738
+ {
12739
+ description: 'Salto site user is not subscribed.',
12740
+ properties: {
12741
+ error_code: {
12742
+ description:
12743
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12744
+ enum: ['salto_site_user_not_subscribed'],
12745
+ type: 'string',
12961
12746
  },
12962
- {
12747
+ is_access_code_error: { enum: [true], type: 'boolean' },
12748
+ message: { type: 'string' },
12749
+ },
12750
+ required: ['message', 'is_access_code_error', 'error_code'],
12751
+ type: 'object',
12752
+ },
12753
+ {
12754
+ description:
12755
+ 'Access code has not yet been fully moved to the device.',
12756
+ properties: {
12757
+ error_code: {
12963
12758
  description:
12964
- 'Access code has not yet been fully moved to the device.',
12965
- properties: {
12966
- error_code: {
12967
- description:
12968
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12969
- enum: ['hubitat_device_programming_delay'],
12970
- type: 'string',
12971
- },
12972
- is_access_code_error: { enum: [true], type: 'boolean' },
12973
- message: { type: 'string' },
12974
- },
12975
- required: [
12976
- 'message',
12977
- 'is_access_code_error',
12978
- 'error_code',
12979
- ],
12980
- type: 'object',
12759
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12760
+ enum: ['hubitat_device_programming_delay'],
12761
+ type: 'string',
12981
12762
  },
12982
- {
12983
- description: 'No free positions available on the device.',
12984
- properties: {
12985
- error_code: {
12986
- description:
12987
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12988
- enum: ['hubitat_no_free_positions_available'],
12989
- type: 'string',
12990
- },
12991
- is_access_code_error: { enum: [true], type: 'boolean' },
12992
- message: { type: 'string' },
12993
- },
12994
- required: [
12995
- 'message',
12996
- 'is_access_code_error',
12997
- 'error_code',
12998
- ],
12999
- type: 'object',
12763
+ is_access_code_error: { enum: [true], type: 'boolean' },
12764
+ message: { type: 'string' },
12765
+ },
12766
+ required: ['message', 'is_access_code_error', 'error_code'],
12767
+ type: 'object',
12768
+ },
12769
+ {
12770
+ description: 'No free positions available on the device.',
12771
+ properties: {
12772
+ error_code: {
12773
+ description:
12774
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12775
+ enum: ['hubitat_no_free_positions_available'],
12776
+ type: 'string',
13000
12777
  },
13001
- ],
12778
+ is_access_code_error: { enum: [true], type: 'boolean' },
12779
+ message: { type: 'string' },
12780
+ },
12781
+ required: ['message', 'is_access_code_error', 'error_code'],
12782
+ type: 'object',
13002
12783
  },
13003
12784
  {
13004
- description: 'Error associated with the `device`.',
13005
- oneOf: [
13006
- {
13007
- description: 'Device is offline',
13008
- properties: {
13009
- error_code: {
13010
- description:
13011
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13012
- enum: ['device_offline'],
13013
- type: 'string',
13014
- },
13015
- is_device_error: { enum: [true], type: 'boolean' },
13016
- message: { type: 'string' },
13017
- },
13018
- required: ['message', 'is_device_error', 'error_code'],
13019
- type: 'object',
12785
+ description: 'Device is offline',
12786
+ properties: {
12787
+ error_code: {
12788
+ description:
12789
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12790
+ enum: ['device_offline'],
12791
+ type: 'string',
13020
12792
  },
13021
- {
13022
- description: 'Device has been removed',
13023
- properties: {
13024
- error_code: {
13025
- description:
13026
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13027
- enum: ['device_removed'],
13028
- type: 'string',
13029
- },
13030
- is_device_error: { enum: [true], type: 'boolean' },
13031
- message: { type: 'string' },
13032
- },
13033
- required: ['message', 'is_device_error', 'error_code'],
13034
- type: 'object',
12793
+ is_device_error: { enum: [true], type: 'boolean' },
12794
+ message: { type: 'string' },
12795
+ },
12796
+ required: ['message', 'is_device_error', 'error_code'],
12797
+ type: 'object',
12798
+ },
12799
+ {
12800
+ description: 'Device has been removed',
12801
+ properties: {
12802
+ error_code: {
12803
+ description:
12804
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12805
+ enum: ['device_removed'],
12806
+ type: 'string',
13035
12807
  },
13036
- {
13037
- description: 'Account is disconnected',
13038
- properties: {
13039
- error_code: {
13040
- description:
13041
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13042
- enum: ['account_disconnected'],
13043
- type: 'string',
13044
- },
13045
- is_device_error: { enum: [true], type: 'boolean' },
13046
- message: { type: 'string' },
13047
- },
13048
- required: ['message', 'is_device_error', 'error_code'],
13049
- type: 'object',
12808
+ is_device_error: { enum: [true], type: 'boolean' },
12809
+ message: { type: 'string' },
12810
+ },
12811
+ required: ['message', 'is_device_error', 'error_code'],
12812
+ type: 'object',
12813
+ },
12814
+ {
12815
+ description: 'Hub is disconnected',
12816
+ properties: {
12817
+ error_code: {
12818
+ description:
12819
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12820
+ enum: ['hub_disconnected'],
12821
+ type: 'string',
12822
+ },
12823
+ is_device_error: { enum: [true], type: 'boolean' },
12824
+ message: { type: 'string' },
12825
+ },
12826
+ required: ['message', 'is_device_error', 'error_code'],
12827
+ type: 'object',
12828
+ },
12829
+ {
12830
+ description: 'Device is disconnected',
12831
+ properties: {
12832
+ error_code: {
12833
+ description:
12834
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12835
+ enum: ['device_disconnected'],
12836
+ type: 'string',
13050
12837
  },
13051
- {
13052
- description: 'Hub is disconnected',
13053
- properties: {
13054
- error_code: {
13055
- description:
13056
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13057
- enum: ['hub_disconnected'],
13058
- type: 'string',
13059
- },
13060
- is_device_error: { enum: [true], type: 'boolean' },
13061
- message: { type: 'string' },
13062
- },
13063
- required: ['message', 'is_device_error', 'error_code'],
13064
- type: 'object',
12838
+ is_device_error: { enum: [true], type: 'boolean' },
12839
+ message: { type: 'string' },
12840
+ },
12841
+ required: ['message', 'is_device_error', 'error_code'],
12842
+ type: 'object',
12843
+ },
12844
+ {
12845
+ description: 'The backup access code pool is empty.',
12846
+ properties: {
12847
+ error_code: {
12848
+ description:
12849
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12850
+ enum: ['empty_backup_access_code_pool'],
12851
+ type: 'string',
13065
12852
  },
13066
- {
13067
- description: 'Device is disconnected',
13068
- properties: {
13069
- error_code: {
13070
- description:
13071
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13072
- enum: ['device_disconnected'],
13073
- type: 'string',
13074
- },
13075
- is_device_error: { enum: [true], type: 'boolean' },
13076
- message: { type: 'string' },
13077
- },
13078
- required: ['message', 'is_device_error', 'error_code'],
13079
- type: 'object',
12853
+ is_device_error: { enum: [true], type: 'boolean' },
12854
+ message: { type: 'string' },
12855
+ },
12856
+ required: ['message', 'is_device_error', 'error_code'],
12857
+ type: 'object',
12858
+ },
12859
+ {
12860
+ description: 'User is not authorized to use the August Lock.',
12861
+ properties: {
12862
+ error_code: {
12863
+ description:
12864
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12865
+ enum: ['august_lock_not_authorized'],
12866
+ type: 'string',
13080
12867
  },
13081
- {
13082
- description: 'The backup access code pool is empty.',
13083
- properties: {
13084
- error_code: {
13085
- description:
13086
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13087
- enum: ['empty_backup_access_code_pool'],
13088
- type: 'string',
13089
- },
13090
- is_device_error: { enum: [true], type: 'boolean' },
13091
- message: { type: 'string' },
13092
- },
13093
- required: ['message', 'is_device_error', 'error_code'],
13094
- type: 'object',
12868
+ is_device_error: { enum: [true], type: 'boolean' },
12869
+ message: { type: 'string' },
12870
+ },
12871
+ required: ['message', 'is_device_error', 'error_code'],
12872
+ type: 'object',
12873
+ },
12874
+ {
12875
+ description: 'Lock is not connected to the Seam Bridge.',
12876
+ properties: {
12877
+ error_code: {
12878
+ description:
12879
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12880
+ enum: ['august_lock_missing_bridge'],
12881
+ type: 'string',
13095
12882
  },
13096
- {
12883
+ is_device_error: { enum: [true], type: 'boolean' },
12884
+ message: { type: 'string' },
12885
+ },
12886
+ required: ['message', 'is_device_error', 'error_code'],
12887
+ type: 'object',
12888
+ },
12889
+ {
12890
+ description: 'Salto site user limit reached.',
12891
+ properties: {
12892
+ error_code: {
13097
12893
  description:
13098
- 'User is not authorized to use the August Lock.',
13099
- properties: {
13100
- error_code: {
13101
- description:
13102
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13103
- enum: ['august_lock_not_authorized'],
13104
- type: 'string',
13105
- },
13106
- is_device_error: { enum: [true], type: 'boolean' },
13107
- message: { type: 'string' },
13108
- },
13109
- required: ['message', 'is_device_error', 'error_code'],
13110
- type: 'object',
12894
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12895
+ enum: ['salto_site_user_limit_reached'],
12896
+ type: 'string',
13111
12897
  },
13112
- {
13113
- description: 'Lock is not connected to the Seam Bridge.',
13114
- properties: {
13115
- error_code: {
13116
- description:
13117
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13118
- enum: ['august_lock_missing_bridge'],
13119
- type: 'string',
13120
- },
13121
- is_device_error: { enum: [true], type: 'boolean' },
13122
- message: { type: 'string' },
13123
- },
13124
- required: ['message', 'is_device_error', 'error_code'],
13125
- type: 'object',
12898
+ is_device_error: { enum: [true], type: 'boolean' },
12899
+ message: { type: 'string' },
12900
+ },
12901
+ required: ['message', 'is_device_error', 'error_code'],
12902
+ type: 'object',
12903
+ },
12904
+ {
12905
+ description: 'Lock is not paired with a Gateway.',
12906
+ properties: {
12907
+ error_code: {
12908
+ description:
12909
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12910
+ enum: ['ttlock_lock_not_paired_to_gateway'],
12911
+ type: 'string',
13126
12912
  },
13127
- {
13128
- description: 'Salto site user limit reached.',
13129
- properties: {
13130
- error_code: {
13131
- description:
13132
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13133
- enum: ['salto_site_user_limit_reached'],
13134
- type: 'string',
13135
- },
13136
- is_device_error: { enum: [true], type: 'boolean' },
13137
- message: { type: 'string' },
13138
- },
13139
- required: ['message', 'is_device_error', 'error_code'],
13140
- type: 'object',
12913
+ is_device_error: { enum: [true], type: 'boolean' },
12914
+ message: { type: 'string' },
12915
+ },
12916
+ required: ['message', 'is_device_error', 'error_code'],
12917
+ type: 'object',
12918
+ },
12919
+ {
12920
+ description: 'Missing device credentials.',
12921
+ properties: {
12922
+ error_code: {
12923
+ description:
12924
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12925
+ enum: ['missing_device_credentials'],
12926
+ type: 'string',
13141
12927
  },
13142
- {
13143
- description: 'Lock is not paired with a Gateway.',
13144
- properties: {
13145
- error_code: {
13146
- description:
13147
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13148
- enum: ['ttlock_lock_not_paired_to_gateway'],
13149
- type: 'string',
13150
- },
13151
- is_device_error: { enum: [true], type: 'boolean' },
13152
- message: { type: 'string' },
13153
- },
13154
- required: ['message', 'is_device_error', 'error_code'],
13155
- type: 'object',
12928
+ is_device_error: { enum: [true], type: 'boolean' },
12929
+ message: { type: 'string' },
12930
+ },
12931
+ required: ['message', 'is_device_error', 'error_code'],
12932
+ type: 'object',
12933
+ },
12934
+ {
12935
+ description: 'The auxiliary heat is running.',
12936
+ properties: {
12937
+ error_code: {
12938
+ description:
12939
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12940
+ enum: ['auxiliary_heat_running'],
12941
+ type: 'string',
13156
12942
  },
13157
- {
13158
- description: 'Missing device credentials.',
13159
- properties: {
13160
- error_code: {
13161
- description:
13162
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13163
- enum: ['missing_device_credentials'],
13164
- type: 'string',
13165
- },
13166
- is_device_error: { enum: [true], type: 'boolean' },
13167
- message: { type: 'string' },
13168
- },
13169
- required: ['message', 'is_device_error', 'error_code'],
13170
- type: 'object',
12943
+ is_device_error: { enum: [true], type: 'boolean' },
12944
+ message: { type: 'string' },
12945
+ },
12946
+ required: ['message', 'is_device_error', 'error_code'],
12947
+ type: 'object',
12948
+ },
12949
+ {
12950
+ description: 'Subscription required to connect.',
12951
+ properties: {
12952
+ error_code: {
12953
+ description:
12954
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12955
+ enum: ['subscription_required'],
12956
+ type: 'string',
13171
12957
  },
13172
- {
13173
- description: 'The auxiliary heat is running.',
13174
- properties: {
13175
- error_code: {
13176
- description:
13177
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13178
- enum: ['auxiliary_heat_running'],
13179
- type: 'string',
13180
- },
13181
- is_device_error: { enum: [true], type: 'boolean' },
13182
- message: { type: 'string' },
13183
- },
13184
- required: ['message', 'is_device_error', 'error_code'],
13185
- type: 'object',
12958
+ is_device_error: { enum: [true], type: 'boolean' },
12959
+ message: { type: 'string' },
12960
+ },
12961
+ required: ['message', 'is_device_error', 'error_code'],
12962
+ type: 'object',
12963
+ },
12964
+ {
12965
+ description: 'Account is disconnected.',
12966
+ properties: {
12967
+ error_code: {
12968
+ description:
12969
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12970
+ enum: ['account_disconnected'],
12971
+ type: 'string',
13186
12972
  },
13187
- {
13188
- description: 'Subscription required to connect.',
13189
- properties: {
13190
- error_code: {
13191
- description:
13192
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
13193
- enum: ['subscription_required'],
13194
- type: 'string',
13195
- },
13196
- is_device_error: { enum: [true], type: 'boolean' },
13197
- message: { type: 'string' },
13198
- },
13199
- required: ['message', 'is_device_error', 'error_code'],
13200
- type: 'object',
12973
+ is_connected_account_error: {
12974
+ enum: [true],
12975
+ type: 'boolean',
13201
12976
  },
12977
+ message: { type: 'string' },
12978
+ },
12979
+ required: [
12980
+ 'message',
12981
+ 'is_connected_account_error',
12982
+ 'error_code',
13202
12983
  ],
12984
+ type: 'object',
13203
12985
  },
13204
12986
  {
13205
- oneOf: [
13206
- {
13207
- description: 'Account is disconnected.',
13208
- properties: {
13209
- error_code: {
13210
- description:
13211
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13212
- enum: ['account_disconnected'],
13213
- type: 'string',
13214
- },
13215
- is_connected_account_error: {
13216
- enum: [true],
13217
- type: 'boolean',
13218
- },
13219
- message: { type: 'string' },
13220
- },
13221
- required: [
13222
- 'message',
13223
- 'is_connected_account_error',
13224
- 'error_code',
13225
- ],
13226
- type: 'object',
12987
+ description: 'Credentials provided were invalid.',
12988
+ properties: {
12989
+ error_code: {
12990
+ description:
12991
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
12992
+ enum: ['invalid_credentials'],
12993
+ type: 'string',
13227
12994
  },
13228
- {
13229
- description: 'Credentials provided were invalid.',
13230
- properties: {
13231
- error_code: {
13232
- description:
13233
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
13234
- enum: ['invalid_credentials'],
13235
- type: 'string',
13236
- },
13237
- is_connected_account_error: {
13238
- enum: [true],
13239
- type: 'boolean',
13240
- },
13241
- message: { type: 'string' },
13242
- },
13243
- required: [
13244
- 'message',
13245
- 'is_connected_account_error',
13246
- 'error_code',
13247
- ],
13248
- type: 'object',
12995
+ is_connected_account_error: {
12996
+ enum: [true],
12997
+ type: 'boolean',
13249
12998
  },
12999
+ message: { type: 'string' },
13000
+ },
13001
+ required: [
13002
+ 'message',
13003
+ 'is_connected_account_error',
13004
+ 'error_code',
13250
13005
  ],
13006
+ type: 'object',
13251
13007
  },
13252
13008
  ],
13253
13009
  },
@@ -13278,6 +13034,7 @@ export default {
13278
13034
  description:
13279
13035
  'Collection of warnings associated with the access code, structured in a dictionary format. A unique "warning_code" keys each warning. Each warning entry is an object containing two fields: "message" and "created_at." "message" is a string that describes the warning. "created_at" is a date that indicates when the warning was generated. This structure enables detailed tracking and timely response to potential issues that are not critical but that may require attention.',
13280
13036
  items: {
13037
+ discriminator: { propertyName: 'warning_code' },
13281
13038
  oneOf: [
13282
13039
  {
13283
13040
  description: 'Failed to set code on Smart Things device.',
@@ -13711,6 +13468,7 @@ export default {
13711
13468
  description: 'Warnings associated with the `acs_credential`.',
13712
13469
  items: {
13713
13470
  description: 'Warning associated with the `acs_credential`.',
13471
+ discriminator: { propertyName: 'warning_code' },
13714
13472
  oneOf: [
13715
13473
  {
13716
13474
  description:
@@ -13947,6 +13705,7 @@ export default {
13947
13705
  description: 'Errors associated with the `acs_user`.',
13948
13706
  items: {
13949
13707
  description: 'Error associated with the `acs_user`.',
13708
+ discriminator: { propertyName: 'error_code' },
13950
13709
  oneOf: [
13951
13710
  {
13952
13711
  description:
@@ -14139,6 +13898,7 @@ export default {
14139
13898
  description: 'Warnings associated with the `acs_user`.',
14140
13899
  items: {
14141
13900
  description: 'Warning associated with the `acs_user`.',
13901
+ discriminator: { propertyName: 'warning_code' },
14142
13902
  oneOf: [
14143
13903
  {
14144
13904
  description:
@@ -14304,255 +14064,231 @@ export default {
14304
14064
  description:
14305
14065
  'Array of errors associated with the device. Each error object within the array contains two fields: "error_code" and "message." "error_code" is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.',
14306
14066
  items: {
14067
+ discriminator: { propertyName: 'error_code' },
14307
14068
  oneOf: [
14308
14069
  {
14309
- description: 'Error associated with the `device`.',
14310
- oneOf: [
14311
- {
14312
- description: 'Device is offline',
14313
- properties: {
14314
- error_code: {
14315
- description:
14316
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14317
- enum: ['device_offline'],
14318
- type: 'string',
14319
- },
14320
- is_device_error: { enum: [true], type: 'boolean' },
14321
- message: { type: 'string' },
14322
- },
14323
- required: ['message', 'is_device_error', 'error_code'],
14324
- type: 'object',
14070
+ description: 'Device is offline',
14071
+ properties: {
14072
+ error_code: {
14073
+ description:
14074
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14075
+ enum: ['device_offline'],
14076
+ type: 'string',
14325
14077
  },
14326
- {
14327
- description: 'Device has been removed',
14328
- properties: {
14329
- error_code: {
14330
- description:
14331
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14332
- enum: ['device_removed'],
14333
- type: 'string',
14334
- },
14335
- is_device_error: { enum: [true], type: 'boolean' },
14336
- message: { type: 'string' },
14337
- },
14338
- required: ['message', 'is_device_error', 'error_code'],
14339
- type: 'object',
14078
+ is_device_error: { enum: [true], type: 'boolean' },
14079
+ message: { type: 'string' },
14080
+ },
14081
+ required: ['message', 'is_device_error', 'error_code'],
14082
+ type: 'object',
14083
+ },
14084
+ {
14085
+ description: 'Device has been removed',
14086
+ properties: {
14087
+ error_code: {
14088
+ description:
14089
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14090
+ enum: ['device_removed'],
14091
+ type: 'string',
14340
14092
  },
14341
- {
14342
- description: 'Account is disconnected',
14343
- properties: {
14344
- error_code: {
14345
- description:
14346
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14347
- enum: ['account_disconnected'],
14348
- type: 'string',
14349
- },
14350
- is_device_error: { enum: [true], type: 'boolean' },
14351
- message: { type: 'string' },
14352
- },
14353
- required: ['message', 'is_device_error', 'error_code'],
14354
- type: 'object',
14093
+ is_device_error: { enum: [true], type: 'boolean' },
14094
+ message: { type: 'string' },
14095
+ },
14096
+ required: ['message', 'is_device_error', 'error_code'],
14097
+ type: 'object',
14098
+ },
14099
+ {
14100
+ description: 'Hub is disconnected',
14101
+ properties: {
14102
+ error_code: {
14103
+ description:
14104
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14105
+ enum: ['hub_disconnected'],
14106
+ type: 'string',
14107
+ },
14108
+ is_device_error: { enum: [true], type: 'boolean' },
14109
+ message: { type: 'string' },
14110
+ },
14111
+ required: ['message', 'is_device_error', 'error_code'],
14112
+ type: 'object',
14113
+ },
14114
+ {
14115
+ description: 'Device is disconnected',
14116
+ properties: {
14117
+ error_code: {
14118
+ description:
14119
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14120
+ enum: ['device_disconnected'],
14121
+ type: 'string',
14355
14122
  },
14356
- {
14357
- description: 'Hub is disconnected',
14358
- properties: {
14359
- error_code: {
14360
- description:
14361
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14362
- enum: ['hub_disconnected'],
14363
- type: 'string',
14364
- },
14365
- is_device_error: { enum: [true], type: 'boolean' },
14366
- message: { type: 'string' },
14367
- },
14368
- required: ['message', 'is_device_error', 'error_code'],
14369
- type: 'object',
14123
+ is_device_error: { enum: [true], type: 'boolean' },
14124
+ message: { type: 'string' },
14125
+ },
14126
+ required: ['message', 'is_device_error', 'error_code'],
14127
+ type: 'object',
14128
+ },
14129
+ {
14130
+ description: 'The backup access code pool is empty.',
14131
+ properties: {
14132
+ error_code: {
14133
+ description:
14134
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14135
+ enum: ['empty_backup_access_code_pool'],
14136
+ type: 'string',
14370
14137
  },
14371
- {
14372
- description: 'Device is disconnected',
14373
- properties: {
14374
- error_code: {
14375
- description:
14376
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14377
- enum: ['device_disconnected'],
14378
- type: 'string',
14379
- },
14380
- is_device_error: { enum: [true], type: 'boolean' },
14381
- message: { type: 'string' },
14382
- },
14383
- required: ['message', 'is_device_error', 'error_code'],
14384
- type: 'object',
14138
+ is_device_error: { enum: [true], type: 'boolean' },
14139
+ message: { type: 'string' },
14140
+ },
14141
+ required: ['message', 'is_device_error', 'error_code'],
14142
+ type: 'object',
14143
+ },
14144
+ {
14145
+ description: 'User is not authorized to use the August Lock.',
14146
+ properties: {
14147
+ error_code: {
14148
+ description:
14149
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14150
+ enum: ['august_lock_not_authorized'],
14151
+ type: 'string',
14385
14152
  },
14386
- {
14387
- description: 'The backup access code pool is empty.',
14388
- properties: {
14389
- error_code: {
14390
- description:
14391
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14392
- enum: ['empty_backup_access_code_pool'],
14393
- type: 'string',
14394
- },
14395
- is_device_error: { enum: [true], type: 'boolean' },
14396
- message: { type: 'string' },
14397
- },
14398
- required: ['message', 'is_device_error', 'error_code'],
14399
- type: 'object',
14153
+ is_device_error: { enum: [true], type: 'boolean' },
14154
+ message: { type: 'string' },
14155
+ },
14156
+ required: ['message', 'is_device_error', 'error_code'],
14157
+ type: 'object',
14158
+ },
14159
+ {
14160
+ description: 'Lock is not connected to the Seam Bridge.',
14161
+ properties: {
14162
+ error_code: {
14163
+ description:
14164
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14165
+ enum: ['august_lock_missing_bridge'],
14166
+ type: 'string',
14400
14167
  },
14401
- {
14168
+ is_device_error: { enum: [true], type: 'boolean' },
14169
+ message: { type: 'string' },
14170
+ },
14171
+ required: ['message', 'is_device_error', 'error_code'],
14172
+ type: 'object',
14173
+ },
14174
+ {
14175
+ description: 'Salto site user limit reached.',
14176
+ properties: {
14177
+ error_code: {
14402
14178
  description:
14403
- 'User is not authorized to use the August Lock.',
14404
- properties: {
14405
- error_code: {
14406
- description:
14407
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14408
- enum: ['august_lock_not_authorized'],
14409
- type: 'string',
14410
- },
14411
- is_device_error: { enum: [true], type: 'boolean' },
14412
- message: { type: 'string' },
14413
- },
14414
- required: ['message', 'is_device_error', 'error_code'],
14415
- type: 'object',
14179
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14180
+ enum: ['salto_site_user_limit_reached'],
14181
+ type: 'string',
14416
14182
  },
14417
- {
14418
- description: 'Lock is not connected to the Seam Bridge.',
14419
- properties: {
14420
- error_code: {
14421
- description:
14422
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14423
- enum: ['august_lock_missing_bridge'],
14424
- type: 'string',
14425
- },
14426
- is_device_error: { enum: [true], type: 'boolean' },
14427
- message: { type: 'string' },
14428
- },
14429
- required: ['message', 'is_device_error', 'error_code'],
14430
- type: 'object',
14183
+ is_device_error: { enum: [true], type: 'boolean' },
14184
+ message: { type: 'string' },
14185
+ },
14186
+ required: ['message', 'is_device_error', 'error_code'],
14187
+ type: 'object',
14188
+ },
14189
+ {
14190
+ description: 'Lock is not paired with a Gateway.',
14191
+ properties: {
14192
+ error_code: {
14193
+ description:
14194
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14195
+ enum: ['ttlock_lock_not_paired_to_gateway'],
14196
+ type: 'string',
14431
14197
  },
14432
- {
14433
- description: 'Salto site user limit reached.',
14434
- properties: {
14435
- error_code: {
14436
- description:
14437
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14438
- enum: ['salto_site_user_limit_reached'],
14439
- type: 'string',
14440
- },
14441
- is_device_error: { enum: [true], type: 'boolean' },
14442
- message: { type: 'string' },
14443
- },
14444
- required: ['message', 'is_device_error', 'error_code'],
14445
- type: 'object',
14198
+ is_device_error: { enum: [true], type: 'boolean' },
14199
+ message: { type: 'string' },
14200
+ },
14201
+ required: ['message', 'is_device_error', 'error_code'],
14202
+ type: 'object',
14203
+ },
14204
+ {
14205
+ description: 'Missing device credentials.',
14206
+ properties: {
14207
+ error_code: {
14208
+ description:
14209
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14210
+ enum: ['missing_device_credentials'],
14211
+ type: 'string',
14446
14212
  },
14447
- {
14448
- description: 'Lock is not paired with a Gateway.',
14449
- properties: {
14450
- error_code: {
14451
- description:
14452
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14453
- enum: ['ttlock_lock_not_paired_to_gateway'],
14454
- type: 'string',
14455
- },
14456
- is_device_error: { enum: [true], type: 'boolean' },
14457
- message: { type: 'string' },
14458
- },
14459
- required: ['message', 'is_device_error', 'error_code'],
14460
- type: 'object',
14213
+ is_device_error: { enum: [true], type: 'boolean' },
14214
+ message: { type: 'string' },
14215
+ },
14216
+ required: ['message', 'is_device_error', 'error_code'],
14217
+ type: 'object',
14218
+ },
14219
+ {
14220
+ description: 'The auxiliary heat is running.',
14221
+ properties: {
14222
+ error_code: {
14223
+ description:
14224
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14225
+ enum: ['auxiliary_heat_running'],
14226
+ type: 'string',
14461
14227
  },
14462
- {
14463
- description: 'Missing device credentials.',
14464
- properties: {
14465
- error_code: {
14466
- description:
14467
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14468
- enum: ['missing_device_credentials'],
14469
- type: 'string',
14470
- },
14471
- is_device_error: { enum: [true], type: 'boolean' },
14472
- message: { type: 'string' },
14473
- },
14474
- required: ['message', 'is_device_error', 'error_code'],
14475
- type: 'object',
14228
+ is_device_error: { enum: [true], type: 'boolean' },
14229
+ message: { type: 'string' },
14230
+ },
14231
+ required: ['message', 'is_device_error', 'error_code'],
14232
+ type: 'object',
14233
+ },
14234
+ {
14235
+ description: 'Subscription required to connect.',
14236
+ properties: {
14237
+ error_code: {
14238
+ description:
14239
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14240
+ enum: ['subscription_required'],
14241
+ type: 'string',
14476
14242
  },
14477
- {
14478
- description: 'The auxiliary heat is running.',
14479
- properties: {
14480
- error_code: {
14481
- description:
14482
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14483
- enum: ['auxiliary_heat_running'],
14484
- type: 'string',
14485
- },
14486
- is_device_error: { enum: [true], type: 'boolean' },
14487
- message: { type: 'string' },
14488
- },
14489
- required: ['message', 'is_device_error', 'error_code'],
14490
- type: 'object',
14243
+ is_device_error: { enum: [true], type: 'boolean' },
14244
+ message: { type: 'string' },
14245
+ },
14246
+ required: ['message', 'is_device_error', 'error_code'],
14247
+ type: 'object',
14248
+ },
14249
+ {
14250
+ description: 'Account is disconnected.',
14251
+ properties: {
14252
+ error_code: {
14253
+ description:
14254
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14255
+ enum: ['account_disconnected'],
14256
+ type: 'string',
14491
14257
  },
14492
- {
14493
- description: 'Subscription required to connect.',
14494
- properties: {
14495
- error_code: {
14496
- description:
14497
- 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14498
- enum: ['subscription_required'],
14499
- type: 'string',
14500
- },
14501
- is_device_error: { enum: [true], type: 'boolean' },
14502
- message: { type: 'string' },
14503
- },
14504
- required: ['message', 'is_device_error', 'error_code'],
14505
- type: 'object',
14258
+ is_connected_account_error: {
14259
+ enum: [true],
14260
+ type: 'boolean',
14506
14261
  },
14262
+ message: { type: 'string' },
14263
+ },
14264
+ required: [
14265
+ 'message',
14266
+ 'is_connected_account_error',
14267
+ 'error_code',
14507
14268
  ],
14269
+ type: 'object',
14508
14270
  },
14509
14271
  {
14510
- oneOf: [
14511
- {
14512
- description: 'Account is disconnected.',
14513
- properties: {
14514
- error_code: {
14515
- description:
14516
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
14517
- enum: ['account_disconnected'],
14518
- type: 'string',
14519
- },
14520
- is_connected_account_error: {
14521
- enum: [true],
14522
- type: 'boolean',
14523
- },
14524
- message: { type: 'string' },
14525
- },
14526
- required: [
14527
- 'message',
14528
- 'is_connected_account_error',
14529
- 'error_code',
14530
- ],
14531
- type: 'object',
14272
+ description: 'Credentials provided were invalid.',
14273
+ properties: {
14274
+ error_code: {
14275
+ description:
14276
+ 'Unique identifier of the type of error. Enables quick recognition and categorization of the issue.',
14277
+ enum: ['invalid_credentials'],
14278
+ type: 'string',
14532
14279
  },
14533
- {
14534
- description: 'Credentials provided were invalid.',
14535
- properties: {
14536
- error_code: {
14537
- description:
14538
- 'Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.',
14539
- enum: ['invalid_credentials'],
14540
- type: 'string',
14541
- },
14542
- is_connected_account_error: {
14543
- enum: [true],
14544
- type: 'boolean',
14545
- },
14546
- message: { type: 'string' },
14547
- },
14548
- required: [
14549
- 'message',
14550
- 'is_connected_account_error',
14551
- 'error_code',
14552
- ],
14553
- type: 'object',
14280
+ is_connected_account_error: {
14281
+ enum: [true],
14282
+ type: 'boolean',
14554
14283
  },
14284
+ message: { type: 'string' },
14285
+ },
14286
+ required: [
14287
+ 'message',
14288
+ 'is_connected_account_error',
14289
+ 'error_code',
14555
14290
  ],
14291
+ type: 'object',
14556
14292
  },
14557
14293
  ],
14558
14294
  },
@@ -14709,6 +14445,7 @@ export default {
14709
14445
  description:
14710
14446
  'Array of warnings associated with the device. Each warning object within the array contains two fields: "warning_code" and "message." "warning_code" is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. "message" provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.',
14711
14447
  items: {
14448
+ discriminator: { propertyName: 'warning_code' },
14712
14449
  oneOf: [
14713
14450
  {
14714
14451
  description: 'Backup access code unhealthy.',
@@ -25718,6 +25455,8 @@ export default {
25718
25455
  },
25719
25456
  '/thermostats/simulate/hvac_mode_adjusted': {
25720
25457
  post: {
25458
+ description:
25459
+ 'Simulates having adjusted the [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) for a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats). Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).',
25721
25460
  operationId: 'thermostatsSimulateHvacModeAdjustedPost',
25722
25461
  requestBody: {
25723
25462
  content: {
@@ -25727,8 +25466,17 @@ export default {
25727
25466
  oneOf: [
25728
25467
  {
25729
25468
  properties: {
25730
- device_id: { format: 'uuid', type: 'string' },
25731
- hvac_mode: { enum: ['off'], type: 'string' },
25469
+ device_id: {
25470
+ description: 'ID of the desired thermostat device.',
25471
+ format: 'uuid',
25472
+ type: 'string',
25473
+ },
25474
+ hvac_mode: {
25475
+ description:
25476
+ 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
25477
+ enum: ['off'],
25478
+ type: 'string',
25479
+ },
25732
25480
  },
25733
25481
  required: ['hvac_mode', 'device_id'],
25734
25482
  type: 'object',
@@ -25736,31 +25484,57 @@ export default {
25736
25484
  {
25737
25485
  properties: {
25738
25486
  cooling_set_point_celsius: {
25487
+ description:
25488
+ 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
25739
25489
  format: 'float',
25740
25490
  type: 'number',
25741
25491
  },
25742
25492
  cooling_set_point_fahrenheit: {
25493
+ description:
25494
+ 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
25743
25495
  format: 'float',
25744
25496
  type: 'number',
25745
25497
  },
25746
- device_id: { format: 'uuid', type: 'string' },
25747
- hvac_mode: { enum: ['cool'], type: 'string' },
25498
+ device_id: {
25499
+ description: 'ID of the desired thermostat device.',
25500
+ format: 'uuid',
25501
+ type: 'string',
25502
+ },
25503
+ hvac_mode: {
25504
+ description:
25505
+ 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
25506
+ enum: ['cool'],
25507
+ type: 'string',
25508
+ },
25748
25509
  },
25749
25510
  required: ['hvac_mode', 'device_id'],
25750
25511
  type: 'object',
25751
25512
  },
25752
25513
  {
25753
25514
  properties: {
25754
- device_id: { format: 'uuid', type: 'string' },
25515
+ device_id: {
25516
+ description: 'ID of the desired thermostat device.',
25517
+ format: 'uuid',
25518
+ type: 'string',
25519
+ },
25755
25520
  heating_set_point_celsius: {
25521
+ description:
25522
+ 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
25756
25523
  format: 'float',
25757
25524
  type: 'number',
25758
25525
  },
25759
25526
  heating_set_point_fahrenheit: {
25527
+ description:
25528
+ 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
25760
25529
  format: 'float',
25761
25530
  type: 'number',
25762
25531
  },
25763
- hvac_mode: { enum: ['heat'], type: 'string' },
25532
+ hvac_mode: {
25533
+ description:
25534
+ 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
25535
+ enum: ['heat'],
25536
+ type: 'string',
25537
+ },
25764
25538
  },
25765
25539
  required: ['hvac_mode', 'device_id'],
25766
25540
  type: 'object',
@@ -25768,23 +25542,40 @@ export default {
25768
25542
  {
25769
25543
  properties: {
25770
25544
  cooling_set_point_celsius: {
25545
+ description:
25546
+ 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `cooling_set_point_celsius` or `cooling_set_point_fahrenheit`.',
25771
25547
  format: 'float',
25772
25548
  type: 'number',
25773
25549
  },
25774
25550
  cooling_set_point_fahrenheit: {
25551
+ description:
25552
+ 'Desired simulated cooling [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `cooling_set_point_fahrenheit` or `cooling_set_point_celsius`.',
25775
25553
  format: 'float',
25776
25554
  type: 'number',
25777
25555
  },
25778
- device_id: { format: 'uuid', type: 'string' },
25556
+ device_id: {
25557
+ description: 'ID of the desired thermostat device.',
25558
+ format: 'uuid',
25559
+ type: 'string',
25560
+ },
25779
25561
  heating_set_point_celsius: {
25562
+ description:
25563
+ 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °C. You must set `heating_set_point_celsius` or `heating_set_point_fahrenheit`.',
25780
25564
  format: 'float',
25781
25565
  type: 'number',
25782
25566
  },
25783
25567
  heating_set_point_fahrenheit: {
25568
+ description:
25569
+ 'Desired simulated heating [set point](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/set-points) in °F. You must set `heating_set_point_fahrenheit` or `heating_set_point_celsius`.',
25784
25570
  format: 'float',
25785
25571
  type: 'number',
25786
25572
  },
25787
- hvac_mode: { enum: ['heat_cool'], type: 'string' },
25573
+ hvac_mode: {
25574
+ description:
25575
+ 'Desired [HVAC mode](https://docs.seam.co/latest/capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode) to simulate.',
25576
+ enum: ['heat_cool'],
25577
+ type: 'string',
25578
+ },
25788
25579
  },
25789
25580
  required: ['hvac_mode', 'device_id'],
25790
25581
  type: 'object',
@@ -25820,19 +25611,36 @@ export default {
25820
25611
  'x-fern-sdk-group-name': ['thermostats', 'simulate'],
25821
25612
  'x-fern-sdk-method-name': 'hvac_mode_adjusted',
25822
25613
  'x-response-key': null,
25614
+ 'x-title': 'HVAC Mode Adjusted',
25823
25615
  },
25824
25616
  },
25825
25617
  '/thermostats/simulate/temperature_reached': {
25826
25618
  post: {
25619
+ description:
25620
+ 'Simulates a [thermostat](https://docs.seam.co/latest/capability-guides/thermostats) reaching a specified temperature. Only applicable for [sandbox devices](https://docs.seam.co/latest/core-concepts/workspaces#sandbox-workspaces). See also [Testing Your Thermostat App with Simulate Endpoints](https://docs.seam.co/latest/capability-guides/thermostats/testing-your-thermostat-app-with-simulate-endpoints).',
25827
25621
  operationId: 'thermostatsSimulateTemperatureReachedPost',
25828
25622
  requestBody: {
25829
25623
  content: {
25830
25624
  'application/json': {
25831
25625
  schema: {
25832
25626
  properties: {
25833
- device_id: { format: 'uuid', type: 'string' },
25834
- temperature_celsius: { format: 'float', type: 'number' },
25835
- temperature_fahrenheit: { format: 'float', type: 'number' },
25627
+ device_id: {
25628
+ description: 'ID of the desired thermostat device.',
25629
+ format: 'uuid',
25630
+ type: 'string',
25631
+ },
25632
+ temperature_celsius: {
25633
+ description:
25634
+ 'Desired simulated temperature in °C. You must set `temperature_celsius` or `temperature_fahrenheit`.',
25635
+ format: 'float',
25636
+ type: 'number',
25637
+ },
25638
+ temperature_fahrenheit: {
25639
+ description:
25640
+ 'Desired simulated temperature in °F. You must set `temperature_fahrenheit` or `temperature_celsius`.',
25641
+ format: 'float',
25642
+ type: 'number',
25643
+ },
25836
25644
  },
25837
25645
  required: ['device_id'],
25838
25646
  type: 'object',
@@ -25866,6 +25674,7 @@ export default {
25866
25674
  'x-fern-sdk-group-name': ['thermostats', 'simulate'],
25867
25675
  'x-fern-sdk-method-name': 'temperature_reached',
25868
25676
  'x-response-key': null,
25677
+ 'x-title': 'Temperature Reached',
25869
25678
  },
25870
25679
  },
25871
25680
  '/thermostats/update_climate_preset': {